Module::getMenus() - Code Metrics - Inspection of "add ability to chose db connection for User model." - mdmsoft/yii2-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( df46a8...ddc7c0 )

by Misbahul D

created 2016-08-09 14:19 UTC

Module::getMenus() C

↳ Parent: Module

Complexity

Conditions	14
Paths	9

Size

Total Lines	40
Code Lines	25

Duplication

Lines	0
Ratio	0 %

Importance

Changes	8
Bugs	1	Features	2

Metric	Value
c	8
b	1
f	2
dl	0
loc	40
rs	5.0864
cc	14
eloc	25
nc	9
nop	0

How to fix Complexity

<?php

namespace mdm\admin;

use Yii;
use yii\helpers\Inflector;
use yii\helpers\ArrayHelper;

/**
 * GUI manager for RBAC.
 * 
 * Use [[\yii\base\Module::$controllerMap]] to change property of controller. 
 * To change listed menu, use property [[$menus]].
 * 
 * ```
 * 'layout' => 'left-menu', // default to null mean use application layout.
 * 'controllerMap' => [
 *     'assignment' => [
 *         'class' => 'mdm\admin\controllers\AssignmentController',
 *         'userClassName' => 'app\models\User',
 *         'idField' => 'id'
 *     ]
 * ],
 * 'menus' => [
 *     'assignment' => [
 *         'label' => 'Grand Access' // change label
 *     ],
 *     'route' => null, // disable menu
 * ],
 * ```
 * 
 * @property string $mainLayout Main layout using for module. Default to layout of parent module.
 * Its used when `layout` set to 'left-menu', 'right-menu' or 'top-menu'.
 * @property array $menus List avalible menu of module.
 * It generated by module items .
 * 
 * @author Misbahul D Munir <[email protected]>
 * @since 1.0
 */
class Module extends \yii\base\Module
{
    /**
     * @inheritdoc
     */
    public $defaultRoute = 'assignment';
    /**
     * @var array Nav bar items.
     */
    public $navbar;
    /**
     * @var string Main layout using for module. Default to layout of parent module.
     * Its used when `layout` set to 'left-menu', 'right-menu' or 'top-menu'.
     */
    public $mainLayout = '@mdm/admin/views/layouts/main.php';
    /**
     * @var array 
     * @see [[menus]]
     */
    private $_menus = [];
    /**
     * @var array 
     * @see [[menus]]
     */
    private $_coreItems = [
        'user' => 'Users',
        'assignment' => 'Assignments',
        'role' => 'Roles',
        'permission' => 'Permissions',
        'route' => 'Routes',
        'rule' => 'Rules',
        'menu' => 'Menus',
    ];
    /**
     * @var array 
     * @see [[items]]
     */
    private $_normalizeMenus;

    /**
     * @var string Default url for breadcrumb
     */
    public $defaultUrl;

    /**
     * @var string Default url label for breadcrumb
     */
    public $defaultUrlLabel;

    /**
     * @inheritdoc
     */
    public function init()
    {
        parent::init();
        if (!isset(Yii::$app->i18n->translations['rbac-admin'])) {
            Yii::$app->i18n->translations['rbac-admin'] = [
                'class' => 'yii\i18n\PhpMessageSource',
                'sourceLanguage' => 'en',
                'basePath' => '@mdm/admin/messages'
            ];
        }
        
        //user did not define the Navbar?
        if ($this->navbar === null && Yii::$app instanceof \yii\web\Application) {
            $this->navbar = [
                ['label' => Yii::t('rbac-admin', 'Help'), 'url' => ['default/index']],
                ['label' => Yii::t('rbac-admin', 'Application'), 'url' => Yii::$app->homeUrl]
            ];
        }
        if (class_exists('yii\jui\JuiAsset')) {
            Yii::$container->set('mdm\admin\AutocompleteAsset', 'yii\jui\JuiAsset');
        }
    }

    /**
     * Get avalible menu.
     * @return array
     */
    public function getMenus()
    {
        if ($this->_normalizeMenus === null) {
            $mid = '/' . $this->getUniqueId() . '/';
            // resolve core menus
            $this->_normalizeMenus = [];

            $config = components\Configs::instance();
            $conditions = [
                'user' => $config->db && $config->db->schema->getTableSchema($config->userTable),
                'assignment' => ($userClass = Yii::$app->getUser()->identityClass) && is_subclass_of($userClass, 'yii\db\BaseActiveRecord'),
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.
}
                'menu' => $config->db && $config->db->schema->getTableSchema($config->menuTable),
            ];
            foreach ($this->_coreItems as $id => $lable) {
                if (!isset($conditions[$id]) || $conditions[$id]) {
                    $this->_normalizeMenus[$id] = ['label' => Yii::t('rbac-admin', $lable), 'url' => [$mid . $id]];
                }
            }
            foreach (array_keys($this->controllerMap) as $id) {
                $this->_normalizeMenus[$id] = ['label' => Yii::t('rbac-admin', Inflector::humanize($id)), 'url' => [$mid . $id]];
            }

            // user configure menus
            foreach ($this->_menus as $id => $value) {
                if (empty($value)) {
                    unset($this->_normalizeMenus[$id]);
                    continue;
                }
                if (is_string($value)) {
                    $value = ['label' => $value];
                }
                $this->_normalizeMenus[$id] = isset($this->_normalizeMenus[$id]) ? array_merge($this->_normalizeMenus[$id], $value)
                        : $value;
                if (!isset($this->_normalizeMenus[$id]['url'])) {
                    $this->_normalizeMenus[$id]['url'] = [$mid . $id];
                }
            }
        }
        return $this->_normalizeMenus;
    }

    /**
     * Set or add avalible menu.
     * @param array $menus
     */
    public function setMenus($menus)
    {
        $this->_menus = array_merge($this->_menus, $menus);
        $this->_normalizeMenus = null;

    }

    /**
     * @inheritdoc
     */
    public function beforeAction($action)
    {
        if (parent::beforeAction($action)) {
            /* @var $action \yii\base\Action */
            $view = $action->controller->getView();

            $view->params['breadcrumbs'][] = [
                'label' => ($this->defaultUrlLabel ?: Yii::t('rbac-admin', 'Admin')),
                'url' => ['/' . ($this->defaultUrl ?: $this->uniqueId)]
            ];
            return true;
        }
        return false;
    }
}


1			<?php
2
3			namespace mdm\admin;
4
5			use Yii;
6			use yii\helpers\Inflector;
7			use yii\helpers\ArrayHelper;
8
9			/**
10			* GUI manager for RBAC.
11			*
12			* Use [[\yii\base\Module::$controllerMap]] to change property of controller.
13			* To change listed menu, use property [[$menus]].
14			*
15			* ```
16			* 'layout' => 'left-menu', // default to null mean use application layout.
17			* 'controllerMap' => [
18			* 'assignment' => [
19			* 'class' => 'mdm\admin\controllers\AssignmentController',
20			* 'userClassName' => 'app\models\User',
21			* 'idField' => 'id'
22			* ]
23			* ],
24			* 'menus' => [
25			* 'assignment' => [
26			* 'label' => 'Grand Access' // change label
27			* ],
28			* 'route' => null, // disable menu
29			* ],
30			* ```
31			*
32			* @property string $mainLayout Main layout using for module. Default to layout of parent module.
33			* Its used when `layout` set to 'left-menu', 'right-menu' or 'top-menu'.
34			* @property array $menus List avalible menu of module.
35			* It generated by module items .
36			*
37			* @author Misbahul D Munir <[email protected]>
38			* @since 1.0
39			*/
40			class Module extends \yii\base\Module
41			{
42			/**
43			* @inheritdoc
44			*/
45			public $defaultRoute = 'assignment';
46			/**
47			* @var array Nav bar items.
48			*/
49			public $navbar;
50			/**
51			* @var string Main layout using for module. Default to layout of parent module.
52			* Its used when `layout` set to 'left-menu', 'right-menu' or 'top-menu'.
53			*/
54			public $mainLayout = '@mdm/admin/views/layouts/main.php';
55			/**
56			* @var array
57			* @see [[menus]]
58			*/
59			private $_menus = [];
60			/**
61			* @var array
62			* @see [[menus]]
63			*/
64			private $_coreItems = [
65			'user' => 'Users',
66			'assignment' => 'Assignments',
67			'role' => 'Roles',
68			'permission' => 'Permissions',
69			'route' => 'Routes',
70			'rule' => 'Rules',
71			'menu' => 'Menus',
72			];
73			/**
74			* @var array
75			* @see [[items]]
76			*/
77			private $_normalizeMenus;
78
79			/**
80			* @var string Default url for breadcrumb
81			*/
82			public $defaultUrl;
83
84			/**
85			* @var string Default url label for breadcrumb
86			*/
87			public $defaultUrlLabel;
88
89			/**
90			* @inheritdoc
91			*/
92			public function init()
93			{
94			parent::init();
95			if (!isset(Yii::$app->i18n->translations['rbac-admin'])) {
96			Yii::$app->i18n->translations['rbac-admin'] = [
97			'class' => 'yii\i18n\PhpMessageSource',
98			'sourceLanguage' => 'en',
99			'basePath' => '@mdm/admin/messages'
100			];
101			}
102
103			//user did not define the Navbar?
104			if ($this->navbar === null && Yii::$app instanceof \yii\web\Application) {
105			$this->navbar = [
106			['label' => Yii::t('rbac-admin', 'Help'), 'url' => ['default/index']],
107			['label' => Yii::t('rbac-admin', 'Application'), 'url' => Yii::$app->homeUrl]
108			];
109			}
110			if (class_exists('yii\jui\JuiAsset')) {
111			Yii::$container->set('mdm\admin\AutocompleteAsset', 'yii\jui\JuiAsset');
112			}
113			}
114
115			/**
116			* Get avalible menu.
117			* @return array
118			*/
119			public function getMenus()
120			{
121			if ($this->_normalizeMenus === null) {
122			$mid = '/' . $this->getUniqueId() . '/';
123			// resolve core menus
124			$this->_normalizeMenus = [];
125
126			$config = components\Configs::instance();
127			$conditions = [
128			'user' => $config->db && $config->db->schema->getTableSchema($config->userTable),
129			'assignment' => ($userClass = Yii::$app->getUser()->identityClass) && is_subclass_of($userClass, 'yii\db\BaseActiveRecord'),
			0 ignored issues – show Bug introduced 2016-03-18 12:53 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...
130			'menu' => $config->db && $config->db->schema->getTableSchema($config->menuTable),
131			];
132			foreach ($this->_coreItems as $id => $lable) {
133			if (!isset($conditions[$id]) \|\| $conditions[$id]) {
134			$this->_normalizeMenus[$id] = ['label' => Yii::t('rbac-admin', $lable), 'url' => [$mid . $id]];
135			}
136			}
137			foreach (array_keys($this->controllerMap) as $id) {
138			$this->_normalizeMenus[$id] = ['label' => Yii::t('rbac-admin', Inflector::humanize($id)), 'url' => [$mid . $id]];
139			}
140
141			// user configure menus
142			foreach ($this->_menus as $id => $value) {
143			if (empty($value)) {
144			unset($this->_normalizeMenus[$id]);
145			continue;
146			}
147			if (is_string($value)) {
148			$value = ['label' => $value];
149			}
150			$this->_normalizeMenus[$id] = isset($this->_normalizeMenus[$id]) ? array_merge($this->_normalizeMenus[$id], $value)
151			: $value;
152			if (!isset($this->_normalizeMenus[$id]['url'])) {
153			$this->_normalizeMenus[$id]['url'] = [$mid . $id];
154			}
155			}
156			}
157			return $this->_normalizeMenus;
158			}
159
160			/**
161			* Set or add avalible menu.
162			* @param array $menus
163			*/
164			public function setMenus($menus)
165			{
166			$this->_menus = array_merge($this->_menus, $menus);
167			$this->_normalizeMenus = null;
			0 ignored issues – show Documentation Bug introduced 2016-03-18 12:53 UTC by Report Bug Copy Issue Report It seems like `null` of type `null` is incompatible with the declared type `array` of property `$_normalizeMenus`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
168			}
169
170			/**
171			* @inheritdoc
172			*/
173			public function beforeAction($action)
174			{
175			if (parent::beforeAction($action)) {
176			/* @var $action \yii\base\Action */
177			$view = $action->controller->getView();
178
179			$view->params['breadcrumbs'][] = [
180			'label' => ($this->defaultUrlLabel ?: Yii::t('rbac-admin', 'Admin')),
181			'url' => ['/' . ($this->defaultUrl ?: $this->uniqueId)]
182			];
183			return true;
184			}
185			return false;
186			}
187			}
188

mdmsoft / yii2-admin

Push — master ( df46a8...ddc7c0 )

Module::getMenus() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like