MaintenanceController::options() - Code Metrics - Inspection of "console update" - Dominus77/yii2-maintenance - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 0f05be...110caf )

by Alexey

created 2020-03-09 06:29 UTC

MaintenanceController::options() A

↳ Parent: MaintenanceController

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	6
c	1
b	0
f	0
dl	0
loc	8
rs	10
cc	1
nc	1
nop	1

<?php

namespace dominus77\maintenance\commands;

use Yii;
use dominus77\maintenance\BackendMaintenance;
use yii\helpers\Console;
use yii\console\Controller;
use yii\base\Module;
use dominus77\maintenance\Maintenance;
use dominus77\maintenance\models\FileStateForm;
use dominus77\maintenance\models\SubscribeForm;
use dominus77\maintenance\interfaces\StateInterface;

/**
 * Maintenance mode
 * @package dominus77\maintenance\commands
 *
 * @property FileStateForm $defaultValue
 * @property FileStateForm $fileStateForm
 */
class MaintenanceController extends Controller
{
    /**
     * Date
     * @var string
     */
    public $date;
    /**
     * Title
     * @var string
     */
    public $title;
    /**
     * Content
     * @var string
     */
    public $content;
    /**
     * @var string
     */
    public $subscribe;

    /**
     * @var string
     */
    public $timer;

    /**
     * @var StateInterface
     */
    protected $state;
    /**
     * @var mixed string
     */
    protected $exampleData;

    /**
     * @var FileStateForm
     */
    protected $stateForm;
    /**
     * @var SubscribeForm
     */
    protected $subscribeForm;
    /**
     * @var string
     */
    protected $enabled;
    /**
     * @var string
     */
    protected $disabled;
    /**
     * @var string
     */
    protected $enabledMode;
    /**
     * @var string
     */
    protected $updatedMode;
    protected $notUpdatedMode;
    /**
     * @var string
     */
    protected $disabledMode;

    /**
     * MaintenanceController constructor.
     *
     * @param string $id
     * @param Module $module
     * @param StateInterface $state
     * @param array $config
     */
    public function __construct($id, Module $module, StateInterface $state, array $config = [])
    {
        $this->state = $state;
        $this->exampleData = $this->exampleDateFormat();
        $this->stateForm = new FileStateForm();
        $this->subscribeForm = new SubscribeForm();
        $this->enabledMode = $this->ansiFormat(Maintenance::t('app', 'ENABLED'), Console::FG_RED);
        $this->updatedMode = $this->ansiFormat(Maintenance::t('app', 'UPDATED'), Console::FG_GREEN);
        $this->notUpdatedMode = $this->ansiFormat(Maintenance::t('app', 'NOT UPDATED'), Console::FG_YELLOW);
        $this->disabledMode = $this->ansiFormat(Maintenance::t('app', 'DISABLED'), Console::FG_GREEN);
        $this->enabled = $this->ansiFormat(Maintenance::t('app', 'ENABLED'), Console::FG_GREEN);
        $this->disabled = $this->ansiFormat(Maintenance::t('app', 'DISABLED'), Console::FG_RED);
        parent::__construct($id, $module, $config);
    }


    /**
     * Options
     *
     * @param string $actionId
     * @return array|string[]
     */
    public function options($actionId)
    {
        return [
            'date',
            'title',
            'content',
            'subscribe',
            'timer'
        ];
    }

    /**
     * Aliases
     *
     * @return array
     */
    public function optionAliases()
    {
        return [
            'd' => 'date',
            't' => 'title',
            'c' => 'content',
            's' => 'subscribe',
            'tm' => 'timer'
        ];
    }

    /**
     * Maintenance status
     */
    public function actionIndex()
    {
        if ($this->state->isEnabled()) {
            $this->renderGroupEnabled();
        } else {
            $this->renderGroupDisabled();
        }
    }

    /**
     * Enable maintenance mode
     */
    public function actionEnable()
    {
        $stateForm = new FileStateForm();
        if (!$this->stateForm->isEnabled()) {
            $stateForm->mode = Maintenance::STATUS_CODE_MAINTENANCE;
            $stateForm = $this->setFileStateForm($stateForm);
            $this->setDefaultValue($stateForm);
            if ($stateForm->validate()) {
                $stateForm->save();
            }
        }
        $this->renderGroupEnabled();
    }

    /**
     * Disable maintenance mode and send notify
     */
    public function actionDisable()
    {
        $status = $status = $this->disabledMode;

        $this->renderMaintenanceModeHasBeenStatus($status);
        $this->stdout(PHP_EOL);
        if ($this->stateForm->isEnabled()) {
            $this->stateForm->disable();
            $result = $this->subscribeForm->send();
            if ($result || $result === 0) {
                $this->renderNotifiedSubscribers($result);
                $this->stdout(PHP_EOL);
            }
        }
        $this->renderEnableMaintenanceMode();
        $this->stdout(PHP_EOL);
        $this->renderOptionsTable();
    }

    /**
     * Update date and time maintenance mode
     */
    public function actionUpdate()
    {
        if ($this->state->isEnabled()) {
            $this->stateForm->mode = Maintenance::STATUS_CODE_MAINTENANCE;
            $stateForm = $this->setFileStateForm($this->stateForm);

            if ($stateForm->validate()) {
                $stateForm->save();

                $status = $this->updatedMode;
                $this->renderMaintenanceModeHasBeenStatus($status);
                $this->stdout(PHP_EOL);

                $this->renderOnUntilDateTime();
                $this->stdout(PHP_EOL);
                $this->stdout(PHP_EOL);

                $this->renderCountDownStatus();
                $this->stdout(PHP_EOL);
                $this->renderSubscriptionFormStatus();
                $this->stdout(PHP_EOL);

                $this->renderUpdateMaintenanceMode();
                $this->stdout(PHP_EOL);

                $this->renderOptionsTable();
            } else {
                $status = $this->notUpdatedMode;
                $this->renderMaintenanceModeHasBeenStatus($status);
                $this->stdout(PHP_EOL);

                $this->renderUpdateMaintenanceMode();
                $this->stdout(PHP_EOL);

                $this->renderOptionsTable();
            }
        } else {
            $this->renderGroupDisabled();
        }
    }

    /**
     * Show subscribers to whom messages
     */
    public function actionSubscribers()
    {
        if (!$this->stateForm->isEnabled()) {
            $this->renderGroupDisabled();
        } else if ($emails = $this->subscribeForm->getEmails()) {
            $status = $this->enabledMode;
            $this->renderMaintenanceModeHasBeenStatus($status);
            $this->stdout(PHP_EOL);

            $this->renderOnUntilDateTime();
            $this->stdout(PHP_EOL);

            $this->renderSubscriptionInfo();
            $this->stdout(PHP_EOL);
            $this->stdout(PHP_EOL);

            foreach ($emails as $email) {
                $this->stdout($email . PHP_EOL);
            }
        } else {
            $status = $this->enabledMode;
            $this->renderMaintenanceModeHasBeenStatus($status);
            $this->stdout(PHP_EOL);
            $this->renderOnUntilDateTime();
            $this->stdout(PHP_EOL);

            $this->stdout(Maintenance::t('app', 'No subscribers'));
            $this->stdout(PHP_EOL);
        }
    }

    /**
     * Options
     */
    public function actionOptions()
    {
        $this->renderOptionsTable();
    }

    /**
     * lcfirst()
     * @param $str string
     * @return string
     */
    protected function mb_lcfirst($str = '')
    {
        if (is_string($str) && !empty($str)) {
            $charset = Yii::$app->charset;
            $first = mb_substr($str, 0, 1, $charset);
            $last = mb_substr($str, 1);
            $first = mb_strtolower($first, $charset);
            $last = mb_strtolower($last, $charset);
            return $first . $last;
        }
        return $str;
    }

    /**
     * Render is Disabled
     */
    public function renderGroupDisabled()
    {
        $status = $this->disabledMode;
        $this->renderMaintenanceModeHasBeenStatus($status);
        $this->stdout(PHP_EOL);

        $this->renderEnableMaintenanceMode();
        $this->stdout(PHP_EOL);

        $this->renderOptionsTable();
    }

    /**
     * Render is Enabled
     */
    public function renderGroupEnabled()
    {
        $status = $this->enabledMode;
        $this->renderMaintenanceModeHasBeenStatus($status);
        $this->stdout(PHP_EOL);

        $this->renderOnUntilDateTime();
        $this->stdout(PHP_EOL);

        $this->renderSubscriptionInfo();
        $this->stdout(PHP_EOL);
        $this->stdout(PHP_EOL);

        $this->renderCountDownStatus();
        $this->stdout(PHP_EOL);

        $this->renderSubscriptionFormStatus();
        $this->stdout(PHP_EOL);

        $this->renderDisableAndSubscribe();
        $this->stdout(PHP_EOL);

        $this->renderUpdateMaintenanceMode();
        $this->stdout(PHP_EOL);

        $this->renderOptionsTable();
    }

    /**
     * Notified 2 subscribers.
     *
     * @param $count int
     */
    public function renderNotifiedSubscribers($count = 0)
    {
        $this->stdout(Maintenance::t('app', '{n, plural, =0{No subscribers} =1{Notified one subscriber} other{Notified # subscribers}}.', [
            'n' => $count
        ]));
    }

    /**
     * Maintenance Mode has been ENABLED/DISABLED
     *
     * @param $status string
     */
    public function renderMaintenanceModeHasBeenStatus($status)
    {
        $message = Maintenance::t('app', 'Maintenance Mode has been {:status}', [
            ':status' => $status,
        ]);
        $this->stdout($message);
    }

    /**
     * on until 09-03-2020 11:15:04
     */
    public function renderOnUntilDateTime()
    {
        $datetime = $this->stateForm->getDateTime();
        $message = Maintenance::t('app', 'on until {:datetime}', [
            ':datetime' => $datetime
        ]);
        $this->stdout($message);
    }

    /**
     * Total 2 followers.
     */
    public function renderSubscriptionInfo()
    {
        $message = Maintenance::t('app', '{n, plural, =0{No subscribers} =1{Total one subscriber} other{Total # subscribers}}.', [
            'n' => count($this->subscribeForm->getEmails())
        ]);
        $this->stdout($message);
    }

    /**
     * Count Down: ENABLED
     */
    public function renderCountDownStatus()
    {
        $status = $this->stateForm->isTimer() ? $this->enabled : $this->disabled;
        $message = Maintenance::t('app', 'Count Down: {:status}', [
            ':status' => $status
        ]);
        $this->stdout($message);
    }

    /**
     * Subscription form: ENABLED
     */
    public function renderSubscriptionFormStatus()
    {
        $status = $this->stateForm->isSubscribe() ? $this->enabled : $this->disabled;
        $message = Maintenance::t('app', 'Subscription form: {:status}', [
            ':status' => $status
        ]);
        $this->stdout($message);
    }

    /**
     * To turn off and notify subscribers,
     * use:
     * php yii maintenance/disable
     */
    public function renderDisableAndSubscribe()
    {
        $message = Maintenance::t('app', "To turn off and notify subscribers,\nuse:");
        $this->stdout(PHP_EOL . $message . PHP_EOL);
        $message = 'php yii maintenance/disable';
        $this->stdout($message);
    }

    /**
     * To enable the maintenance mode,
     * use:
     * php yii maintenance/enable --option='value'
     */
    public function renderEnableMaintenanceMode()
    {
        $message = Maintenance::t('app', "To enable the maintenance mode,\nuse:");
        $this->stdout(PHP_EOL . $message . PHP_EOL);

        $option = Maintenance::t('app', 'Option');
        $value = Maintenance::t('app', 'Value');
        $message = Maintenance::t('app', "php yii maintenance/enable --{:option}1='{:value}1' --{:option}2='{:value}2' ...", [
            ':option' => $this->mb_lcfirst(trim($option)),
            ':value' => $this->mb_lcfirst(trim($value))
        ]);
        $this->stdout($message);
    }

    /**
     * To update the maintenance mode,
     * use:
     * php yii maintenance/update --option='value'
     */
    public function renderUpdateMaintenanceMode()
    {
        $message = Maintenance::t('app', "To update the maintenance mode,\nuse:");
        $this->stdout(PHP_EOL . $message . PHP_EOL);

        $option = Maintenance::t('app', 'Option');
        $value = Maintenance::t('app', 'Value');
        $message = Maintenance::t('app', "php yii maintenance/update --{:option}1='{:value}1' --{:option}2='{:value}2' ...", [
            ':option' => $this->mb_lcfirst(trim($option)),
            ':value' => $this->mb_lcfirst(trim($value))
        ]);
        $this->stdout($message);
    }

    /**
     * Options and aliases
     */
    public function renderOptionsTable()
    {
        $option = Maintenance::t('app', 'Option');
        $alias = Maintenance::t('app', 'Alias');
        $value = Maintenance::t('app', 'Value');
        $exampleDat = $this->exampleDateFormat();
        $this->stdout(PHP_EOL);
        $this->stdout('---------------------------------------------' . PHP_EOL);
        $this->stdout('|   ' . $option . '    | ' . $alias . ' | ' . $value . '            |' . PHP_EOL);
        $this->stdout('|=============|=======|=====================|' . PHP_EOL);
        $this->stdout('| --date      | -d    | ' . $exampleDat . ' |' . PHP_EOL);
        $this->stdout('| --title     | -t    | string              |' . PHP_EOL);
        $this->stdout('| --content   | -c    | string              |' . PHP_EOL);
        $this->stdout('| --subscribe | -s    | true/false          |' . PHP_EOL);
        $this->stdout('| --timer     | -tm   | true/false          |' . PHP_EOL);
        $this->stdout('---------------------------------------------' . PHP_EOL);
    }

    /**
     * @param FileStateForm $stateForm
     * @return FileStateForm
     */
    protected function setFileStateForm(FileStateForm $stateForm)
    {
        if ($this->date) {
            $stateForm->date = $this->date;
        }
        if ($this->title) {
            $stateForm->title = $this->title;
        }
        if ($this->content) {
            $stateForm->text = $this->content;
        }
        if ($this->subscribe) {
            $stateForm->subscribe = $this->subscribe === 'true';
        }
        if ($this->timer) {
            $stateForm->countDown = $this->timer === 'true';
        }
        return $stateForm;
    }

    /**
     * @param FileStateForm $stateForm
     */
    protected function setDefaultValue(FileStateForm $stateForm)
    {
        if ($stateForm->title === null && $this->title === null) {
            $stateForm->title = BackendMaintenance::t('app', $stateForm->getDefaultTitle());
        }
        if ($stateForm->text === null && $this->content === null) {
            $stateForm->text = BackendMaintenance::t('app', $stateForm->getDefaultText());
        }
    }

    /**
     * Example format date time
     * @return mixed
     */
    protected function exampleDateFormat()
    {
        return date($this->state->getDateFormat());
    }
}



1			<?php
2
3			namespace dominus77\maintenance\commands;
4
5			use Yii;
6			use dominus77\maintenance\BackendMaintenance;
7			use yii\helpers\Console;
8			use yii\console\Controller;
9			use yii\base\Module;
10			use dominus77\maintenance\Maintenance;
11			use dominus77\maintenance\models\FileStateForm;
12			use dominus77\maintenance\models\SubscribeForm;
13			use dominus77\maintenance\interfaces\StateInterface;
14
15			/**
16			* Maintenance mode
17			* @package dominus77\maintenance\commands
18			*
19			* @property FileStateForm $defaultValue
20			* @property FileStateForm $fileStateForm
21			*/
22			class MaintenanceController extends Controller
23			{
24			/**
25			* Date
26			* @var string
27			*/
28			public $date;
29			/**
30			* Title
31			* @var string
32			*/
33			public $title;
34			/**
35			* Content
36			* @var string
37			*/
38			public $content;
39			/**
40			* @var string
41			*/
42			public $subscribe;
43
44			/**
45			* @var string
46			*/
47			public $timer;
48
49			/**
50			* @var StateInterface
51			*/
52			protected $state;
53			/**
54			* @var mixed string
55			*/
56			protected $exampleData;
57
58			/**
59			* @var FileStateForm
60			*/
61			protected $stateForm;
62			/**
63			* @var SubscribeForm
64			*/
65			protected $subscribeForm;
66			/**
67			* @var string
68			*/
69			protected $enabled;
70			/**
71			* @var string
72			*/
73			protected $disabled;
74			/**
75			* @var string
76			*/
77			protected $enabledMode;
78			/**
79			* @var string
80			*/
81			protected $updatedMode;
82			protected $notUpdatedMode;
83			/**
84			* @var string
85			*/
86			protected $disabledMode;
87
88			/**
89			* MaintenanceController constructor.
90			*
91			* @param string $id
92			* @param Module $module
93			* @param StateInterface $state
94			* @param array $config
95			*/
96			public function __construct($id, Module $module, StateInterface $state, array $config = [])
97			{
98			$this->state = $state;
99			$this->exampleData = $this->exampleDateFormat();
100			$this->stateForm = new FileStateForm();
101			$this->subscribeForm = new SubscribeForm();
102			$this->enabledMode = $this->ansiFormat(Maintenance::t('app', 'ENABLED'), Console::FG_RED);
103			$this->updatedMode = $this->ansiFormat(Maintenance::t('app', 'UPDATED'), Console::FG_GREEN);
104			$this->notUpdatedMode = $this->ansiFormat(Maintenance::t('app', 'NOT UPDATED'), Console::FG_YELLOW);
105			$this->disabledMode = $this->ansiFormat(Maintenance::t('app', 'DISABLED'), Console::FG_GREEN);
106			$this->enabled = $this->ansiFormat(Maintenance::t('app', 'ENABLED'), Console::FG_GREEN);
107			$this->disabled = $this->ansiFormat(Maintenance::t('app', 'DISABLED'), Console::FG_RED);
108			parent::__construct($id, $module, $config);
109			}
110
111
112			/**
113			* Options
114			*
115			* @param string $actionId
116			* @return array\|string[]
117			*/
118			public function options($actionId)
119			{
120			return [
121			'date',
122			'title',
123			'content',
124			'subscribe',
125			'timer'
126			];
127			}
128
129			/**
130			* Aliases
131			*
132			* @return array
133			*/
134			public function optionAliases()
135			{
136			return [
137			'd' => 'date',
138			't' => 'title',
139			'c' => 'content',
140			's' => 'subscribe',
141			'tm' => 'timer'
142			];
143			}
144
145			/**
146			* Maintenance status
147			*/
148			public function actionIndex()
149			{
150			if ($this->state->isEnabled()) {
151			$this->renderGroupEnabled();
152			} else {
153			$this->renderGroupDisabled();
154			}
155			}
156
157			/**
158			* Enable maintenance mode
159			*/
160			public function actionEnable()
161			{
162			$stateForm = new FileStateForm();
163			if (!$this->stateForm->isEnabled()) {
164			$stateForm->mode = Maintenance::STATUS_CODE_MAINTENANCE;
165			$stateForm = $this->setFileStateForm($stateForm);
166			$this->setDefaultValue($stateForm);
167			if ($stateForm->validate()) {
168			$stateForm->save();
169			}
170			}
171			$this->renderGroupEnabled();
172			}
173
174			/**
175			* Disable maintenance mode and send notify
176			*/
177			public function actionDisable()
178			{
179			$status = $status = $this->disabledMode;
			0 ignored issues – show Unused Code introduced 2020-03-09 06:31 UTC by Report Bug Copy Issue Report The assignment to `$status` is dead and can be removed. Loading history...
180			$this->renderMaintenanceModeHasBeenStatus($status);
181			$this->stdout(PHP_EOL);
182			if ($this->stateForm->isEnabled()) {
183			$this->stateForm->disable();
184			$result = $this->subscribeForm->send();
185			if ($result \|\| $result === 0) {
186			$this->renderNotifiedSubscribers($result);
187			$this->stdout(PHP_EOL);
188			}
189			}
190			$this->renderEnableMaintenanceMode();
191			$this->stdout(PHP_EOL);
192			$this->renderOptionsTable();
193			}
194
195			/**
196			* Update date and time maintenance mode
197			*/
198			public function actionUpdate()
199			{
200			if ($this->state->isEnabled()) {
201			$this->stateForm->mode = Maintenance::STATUS_CODE_MAINTENANCE;
202			$stateForm = $this->setFileStateForm($this->stateForm);
203
204			if ($stateForm->validate()) {
205			$stateForm->save();
206
207			$status = $this->updatedMode;
208			$this->renderMaintenanceModeHasBeenStatus($status);
209			$this->stdout(PHP_EOL);
210
211			$this->renderOnUntilDateTime();
212			$this->stdout(PHP_EOL);
213			$this->stdout(PHP_EOL);
214
215			$this->renderCountDownStatus();
216			$this->stdout(PHP_EOL);
217			$this->renderSubscriptionFormStatus();
218			$this->stdout(PHP_EOL);
219
220			$this->renderUpdateMaintenanceMode();
221			$this->stdout(PHP_EOL);
222
223			$this->renderOptionsTable();
224			} else {
225			$status = $this->notUpdatedMode;
226			$this->renderMaintenanceModeHasBeenStatus($status);
227			$this->stdout(PHP_EOL);
228
229			$this->renderUpdateMaintenanceMode();
230			$this->stdout(PHP_EOL);
231
232			$this->renderOptionsTable();
233			}
234			} else {
235			$this->renderGroupDisabled();
236			}
237			}
238
239			/**
240			* Show subscribers to whom messages
241			*/
242			public function actionSubscribers()
243			{
244			if (!$this->stateForm->isEnabled()) {
245			$this->renderGroupDisabled();
246			} else if ($emails = $this->subscribeForm->getEmails()) {
247			$status = $this->enabledMode;
248			$this->renderMaintenanceModeHasBeenStatus($status);
249			$this->stdout(PHP_EOL);
250
251			$this->renderOnUntilDateTime();
252			$this->stdout(PHP_EOL);
253
254			$this->renderSubscriptionInfo();
255			$this->stdout(PHP_EOL);
256			$this->stdout(PHP_EOL);
257
258			foreach ($emails as $email) {
259			$this->stdout($email . PHP_EOL);
260			}
261			} else {
262			$status = $this->enabledMode;
263			$this->renderMaintenanceModeHasBeenStatus($status);
264			$this->stdout(PHP_EOL);
265			$this->renderOnUntilDateTime();
266			$this->stdout(PHP_EOL);
267
268			$this->stdout(Maintenance::t('app', 'No subscribers'));
269			$this->stdout(PHP_EOL);
270			}
271			}
272
273			/**
274			* Options
275			*/
276			public function actionOptions()
277			{
278			$this->renderOptionsTable();
279			}
280
281			/**
282			* lcfirst()
283			* @param $str string
284			* @return string
285			*/
286			protected function mb_lcfirst($str = '')
287			{
288			if (is_string($str) && !empty($str)) {
289			$charset = Yii::$app->charset;
290			$first = mb_substr($str, 0, 1, $charset);
291			$last = mb_substr($str, 1);
292			$first = mb_strtolower($first, $charset);
293			$last = mb_strtolower($last, $charset);
294			return $first . $last;
295			}
296			return $str;
297			}
298
299			/**
300			* Render is Disabled
301			*/
302			public function renderGroupDisabled()
303			{
304			$status = $this->disabledMode;
305			$this->renderMaintenanceModeHasBeenStatus($status);
306			$this->stdout(PHP_EOL);
307
308			$this->renderEnableMaintenanceMode();
309			$this->stdout(PHP_EOL);
310
311			$this->renderOptionsTable();
312			}
313
314			/**
315			* Render is Enabled
316			*/
317			public function renderGroupEnabled()
318			{
319			$status = $this->enabledMode;
320			$this->renderMaintenanceModeHasBeenStatus($status);
321			$this->stdout(PHP_EOL);
322
323			$this->renderOnUntilDateTime();
324			$this->stdout(PHP_EOL);
325
326			$this->renderSubscriptionInfo();
327			$this->stdout(PHP_EOL);
328			$this->stdout(PHP_EOL);
329
330			$this->renderCountDownStatus();
331			$this->stdout(PHP_EOL);
332
333			$this->renderSubscriptionFormStatus();
334			$this->stdout(PHP_EOL);
335
336			$this->renderDisableAndSubscribe();
337			$this->stdout(PHP_EOL);
338
339			$this->renderUpdateMaintenanceMode();
340			$this->stdout(PHP_EOL);
341
342			$this->renderOptionsTable();
343			}
344
345			/**
346			* Notified 2 subscribers.
347			*
348			* @param $count int
349			*/
350			public function renderNotifiedSubscribers($count = 0)
351			{
352			$this->stdout(Maintenance::t('app', '{n, plural, =0{No subscribers} =1{Notified one subscriber} other{Notified # subscribers}}.', [
353			'n' => $count
354			]));
355			}
356
357			/**
358			* Maintenance Mode has been ENABLED/DISABLED
359			*
360			* @param $status string
361			*/
362			public function renderMaintenanceModeHasBeenStatus($status)
363			{
364			$message = Maintenance::t('app', 'Maintenance Mode has been {:status}', [
365			':status' => $status,
366			]);
367			$this->stdout($message);
368			}
369
370			/**
371			* on until 09-03-2020 11:15:04
372			*/
373			public function renderOnUntilDateTime()
374			{
375			$datetime = $this->stateForm->getDateTime();
376			$message = Maintenance::t('app', 'on until {:datetime}', [
377			':datetime' => $datetime
378			]);
379			$this->stdout($message);
380			}
381
382			/**
383			* Total 2 followers.
384			*/
385			public function renderSubscriptionInfo()
386			{
387			$message = Maintenance::t('app', '{n, plural, =0{No subscribers} =1{Total one subscriber} other{Total # subscribers}}.', [
388			'n' => count($this->subscribeForm->getEmails())
389			]);
390			$this->stdout($message);
391			}
392
393			/**
394			* Count Down: ENABLED
395			*/
396			public function renderCountDownStatus()
397			{
398			$status = $this->stateForm->isTimer() ? $this->enabled : $this->disabled;
399			$message = Maintenance::t('app', 'Count Down: {:status}', [
400			':status' => $status
401			]);
402			$this->stdout($message);
403			}
404
405			/**
406			* Subscription form: ENABLED
407			*/
408			public function renderSubscriptionFormStatus()
409			{
410			$status = $this->stateForm->isSubscribe() ? $this->enabled : $this->disabled;
411			$message = Maintenance::t('app', 'Subscription form: {:status}', [
412			':status' => $status
413			]);
414			$this->stdout($message);
415			}
416
417			/**
418			* To turn off and notify subscribers,
419			* use:
420			* php yii maintenance/disable
421			*/
422			public function renderDisableAndSubscribe()
423			{
424			$message = Maintenance::t('app', "To turn off and notify subscribers,\nuse:");
425			$this->stdout(PHP_EOL . $message . PHP_EOL);
426			$message = 'php yii maintenance/disable';
427			$this->stdout($message);
428			}
429
430			/**
431			* To enable the maintenance mode,
432			* use:
433			* php yii maintenance/enable --option='value'
434			*/
435			public function renderEnableMaintenanceMode()
436			{
437			$message = Maintenance::t('app', "To enable the maintenance mode,\nuse:");
438			$this->stdout(PHP_EOL . $message . PHP_EOL);
439
440			$option = Maintenance::t('app', 'Option');
441			$value = Maintenance::t('app', 'Value');
442			$message = Maintenance::t('app', "php yii maintenance/enable --{:option}1='{:value}1' --{:option}2='{:value}2' ...", [
443			':option' => $this->mb_lcfirst(trim($option)),
444			':value' => $this->mb_lcfirst(trim($value))
445			]);
446			$this->stdout($message);
447			}
448
449			/**
450			* To update the maintenance mode,
451			* use:
452			* php yii maintenance/update --option='value'
453			*/
454			public function renderUpdateMaintenanceMode()
455			{
456			$message = Maintenance::t('app', "To update the maintenance mode,\nuse:");
457			$this->stdout(PHP_EOL . $message . PHP_EOL);
458
459			$option = Maintenance::t('app', 'Option');
460			$value = Maintenance::t('app', 'Value');
461			$message = Maintenance::t('app', "php yii maintenance/update --{:option}1='{:value}1' --{:option}2='{:value}2' ...", [
462			':option' => $this->mb_lcfirst(trim($option)),
463			':value' => $this->mb_lcfirst(trim($value))
464			]);
465			$this->stdout($message);
466			}
467
468			/**
469			* Options and aliases
470			*/
471			public function renderOptionsTable()
472			{
473			$option = Maintenance::t('app', 'Option');
474			$alias = Maintenance::t('app', 'Alias');
475			$value = Maintenance::t('app', 'Value');
476			$exampleDat = $this->exampleDateFormat();
477			$this->stdout(PHP_EOL);
478			$this->stdout('---------------------------------------------' . PHP_EOL);
479			$this->stdout('\| ' . $option . ' \| ' . $alias . ' \| ' . $value . ' \|' . PHP_EOL);
480			$this->stdout('\|=============\|=======\|=====================\|' . PHP_EOL);
481			$this->stdout('\| --date \| -d \| ' . $exampleDat . ' \|' . PHP_EOL);
482			$this->stdout('\| --title \| -t \| string \|' . PHP_EOL);
483			$this->stdout('\| --content \| -c \| string \|' . PHP_EOL);
484			$this->stdout('\| --subscribe \| -s \| true/false \|' . PHP_EOL);
485			$this->stdout('\| --timer \| -tm \| true/false \|' . PHP_EOL);
486			$this->stdout('---------------------------------------------' . PHP_EOL);
487			}
488
489			/**
490			* @param FileStateForm $stateForm
491			* @return FileStateForm
492			*/
493			protected function setFileStateForm(FileStateForm $stateForm)
494			{
495			if ($this->date) {
496			$stateForm->date = $this->date;
497			}
498			if ($this->title) {
499			$stateForm->title = $this->title;
500			}
501			if ($this->content) {
502			$stateForm->text = $this->content;
503			}
504			if ($this->subscribe) {
505			$stateForm->subscribe = $this->subscribe === 'true';
506			}
507			if ($this->timer) {
508			$stateForm->countDown = $this->timer === 'true';
509			}
510			return $stateForm;
511			}
512
513			/**
514			* @param FileStateForm $stateForm
515			*/
516			protected function setDefaultValue(FileStateForm $stateForm)
517			{
518			if ($stateForm->title === null && $this->title === null) {
519			$stateForm->title = BackendMaintenance::t('app', $stateForm->getDefaultTitle());
520			}
521			if ($stateForm->text === null && $this->content === null) {
522			$stateForm->text = BackendMaintenance::t('app', $stateForm->getDefaultText());
523			}
524			}
525
526			/**
527			* Example format date time
528			* @return mixed
529			*/
530			protected function exampleDateFormat()
531			{
532			return date($this->state->getDateFormat());
533			}
534			}
535
536

Dominus77 / yii2-maintenance

Push — master ( 0f05be...110caf )

MaintenanceController::options() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like