AdminHomeController::buildUserList() - Code Metrics - Inspection of "Added Module Template" - butcherman/Tech_Bench - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — dev6 ( b95c31...59969f )

by Ron

created 2021-06-12 00:37 UTC

AdminHomeController::buildUserList() A

↳ Parent: AdminHomeController

Complexity

Conditions	3
Paths	4

Size

Total Lines	35
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	17
CRAP Score	3

Importance

Changes

Metric	Value
eloc	19
c	0
b	0
f	0
dl	0
loc	35
ccs	17
cts	17
cp	1
rs	9.6333
cc	3
nc	4
nop	0
crap	3

<?php

namespace App\Http\Controllers\Admin;

use Inertia\Inertia;
use Nwidart\Modules\Facades\Module;

use App\Models\UserRolePermissions;
use App\Http\Controllers\Controller;

use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Gate;

class AdminHomeController extends Controller
{
    /**
     *  Administration Home Page
     */
    public function __invoke()
    {
        Gate::authorize('admin-link', Auth::user());

        //  Build each of the Administration menus depending on customer's access
        $userBuild      = $this->buildUserList();
        $equipmentBuild = $this->buildEquipmentList();
        $custBuild      = $this->buildCustomerList();
        $moduleBuild    = $this->buildModuleAdmin();



        return Inertia::render('Admin/index', [
            'links' => array_merge($userBuild, $equipmentBuild, $custBuild, $moduleBuild),
        ]);
    }

    //  Build the user administration links if the user has access
    protected function buildUserList()
    {
        $userBuild = [];
        if($this->getPermissionValue('Manage Users'))
        {
            $userBuild = [
                [
                    'name' => 'Create New User',
                    'icon' => 'fas fa-user-plus',
                    'link' => route('admin.user.create'),
                ],
                [
                    'name' => 'Modify User',
                    'icon' => 'fas fa-user-edit',
                    'link' => route('admin.user.list'),
                ],
                [
                    'name' => 'Show Deactivated Users',
                    'icon' => 'fas fa-store-alt-slash',
                    'link' => route('admin.disabled.index'),
                ],
            ];
        }

        $roleBuild = [];
        if($this->getPermissionValue('Manage Permissions'))
        {
            $roleBuild = [[
                'name' => 'User Roles and Permissions',
                'icon' => 'fas fa-users-cog',
                'link' => route('admin.user-roles.index'),
            ]];
        }

        return ['users' => array_merge($userBuild, $roleBuild)];
    }

    //  Build the equipment administration links if the user has access
    protected function buildEquipmentList()
    {
        $nav = [];
        if($this->getPermissionValue('Manage Equipment'))
        {
            $nav = [
                'equipment types and categories' => [
                    [
                        'name' => 'Create New Category',
                        'icon' => 'fas fa-plus-square',
                        'link' => route('admin.equipment.categories.create'),
                    ],
                    [
                        'name' => 'Modify Existing Category',
                        'icon' => 'fas fa-edit',
                        'link' => route('admin.equipment.categories.index'),
                    ],
                    [
                        'name' => 'Create New Equipment',
                        'icon' => 'fas fa-plus-square',
                        'link' => route('admin.equipment.create'),
                    ],
                    [
                        'name' => 'Modify Existing Equipment',
                        'icon' => 'fas fa-edit',
                        'link' => route('admin.equipment.index'),
                    ],
                    //  TODO - Finish Me
                    // [
                    //     'name' => 'Modify Information Gathered for Customer Equipment',
                    //     'icon' => '',
                    //     'link' => '#',
                    // ],
                ]
                ];
        }

        return $nav;
    }

    //  Build Customer Management list
    protected function buildCustomerList()
    {
        $nav = [];

        if($this->getPermissionValue('Manage Customers'))
        {
            $nav = [
                'Manage Customers' => [
                    [
                        'name' => 'Change Customer ID Number',
                        'icon' => 'fas fa-fingerprint',
                        'link' => route('customers.change-id.index'),
                    ],
                    [
                        'name' => 'View Deactivated Customers',
                        'icon' => 'fas fa-ban',
                        'link' => route('customers.show-deactivated'),
                    ],
                    [
                        'name' => 'View Deleted Customer Information',
                        'icon' => 'fas fa-trash-alt',
                        'link' => '#',
                    ],
                ],
            ];
        }

        return $nav;
    }

    protected function buildModuleAdmin()
    {
        $nav = [];
        $modules = Module::allEnabled();

        foreach($modules as $module)
        {
            $name    = $module->getLowerName();
            $navData = config($name.'.admin_nav');
            $modNav  = [];

            foreach($navData as $n)
            {
                $modNav[] = [
                    'name' => $n['name'],
                    'link' => route($n['route']),
                    'icon' => $n['icon'],
                ];
            }

            //  Split Camel Case name into normal name
            $nav[implode(' ',preg_split('/(?=[A-Z])/', $module->getName()))] = $modNav;
        }

        return $nav;
    }








    //  Determine if the user has permissions for a specific area
    protected function getPermissionValue($description)
    {
        $allowed = UserRolePermissions::where('role_id', Auth::user()->role_id)->whereHas('UserRolePermissionTypes', function($q) use ($description)

        {
            $q->where('description', $description);
        })->first();

        return $allowed->allow;
    }
}


1		<?php
2
3		namespace App\Http\Controllers\Admin;
4
5		use Inertia\Inertia;
6		use Nwidart\Modules\Facades\Module;
7
8		use App\Models\UserRolePermissions;
9		use App\Http\Controllers\Controller;
10
11		use Illuminate\Support\Facades\Auth;
12		use Illuminate\Support\Facades\Gate;
13
14		class AdminHomeController extends Controller
15		{
16		/**
17		* Administration Home Page
18	2	*/
19		public function __invoke()
20	2	{
21		Gate::authorize('admin-link', Auth::user());
22
23	1	// Build each of the Administration menus depending on customer's access
24	1	$userBuild = $this->buildUserList();
25	1	$equipmentBuild = $this->buildEquipmentList();
26		$custBuild = $this->buildCustomerList();
27		$moduleBuild = $this->buildModuleAdmin();
28
29
30	1
31	1	return Inertia::render('Admin/index', [
32		'links' => array_merge($userBuild, $equipmentBuild, $custBuild, $moduleBuild),
33		]);
34		}
35
36	1	// Build the user administration links if the user has access
37		protected function buildUserList()
38	1	{
39	1	$userBuild = [];
40		if($this->getPermissionValue('Manage Users'))
41		{
42		$userBuild = [
43	1	[
44	1	'name' => 'Create New User',
45	1	'icon' => 'fas fa-user-plus',
46		'link' => route('admin.user.create'),
47		],
48	1	[
49	1	'name' => 'Modify User',
50	1	'icon' => 'fas fa-user-edit',
51		'link' => route('admin.user.list'),
52		],
53	1	[
54	1	'name' => 'Show Deactivated Users',
55	1	'icon' => 'fas fa-store-alt-slash',
56		'link' => route('admin.disabled.index'),
57		],
58		];
59		}
60	1
61	1	$roleBuild = [];
62		if($this->getPermissionValue('Manage Permissions'))
63		{
64	1	$roleBuild = [[
65	1	'name' => 'User Roles and Permissions',
66	1	'icon' => 'fas fa-users-cog',
67		'link' => route('admin.user-roles.index'),
68		]];
69		}
70	1
71		return ['users' => array_merge($userBuild, $roleBuild)];
72		}
73
74	1	// Build the equipment administration links if the user has access
75		protected function buildEquipmentList()
76	1	{
77	1	$nav = [];
78		if($this->getPermissionValue('Manage Equipment'))
79		{
80		$nav = [
81		'equipment types and categories' => [
82	1	[
83	1	'name' => 'Create New Category',
84	1	'icon' => 'fas fa-plus-square',
85		'link' => route('admin.equipment.categories.create'),
86		],
87	1	[
88	1	'name' => 'Modify Existing Category',
89	1	'icon' => 'fas fa-edit',
90		'link' => route('admin.equipment.categories.index'),
91		],
92	1	[
93	1	'name' => 'Create New Equipment',
94	1	'icon' => 'fas fa-plus-square',
95		'link' => route('admin.equipment.create'),
96		],
97	1	[
98	1	'name' => 'Modify Existing Equipment',
99	1	'icon' => 'fas fa-edit',
100		'link' => route('admin.equipment.index'),
101		],
102		// TODO - Finish Me
103		// [
104		// 'name' => 'Modify Information Gathered for Customer Equipment',
105		// 'icon' => '',
106		// 'link' => '#',
107		// ],
108		]
109		];
110		}
111	1
112		return $nav;
113		}
114
115	1	// Build Customer Management list
116		protected function buildCustomerList()
117	1	{
118		$nav = [];
119	1
120		if($this->getPermissionValue('Manage Customers'))
121		{
122		$nav = [
123		'Manage Customers' => [
124	1	[
125	1	'name' => 'Change Customer ID Number',
126	1	'icon' => 'fas fa-fingerprint',
127		'link' => route('customers.change-id.index'),
128		],
129	1	[
130	1	'name' => 'View Deactivated Customers',
131	1	'icon' => 'fas fa-ban',
132		'link' => route('customers.show-deactivated'),
133		],
134		[
135		'name' => 'View Deleted Customer Information',
136		'icon' => 'fas fa-trash-alt',
137		'link' => '#',
138		],
139		],
140		];
141		}
142	1
143		return $nav;
144		}
145
146		protected function buildModuleAdmin()
147		{
148		$nav = [];
149		$modules = Module::allEnabled();
150
151		foreach($modules as $module)
152		{
153	1	$name = $module->getLowerName();
154		$navData = config($name.'.admin_nav');
155	1	$modNav = [];
156
157	1	foreach($navData as $n)
158	1	{
159		$modNav[] = [
160	1	'name' => $n['name'],
161		'link' => route($n['route']),
162		'icon' => $n['icon'],
163		];
164		}
165
166		// Split Camel Case name into normal name
167		$nav[implode(' ',preg_split('/(?=[A-Z])/', $module->getName()))] = $modNav;
168		}
169
170		return $nav;
171		}
172
173
174
175
176
177
178
179
180		// Determine if the user has permissions for a specific area
181		protected function getPermissionValue($description)
182		{
183		$allowed = UserRolePermissions::where('role_id', Auth::user()->role_id)->whereHas('UserRolePermissionTypes', function($q) use ($description)
		1 ignored issue – show Bug introduced 2021-04-03 02:35 UTC by Report Bug Copy Issue Report Accessing `role_id` on the interface `Illuminate\Contracts\Auth\Authenticatable` suggest that you code against a concrete implementation. How about adding an `instanceof` check? Loading history...
184		{
185		$q->where('description', $description);
186		})->first();
187
188		return $allowed->allow;
189		}
190		}
191

butcherman / Tech_Bench

Push — dev6 ( b95c31...59969f )

AdminHomeController::buildUserList() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like