dominus77\maintenance\states\FileState

Complexity

Total Complexity

17

Size/Duplication

Total Lines	185
Duplicated Lines	0 %

Importance

Changes	6
Bugs	3	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	4	1
A	timestamp()	0	4	1
A	getDateFormat()	0	3	1
A	disable()	0	6	2
A	statusCode()	0	4	1
A	isEnabled()	0	3	1
A	enable()	0	6	1
A	getFilePath()	0	3	1
A	getFileStatePath()	0	3	1
A	getDefaultTitle()	0	3	1
A	getSubscribeOptionsTemplate()	0	6	3
A	getSubscribeOptions()	0	3	1
A	getDefaultContent()	0	3	1
A	getSubscribePath()	0	3	1

<?php

namespace dominus77\maintenance\states;

use Yii;
use Exception;
use yii\base\BaseObject;
use dominus77\maintenance\interfaces\StateInterface;
use dominus77\maintenance\models\FileStateForm;

/**
 * Class FileState
 * @package dominus77\maintenance\states
 *
 * @property array|mixed $subscribeOptionsTemplate
 * @property string $fileStatePath
 */
class FileState extends BaseObject implements StateInterface
{
    /**
     * @var string the filename that will determine if the maintenance mode is enabled
     */
    public $fileName = 'YII_MAINTENANCE_MODE_ENABLED';

    /**
     * Default title
     * @var string
     */
    public $defaultTitle = 'Maintenance';

    /**
     * Default content
     * @var string
     */
    public $defaultContent = 'The site is undergoing technical work. We apologize for any inconvenience caused.';

    /**
     * @var string name of the file where subscribers will be stored
     */
    public $fileSubscribe = 'YII_MAINTENANCE_MODE_SUBSCRIBE';

    /**
     * Options SubscribeFormWidget
     * @var array
     */
    public $subscribeOptions = [];

    /**
     * @var string the directory in that the file stated in $fileName above is residing
     */
    public $directory = '@runtime';

    /**
     * @var string the complete path of the file - populated in init
     */
    public $path;

    /**
     * @var string the complete path of the file subscribe - populated in init
     */
    public $subscribePath;

    /**
     * Enter Datetime format
     * @var string
     */
    public $dateFormat = 'd-m-Y H:i:s';

    /**
     * Initialization
     */
    public function init()
    {
        $this->path = $this->getFilePath($this->fileName);

It seems like $this->getFilePath($this->fileName) can also be of type boolean. However, the property $path is declared as type string. Maybe add an additional type check?

        $this->subscribePath = $this->getFilePath($this->fileSubscribe);

It seems like $this->getFilePath($this->fileSubscribe) can also be of type boolean. However, the property $subscribePath is declared as type string. Maybe add an additional type check?

    }

    /**
     * Turn on mode.
     *
     * @return bool|mixed
     */
    public function enable()
    {
        file_put_contents($this->path,
            'The maintenance Mode of your Application is enabled if this file exists.');
        chmod($this->path, 0765);
        return true;
    }

    /**
     * Turn off mode.
     *
     * @return bool|mixed
     */
    public function disable()
    {
        if (file_exists($this->path)) {
            unlink($this->path);
        }
        return true;
    }

    /**
     * @return bool will return true if the file exists
     */
    public function isEnabled()
    {
        return file_exists($this->path);
    }

    /**
     * Timestamp
     *
     * @return int
     * @throws Exception
     */
    public function timestamp()
    {
        $model = new FileStateForm();
        return $model->getTimestamp();
    }

    /**
     * Status code
     * @return int|string
     */
    public function statusCode()
    {
        $model = new FileStateForm();
        return $model->getStatusCode();

The expression return $model->getStatusCode() also could return the type string which is incompatible with the return type mandated by dominus77\maintenance\interfaces\StateInterface::statusCode() of integer.

    }

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

    /**
     * @return string
     */
    public function getDefaultTitle()
    {
        return $this->defaultTitle;
    }

    /**
     * @return string
     */
    public function getDefaultContent()
    {
        return $this->defaultContent;
    }

    /**
     * @return string
     */
    public function getFileStatePath()
    {
        return $this->path;
    }

    /**
     * @return string
     */
    public function getSubscribePath()
    {
        return $this->subscribePath;
    }

    /**
     * @return array
     */
    public function getSubscribeOptions()
    {
        return $this->subscribeOptions;
    }

    /**
     * @return array|mixed
     */
    public function getSubscribeOptionsTemplate()
    {
        return (isset($this->subscribeOptions['template']) && !empty($this->subscribeOptions['template'])) ?
            $this->subscribeOptions['template'] : [
                'html' => '@dominus77/maintenance/mail/emailNotice-html',
                'text' => '@dominus77/maintenance/mail/emailNotice-text'
            ];
    }

    /**
     * Return file path.
     *
     * @param $fileName string
     * @return bool|string
     */
    protected function getFilePath($fileName)
    {
        return Yii::getAlias($this->directory . '/' . $fileName);
    }
}