Modular::createNotFoundException() - Code Metrics - Inspection of "[WIP] Psr12" - ROAResearch/yii2-roa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2)

by Angel

created 2019-11-12 22:51 UTC

Modular::createNotFoundException() A

↳ Parent: Modular

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?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 <[email protected]>
 */
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;

    /**
     * @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()
    {
        if (empty($this->moduleId)) {
            throw new InvalidConfigException('`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])
        );
    }
}


1			<?php
2
3			namespace roaresearch\yii2\roa\urlRules;
4
5			use Yii;
6			use yii\{base\InvalidConfigException, web\NotFoundHttpException};
7
8			/**
9			* Url Rule to handle modules implementing the `UrlRuleCreator` interface.
10			*
11			* @author Angel (Faryshta) Guevara <[email protected]>
12			*/
13			class Modular extends Composite
14			{
15			/**
16			* @inheritdoc
17			*
18			* can accept parameters.
19			*
20			* - {moduleId}: the unique module id associated to this rule.
21			*/
22			public $notFoundMessage = 'Unknown route for module `{moduleId}`.';
23
24			/**
25			* @var string unique id to grab the module from the application that will
26			* parse the rules.
27			*/
28			public $moduleId;
29
30			/**
31			* @inheritdoc
32			*/
33			protected function isApplicable(string $route): bool
34			{
35			// only parse rules which start with the module id
36			return 0 === strpos($route, $this->moduleId);
37			}
38
39			/**
40			* @inheritdoc
41			*/
42			protected function createRules()
43			{
44			if (empty($this->moduleId)) {
45			throw new InvalidConfigException('`moduleId` must be set.');
46			}
47			$module = Yii::$app->getModule($this->moduleId);
48			if (!$module instanceof UrlRuleCreator) {
49			throw new InvalidConfigException(
50			"Module `{$this->moduleId}` must implement "
51			. UrlRuleCreator::class
52			);
53			}
54
55			return $module->createUrlRules($this);
56			}
57
58			/**
59			* @inheritdoc
60			*/
61			protected function createNotFoundException(): NotFoundHttpException
62			{
63			return new NotFoundHttpException(
64			strtr($this->notFoundMessage, ['{moduleId}' => $this->moduleId])
65			);
66			}
67			}
68

ROAResearch / yii2-roa

Pull Request — master (#2)

Modular::createNotFoundException() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like