pheme\settings\models\BaseSetting

Complexity

Total Complexity

33

Size/Duplication

Total Lines	207
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

97.65%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	tableName()	0	4	1
A	afterSave()	0	5	1
A	afterDelete()	0	5	1
A	activateSetting()	0	10	3
A	deactivateSetting()	0	10	3
A	rules()	0	15	1
A	behaviors()	0	13	1
A	getSettings()	0	8	1
A	setSetting()	0	21	4
A	deleteSetting()	0	8	2
A	deleteAllSettings()	0	4	1
A	findSetting()	0	13	3
B	getValueType()	0	42	11

<?php
/**
 * @link http://phe.me
 * @copyright Copyright (c) 2014 Pheme
 * @license MIT http://opensource.org/licenses/MIT
 */

namespace pheme\settings\models;

use Yii;
use yii\base\InvalidArgumentException;
use yii\helpers\Json;
use yii\db\ActiveRecord;
use yii\helpers\ArrayHelper;
use yii\behaviors\TimestampBehavior;

/**
 * This is the model class for table "settings".
 *
 * @property integer $id
 * @property string $type
 * @property string $section
 * @property string $key
 * @property string $value
 * @property boolean $active
 * @property string $created
 * @property string $modified
 *
 * @author Aris Karageorgos <aris@phe.me>
 */
class BaseSetting extends ActiveRecord implements SettingInterface
{
    /**
     * @inheritdoc
     */
    public static function tableName()
    {
        return '{{%settings}}';
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return [
            [['value'], 'string'],
            [['section', 'key'], 'string', 'max' => 255],
            [
                ['key'],
                'unique',
                'targetAttribute' => ['section', 'key'],
            ],
            ['type', 'in', 'range' => ['string', 'integer', 'boolean', 'float', 'double', 'object', 'null', 'ip', 'email', 'url']],
            [['created', 'modified'], 'safe'],
            [['active'], 'boolean'],
        ];
    }

    public function afterSave($insert, $changedAttributes)
    {
        parent::afterSave($insert, $changedAttributes);
        Yii::$app->settings->clearCache();
    }

    public function afterDelete()
    {
        parent::afterDelete();
        Yii::$app->settings->clearCache();
    }

    /**
     * @return array
     */
    public function behaviors()
    {
        return [
            'timestamp' => [
                'class' => TimestampBehavior::className(),

The method yii\base\BaseObject::className() has been deprecated with message: since 2.0.14. On PHP >=5.5, use `::class` instead.

                'attributes' => [
                    ActiveRecord::EVENT_BEFORE_INSERT => 'created',
                    ActiveRecord::EVENT_BEFORE_UPDATE => 'modified',
                ],
                'value' => date('Y-m-d H:i:s'),//new Expression('NOW()'),
            ],
        ];
    }

    /**
     * @inheritdoc
     */
    public function getSettings()
    {
        $settings = static::find()->where(['active' => true])->asArray()->all();
        return array_merge_recursive(
            ArrayHelper::map($settings, 'key', 'value', 'section'),
            ArrayHelper::map($settings, 'key', 'type', 'section')
        );
    }

    /**
     * @inheritdoc
     */
    public function setSetting($section, $key, $value, $type = null)
    {
        $model = static::findOne(['section' => $section, 'key' => $key]);

        if ($model === null) {
            $model = new static();
            $model->active = 1;
        }
        $model->section = $section;
        $model->key = $key;
        $model->value = strval($value);

        if ($type !== null) {
            $model->type = $type;
        } elseif ( ! isset($model->type) ) {
            $type = $this->getValueType($value);
            $model->type = $type;
        }

        return $model->save();
    }

    /**
     * @inheritdoc
     */
    public function activateSetting($section, $key)
    {
        $model = static::findOne(['section' => $section, 'key' => $key]);

        if ($model && $model->active == 0) {
            $model->active = 1;
            return $model->save();
        }
        return false;
    }

    /**
     * @inheritdoc
     */
    public function deactivateSetting($section, $key)
    {
        $model = static::findOne(['section' => $section, 'key' => $key]);

        if ($model && $model->active == 1) {
            $model->active = 0;
            return $model->save();
        }
        return false;
    }

    /**
     * @inheritdoc
     */
    public function deleteSetting($section, $key)
    {
        $model = static::findOne(['section' => $section, 'key' => $key]);

        if ($model) {
            return $model->delete();
        }
    }

    /**
     * @inheritdoc
     */
    public function deleteAllSettings()
    {
        return static::deleteAll();

The return type of return static::deleteAll(); (integer) is incompatible with the return type declared by the interface pheme\settings\models\SettingInterface::deleteAllSettings of type boolean.

    }

    /**
     * @inheritdoc
     */
    public function findSetting($key, $section = null)
    {
        if (is_null($section)) {
            $pieces = explode('.', $key, 2);
            if (count($pieces) > 1) {
                $section = $pieces[0];
                $key = $pieces[1];
            } else {
                $section = '';
            }
        }
        return $this->find()->where(['section' => $section, 'key' => $key])->limit(1)->one();

The return type of return $this->find()->where(array('section' => $section, 'key' => $key))->limit(1)->one(); (yii\db\ActiveRecord|array|null) is incompatible with the return type declared by the interface pheme\settings\models\SettingInterface::findSetting of type pheme\settings\models\SettingInterface.

    }

    /**
     * @param $value
     * @return string|void
     */
    protected function getValueType($value)
    {

        if (filter_var($value, FILTER_VALIDATE_EMAIL)) {
            return 'email';
        }

        if (filter_var($value, FILTER_VALIDATE_URL)) {
            return 'url';
        }

        if (filter_var($value, FILTER_VALIDATE_IP)) {
            return 'ip';
        }

        if (filter_var($value, FILTER_VALIDATE_BOOLEAN)) {
            return 'boolean';
        }

        if (filter_var($value, FILTER_VALIDATE_INT)) {
            return 'integer';
        }

        if (filter_var($value, FILTER_VALIDATE_FLOAT)) {
            return 'float';
        }

        $t = gettype($value);

        if ($t === 'string' && !empty($value)) {
            $error = false;
            try {
                Json::decode($value);
            } catch (InvalidArgumentException $e) {
                $error = true;
            }
            if (!$error) {
                $t = 'object';
            }
        }
        return $t;
    }
}