solutosoft / yii-settings

src/Settings.php

<?php

namespace Soluto\Settings;

use Yii;
use yii\base\Component;
use yii\db\Connection;
use yii\db\Query;
use yii\base\Event;

class Settings extends Component
{
    /**
     * @event SettingsEvent an event that is triggered before execute command.
     */
    const EVENT_BEFORE_EXECUTE = 'beforeExecute';

    /**
     * @var string Name of the table where configurations will be stored
     */
    public $tableName = '{{%setting}}';

    /**
     * @var string Name of column where keys will be stored
     */
    public $keyColumnName = 'key';

    /**
     * @var string Name of column where values will be stored
     */
    public $valueColumnName = 'value';

    /**
     * @return Connection the DB connection instance
     */
    protected function getDb()
    {
        return Yii::$app->getDb();
    }

    /**
     * Whether the configuration exists in the database
     * @param string $name configuration name
     * @param integer $tenantId The tenant id value
     * @return bool
     */
    protected function exists($name)
    {
        $query = $this->createQuery($name);
        return $query->exists();
    }

    /**
     * Returns configuration value from database
     * @param string $name configuration name
     * @return string value stored in database
     */
    public function get($name, $defaultValue = null)
    {
        $value = null;
        $query = $this->createQuery($name);
        $row = $query->one($this->getDb());

        $value = ($row) ? $row[$this->valueColumnName] : null;

        if (is_string($value) && trim($value) == '') {
            $value = null;
        }

        return ($value !== null) ? $value : $defaultValue;
    }

    /**
     * Store configuration value to database
     * @param string $name
     * @param mixed $value
     */
    public function set($name, $value)
    {
        $db = $this->getDb();
        $values = [$this->valueColumnName => $value];
        $where = [$this->keyColumnName => $name];

        $event = $this->beforeExecute();
        if ($event->data) {
            $values = array_merge($event->data, $values);
            $where = array_merge($event->data, $where);
        }

        if ($this->exists($name)) {
            $db->createCommand()
                ->update($this->tableName, $values, $where)
                ->execute();
        } else  {
            $values = array_merge($values, $where);

            $db->createCommand()
                ->insert($this->tableName, $values)
                ->execute();
        }
    }

    /**
     * Retrieves all configurations stored in database
     * @param integer $tenantId
     * @return array
     */
    public function all()
    {
        $result = [];

        $query = $this->createQuery()
            ->addSelect($this->keyColumnName);

        $rows = $query->all($this->getDb());

        foreach ($rows as $row) {
            $result[$row[$this->keyColumnName]] = $row[$this->valueColumnName];
        }

        return $result;
    }

    /**
     * Store all configuration in database
     * @param array $names
     */
    public function save($names)
    {
        foreach ($names as $key => $value) {
            $this->set($key, $value) ;
        }
    }

    /**
     * Remove specified setting
     * @param array|string $name
     */
    public function remove($name)
    {
        $where = [$this->keyColumnName => $name];

        $event = $this->beforeExecute();
        if ($event->data) {
            $where = array_merge($event->data, $where);
        }

        $this->getDb()
            ->createCommand()
            ->delete($this->tableName, $where)
            ->execute();
    }

    /**
     * Removes all settings
     */
    public function removeAll()
    {
        $event = $this->beforeExecute();
        $where = $event->data ? $event->data : '';

        $this->getDb()
            ->createCommand()
            ->delete($this->tableName, $where)
            ->execute();
    }

    /**
     * Creates query to find settings value
     * @param string $name
     * @return \yii\db\Query
     */
    protected function createQuery($name = null)
    {
        $query = (new Query())
            ->select([$this->valueColumnName])
            ->from($this->tableName);

        $event = $this->beforeExecute();

        if ($event->data) {
            $query->andWhere($event->data);
        }

        if ($name) {

The expression $name of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $query->andWhere([$this->keyColumnName => $name]);
        }

        return $query;
    }

    /**
     * This method is called at the before execute db command
     * @return yii\base\Event
     */
    protected function beforeExecute()
    {
        $event = new Event();
        $this->trigger(self::EVENT_BEFORE_EXECUTE, $event);
        return $event;
    }

}