FileStateForm::isEnabled() - Code Metrics - Inspection of "replace css class" - Dominus77/yii2-advanced-start - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( ff2b0b...f369f8 )

by Alexey
created 2020-02-29 01:11 UTC
FileStateForm::isEnabled() A

↳ Parent: FileStateForm
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	1
c	1
b	0
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	0
<?php

namespace common\components\maintenance\models;

use Yii;
use yii\base\Model;
use yii\base\InvalidConfigException;
use yii\helpers\ArrayHelper;
use common\components\maintenance\interfaces\StateInterface;
use common\components\maintenance\states\FileState;
use Exception;

/**
 * Class FileStateForm
 * @package common\components\maintenance\models
 *
 * @property mixed $followers
 * @property mixed $datetime
 * @property mixed $modeName
 * @property string $dateFormat
 * @property int $timestamp
 */
class FileStateForm extends Model
{
    const MODE_MAINTENANCE_ON = 'On';
    const MODE_MAINTENANCE_OFF = 'Off';
    const MAINTENANCE_NOTIFY_SENDER_KEY = 'notifySender';
    const MAINTENANCE_UPDATE_KEY = 'maintenanceUpdate';

    /**
     * Select mode
     * @var array
     */
    public $mode;
    /**
     * Datetime
     * @var string
     */
    public $date;
    /**
     * Title
     * @var string
     */
    public $title;
    /**
     * Text
     * @var string
     */
    public $text;
    /**
     * Subscribe
     * @var bool
     */
    public $subscribe = true;
    /**
     * CountDown
     * @var bool
     */
    public $countDown = true;

    /**
     * @var StateInterface
     */
    protected $state;

    /**
     * @var array
     */
    private $followers;

    /**
     * @inheritDoc
     */
    public function init()
    {
        parent::init();
        $this->state = Yii::$container->get(StateInterface::class);
        $this->mode = self::MODE_MAINTENANCE_OFF;

        $this->date = $this->datetime;
        $this->title = $this->title ?: Yii::t('app', $this->state->defaultTitle);
        $this->text = $this->text ?: Yii::t('app', $this->state->defaultContent);
        $this->setFollowers();
        $this->setData();
    }

    /**
     * @inheritDoc
     * @return array
     */
    public function rules()
    {
        return [
            ['date', 'trim'],
            ['mode', 'required'],
            ['date', 'string', 'max' => 19],
            ['date', 'validateDateAttribute'],
            [['title', 'text'], 'string'],
            [['subscribe', 'countDown'], 'boolean']
        ];
    }

    /**
     * @param $attribute
     * @throws InvalidConfigException
     */
    public function validateDateAttribute($attribute)
    {
        if ($attribute && !$this->state->validDate($this->$attribute)) {
        if ($attribute && !$this->state->/** @scrutinizer ignore-call */ validDate($this->$attribute)) {
            $example = Yii::$app->formatter->asDatetime(time(), 'php:' . $this->state->dateFormat);

            $this->addError($attribute, Yii::t('app', 'Invalid date format. Use example: {:example}', [':example' => $example]));
        }
    }

    /**
     * @inheritDoc
     * @return array
     */
    public function attributeLabels()
    {
        return [
            'mode' => Yii::t('app', 'Mode'),
            'date' => Yii::t('app', 'Date and Time'),
            'title' => Yii::t('app', 'Title'),
            'text' => Yii::t('app', 'Text'),
            'subscribe' => Yii::t('app', 'Subscribe'),
            'countDown' => Yii::t('app', 'Count Down'),
        ];
    }

    /**
     * Mode name
     * @return mixed
     */
    public function getModeName()
    {
        return ArrayHelper::getValue(self::getModesArray(), $this->mode);
    }

    /**
     * Modes
     * @return array
     */
    public static function getModesArray()
    {
        return [
            self::MODE_MAINTENANCE_OFF => Yii::t('app', 'Mode normal'),
            self::MODE_MAINTENANCE_ON => Yii::t('app', 'Mode maintenance'),
        ];
    }

    /**
     * Save this in file
     */
    public function save()
    {
        $result = false;
        if ($this->mode === self::MODE_MAINTENANCE_ON) {

            if ($this->isEnabled()) {
                $this->update();
                Yii::$app->session->setFlash(self::MAINTENANCE_UPDATE_KEY, Yii::t('app', 'Maintenance mode successfully updated!'));
                $result = true;
            } else {
                $this->enable();
                $result = true;
            }
        }
        if ($this->mode === self::MODE_MAINTENANCE_OFF) {

            $count = $this->disable();
            Yii::$app->session->setFlash(self::MAINTENANCE_NOTIFY_SENDER_KEY, Yii::t('app',
                '{n, plural, =0{no followers} =1{one message sent} other{# messages sent}}',
                ['n' => $count])
            );
            $result = true;
        }
        return $result;
    }

    /**
     * Enable
     * @return mixed
     */
    public function enable()
    {
        $subscribe = $this->subscribe ? FileState::MAINTENANCE_SUBSCRIBE_ON : FileState::MAINTENANCE_SUBSCRIBE_OFF;
        return $this->state->enable($this->date, $this->title, $this->text, $subscribe);
    }

    /**
     * Update
     * @return array
     */
    public function update()
    {
        $result = [];
        foreach ($this->attributes as $key => $value) {
            if ($key === FileState::MAINTENANCE_PARAM_SUBSCRIBE) {
                $value = $value ? FileState::MAINTENANCE_SUBSCRIBE_ON : FileState::MAINTENANCE_SUBSCRIBE_OFF;
            }
            $result[$key] = $this->state->update($key, $value);
        }
        return $result;
    }

    /**
     * Disable
     * @return int|mixed
     */
    public function disable()
    {
        return $this->state->disable();
    }

    /**
     * @return mixed
     * @throws Exception
     */
    public function getDatetime()
    {
        return $this->state->datetime($this->getTimestamp(), $this->state->dateFormat);
        return $this->state->/** @scrutinizer ignore-call */ datetime($this->getTimestamp(), $this->state->dateFormat);
    }

    /**
     * @return int
     * @throws Exception
     */
    public function getTimestamp()
    {
        return $this->state->timestamp();
        return $this->state->/** @scrutinizer ignore-call */ timestamp();
    }

    /**
     * @return array
     */
    public function getFollowers()
    {
        $items = [];
        foreach ($this->followers as $follower) {
            $items[]['email'] = $follower;
        }
        return $items;
    }

    /**
     * @param array $followers
     */
    public function setFollowers($followers = [])
    {
        $this->followers = $followers ?: $this->state->emails();
        $this->followers = $followers ?: $this->state->/** @scrutinizer ignore-call */ emails();
    }

    /**
     * @return bool
     */
    public function isEnabled()
    {
        return $this->state->isEnabled();
    }

    /**
     * @return string
     */
    public function getDateFormat()
    {
        return $this->state->dateFormat;

    }

    /**
     * Set data is enabled
     */
    private function setData()
    {
        if ($this->isEnabled()) {
            $this->mode = self::MODE_MAINTENANCE_ON;

            $this->date = $this->datetime;
            $this->title = $this->state->getParams(FileState::MAINTENANCE_PARAM_TITLE);
            $this->title = $this->state->getParams(FileState::MAINTENANCE_PARAM_TITLE);
            $this->text = $this->state->getParams(FileState::MAINTENANCE_PARAM_CONTENT);
            $subscribe = $this->state->getParams(FileState::MAINTENANCE_PARAM_SUBSCRIBE);
            $this->subscribe = ($subscribe === FileState::MAINTENANCE_SUBSCRIBE_ON);
            $this->countDown = true;
        }
    }
}

Dominus77 / yii2-advanced-start

Push — master ( ff2b0b...f369f8 )

FileStateForm::isEnabled() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
