FileState::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
FileState::isEnabled() A

↳ Parent: FileState
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

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

namespace common\components\maintenance\states;

use Yii;
use DateTime;
use Generator;
use Exception;
use RuntimeException;
use yii\base\BaseObject;
use yii\base\InvalidConfigException;
use common\components\maintenance\interfaces\StateInterface;
use common\components\maintenance\models\SubscribeForm;
use yii\helpers\ArrayHelper;

/**
 * Class FileState
 * @package common\components\maintenance\states
 *
 * @property bool|string $filePath
 * @property array $contentArray
 * @property array $maintenanceFileLinesParamsArray
 * @property bool $validDate
 */
class FileState extends BaseObject implements StateInterface
{
    const MAINTENANCE_PARAM_DATE = 'date';
    const MAINTENANCE_PARAM_TITLE = 'title';
    const MAINTENANCE_PARAM_CONTENT = 'text';
    const MAINTENANCE_PARAM_SUBSCRIBE = 'subscribe';

    const MAINTENANCE_SUBSCRIBE_ON = 'true';
    const MAINTENANCE_SUBSCRIBE_OFF = 'false';

    /**
     * @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';

    /**
     * Set status subscribe
     * @var string
     */
    public $subscribe;

    /**
     * @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);
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $this->subscribePath = $this->getFilePath($this->fileSubscribe);
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $this->subscribe = $this->subscribe ?: self::MAINTENANCE_SUBSCRIBE_ON;
    }

    /**
     * Turn on mode.
     *
     * @param string $datetime
     * @param string $title
     * @param string $content
     * @param string $subscribe
     * @return mixed|void
     * @throws Exception
     */
    public function enable($datetime = '', $title = '', $content = '', $subscribe = '')
    {
        $date = new DateTime(date($this->dateFormat));
        if ($this->validDate($datetime)) {
            $date = new DateTime($datetime);
        }
        $timestamp = $date->getTimestamp();

        $title = $title ?: Yii::t('app', $this->defaultTitle);
        $content = $content ?: Yii::t('app', $this->defaultContent);
        $subscribe = $subscribe ?: $this->subscribe;

        $data = $timestamp . PHP_EOL . $title . PHP_EOL . $content . PHP_EOL . $subscribe . PHP_EOL;
        $result = file_put_contents($this->path, $data);
        chmod($this->path, 0765);

        if ($result === false) {
            throw new RuntimeException(
                "Attention: the maintenance mode could not be enabled because {$this->path} could not be created."
            );
        }
        return true;
    }

    /**
     * Update param in maintenance file
     * @param string $param
     * @param string $value
     * @return bool
     * @throws Exception
     */
    public function update($param = '', $value = '')
    {
        switch ($param) {
            case self::MAINTENANCE_PARAM_DATE:
                if ($this->validDate($value)) {
                    $date = new DateTime($value);
                    $this->replace($date->getTimestamp(), $this->getLine(self::MAINTENANCE_PARAM_DATE));
                }
                break;
            case self::MAINTENANCE_PARAM_TITLE:
                $this->replace($value, $this->getLine(self::MAINTENANCE_PARAM_TITLE));
                break;
            case self::MAINTENANCE_PARAM_CONTENT:
                $this->replace($value, $this->getLine(self::MAINTENANCE_PARAM_CONTENT));
                break;
            case self::MAINTENANCE_PARAM_SUBSCRIBE:
                $this->replace($value, $this->getLine(self::MAINTENANCE_PARAM_SUBSCRIBE));
                break;
            default:
                return false;
        }
        return true;
    }

    /**
     * Turn off mode.
     *
     * @return int|mixed
     */
    public function disable()
    {
        $result = 0;
        try {
            if (file_exists($this->path)) {
                unlink($this->path);
                $subscribe = new SubscribeForm();
                $result = $subscribe->send($this->emails());
                if ($result > 0) {
                    unlink($this->subscribePath);
                }
            }
        } catch (RuntimeException $e) {
            throw new RuntimeException(
                "Attention: the maintenance mode could not be disabled because {$this->path} could not be removed."
            );
        }
        return $result;
    }

    /**
     * File Line Param
     * @param $param
     * @return mixed
     */
    public function getLine($param)
    {
        return ArrayHelper::getValue(array_flip($this->getMaintenanceFileLinesParamsArray()), $param);
    }

    /**
     * File Lines Params
     * @return array
     */
    protected function getMaintenanceFileLinesParamsArray()
    {
        return [
            1 => self::MAINTENANCE_PARAM_DATE,
            2 => self::MAINTENANCE_PARAM_TITLE,
            3 => self::MAINTENANCE_PARAM_CONTENT,
            4 => self::MAINTENANCE_PARAM_SUBSCRIBE
        ];
    }

    /**
     * Update text line to mode file
     *
     * @param string $replace
     * @param int $line
     * @return mixed|void
     * @throws Exception
     */
    public function replace($replace, $line = 1)
    {
        $result = false;
        if ($replace && file_exists($this->path)) {
            $file = file($this->path);
            $file[$line - 1] = $replace . PHP_EOL;
            $result = file_put_contents($this->path, implode('', $file));
            $result = file_put_contents($this->path, implode('', /** @scrutinizer ignore-type */ $file));
        }
        if ($result === false) {
            throw new RuntimeException(
                "Attention: failed to update the end date of the maintenance mode, because {$this->path} failed to update."
            );
        }
    }

    /**
     * Validate datetime
     *
     * @param $date
     * @return bool
     */
    public function validDate($date)
    {
        $d = DateTime::createFromFormat($this->dateFormat, $date);
        return $d && $d->format($this->dateFormat) === $date;
    }

    /**
     * Date ant Time
     *
     * @param string $format
     * @param string|integer $timestamp
     * @return string
     * @throws InvalidConfigException
     */
    public function datetime($timestamp = '', $format = '')
    {
        $format = $format ?: $this->dateFormat;
        $timestamp = $timestamp ?: $this->timestamp();
        return Yii::$app->formatter->asDatetime($timestamp, 'php:' . $format);
    }

    /**
     * Timestamp
     *
     * @return string
     */
    public function timestamp()
    {
        return $this->getParams(self::MAINTENANCE_PARAM_DATE);

    }

    /**
     * Save email in file
     *
     * @param string $str
     * @param string $file
     * @return bool
     */
    public function save($str, $file)
    {
        try {
            if ($str && $file) {
                $fp = fopen($file, 'ab');
                fwrite($fp, $str . PHP_EOL);
                fwrite(/** @scrutinizer ignore-type */ $fp, $str . PHP_EOL);
                fclose($fp);
                fclose(/** @scrutinizer ignore-type */ $fp);
                return chmod($file, 0765);
            }
            return false;
        } catch (RuntimeException $e) {
            throw new RuntimeException(
                "Attention: Subscriber cannot be added because {$file} could not be save."
            );
        }
    }

    /**
     * Get params this maintenance file
     * @param string $param
     * @return array|false|mixed|string
     */
    public function getParams($param = '')
    {
        $content = $this->getContentArray($this->path);
        if ($param) {
            switch ($param) {
                case self::MAINTENANCE_PARAM_DATE:
                    $value = isset($content[0]) ? $content[0] : time();
                    break;
                case self::MAINTENANCE_PARAM_TITLE:
                    $value = isset($content[1]) ? $content[1] : '';
                    break;
                case self::MAINTENANCE_PARAM_CONTENT:
                    $value = isset($content[2]) ? $content[2] : '';
                    break;
                case self::MAINTENANCE_PARAM_SUBSCRIBE:
                    $value = isset($content[3]) ? $content[3] : '';
                    break;
                default:
                    $value = '';
            }
            return $value;
        }
        return $content;
    }

    /**
     * Return emails to followers
     *
     * @return array
     */
    public function emails()
    {
        $contents = $this->getContentArray($this->subscribePath);
        sort($contents);
        return $contents;
    }

    /**
     * Return content to array this file
     *
     * @param $file string
     * @return array
     */
    protected function getContentArray($file)
    {
        $contents = $this->readTheFile($file);
        $items = [];
        foreach ($contents as $key => $item) {
            $items[] = $item;
        }
        return array_filter($items);
    }

    /**
     * Read file
     *
     * @param $file string
     * @return Generator
     */
    protected function readTheFile($file)
    {
        try {
            if (file_exists($file)) {
                $handle = fopen($file, 'rb');
                while (!feof($handle)) {
                while (!feof(/** @scrutinizer ignore-type */ $handle)) {
                    yield trim(fgets($handle));
                    yield trim(fgets(/** @scrutinizer ignore-type */ $handle));
                }
                fclose($handle);
                fclose(/** @scrutinizer ignore-type */ $handle);
            }
        } catch (RuntimeException $e) {
            throw new RuntimeException(
                "Failed to read $file file"
            );
        }
    }

    /**
     * Create file
     *
     * @param $file string
     */
    /*protected function createFile($file)
    {
        try {
            if ($file && !file_exists($file)) {
                file_put_contents($file, '');
                chmod($file, 0765);
            }
        } catch (RuntimeException $e) {
            throw new RuntimeException(
                "Failed to create $file file."
            );
        }
    }*/

    /**
     * @return bool will return true if on timer
     */
    public function isTimer()
    {
        return (($date = $this->getParams(self::MAINTENANCE_PARAM_DATE)) && $date > time());
    }

    /**
     * @return bool will return true if on subscribe
     */
    public function isSubscribe()
    {
        $param = $this->getParams(self::MAINTENANCE_PARAM_SUBSCRIBE);
        return $param === 'true';
    }

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

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

Dominus77 / yii2-advanced-start

Push — master ( ff2b0b...f369f8 )

FileState::isEnabled() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
