roaresearch\yii2\roa\urlRules\Modular

Complexity

Total Complexity

5

Size/Duplication

Total Lines	53
Duplicated Lines	0 %

Test Coverage

Coverage

25%

Importance

Changes

0

3 Methods

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

<?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 string $notFoundMessage = 'Unknown route for module `{moduleId}`.';

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

    /**
     * @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()
    {
        $this->moduleId ?: throw new InvalidConfigException(
            $this::class . '::$moduleId must be set.'
        );

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

        return $module->createUrlRules($this);
    }

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