Ticaje\Configuration\Traits\General

Complexity

Total Complexity

8

Size/Duplication

Total Lines	41
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getGeneralPath()	0	3	1
A	setValue()	0	6	3
A	getXmlGeneralPath()	0	7	2
A	getGeneralConfig()	0	3	2

<?php
declare(strict_types=1);

/**
 * Status Trait
 * @category    Ticaje
 * @package     Ticaje_Setting
 * @author      Hector Luis Barrientos <ticaje@filetea.me>
 */

namespace Ticaje\Configuration\Traits;

use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Store\Model\ScopeInterface;
use Magento\Store\Model\Store;
use Ticaje\Configuration\Setting\GeneralInterface;

The type Ticaje\Configuration\Setting\GeneralInterface was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * Trait General
 * @package Ticaje\Configuration\Traits
 * Classes using this trait must implement Ticaje\Configuration\Setting\GeneralInterface
 * @Disclaimer: This trait provides the general methods for operating with all configurations within General section of adminhtml/system.xml
 */
trait General
{
    protected $generalPath = 'general'; // Could be overridden by client classes

    /**
     * @inheritDoc
     */
    public function getGeneralConfig($field = null, $storeId = null): string
    {
        return $this->scopeConfig->getValue($this->getXmlGeneralPath($field), ScopeInterface::SCOPE_STORE, $storeId) ?: '';
    }

    /**
     * @inheritDoc
     */
    public function setValue($field, $value, $storeId = null): GeneralInterface
    {
        $storeId = $storeId ?: Store::DEFAULT_STORE_ID;
        $scope = $storeId == Store::DEFAULT_STORE_ID ? ScopeConfigInterface::SCOPE_TYPE_DEFAULT : ScopeInterface::SCOPE_STORES;
        $this->resourceConfig->saveConfig($this->getXmlGeneralPath($field), $value, $scope, $storeId);
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function getXmlGeneralPath($field): string
    {
        $xmlPath = $this->getXmlBasePath() . '/' . $this->getGeneralPath();

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

        if ($field) {
            $xmlPath .= '/' . $field;
        }
        return $xmlPath;
    }

    /**
     * @inheritDoc
     */
    public function getGeneralPath(): string
    {
        return $this->generalPath;
    }
}