roaresearch\yii2\roa\urlRules\Modular

Complexity

Total Complexity

6

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Test Coverage

Coverage

58.81%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	ensureRules()	0	15	3
A	isApplicable()	0	4	1
A	createNotFoundException()	0	4	1
A	createRules()	0	3	1

<?php

namespace roaresearch\yii2\roa\urlRules;

use Yii;
use yii\{base\InvalidConfigException, web\NotFoundHttpException};

/**
 * Url Rule to handle modules implementing the `UrlRuleCreator` interface.
 *
 * @author Angel (Faryshta) Guevara <aguevara@alquimiadigital.mx>
 */
class Modular extends Composite
{
    /**
     * @inheritdoc
     *
     * can accept parameters.
     *
     * - {moduleId}: the unique module id associated to this rule.
     */
    public $notFoundMessage = 'Unknown route for module `{moduleId}`.';

    /**
     * @var string unique id to grab the module from the application that will
     * parse the rules.
     */
    public $moduleId;

    /**
     * @var UrlRuleCreator
     */
    protected $module;

    /**
     * @inheritdoc
     */
    protected function isApplicable(string $route): bool
    {
        // only parse rules which start with the module id
        return 0 === strpos($route, $this->moduleId);
    }

    /**
     * @inheritdoc

     */
    protected function createRules()
    {
        return $this->module->createUrlRules($this);
    }

    /**
     * @inheritdoc
     */
    protected function createNotFoundException(): NotFoundHttpException
    {
        return new NotFoundHttpException(
            strtr($this->notFoundMessage, ['{moduleId}' => $this->moduleId])
        );
    }

    protected function ensureRules()
    {
        if (empty($this->moduleId)) {
            throw new InvalidConfigException('`moduleId` must be set.');
        }
        $this->module = Yii::$app->getModule($this->moduleId);

It seems like Yii::app->getModule($this->moduleId) can also be of type yii\base\Module. However, the property $module is declared as type roaresearch\yii2\roa\urlRules\UrlRuleCreator. Maybe add an additional type check?

        if (!$this->module instanceof UrlRuleCreator) {
            throw new InvalidConfigException(
                "Module `{$this->moduleId}` must implement "
                    . UrlRuleCreator::class
            );
        }
        $this->module->initCreator($this);

        parent::ensureRules();
    }
}