FileState::init() - Code Metrics - Inspection of "grid view and link pager" - Dominus77/yii2-maintenance - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 84eed8...6d6bcb )

by Alexey

created 2020-03-10 08:54 UTC

FileState::init() A

↳ Parent: FileState

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
eloc	2
c	2
b	0
f	0
dl	0
loc	4
rs	10
cc	1
nc	1
nop	0

<?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';

    /**
     * Page size to backend
     * @var int
     */
    public $pageSize = 16;

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

    /**
     * Turn on mode.
     *
     * @return bool|mixed
     */
    public function enable()
    {
        $this->disable();
        file_put_contents($this->getFileStatePath(),
            '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->getFileStatePath())) {
            unlink($this->getFileStatePath());
        }
        return true;
    }

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

    /**
     * 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();
    }

    /**
     * @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 int
     */
    public function getPageSize()
    {
        return (int)$this->pageSize ?: 18;
    }

    /**
     * @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 string
     */
    protected function getFilePath($fileName)
    {
        return (string)Yii::getAlias($this->directory . '/' . $fileName);
    }
}


1			<?php
2
3			namespace dominus77\maintenance\states;
4
5			use Yii;
6			use Exception;
7			use yii\base\BaseObject;
8			use dominus77\maintenance\interfaces\StateInterface;
9			use dominus77\maintenance\models\FileStateForm;
10
11			/**
12			* Class FileState
13			* @package dominus77\maintenance\states
14			*
15			* @property array\|mixed $subscribeOptionsTemplate
16			* @property string $fileStatePath
17			*/
18			class FileState extends BaseObject implements StateInterface
19			{
20			/**
21			* @var string the filename that will determine if the maintenance mode is enabled
22			*/
23			public $fileName = 'YII_MAINTENANCE_MODE_ENABLED';
24
25			/**
26			* Default title
27			* @var string
28			*/
29			public $defaultTitle = 'Maintenance';
30
31			/**
32			* Default content
33			* @var string
34			*/
35			public $defaultContent = 'The site is undergoing technical work. We apologize for any inconvenience caused.';
36
37			/**
38			* @var string name of the file where subscribers will be stored
39			*/
40			public $fileSubscribe = 'YII_MAINTENANCE_MODE_SUBSCRIBE';
41
42			/**
43			* Options SubscribeFormWidget
44			* @var array
45			*/
46			public $subscribeOptions = [];
47
48			/**
49			* @var string the directory in that the file stated in $fileName above is residing
50			*/
51			public $directory = '@runtime';
52
53			/**
54			* @var string the complete path of the file - populated in init
55			*/
56			public $path;
57
58			/**
59			* @var string the complete path of the file subscribe - populated in init
60			*/
61			public $subscribePath;
62
63			/**
64			* Enter Datetime format
65			* @var string
66			*/
67			public $dateFormat = 'd-m-Y H:i:s';
68
69			/**
70			* Page size to backend
71			* @var int
72			*/
73			public $pageSize = 16;
74
75			/**
76			* Initialization
77			*/
78			public function init()
79			{
80			$this->path = $this->getFilePath($this->fileName);
81			$this->subscribePath = $this->getFilePath($this->fileSubscribe);
82			}
83
84			/**
85			* Turn on mode.
86			*
87			* @return bool\|mixed
88			*/
89			public function enable()
90			{
91			$this->disable();
92			file_put_contents($this->getFileStatePath(),
93			'The maintenance Mode of your Application is enabled if this file exists.');
94			chmod($this->path, 0765);
95			return true;
96			}
97
98			/**
99			* Turn off mode.
100			*
101			* @return bool\|mixed
102			*/
103			public function disable()
104			{
105			if (file_exists($this->getFileStatePath())) {
106			unlink($this->getFileStatePath());
107			}
108			return true;
109			}
110
111			/**
112			* @return bool will return true if the file exists
113			*/
114			public function isEnabled()
115			{
116			return file_exists($this->getFileStatePath());
117			}
118
119			/**
120			* Timestamp
121			*
122			* @return int
123			* @throws Exception
124			*/
125			public function timestamp()
126			{
127			$model = new FileStateForm();
128			return $model->getTimestamp();
129			}
130
131			/**
132			* Status code
133			* @return int\|string
134			*/
135			public function statusCode()
136			{
137			$model = new FileStateForm();
138			return $model->getStatusCode();
139			}
140
141			/**
142			* @return string
143			*/
144			public function getDateFormat()
145			{
146			return $this->dateFormat;
147			}
148
149			/**
150			* @return string
151			*/
152			public function getDefaultTitle()
153			{
154			return $this->defaultTitle;
155			}
156
157			/**
158			* @return string
159			*/
160			public function getDefaultContent()
161			{
162			return $this->defaultContent;
163			}
164
165			/**
166			* @return int
167			*/
168			public function getPageSize()
169			{
170			return (int)$this->pageSize ?: 18;
171			}
172
173			/**
174			* @return string
175			*/
176			public function getFileStatePath()
177			{
178			return $this->path;
179			}
180
181			/**
182			* @return string
183			*/
184			public function getSubscribePath()
185			{
186			return $this->subscribePath;
187			}
188
189			/**
190			* @return array
191			*/
192			public function getSubscribeOptions()
193			{
194			return $this->subscribeOptions;
195			}
196
197			/**
198			* @return array\|mixed
199			*/
200			public function getSubscribeOptionsTemplate()
201			{
202			return (isset($this->subscribeOptions['template']) && !empty($this->subscribeOptions['template'])) ?
203			$this->subscribeOptions['template'] : [
204			'html' => '@dominus77/maintenance/mail/emailNotice-html',
205			'text' => '@dominus77/maintenance/mail/emailNotice-text'
206			];
207			}
208
209			/**
210			* Return file path.
211			*
212			* @param $fileName string
213			* @return string
214			*/
215			protected function getFilePath($fileName)
216			{
217			return (string)Yii::getAlias($this->directory . '/' . $fileName);
218			}
219			}
220

Dominus77 / yii2-maintenance

Push — master ( 84eed8...6d6bcb )

FileState::init() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like