common\components\maintenance\Maintenance

Complexity

Total Complexity

13

Size/Duplication

Total Lines	96
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	bootstrap()	0	25	6
A	filtersExcepted()	0	17	6

<?php

namespace common\components\maintenance;

use Yii;
use yii\base\InvalidConfigException;
use yii\web\Application;
use yii\base\BaseObject;
use yii\base\BootstrapInterface;
use common\components\maintenance\interfaces\StateInterface;

/**
 * Class Maintenance
 * @package common\components\maintenance
 */
class Maintenance extends BaseObject implements BootstrapInterface
{
    /**
     * Value of "OK" status code.
     */
    const STATUS_CODE_OK = 200;

    /**
     * Route to maintenance action.
     * @var string
     */
    public $route;
    /**
     * @var array
     */
    public $filters;
    /**
     * Default status code to send on maintenance
     * 503 = Service Unavailable
     * @var integer
     */
    public $statusCode = 503;
    /**
     * Retry-After header
     * @var bool|string
     */
    public $retryAfter = false;
    /**
     * @var StateInterface
     */
    protected $state;

    /**
     * Maintenance constructor.
     * @param StateInterface $state
     * @param array $config
     */
    public function __construct(StateInterface $state, array $config = [])
    {
        $this->state = $state;
        parent::__construct($config);
    }

    /**
     * @param Application $app
     * @throws InvalidConfigException
     */
    public function bootstrap($app)
    {
        if (YII_DEBUG) {
            $urlManager = $app->urlManager;
            $urlManager->addRules(
                [
                    '<_m:debug>/<_c:\w+>/<_a:\w+>' => '<_m>/<_c>/<_a>',
                ]
            );
        }

        $response = $app->response;
        if ($app->request->isAjax) {
            $response->statusCode = self::STATUS_CODE_OK;
        } else {
            $response->statusCode = $this->statusCode;
            if ($this->retryAfter) {
                $response->headers->set('Retry-After', $this->retryAfter);

It seems like $this->retryAfter can also be of type true; however, parameter $value of yii\web\HeaderCollection::set() does only seem to accept string, maybe add an additional type check?

            }
        }

        if ($this->state->isEnabled() && !$this->filtersExcepted()) {
            $app->catchAll = [$this->route];
        } else {
            $response->statusCode = self::STATUS_CODE_OK;
        }
    }

    /**
     * @return bool
     * @throws InvalidConfigException
     */
    protected function filtersExcepted()
    {
        if (!is_array($this->filters) || empty($this->filters)) {

The condition is_array($this->filters) is always true.

            return false;
        }
        foreach ($this->filters as $config) {
            $filter = Yii::createObject($config);
            if (!($filter instanceof Filter)) {
                throw new InvalidConfigException(
                    'Class "' . get_class($filter) . '" must instance of "' . Filter::class . '".'
                );
            }
            if ($filter->isAllowed()) {
                return true;
            }
        }
        return false;
    }
}