Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory :  /home/corals/ts.corals.io/corals-api/Corals/core/Settings/Traits/

Upload File : current_dir [ Writeable ] document_root [ Writeable ]

<?php

namespace Corals\Settings\Traits;

use Corals\Settings\Models\ModelSetting;

trait HasSettings
{
    /**
     * Returns a morphMany relationship.
     *
     * @return morphMany The relationship.
     */
    public function settings()
    {
        return $this->morphMany(ModelSetting::class, 'model');
    }

    /**
     * Returns a Setting model instance.
     *
     * @param string $code Setting code.
     * @return ModelSetting The Setting model.
     */
    public function getSetting(string $code)
    {
        return $this->settings()->where('code', $code)->first();
    }

    /**
     * Get the value of a setting by code and cast type. If no cast type is provided,
     * it will return using the cast stored in the database.
     *
     * @param string $code Setting code.
     * @param string $castType The cast type of the value returned.
     * @return null|string|int|bool|float The value of the setting. Null if does not exist.
     */
    public function getSettingValue(string $code, $castType = null)
    {
        $setting = $this->getSetting($code);
        $value = optional($setting)->value;

        if (is_null($value)) {
            return null;
        }

        return $this->castValue($value, ($castType) ?: $setting->cast_type);
    }

    protected function castValue($value, $castType, $inverse = false)
    {
        switch ($castType) {
            case 'string':
                return (string)$value;
            case 'integer':
                return (int)$value;
            case 'boolean':
                if ($inverse) {
                    return $value;
                }
                return (bool)((string)$value === '1' || (string)$value === 'true');
            case 'float':
                return (float)$value;
            case 'array':
                if ($inverse) {
                    return json_encode($value);
                }
                return json_decode($value, true);
            default:
                return (string)$value;
        }
    }

    /**
     * Set up a new setting. If the code exists, it updated it.
     *
     * @param string $code Setting code.
     * @param null|string|int|bool|float $value The setting value.
     * @param string $castType The cast type of the value.
     * @return ModelSetting The Setting model.
     */
    public function newSetting(string $code, $value = null, $castType = 'string')
    {
        $castType = $this->validateCastType($castType);

        $value = $this->castValue($value, $castType, true);

        if ($setting = $this->getSetting($code)) {
            return $this->updateSetting($code, $value, $castType);
        }

        $castType = (!is_null($castType)) ? $castType : 'string';

        return $this->settings()->save(new ModelSetting([
            'code' => $code,
            'value' => $value,
            'cast_type' => $castType,
        ]));
    }

    /**
     * Update a setting. If the code does not exist, it is added.
     *
     * @param string $code Setting code.
     * @param null|string|int|bool|float $newValue The setting value.
     * @param string $castType The cast type of the value.
     * @return ModelSetting The Setting model.
     */
    public function updateSetting(string $code, $newValue = null, $castType = null)
    {
        if (!$setting = $this->getSetting($code)) {
            return $this->newSetting($code, $newValue, $castType);
        }

        $castType = $this->validateCastType($castType);

        $setting->update([
            'value' => $newValue,
            'cast_type' => (!is_null($castType)) ? $castType : $setting->cast_type,
        ]);

        return $setting;
    }

    /**
     * Delete a setting. If does not exist, returns null.
     *
     * @param string $code The setting code.
     * @return bool Wether the setting was deleted or not.
     * @throws \Exception
     */
    public function deleteSetting(string $code): bool
    {
        if (!$setting = $this->getSetting($code)) {
            return false;
        }

        return (bool)$setting->delete();
    }

    /**
     * Delete all the settings.
     *
     * @return bool Wether the setting was deleted or not.
     */
    public function deleteSettings()
    {
        return (bool)$this->settings()->delete();
    }

    /**
     * Check if castType is a valid option, if not return string.
     *
     * @param null $castType
     * @return null|string
     */
    private function validateCastType($castType = null)
    {
        if (!is_null($castType) && !in_array($castType,
                ['integer', 'boolean', 'string', 'float', 'array'])) {
            return 'string';
        }

        return $castType;
    }
}