CustomerFilesController::store() - Code Metrics - Inspection of "Updated Customer Files" - butcherman/Tech_Bench - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — dev5 ( 8e9925...6e89ff )

by Ron

created 2019-11-23 21:37 UTC

CustomerFilesController::store() A

↳ Parent: CustomerFilesController

Complexity

Conditions	3
Paths	3

Size

Total Lines	64
Code Lines	33

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	29
CRAP Score	3.0024

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	33
c	1
b	0
f	0
nc	3
nop	1
dl	0
loc	64
ccs	29
cts	31
cp	0.9355
crap	3.0024
rs	9.392

How to fix Long Method

<?php

namespace App\Http\Controllers\Customers;

use App\Files;
use App\Customers;
use App\CustomerFiles;
use App\CustomerFileTypes;
use Illuminate\Http\Request;
use Illuminate\Http\UploadedFile;
use Illuminate\Support\Facades\Log;
use App\Http\Controllers\Controller;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Route;
use Pion\Laravel\ChunkUpload\Receiver\FileReceiver;
use Pion\Laravel\ChunkUpload\Handler\HandlerFactory;
use Pion\Laravel\ChunkUpload\Handler\AbstractHandler;
use Pion\Laravel\ChunkUpload\Exceptions\UploadMissingFileException;

class CustomerFilesController extends Controller
{
    public function __construct()
    {
        $this->middleware('auth');
    }

    //  Get the types of files that can be attached to a customer
    // public function getFileTypes()
    // {
    //     $fileTypes = CustomerFileTypes::all();
    //     $fTypes    = [];
    //     foreach($fileTypes as $type)
    //     {
    //         $fTypes[$type->file_type_id] = $type->description;
    //     }

    //     return response()->json($fileTypes);
    // }

    //  Store a new customer file
    public function store(Request $request)
    {
        //  Validate the form
        $request->validate([
            'cust_id' => 'required',
            'name'    => 'required',
            'type'    => 'required'
        ]);

        $receiver = new FileReceiver('file', $request, HandlerFactory::classFromRequest($request));

        //  Verify that the upload is valid and being processed
        if($receiver->isUploaded() === false)
        {
            Log::error('Upload File Missing - '.$request->toArray());
            Log::error('Upload File Missing - './** @scrutinizer ignore-type */ $request->toArray());
            throw new UploadMissingFileException();
        }

        //  Receive and process the file
        $save = $receiver->receive();

        //  See if the upload has finished
        if($save->isFinished())
        {
            $file = $save->getFile();
            //  Set file locationi and clean filename for duplicates
            $filePath = config('filesystems.paths.customers').DIRECTORY_SEPARATOR.$request->cust_id;
            $fileName = Files::cleanFileName($filePath, $file->getClientOriginalName());

            //  Store the file
            $file->storeAs($filePath, $fileName);

            //  Put the file in the database
            $file = Files::create(
            [
                'file_name' => $fileName,
                'file_link' => $filePath.DIRECTORY_SEPARATOR
            ]);

            //  Get information for system files table
            $fileID = $file->file_id;

            //  Input the file into the customer files table
            CustomerFiles::create([
                'file_id'      => $fileID,
                'file_type_id' => $request->type,
                'cust_id'      => $request->cust_id,
                'user_id'      => Auth::user()->user_id,
                'name'         => $request->name
            ]);

            Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);
            Log::debug('Submitted Data - ', $request->toArray());
            Log::info('File added for Customer ID-'.$request->custID.' by User ID-'.Auth::user()->user_id.'.  New File ID-'.$fileID);
        }

        //  Get the current progress
        $handler = $save->handler();

        Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);
        Log::debug('File being uploaded.  Percentage done - '.$handler->getPercentageDone());
        return response()->json([
            'done'   => $handler->getPercentageDone(),
            'status' => true
        ]);
    }

    //  Get the files for the customer
    public function show($id)
    {
        $files = CustomerFiles::where('cust_id', $id)
            ->with('Files')
            ->with('CustomerFileTypes')
            ->with('User')
            ->get();

        return $files;
    }

    //  Update the test information of the file, but not the file itself
    public function update(Request $request, $id)
    {
        $request->validate([
            'cust_id' => 'required',
            'name' => 'required',
            'type' => 'required'
        ]);

        CustomerFiles::find($id)->update([
            'name' => $request->name,
            'file_type_id' => $request->type
        ]);


        return response()->json(['success' => true]);
    }

    //  Remove a customer file
    public function destroy($id)
    {
        //  Remove the file from SystemFiles table
        $data = CustomerFiles::find($id);
        $fileID = $data->file_id;
        $data->delete();

        Log::debug('Route '.Route::currentRouteName().' visited by User ID-'.Auth::user()->user_id);
        Log::info('File Deleted For Customer ID-'.$data->custID.' by User ID-'.Auth::user()->user_id.'.  File ID-'.$id);

        //  Delete from system if no longer in use
        Files::deleteFile($fileID);

        return response()->json(['success' => true]);
    }
}


butcherman / Tech_Bench

Push — dev5 ( 8e9925...6e89ff )

CustomerFilesController::store() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like