Module::init() - Code Metrics - itstructure/yii2-users-module - Measure and Improve Code Quality continuously with Scrutinizer

Module::init() A
last analyzed 2018-06-16 14:29 UTC

↳ Parent: Module

Complexity

Conditions	3
Paths	2

Size

Total Lines	22
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	22
rs	9.2
c	0
b	0
f	0
cc	3
eloc	10
nc	2
nop	0

<?php

namespace Itstructure\UsersModule;

use Yii;
use yii\web\View;
use yii\helpers\ArrayHelper;
use yii\base\Module as BaseModule;
use Itstructure\UsersModule\components\ProfileValidateComponent;

/**
 * Users module class.
 *
 * @property null|string|array $loginUrl
 * @property bool $rbacManage
 * @property bool $customRewrite
 * @property array $accessRoles
 * @property View $_view
 *
 * @package Itstructure\UsersModule
 */
class Module extends BaseModule
{
    /**
     * Login url.
     *
     * @var null|string|array
     */
    public $loginUrl = null;

    /**
     * Set manage for rbac (roles and permissions).
     *
     * @var bool
     */
    public $rbacManage = false;

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

    /**
     * Rewrite rules, labels, attributes, template fields by custom.
     *
     * @var bool
     */
    public $customRewrite = false;

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

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

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

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

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

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        }

        self::registerTranslations();

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

    /**
     * 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/users/' . $category, $message, $params, $language);
    }

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

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

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

        return $this->_view;
    }

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


1			<?php
2
3			namespace Itstructure\UsersModule;
4
5			use Yii;
6			use yii\web\View;
7			use yii\helpers\ArrayHelper;
8			use yii\base\Module as BaseModule;
9			use Itstructure\UsersModule\components\ProfileValidateComponent;
10
11			/**
12			* Users module class.
13			*
14			* @property null\|string\|array $loginUrl
15			* @property bool $rbacManage
16			* @property bool $customRewrite
17			* @property array $accessRoles
18			* @property View $_view
19			*
20			* @package Itstructure\UsersModule
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			* Set manage for rbac (roles and permissions).
33			*
34			* @var bool
35			*/
36			public $rbacManage = false;
37
38			/**
39			* Array of roles to module access.
40			*
41			* @var array
42			*/
43			public $accessRoles = ['@'];
44
45			/**
46			* Rewrite rules, labels, attributes, template fields by custom.
47			*
48			* @var bool
49			*/
50			public $customRewrite = false;
51
52			/**
53			* View component to render content.
54			*
55			* @var View
56			*/
57			private $_view = null;
58
59			/**
60			* Module translations.
61			*
62			* @var array\|null
63			*/
64			private static $_translations = null;
65
66			/**
67			* @inheritdoc
68			*/
69			public function init()
70			{
71			parent::init();
72
73			Yii::setAlias('@users', static::getBaseDir());
74
75			if (null !== $this->loginUrl && method_exists(Yii::$app, 'getUser')) {
76			Yii::$app->getUser()->loginUrl = $this->loginUrl;
			0 ignored issues – show Bug introduced 2018-05-12 19:35 UTC by Report Bug Copy Issue Report The method `getUser` does only exist in `yii\web\Application`, but not in `yii\console\Application`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
77			}
78
79			self::registerTranslations();
80
81			/**
82			* Set Profile validate component
83			*/
84			$this->setComponents(
85			ArrayHelper::merge(
86			$this->getProfileValidateComponentConfig(),
87			$this->components
88			)
89			);
90			}
91
92			/**
93			* Returns module root directory.
94			*
95			* @return string
96			*/
97			public static function getBaseDir(): string
98			{
99			return __DIR__;
100			}
101
102			/**
103			* Module translator.
104			*
105			* @param $category
106			* @param $message
107			* @param array $params
108			* @param null $language
109			*
110			* @return string
111			*/
112			public static function t($category, $message, $params = [], $language = null)
113			{
114			if (null === self::$_translations){
115			self::registerTranslations();
116			}
117
118			return Yii::t('modules/users/' . $category, $message, $params, $language);
119			}
120
121			/**
122			* Set i18N component.
123			*
124			* @return void
125			*/
126			public function registerTranslations(): void
127			{
128			self::$_translations = [
129			'modules/users/*' => [
130			'class' => 'yii\i18n\PhpMessageSource',
131			'forceTranslation' => true,
132			'sourceLanguage' => Yii::$app->language,
133			'basePath' => '@users/messages',
134			'fileMap' => [
135			'modules/users/main' => 'main.php',
136			'modules/users/users' => 'users.php',
137			],
138			]
139			];
140
141			Yii::$app->i18n->translations = ArrayHelper::merge(
142			self::$_translations,
143			Yii::$app->i18n->translations
144			);
145			}
146
147			/**
148			* Get the view.
149			*
150			* @return View
151			*/
152			public function getView()
153			{
154			if (null === $this->_view) {
155			$this->_view = $this->get('view');
156			}
157
158			return $this->_view;
159			}
160
161			/**
162			* Profile validate component config.
163			*
164			* @return array
165			*/
166			private function getProfileValidateComponentConfig(): array
167			{
168			return [
169			'profile-validate-component' => [
170			'class' => ProfileValidateComponent::class,
171			'rbacManage' => $this->rbacManage,
172			'customRewrite' => $this->customRewrite,
173			'authManager' => $this->rbacManage ? Yii::$app->authManager : null,
174			]
175			];
176			}
177			}
178

itstructure / yii2-users-module

Module::init() A last analyzed 2018-06-16 14:29 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

Module::init() A
last analyzed 2018-06-16 14:29 UTC