Module::init() - Code Metrics - Inspection of "Upgrade copyright year" - itstructure/yii2-rbac-module - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 6399b1...1fe07e )

by Andrey

created 2023-01-30 13:42 UTC

Module::init() A

↳ Parent: Module

Complexity

Conditions	5
Paths	4

Size

Total Lines	39
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	5
eloc	18
c	1
b	0
f	0
nc	4
nop	0
dl	0
loc	39
rs	9.3554

<?php

namespace Itstructure\RbacModule;

use Yii;
use yii\web\View;
use yii\helpers\ArrayHelper;
use yii\rbac\ManagerInterface;
use yii\base\{Module as BaseModule, InvalidConfigException};
use Itstructure\RbacModule\components\{RbacValidateComponent, ProfileValidateComponent};

/**
 * Rbac module class.
 *
 * @property null|string|array $loginUrl
 * @property array $accessRoles
 * @property View $_view
 * @property ManagerInterface $_authManager
 *
 * @package Itstructure\RbacModule
 */
class Module extends BaseModule
{
    /**
     * Login url.
     *
     * @var null|string|array
     */
    public $loginUrl = null;

    /**
     * Array of roles to module access.
     *
     * @var array
     */
    public $accessRoles = ['@'];

    /**
     * View component to render content.
     *
     * @var View
     */
    private $_view = null;

    /**
     * Auth manager.
     *
     * @var ManagerInterface
     */
    private $_authManager;

    /**
     * Module translations.
     *
     * @var array|null
     */
    private static $_translations = null;

    /**
     * @inheritdoc
     */
    public function init()
    {
        parent::init();

        $this->_authManager = Yii::$app->authManager;

        if (null === $this->_authManager) {
            throw new InvalidConfigException('The authManager is not defined.');
        }

        if (!$this->_authManager instanceof ManagerInterface) {

            throw new InvalidConfigException('The authManager must be implemented from yii\rbac\ManagerInterface.');
        }

        Yii::setAlias('@rbac', static::getBaseDir());

        if (null !== $this->loginUrl && method_exists(Yii::$app, 'getUser')) {
            Yii::$app->getUser()->loginUrl = $this->loginUrl;
        }

        self::registerTranslations();

        /**
         * Set Rbac validate component
         */
        $this->setComponents(
            ArrayHelper::merge(
                $this->getRbacValidateComponentConfig(),
                $this->components
            )
        );

        /**
         * Set Profile validate component
         */
        $this->setComponents(
            ArrayHelper::merge(
                $this->getProfileValidateComponentConfig(),
                $this->components
            )
        );
    }

    /**
     * Get the view.
     *
     * @return View
     */
    public function getView()
    {
        if (null === $this->_view) {
            $this->_view = $this->get('view');
        }

        return $this->_view;
    }

    /**
     * Returns module root directory.
     *
     * @return string
     */
    public static function getBaseDir(): string
    {
        return __DIR__;
    }

    /**
     * Module translator.
     *
     * @param       $category
     * @param       $message
     * @param array $params
     * @param null  $language

     *
     * @return string
     */
    public static function t($category, $message, $params = [], $language = null)
    {
        if (null === self::$_translations) {
            self::registerTranslations();
        }

        return Yii::t('modules/rbac/' . $category, $message, $params, $language);
    }

    /**
     * Set i18N component.
     *
     * @return void
     */
    private static function registerTranslations(): void
    {
        self::$_translations = [
            'modules/rbac/*' => [
                'class'          => 'yii\i18n\PhpMessageSource',
                'forceTranslation' => true,
                'sourceLanguage' => Yii::$app->language,
                'basePath'       => '@rbac/messages',
                'fileMap'        => [
                    'modules/rbac/main' => 'main.php',
                    'modules/rbac/roles' => 'roles.php',
                    'modules/rbac/permissions' => 'permissions.php',
                    'modules/rbac/profiles' => 'profiles.php',
                    'modules/rbac/rbac' => 'rbac.php',
                ],
            ]
        ];

        Yii::$app->i18n->translations = ArrayHelper::merge(
            self::$_translations,
            Yii::$app->i18n->translations
        );
    }

    /**
     * Rbac validate component config.
     *
     * @return array
     */
    private function getRbacValidateComponentConfig(): array
    {
        return [
            'rbac-validate-component' => [
                'class' => RbacValidateComponent::class,
                'authManager' => $this->_authManager,
            ]
        ];
    }

    /**
     * Profile validate component config.
     *
     * @return array
     */
    private function getProfileValidateComponentConfig(): array
    {
        return [
            'profile-validate-component' => [
                'class' => ProfileValidateComponent::class,
                'authManager' => $this->_authManager,
            ]
        ];
    }
}


1			<?php
2
3			namespace Itstructure\RbacModule;
4
5			use Yii;
6			use yii\web\View;
7			use yii\helpers\ArrayHelper;
8			use yii\rbac\ManagerInterface;
9			use yii\base\{Module as BaseModule, InvalidConfigException};
10			use Itstructure\RbacModule\components\{RbacValidateComponent, ProfileValidateComponent};
11
12			/**
13			* Rbac module class.
14			*
15			* @property null\|string\|array $loginUrl
16			* @property array $accessRoles
17			* @property View $_view
18			* @property ManagerInterface $_authManager
19			*
20			* @package Itstructure\RbacModule
21			*/
22			class Module extends BaseModule
23			{
24			/**
25			* Login url.
26			*
27			* @var null\|string\|array
28			*/
29			public $loginUrl = null;
30
31			/**
32			* Array of roles to module access.
33			*
34			* @var array
35			*/
36			public $accessRoles = ['@'];
37
38			/**
39			* View component to render content.
40			*
41			* @var View
42			*/
43			private $_view = null;
44
45			/**
46			* Auth manager.
47			*
48			* @var ManagerInterface
49			*/
50			private $_authManager;
51
52			/**
53			* Module translations.
54			*
55			* @var array\|null
56			*/
57			private static $_translations = null;
58
59			/**
60			* @inheritdoc
61			*/
62			public function init()
63			{
64			parent::init();
65
66			$this->_authManager = Yii::$app->authManager;
67
68			if (null === $this->_authManager) {
69			throw new InvalidConfigException('The authManager is not defined.');
70			}
71
72			if (!$this->_authManager instanceof ManagerInterface) {
			0 ignored issues – show introduced 2023-01-30 13:44 UTC by Report Bug Copy Issue Report `$this->_authManager` is always a sub-type of `yii\rbac\ManagerInterface`. Loading history...
73			throw new InvalidConfigException('The authManager must be implemented from yii\rbac\ManagerInterface.');
74			}
75
76			Yii::setAlias('@rbac', static::getBaseDir());
77
78			if (null !== $this->loginUrl && method_exists(Yii::$app, 'getUser')) {
79			Yii::$app->getUser()->loginUrl = $this->loginUrl;
80			}
81
82			self::registerTranslations();
83
84			/**
85			* Set Rbac validate component
86			*/
87			$this->setComponents(
88			ArrayHelper::merge(
89			$this->getRbacValidateComponentConfig(),
90			$this->components
91			)
92			);
93
94			/**
95			* Set Profile validate component
96			*/
97			$this->setComponents(
98			ArrayHelper::merge(
99			$this->getProfileValidateComponentConfig(),
100			$this->components
101			)
102			);
103			}
104
105			/**
106			* Get the view.
107			*
108			* @return View
109			*/
110			public function getView()
111			{
112			if (null === $this->_view) {
113			$this->_view = $this->get('view');
114			}
115
116			return $this->_view;
117			}
118
119			/**
120			* Returns module root directory.
121			*
122			* @return string
123			*/
124			public static function getBaseDir(): string
125			{
126			return __DIR__;
127			}
128
129			/**
130			* Module translator.
131			*
132			* @param $category
133			* @param $message
134			* @param array $params
135			* @param null $language
			0 ignored issues – show Documentation Bug introduced 2023-01-30 13:44 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$language` is correct as it would always require `null` to be passed? Loading history...
136			*
137			* @return string
138			*/
139			public static function t($category, $message, $params = [], $language = null)
140			{
141			if (null === self::$_translations) {
142			self::registerTranslations();
143			}
144
145			return Yii::t('modules/rbac/' . $category, $message, $params, $language);
146			}
147
148			/**
149			* Set i18N component.
150			*
151			* @return void
152			*/
153			private static function registerTranslations(): void
154			{
155			self::$_translations = [
156			'modules/rbac/*' => [
157			'class' => 'yii\i18n\PhpMessageSource',
158			'forceTranslation' => true,
159			'sourceLanguage' => Yii::$app->language,
160			'basePath' => '@rbac/messages',
161			'fileMap' => [
162			'modules/rbac/main' => 'main.php',
163			'modules/rbac/roles' => 'roles.php',
164			'modules/rbac/permissions' => 'permissions.php',
165			'modules/rbac/profiles' => 'profiles.php',
166			'modules/rbac/rbac' => 'rbac.php',
167			],
168			]
169			];
170
171			Yii::$app->i18n->translations = ArrayHelper::merge(
172			self::$_translations,
173			Yii::$app->i18n->translations
174			);
175			}
176
177			/**
178			* Rbac validate component config.
179			*
180			* @return array
181			*/
182			private function getRbacValidateComponentConfig(): array
183			{
184			return [
185			'rbac-validate-component' => [
186			'class' => RbacValidateComponent::class,
187			'authManager' => $this->_authManager,
188			]
189			];
190			}
191
192			/**
193			* Profile validate component config.
194			*
195			* @return array
196			*/
197			private function getProfileValidateComponentConfig(): array
198			{
199			return [
200			'profile-validate-component' => [
201			'class' => ProfileValidateComponent::class,
202			'authManager' => $this->_authManager,
203			]
204			];
205			}
206			}
207

itstructure / yii2-rbac-module

Push — master ( 6399b1...1fe07e )

Module::init() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like