Backpack\CRUD\app\Library\CrudPanel\Traits\Settings

Complexity

Total Complexity

16

Size/Duplication

Total Lines	158
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	set()	0	3	1
A	get()	0	3	1
A	operationSetting()	0	5	1
A	setting()	0	7	2
A	getOperationSetting()	0	5	1
A	setOperationSetting()	0	5	1
A	loadDefaultOperationSettingsFromConfig()	0	9	4
A	has()	0	7	2
A	hasOperationSetting()	0	5	1
A	settings()	0	4	1
A	getAvailableOperationsList()	0	8	1

<?php

namespace Backpack\CRUD\app\Library\CrudPanel\Traits;

use Illuminate\Support\Arr;

/**
 * Key-value store for operations.
 */
trait Settings
{
    protected $settings = [];

    /**
     * Getter for the settings key-value store.
     *
     * @param  string  $key  Usually operation.name (ex: list.exportButtons)
     * @return mixed [description]
     */
    public function get(string $key)
    {
        return $this->settings[$key] ?? null;
    }

    /**
     * Setter for the settings key-value store.
     *
     * @param  string  $key  Usually operation.name (ex: reorder.max_level)
     * @param  mixed  $value  The value you want to store.
     * @return mixed Setting value.
     */
    public function set(string $key, $value)
    {
        return $this->settings[$key] = $value;
    }

    /**
     * Check if the settings key is used (has a value).
     *
     * @param  string  $key  Usually operation.name (ex: reorder.max_level)
     * @return bool
     */
    public function has(string $key)
    {
        if (isset($this->settings[$key])) {
            return true;
        }

        return false;
    }

    /**
     * Get all operation settings, ordered by key.
     *
     * @return array
     */
    public function settings()
    {
        return Arr::sort($this->settings, function ($value, $key) {
            return $key;
        });
    }

    /**
     * Getter and setter for the settings key-value store.
     *
     * @param  string  $key  Usually operation.name (ex: list.exportButtons)
     * @param  mixed  $value  The value you want to store.
     * @return mixed Setting value for setter. True/false for getter.
     */
    public function setting(string $key, $value = null)
    {
        if ($value === null) {
            return $this->get($key);
        }

        return $this->set($key, $value);
    }

    /**
     * Convenience method for getting or setting a key on the current operation.
     *
     * @param  string  $key  Has no operation prepended. (ex: exportButtons)
     * @param  mixed  $value  The value you want to store.
     * @return mixed Setting value for setter. True/false for getter.
     */
    public function operationSetting(string $key, $value = null, $operation = null)
    {
        $operation = $operation ?? $this->getCurrentOperation();

It seems like getCurrentOperation() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this->setting($operation.'.'.$key, $value);
    }

    /**
     * Getter for the settings key-value store on a certain operation.
     * Defaults to the current operation.
     *
     * @param  string  $key  Has no operation prepended. (ex: exportButtons)
     * @return mixed [description]
     */
    public function getOperationSetting(string $key, $operation = null)
    {
        $operation = $operation ?? $this->getCurrentOperation();

        return $this->get($operation.'.'.$key) ?? config('backpack.crud.operations.'.$this->getCurrentOperation().'.'.$key) ?? null;
    }

    /**
     * Check if the settings key is used (has a value).
     * Defaults to the current operation.
     *
     * @param  string  $key  Has no operation prepended. (ex: exportButtons)
     * @return mixed [description]
     */
    public function hasOperationSetting(string $key, $operation = null)
    {
        $operation = $operation ?? $this->getCurrentOperation();

        return $this->has($operation.'.'.$key);
    }

    /**
     * Setter for the settings key-value store for a certain operation.
     * Defaults to the current operation.
     *
     * @param  string  $key  Has no operation prepended. (ex: max_level)
     * @param  bool  $value  True/false depending on success.
     */
    public function setOperationSetting(string $key, $value, $operation = null)
    {
        $operation = $operation ?? $this->getCurrentOperation();

        return $this->set($operation.'.'.$key, $value);
    }

    /**
     * Automatically set values in config file (config/backpack/crud)
     * as settings values for that operation.
     *
     * @param  string  $configPath  Config string that leads to where the configs are stored.
     */
    public function loadDefaultOperationSettingsFromConfig($configPath = null)
    {
        $operation = $this->getCurrentOperation();
        $configPath = $configPath ?? 'backpack.operations.'.$operation;
        $configSettings = config($configPath);

        if (is_array($configSettings) && count($configSettings)) {
            foreach ($configSettings as $key => $value) {
                $this->setOperationSetting($key, $value);
            }
        }
    }

    /**
     * Get the current CRUD operations loaded.
     *
     * @return array operaiton names
     */
    public function getAvailableOperationsList(): array
    {
        return collect($this->settings)

$this->settings of type array is incompatible with the type Illuminate\Contracts\Support\Arrayable expected by parameter $value of collect().

            ->keys()
            ->filter(fn(string $key): bool => str_contains($key, '.access'))
            ->map(fn(string $key): string => str_replace('.access', '', $key))
            ->values()
            ->toArray();
    }
}