X-Laravel / model-settings-bag

src/HasSettingsBag.php

<?php

namespace XLaravel\ModelSettingsBag;

use Illuminate\Support\Arr;
use XLaravel\ModelSettingsBag\Exceptions\Exception;

trait HasSettingsBag
{
    # Boot the HasSettingsBag trait.
    public static function bootHasSettingsBag(): void
    {
        self::creating(function ($model) {
            if (!$model->settings) {
                $model->settings = $model->getDefaultSettings() ?: null;
            }
        });

        self::saving(function ($model) {
            if ($model->settings && property_exists($model, 'allowedSettings') && is_array($model->allowedSettings)) {
                $model->settings = Arr::only($model->settings, $model->allowedSettings);
            }
        });
    }

    # Get the model's default settings.
    public function getDefaultSettings(): array
    {
        return (isset($this->defaultSettings) && is_array($this->defaultSettings))
            ? $this->defaultSettings
            : [];
    }

    # Get the settings attribute.
    public function getSettingsAttribute($settings)
    {
        return json_decode($settings, true);
    }

    # Set the settings attribute.
    public function setSettingsAttribute($settings): void
    {
        $this->attributes['settings'] = json_encode($settings);

The property attributes does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    # The model's settings.
    public function settings(string $settingName = null): SettingsBag
    {
        if ($settingName === null) {
            return new SettingsBag($this);

$this of type XLaravel\ModelSettingsBag\HasSettingsBag is incompatible with the type Illuminate\Database\Eloquent\Model expected by parameter $model of XLaravel\ModelSettingsBag\SettingsBag::__construct().

        }

        $settingRelation = $settingName . 'SettingsBag';
        if (!method_exists($this, $settingRelation) || !in_array(__TRAIT__, class_uses($this->{$settingRelation}))) {
            throw new Exception($settingName . ' setting not available on ' . get_class($this) . ' model');
        }

        $settingModel = $this->{$settingRelation};
        if ($settingModel === null) {
            $settingModel = $this->{$settingRelation}()->getRelated();
            $settingModel->{$this->getForeignKey()} = $this->{$this->getKeyName()};

The method getForeignKey() does not exist on XLaravel\ModelSettingsBag\HasSettingsBag. Since you implemented __call, consider adding a @method annotation.

The method getKeyName() does not exist on XLaravel\ModelSettingsBag\HasSettingsBag. Since you implemented __call, consider adding a @method annotation.

        }

        return new SettingsBag($settingModel);
    }

    # Map settings() to another alias specified with $mapSettingsTo.
    public function __call($name, $args)
    {
        if (isset($this->mapSettingsTo) && $name == $this->mapSettingsTo) {
            return $this->settings(...$args);

$args is expanded, but the parameter $settingName of XLaravel\ModelSettingsBag\HasSettingsBag::settings() does not expect variable arguments.

        }

        return is_callable(['parent', '__call'])
            ? parent::__call($name, $args)
            : null;
    }
}