SetTechTips::updateTipDetails() - Code Metrics - Inspection of "Merge pull request #83 from butcherman/dev5" - butcherman/Tech_Bench - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — dev5 ( ecdb11...2a90e7 )

by Ron

created 2020-04-28 11:54 UTC

SetTechTips::updateTipDetails() A

↳ Parent: SetTechTips

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	5
c	0
b	0
f	0
nc	1
nop	1
dl	0
loc	10
ccs	6
cts	6
cp	1
crap	1
rs	10

<?php

namespace App\Domains\TechTips;

use Illuminate\Http\File;

use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Facades\Notification;

use App\Http\Requests\TechTipNewTipRequest;
use App\Http\Requests\TechTipProcessImageRequest;

use App\Domains\FilesDomain;

use App\User;
use App\Files;
use App\Http\Requests\TechTipEditTipRequest;
use App\TechTips;
use App\TechTipFiles;
use App\TechTipSystems;
use App\TechTipFavs;

use App\Notifications\NewTechTip;

class SetTechTips extends FilesDomain
{
    //  Store an image that has been uploaded to assign to a Tech Tip
    public function processTipImage(TechTipProcessImageRequest $request)
    {
        //  Generate a unique hash as the file name and store it in a publicly accessable folder
        $path = 'img/tip_img';
        $location = Storage::disk('public')->putFile($path, new File($request->file));
        Log::info('Image uploaded for tech tip.  Image Data - ', array($request));

        //  Return the full url path to the image
        return Storage::url($location);
    }

    //  Process the new tip form to see if a file is being uploaded, or upload is completed
    public function processNewTip(TechTipNewTipRequest $request)
    {
        if(isset($request->file))
        {
            $fileID = $this->processFileChunk($request);
            if($fileID)
            {
                $fileArr = session('newTipFile') != null ? session('newTipFile') : [];
                $fileArr[] = $fileID;
                session(['newTipFile' => $fileArr]);
            }

            return false;
        }

        return $this->createTip($request);
    }

    //  Update an existin gTech Tip
    public function processEditTip(TechTipEditTipRequest $request, $tipID)
    {
        if(isset($request->file))
        {
            $this->path = config('filesystems.paths.tips').DIRECTORY_SEPARATOR.$tipID;
            $fileID = $this->processFileChunk($request);
            if($fileID)
            {
                //  Attach file to Tech Tip
                TechTipFiles::create([
                    'tip_id' => $tipID,
                    'file_id' => $fileID,
                ]);
            }

            return false;
        }

        $this->updateTipDetails($request);
        $this->updateTipEquipment($request->system_types, $tipID);
        if(isset($request->deletedFileList))
        {
            $this->updateTipFiles($request->deletedFileList);
        }

        return true;
    }

    //  Delete the Tech Tip
    public function deleteTip($tipID)
    {
        TechTipFavs::where('tip_id', $tipID)->delete();

        //  Disable the tip
        TechTips::find($tipID)->delete();
        Log::warning('User - '.Auth::user()->full_name.' deleted Tech Tip ID - '.$tipID);

        return true;
    }

    //  Create the Tech Tip in the datbase
    protected function createTip($tipData)
    {
        //  Remove any forward slash (/) from the Subject Field
        $tipData->merge(['subject' => str_replace('/', '-', $tipData->subject)]);

        //  Enter the tip details and return the tip ID
        $tip = TechTips::create([
            'tip_type_id' => $tipData->tip_type_id,
            'subject'     => $tipData->subject,
            'description' => $tipData->description,
            'user_id'     => Auth::user()->user_id
        ]);
        $tipID = $tip->tip_id;

        $this->processTipEquipment($tipData->equipment, $tipID);
        $this->processFiles($tipID);
        $this->sendNotification($tipData->noEmail, $tipID);

        return $tipID;
    }

    //  Update the tip details
    protected function updateTipDetails($data)
    {
        //  Update the base information
        TechTips::find($data->tip_id)->update([
            'tip_type_id' => $data->tip_type_id,
            'subject'     => $data->subject,
            'description' => $data->description,
        ]);

        return true;
    }

    //  Add or remove any system types attached to the tip
    protected function updateTipEquipment($equipTypes, $tipID)
    {
        $current = TechTipSystems::where('tip_id', $tipID)->get();
        $newEquip = [];

        foreach($equipTypes as $equip)
        {
            if(isset($equip['laravel_through_key']))
            {
                $current = $current->filter(function($item) use ($equip)
                {
                    return $item->sys_id != $equip['sys_id'];
                });
            }
            else
            {
                $newEquip[] = $equip;
            }
        }

        $this->processTipEquipment($newEquip, $tipID);

        foreach($current as $cur)
        {
            TechTipSystems::find($cur->tip_tag_id)->delete();
        }

        return true;
    }

    //  Remove any files that were deleted from the tip
    protected function updateTipFiles($deletedList)
    {
        foreach($deletedList as $delFile)
        {
            $details = TechTipFiles::find($delFile);
            $fileID = $details->file_id;
            $details->delete();

            $this->deleteFile($fileID);
        }
    }

    //  Store any equipment types that were attached to the tip
    protected function processTipEquipment($equipment, $tipID)
    {
        foreach($equipment as $sys)
        {
            TechTipSystems::create([
                'tip_id' => $tipID,
                'sys_id' => $sys['sys_id']
            ]);
        }

        return true;
    }

    //  For all files that were uploaded, move to the proper folder and attach to the tip
    protected function processFiles($tipID)
    {
        if(session('newTipFile') != null)
        {
            $files = session('newTipFile');
            $this->path = config('filesystems.paths.tips').DIRECTORY_SEPARATOR.$tipID;
            foreach($files as $file)
            {
                //  Move the file to the proper folder
                $data = Files::find($file);
                Storage::move($data->file_link.$data->file_name, $this->path.DIRECTORY_SEPARATOR.$data->file_name);
                $data->update([
                    'file_link' => $this->path.DIRECTORY_SEPARATOR
                ]);

                //  Attach file to Tech Tip
                TechTipFiles::create([
                    'tip_id' => $tipID,
                    'file_id' => $data->file_id
                ]);
            }

            session()->forget('newTipFile');
        }

        return true;
    }

    //  Send the notifications for the new tip
    protected function sendNotification($sendEmail, $tipID)
    {
        //  Send out the notifications
        if($sendEmail)
        {
            $details = TechTips::find($tipID);
            $users = User::whereHas('UserSettings', function($query) {
                $query->where('em_tech_tip', 1);
            })->get();

            Notification::send($users, new NewTechTip($details));
        }
    }
}


1		<?php
2
3		namespace App\Domains\TechTips;
4
5		use Illuminate\Http\File;
6
7		use Illuminate\Support\Facades\Log;
8		use Illuminate\Support\Facades\Auth;
9		use Illuminate\Support\Facades\Storage;
10		use Illuminate\Support\Facades\Notification;
11
12		use App\Http\Requests\TechTipNewTipRequest;
13		use App\Http\Requests\TechTipProcessImageRequest;
14
15		use App\Domains\FilesDomain;
16
17		use App\User;
18		use App\Files;
19		use App\Http\Requests\TechTipEditTipRequest;
20		use App\TechTips;
21		use App\TechTipFiles;
22		use App\TechTipSystems;
23		use App\TechTipFavs;
24
25		use App\Notifications\NewTechTip;
26
27		class SetTechTips extends FilesDomain
28		{
29		// Store an image that has been uploaded to assign to a Tech Tip
30	2	public function processTipImage(TechTipProcessImageRequest $request)
31		{
32		// Generate a unique hash as the file name and store it in a publicly accessable folder
33	2	$path = 'img/tip_img';
34	2	$location = Storage::disk('public')->putFile($path, new File($request->file));
35	2	Log::info('Image uploaded for tech tip. Image Data - ', array($request));
36
37		// Return the full url path to the image
38	2	return Storage::url($location);
39		}
40
41		// Process the new tip form to see if a file is being uploaded, or upload is completed
42	4	public function processNewTip(TechTipNewTipRequest $request)
43		{
44	4	if(isset($request->file))
45		{
46	2	$fileID = $this->processFileChunk($request);
47	2	if($fileID)
48		{
49	2	$fileArr = session('newTipFile') != null ? session('newTipFile') : [];
50	2	$fileArr[] = $fileID;
51	2	session(['newTipFile' => $fileArr]);
52		}
53
54	2	return false;
55		}
56
57	4	return $this->createTip($request);
58		}
59
60		// Update an existin gTech Tip
61	4	public function processEditTip(TechTipEditTipRequest $request, $tipID)
62		{
63	4	if(isset($request->file))
64		{
65	2	$this->path = config('filesystems.paths.tips').DIRECTORY_SEPARATOR.$tipID;
66	2	$fileID = $this->processFileChunk($request);
67	2	if($fileID)
68		{
69		// Attach file to Tech Tip
70	2	TechTipFiles::create([
71	2	'tip_id' => $tipID,
72	2	'file_id' => $fileID,
73		]);
74		}
75
76	2	return false;
77		}
78
79	2	$this->updateTipDetails($request);
80	2	$this->updateTipEquipment($request->system_types, $tipID);
81	2	if(isset($request->deletedFileList))
82		{
83		$this->updateTipFiles($request->deletedFileList);
84		}
85
86	2	return true;
87		}
88
89		// Delete the Tech Tip
90	2	public function deleteTip($tipID)
91		{
92	2	TechTipFavs::where('tip_id', $tipID)->delete();
93
94		// Disable the tip
95	2	TechTips::find($tipID)->delete();
96	2	Log::warning('User - '.Auth::user()->full_name.' deleted Tech Tip ID - '.$tipID);
97
98	2	return true;
99		}
100
101		// Create the Tech Tip in the datbase
102	4	protected function createTip($tipData)
103		{
104		// Remove any forward slash (/) from the Subject Field
105	4	$tipData->merge(['subject' => str_replace('/', '-', $tipData->subject)]);
106
107		// Enter the tip details and return the tip ID
108	4	$tip = TechTips::create([
109	4	'tip_type_id' => $tipData->tip_type_id,
110	4	'subject' => $tipData->subject,
111	4	'description' => $tipData->description,
112	4	'user_id' => Auth::user()->user_id
113		]);
114	4	$tipID = $tip->tip_id;
115
116	4	$this->processTipEquipment($tipData->equipment, $tipID);
117	4	$this->processFiles($tipID);
118	4	$this->sendNotification($tipData->noEmail, $tipID);
119
120	4	return $tipID;
121		}
122
123		// Update the tip details
124	2	protected function updateTipDetails($data)
125		{
126		// Update the base information
127	2	TechTips::find($data->tip_id)->update([
128	2	'tip_type_id' => $data->tip_type_id,
129	2	'subject' => $data->subject,
130	2	'description' => $data->description,
131		]);
132
133	2	return true;
134		}
135
136		// Add or remove any system types attached to the tip
137	2	protected function updateTipEquipment($equipTypes, $tipID)
138		{
139	2	$current = TechTipSystems::where('tip_id', $tipID)->get();
140	2	$newEquip = [];
141
142	2	foreach($equipTypes as $equip)
143		{
144	2	if(isset($equip['laravel_through_key']))
145		{
146		$current = $current->filter(function($item) use ($equip)
147		{
148		return $item->sys_id != $equip['sys_id'];
149		});
150		}
151		else
152		{
153	2	$newEquip[] = $equip;
154		}
155		}
156
157	2	$this->processTipEquipment($newEquip, $tipID);
158
159	2	foreach($current as $cur)
160		{
161	2	TechTipSystems::find($cur->tip_tag_id)->delete();
162		}
163
164	2	return true;
165		}
166
167		// Remove any files that were deleted from the tip
168		protected function updateTipFiles($deletedList)
169		{
170		foreach($deletedList as $delFile)
171		{
172		$details = TechTipFiles::find($delFile);
173		$fileID = $details->file_id;
174		$details->delete();
175
176		$this->deleteFile($fileID);
177		}
178		}
179
180		// Store any equipment types that were attached to the tip
181	6	protected function processTipEquipment($equipment, $tipID)
182		{
183	6	foreach($equipment as $sys)
184		{
185	6	TechTipSystems::create([
186	6	'tip_id' => $tipID,
187	6	'sys_id' => $sys['sys_id']
188		]);
189		}
190
191	6	return true;
192		}
193
194		// For all files that were uploaded, move to the proper folder and attach to the tip
195	4	protected function processFiles($tipID)
196		{
197	4	if(session('newTipFile') != null)
198		{
199	2	$files = session('newTipFile');
200	2	$this->path = config('filesystems.paths.tips').DIRECTORY_SEPARATOR.$tipID;
201	2	foreach($files as $file)
202		{
203		// Move the file to the proper folder
204	2	$data = Files::find($file);
205	2	Storage::move($data->file_link.$data->file_name, $this->path.DIRECTORY_SEPARATOR.$data->file_name);
206	2	$data->update([
207	2	'file_link' => $this->path.DIRECTORY_SEPARATOR
208		]);
209
210		// Attach file to Tech Tip
211	2	TechTipFiles::create([
212	2	'tip_id' => $tipID,
213	2	'file_id' => $data->file_id
214		]);
215		}
216
217	2	session()->forget('newTipFile');
218		}
219
220	4	return true;
221		}
222
223		// Send the notifications for the new tip
224	4	protected function sendNotification($sendEmail, $tipID)
225		{
226		// Send out the notifications
227	4	if($sendEmail)
228		{
229		$details = TechTips::find($tipID);
230		$users = User::whereHas('UserSettings', function($query) {
231		$query->where('em_tech_tip', 1);
232		})->get();
233
234		Notification::send($users, new NewTechTip($details));
235		}
236	4	}
237		}
238

butcherman / Tech_Bench

Push — dev5 ( ecdb11...2a90e7 )

SetTechTips::updateTipDetails() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like