Modular::createRules() - Code Metrics - Inspection of "Php8" - ROAResearch/yii2-roa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6)

by Angel

created 2021-04-30 21:44 UTC

Modular::createRules() A

↳ Parent: Modular

Complexity

Conditions	3
Paths	2

Size

Total Lines	15
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
cc	3
eloc	8
nc	2
nop	0
dl	0
loc	15
ccs	0
cts	3
cp	0
crap	12
rs	10
c	0
b	0
f	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 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])
        );
    }
}


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 string $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 string $moduleId;
29
30		/**
31		* @inheritdoc
32		*/
33	44	protected function isApplicable(string $route): bool
34		{
35		// only parse rules which start with the module id
36	44	return 0 === strpos($route, $this->moduleId);
37		}
38
39		/**
40		* @inheritdoc
41		*/
42		protected function createRules()
43		{
44		$this->moduleId ?: throw new InvalidConfigException(
45		$this::class . '::$moduleId must be set.'
46		);
47
48		$module = Yii::$app->getModule($this->moduleId);
49		if (!$module instanceof UrlRuleCreator) {
50		throw new InvalidConfigException(
51		"Module `{$this->moduleId}` must implement "
52		. UrlRuleCreator::class
53		);
54		}
55
56		return $module->createUrlRules($this);
57		}
58
59		/**
60		* @inheritdoc
61		*/
62		protected function createNotFoundException(): NotFoundHttpException
63		{
64		return new NotFoundHttpException(
65		strtr($this->notFoundMessage, ['{moduleId}' => $this->moduleId])
66		);
67		}
68		}
69

ROAResearch / yii2-roa

Pull Request — master (#6)

Modular::createRules() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like