CustomerController::show() - Code Metrics - Inspection of "Updated Testing" - butcherman/Tech_Bench - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — dev6 ( 1762ad...6b002f )

by Ron

created 2021-05-17 23:32 UTC

CustomerController::show() A

↳ Parent: CustomerController

Complexity

Conditions	2
Paths	2

Size

Total Lines	54
Code Lines	43

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	39
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	43
c	1
b	0
f	0
dl	0
loc	54
ccs	39
cts	39
cp	1
rs	9.232
cc	2
nc	2
nop	1
crap	2

How to fix Long Method

<?php

namespace App\Http\Controllers\Customers;

use Inertia\Inertia;

use App\Models\Customer;
use App\Models\CustomerNote;
use App\Models\CustomerFile;
use App\Models\EquipmentType;
use App\Models\CustomerContact;
use App\Models\PhoneNumberType;
use App\Models\CustomerFileType;
use App\Models\CustomerEquipment;
use App\Http\Controllers\Controller;
use App\Models\UserCustomerBookmark;
use App\Http\Requests\Customers\CustomerRequest;

use Illuminate\Support\Str;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Auth;

class CustomerController extends Controller
{
    /**
     *  Customer search page
     */
    public function index()
    {
        return Inertia::render('Customer/index', [
            'can_create'  => Auth::user()->can('create', Customer::class),
            'equip_types' => EquipmentType::orderBy('cat_id')->get()->pluck('name')->values(),
        ]);
    }

    /**
     *  Form to create a new customer
     */
    public function create()
    {
        $this->authorize('create', Customer::class);
        return Inertia::render('Customer/create');
    }

    /**
     *  Save a newly created customer
     */
    public function store(CustomerRequest $request)
    {
        $cust         = $request->toArray();
        $cust['slug'] = Str::slug($request->name);
        $newCust      = Customer::create($cust);

        Log::channel('cust')->info('New Customer - '.$request->name.' created by '.Auth::user()->full_name);


        return redirect(route('customers.show',$newCust->slug))->with(['message' => 'New Customer Created', 'type' => 'success']);
    }

    /**
     *  Show the customer details
     */
    public function show($id)
    {
        //  Check if we are passing the customer slugged name, or customer ID number
        if(is_numeric($id))
        {
            //  To keep things uniform, redirect to a link that has the customers name rather than the ID
            $customer = Customer::findOrFail($id);
            return redirect(route('customers.show', $customer->slug));
        }

        $customer = Customer::where('slug', $id)
                        ->orWhere('cust_id', $id)
                        ->with('Parent')
                        ->with('CustomerEquipment.CustomerEquipmentData')
                        ->with('ParentEquipment.CustomerEquipmentData')
                        ->with('CustomerContact.CustomerContactPhone.PhoneNumberType')
                        ->with('ParentContact.CustomerContactPhone.PhoneNumberType')
                        ->with('CustomerNote')
                        ->with('ParentNote')
                        ->with('CustomerFile.FileUpload')
                        ->with('ParentFile.FileUpload')
                        ->firstOrFail();
        $isFav    = UserCustomerBookmark::where('user_id', Auth::user()->user_id)

                        ->where('cust_id', $customer->cust_id)
                        ->count();

        return Inertia::render('Customer/details', [
            'details'        => $customer,
            'phone_types'    => PhoneNumberType::all(),
            'file_types'     => CustomerFileType::all(),
            'user_functions' => [
                'fav'        => $isFav,                                                  //  Customer is bookmarked by the user
                'edit'       => Auth::user()->can('update', $customer),                  //  User is allowed to edit the customers basic details
                'manage'     => Auth::user()->can('manage', $customer),                  //  User can recover deleted items
                'deactivate' => Auth::user()->can('delete', $customer),                  //  User can deactivate the customer profile
                'equipment'  => [
                    'create' => Auth::user()->can('create', CustomerEquipment::class),   //  If user can add equipment
                    'update' => Auth::user()->can('update', CustomerEquipment::class),   //  If user can edit equipment
                    'delete' => Auth::user()->can('delete', CustomerEquipment::class),   //  If user can delete eqipment
                ],
                'contacts'   => [
                    'create' => Auth::user()->can('create', CustomerContact::class),     //  If user can add contact
                    'update' => Auth::user()->can('update', CustomerContact::class),     //  If user can edit contact
                    'delete' => Auth::user()->can('delete', CustomerContact::class),     //  If user can delete contact
                ],
                'notes'      => [
                    'create' => Auth::user()->can('create', CustomerNote::class),        //  If user can add note
                    'update' => Auth::user()->can('update', CustomerNote::class),        //  If user can edit note
                    'delete' => Auth::user()->can('delete', CustomerNote::class),        //  If user can delete note
                ],
                'files'     => [
                    'create' => Auth::user()->can('create', CustomerFile::class),        //  If user can add file
                    'update' => Auth::user()->can('update', CustomerFile::class),        //  If user can edit file
                    'delete' => Auth::user()->can('delete', CustomerFile::class),        //  If user can delete file
                ],
            ],
        ]);
    }

    /**
     *  Update the customers basic information
     */
    public function update(CustomerRequest $request, $id)
    {
        $cust         = $request->toArray();
        $cust['slug'] = Str::slug($request->name);
        Customer::find($id)->update($cust);

        return redirect(route('customers.show', $cust['slug']))->with(['message' => 'Customer Details Updated', 'type' => 'success']);
    }

    /**
     *  Deactivate the customer
     */
    public function destroy($id)
    {
        $cust = Customer::findOrFail($id);

        $this->authorize('delete', $cust);
        $cust->delete();

        Log::channel('cust')->alert('Customer ID '.$id.' has been deactivated by '.Auth::user()->username);

        return redirect(route('customers.index'))->with(['message' => 'Customer '.$cust->name.' deactivated', 'type' => 'danger']);
    }

    /*
    *   Restore a customer who was deactivated
    */
    public function restore($id)
    {
        $this->authorize('manage', Customer::class);

        $cust = Customer::withTrashed()->where('cust_id', $id)->firstOrFail();
        $cust->restore();

        Log::channel('cust')->info('Customer '.$cust->name.' has been restored by '.Auth::user()->username);


        return redirect()->back()->with(['message' => 'Customers Restored', 'type' => 'success']);
    }

    /*
    *   Completely Delete a customer and all associated informatin/files
    */
    public function forceDelete($id)
    {
        $this->authorize('manage', Customer::class);

        $cust = Customer::withTrashed()->where('cust_id', $id)->firstOrFail();

        Log::channel('cust')->notice('Customer '.$cust->name.' deleted by '.Auth::user()->username);

        $cust->forceDelete();

        return response()->noContent();
    }
}


1		<?php
2
3		namespace App\Http\Controllers\Customers;
4
5		use Inertia\Inertia;
6
7		use App\Models\Customer;
8		use App\Models\CustomerNote;
9		use App\Models\CustomerFile;
10		use App\Models\EquipmentType;
11		use App\Models\CustomerContact;
12		use App\Models\PhoneNumberType;
13		use App\Models\CustomerFileType;
14		use App\Models\CustomerEquipment;
15		use App\Http\Controllers\Controller;
16		use App\Models\UserCustomerBookmark;
17		use App\Http\Requests\Customers\CustomerRequest;
18
19		use Illuminate\Support\Str;
20		use Illuminate\Http\Request;
21		use Illuminate\Support\Facades\Log;
22		use Illuminate\Support\Facades\Auth;
23
24		class CustomerController extends Controller
25		{
26		/**
27		* Customer search page
28		*/
29	1	public function index()
30		{
31	1	return Inertia::render('Customer/index', [
32	1	'can_create' => Auth::user()->can('create', Customer::class),
33	1	'equip_types' => EquipmentType::orderBy('cat_id')->get()->pluck('name')->values(),
34		]);
35		}
36
37		/**
38		* Form to create a new customer
39		*/
40	2	public function create()
41		{
42	2	$this->authorize('create', Customer::class);
43	1	return Inertia::render('Customer/create');
44		}
45
46		/**
47		* Save a newly created customer
48		*/
49	1	public function store(CustomerRequest $request)
50		{
51	1	$cust = $request->toArray();
52	1	$cust['slug'] = Str::slug($request->name);
53	1	$newCust = Customer::create($cust);
54
55	1	Log::channel('cust')->info('New Customer - '.$request->name.' created by '.Auth::user()->full_name);
		1 ignored issue – show Bug introduced 2021-04-29 04:38 UTC by Report Bug Copy Issue Report Accessing `full_name` on the interface `Illuminate\Contracts\Auth\Authenticatable` suggest that you code against a concrete implementation. How about adding an `instanceof` check? Loading history...
56
57	1	return redirect(route('customers.show',$newCust->slug))->with(['message' => 'New Customer Created', 'type' => 'success']);
58		}
59
60		/**
61		* Show the customer details
62		*/
63	3	public function show($id)
64		{
65		// Check if we are passing the customer slugged name, or customer ID number
66	3	if(is_numeric($id))
67		{
68		// To keep things uniform, redirect to a link that has the customers name rather than the ID
69	1	$customer = Customer::findOrFail($id);
70	1	return redirect(route('customers.show', $customer->slug));
71		}
72
73	2	$customer = Customer::where('slug', $id)
74	2	->orWhere('cust_id', $id)
75	2	->with('Parent')
76	2	->with('CustomerEquipment.CustomerEquipmentData')
77	2	->with('ParentEquipment.CustomerEquipmentData')
78	2	->with('CustomerContact.CustomerContactPhone.PhoneNumberType')
79	2	->with('ParentContact.CustomerContactPhone.PhoneNumberType')
80	2	->with('CustomerNote')
81	2	->with('ParentNote')
82	2	->with('CustomerFile.FileUpload')
83	2	->with('ParentFile.FileUpload')
84	2	->firstOrFail();
85	1	$isFav = UserCustomerBookmark::where('user_id', Auth::user()->user_id)
		1 ignored issue – show Bug introduced 2021-04-29 04:38 UTC by Report Bug Copy Issue Report Accessing `user_id` on the interface `Illuminate\Contracts\Auth\Authenticatable` suggest that you code against a concrete implementation. How about adding an `instanceof` check? Loading history...
86	1	->where('cust_id', $customer->cust_id)
87	1	->count();
88
89	1	return Inertia::render('Customer/details', [
90	1	'details' => $customer,
91	1	'phone_types' => PhoneNumberType::all(),
92	1	'file_types' => CustomerFileType::all(),
93		'user_functions' => [
94	1	'fav' => $isFav, // Customer is bookmarked by the user
95	1	'edit' => Auth::user()->can('update', $customer), // User is allowed to edit the customers basic details
96	1	'manage' => Auth::user()->can('manage', $customer), // User can recover deleted items
97	1	'deactivate' => Auth::user()->can('delete', $customer), // User can deactivate the customer profile
98		'equipment' => [
99	1	'create' => Auth::user()->can('create', CustomerEquipment::class), // If user can add equipment
100	1	'update' => Auth::user()->can('update', CustomerEquipment::class), // If user can edit equipment
101	1	'delete' => Auth::user()->can('delete', CustomerEquipment::class), // If user can delete eqipment
102		],
103		'contacts' => [
104	1	'create' => Auth::user()->can('create', CustomerContact::class), // If user can add contact
105	1	'update' => Auth::user()->can('update', CustomerContact::class), // If user can edit contact
106	1	'delete' => Auth::user()->can('delete', CustomerContact::class), // If user can delete contact
107		],
108		'notes' => [
109	1	'create' => Auth::user()->can('create', CustomerNote::class), // If user can add note
110	1	'update' => Auth::user()->can('update', CustomerNote::class), // If user can edit note
111	1	'delete' => Auth::user()->can('delete', CustomerNote::class), // If user can delete note
112		],
113		'files' => [
114	1	'create' => Auth::user()->can('create', CustomerFile::class), // If user can add file
115	1	'update' => Auth::user()->can('update', CustomerFile::class), // If user can edit file
116	1	'delete' => Auth::user()->can('delete', CustomerFile::class), // If user can delete file
117		],
118		],
119		]);
120		}
121
122		/**
123		* Update the customers basic information
124		*/
125	1	public function update(CustomerRequest $request, $id)
126		{
127	1	$cust = $request->toArray();
128	1	$cust['slug'] = Str::slug($request->name);
129	1	Customer::find($id)->update($cust);
130
131	1	return redirect(route('customers.show', $cust['slug']))->with(['message' => 'Customer Details Updated', 'type' => 'success']);
132		}
133
134		/**
135		* Deactivate the customer
136		*/
137	2	public function destroy($id)
138		{
139	2	$cust = Customer::findOrFail($id);
140
141	2	$this->authorize('delete', $cust);
142	1	$cust->delete();
143
144	1	Log::channel('cust')->alert('Customer ID '.$id.' has been deactivated by '.Auth::user()->username);
		1 ignored issue – show Bug introduced 2021-05-12 04:41 UTC by Report Bug Copy Issue Report Accessing `username` on the interface `Illuminate\Contracts\Auth\Authenticatable` suggest that you code against a concrete implementation. How about adding an `instanceof` check? Loading history...
145	1	return redirect(route('customers.index'))->with(['message' => 'Customer '.$cust->name.' deactivated', 'type' => 'danger']);
146		}
147
148		/*
149		* Restore a customer who was deactivated
150		*/
151	2	public function restore($id)
152		{
153	2	$this->authorize('manage', Customer::class);
154
155	1	$cust = Customer::withTrashed()->where('cust_id', $id)->firstOrFail();
156	1	$cust->restore();
157
158	1	Log::channel('cust')->info('Customer '.$cust->name.' has been restored by '.Auth::user()->username);
		1 ignored issue – show Bug introduced 2021-05-17 23:40 UTC by Report Bug Copy Issue Report Accessing `username` on the interface `Illuminate\Contracts\Auth\Authenticatable` suggest that you code against a concrete implementation. How about adding an `instanceof` check? Loading history...
159
160	1	return redirect()->back()->with(['message' => 'Customers Restored', 'type' => 'success']);
161		}
162
163		/*
164		* Completely Delete a customer and all associated informatin/files
165		*/
166	2	public function forceDelete($id)
167		{
168	2	$this->authorize('manage', Customer::class);
169
170	1	$cust = Customer::withTrashed()->where('cust_id', $id)->firstOrFail();
171
172	1	Log::channel('cust')->notice('Customer '.$cust->name.' deleted by '.Auth::user()->username);
		1 ignored issue – show Bug introduced 2021-05-17 23:40 UTC by Report Bug Copy Issue Report Accessing `username` on the interface `Illuminate\Contracts\Auth\Authenticatable` suggest that you code against a concrete implementation. How about adding an `instanceof` check? Loading history...
173	1	$cust->forceDelete();
174
175	1	return response()->noContent();
176		}
177		}
178

butcherman / Tech_Bench

Push — dev6 ( 1762ad...6b002f )

CustomerController::show() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like