BaseController::index() - Code Metrics - Inspection of "add somthing in readme for lumen" - Alive2212/LaravelSmartRestful - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 3a32b0...328300 )

by Babak
created 2018-07-04 06:08 UTC
BaseController::index() F

↳ Parent: BaseController
Complexity

Conditions	14
Paths	909
Size

Total Lines
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	14
nc	909
nop	1
dl	0
loc	74
rs	2.3483
c	0
b	0
f	0
How to fix Long Method Complexity

<?php

namespace Alive2212\LaravelSmartRestful;

use Alive2212\ExcelHelper\ExcelHelper;
use Alive2212\LaravelQueryHelper\QueryHelper;
filter:
    dependency_paths: ["lib/*"]
use Alive2212\LaravelRequestHelper\RequestHelper;
filter:
    dependency_paths: ["lib/*"]
use Alive2212\LaravelSmartResponse\ResponseModel;
use Alive2212\LaravelSmartResponse\SmartResponse\SmartResponse;
filter:
    dependency_paths: ["lib/*"]
use Alive2212\LaravelStringHelper\StringHelper;
filter:
    dependency_paths: ["lib/*"]
use App\Http\Controllers\Controller;
filter:
    dependency_paths: ["lib/*"]
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Database\QueryException;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\MessageBag;
use Illuminate\Support\Facades\Validator;


abstract class BaseController extends Controller
{
    /**
     * to use this class
     * create message list as messages in message file
     * override __constructor and define your model
     * define your rules for index,store and update
     */

    protected $DEFAULT_RESULT_PER_PAGE = 15;

    /**
     * @var array
     */
    protected $pivotFields = [];

    /**
     * @var array
     */
    protected $uniqueFields = [];

    /**
     * @var bool|string
     */
    protected $modelName;

    /**
     * @var string
     */
    protected $messagePrefix = 'messages.api.v1.';

    /**
     * this model
     */
    protected $model;

    /**
     * index request validator rules
     *
     * @var array
     */
    protected $indexValidateArray = [
        //
    ];

    /**
     * array of relationship for eager loading
     *
     * @var array
     */
    protected $indexLoad = [
        //
    ];

    /**
     * array of relationship for eager loading
     *
     * @var array
     */
    protected $editLoad = [
        //
    ];

    /**
     * array of relationship for eager loading
     *
     * @var array
     */
    protected $updateLoad = [
        //
    ];

    /**
     * store request validator rules
     *
     * @var array
     */
    protected $storeValidateArray = [
        //
    ];

    /**
     * update request validator rules
     *
     * @var array
     */
    protected $updateValidateArray = [
        //
    ];

    protected $middlewareParams = [];

    /**
     * defaultController constructor.
     */
    public function __construct()
    {
//        dd("I have closest relationship with all US celebrities");
        $this->initController();
    }

    abstract public function initController();

    /**
     * Display a listing of the resource.
     *
     * @param Request $request
     * @return string
     */
    public function index(Request $request)
    {
        // create response model
        $response = new ResponseModel();

        //set default pagination
        if (isset($request->toArray()['page']['size'])) {
            if (is_null($request->toArray()['page']['size'])) {
                $request['page'] = ['size' => $this->DEFAULT_RESULT_PER_PAGE];
            }
        }

        //set default ordering
        if (isset($request->toArray()['order_by'])) {
            if (is_null($request['order_by'])) {
                $request['order_by'] = "{\"field\":\"id\",\"operator\":\"Desc\"}";
            }
        }


        $validationErrors = $this->checkRequestValidation($request, $this->indexValidateArray);
        if ($validationErrors != null) {

            // return response
            $response->setData(collect($validationErrors->toArray()));
            $response->setMessage("Validation Failed");
            $response->setStatus(false);
            $response->setError(99);
            return SmartResponse::response($response);
        }

        try {
            $data = $request->get('query') != null ?
                $this->model
                    ->whereKey(collect($this->model
                        ->search(($request->get('query')))
                        ->raw())->get('ids')) :
                $this->model;
            if (array_key_exists('file', $request->toArray())) {
                //TODO add relation on top if here and create a tree flatter array in array helper
                return (new ExcelHelper())->setOptions([
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
                    'store_format' => $request->get('file') == null ? 'xls' : $request->get('file'),
                    'download_format' => $request->get('file') == null ? 'xls' : $request->get('file'),
                ])->table($data->get()->toArray())->createExcelFile()->download();
            }

            // load relations
            if (count($this->indexLoad) > 0) {
                $data = $data->with($this->indexLoad);
            }

            // filters by
            if (isset($request->toArray()['filters'])) {
                $data = (new QueryHelper())->deepFilter($data, (new RequestHelper())->getCollectFromJson($request['filters']));
            }

            // order by
            if (isset($request->toArray()['order_by'])) {
                $data = (new QueryHelper())->orderBy($data, (new RequestHelper())->getCollectFromJson($request['order_by']));
            }

            // return response
            $response->setData(collect($data->paginate()));
            $response->setMessage("Successful");
            return SmartResponse::response($response);

        } catch (QueryException $exception) {

            // return response
            $response->setData(collect($exception->getMessage()));
            $response->setError($exception->getCode());
            $response->setMessage("Failed");
            $response->setStatus(false);
            return SmartResponse::response($response);
        }
    }

    public function checkRequestValidation(Request $request, $validationArray)
    {
        $requestParams = $request->toArray();
        $validator = Validator::make($request->all(), $validationArray);
        if ($validator->fails()) {
            return $validator->errors();
        }
        if (is_numeric(array_search($request->getMethod(), ["POST", "PUT", "PATCH"]))) {
            $errors = new MessageBag();
            foreach ($requestParams as $requestParamKey => $requestParamValue) {
                if (is_numeric(array_search($requestParamKey, $this->uniqueFields))) {
                    if ($this->checkExistUniqueRecord($requestParamKey, $requestParamValue)) {
                        $errors->add($requestParamKey, 'This ' . $requestParamKey . ' is exist try another.');
                    }
                }
            }
            if (collect($errors)->count() > 0) {
                return $errors;
            }
        }
        return null;
    }

    /**
     * @param $key
     * @param $value
     * @return bool
     */
    public function checkExistUniqueRecord($key, $value)
    {
        if ($this->model->where($key, $value)->count()) {
            return true;
        }
        return false;
    }

    /**
     * @param $status
     * @return mixed
     */
    public function message($status)
    {
        $key = $this->messagePrefix . $this->modelName . '.' . debug_backtrace()[1]['function'] . '.' . $status;
        return $this->getMessageFromFile($key);
    }

    /**
     * @param $key
     * @return mixed
     */
    public function getMessageFromFile($key)
    {
        return config($key);
    }

    /**
     * Show the form for creating a new resource.
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function create()
    {
        // Create Response Model
        $response = new ResponseModel();

        // return response
        $response->setData(collect($this->model->getFillable()));
        $response->setMessage("Successful");
        return SmartResponse::response($response);
    }

    /**
     * Store a newly created resource in storage.
     *
     * @param  \Illuminate\Http\Request $request
     * @return \Illuminate\Http\JsonResponse
     */
    public function store(Request $request)
    {
        // Create Response Model
        $response = new ResponseModel();

        // TODO must set access in middle ware
        //get user id
        $userId = auth()->id();

        //add author id into the request if doesn't exist
        if (isset($request['author_id'])) {
            if (is_null($request['author_id'])) {
                $request['author_id'] = $userId;
            }
        } else {
            $request['author_id'] = $userId;
        }

        //add user id into the request if doesn't exist
        if (isset($request['user_id'])) {
            if (is_null($request['user_id'])) {
                $request['user_id'] = $userId;
            }
        } else {
            $request['user_id'] = $userId;
        }

        $validationErrors = $this->checkRequestValidation($request, $this->storeValidateArray);
        if ($validationErrors != null) {
            if (env('APP_DEBUG', false)) {
                $response->setMessage(json_encode($validationErrors->getMessages()));
            }
            $response->setStatus(false);
            return SmartResponse::response($response);
        }
        try {
            // get result of model creation
            $result = $this->model->create($request->all());
            // sync many to many relation
            foreach ($this->pivotFields as $pivotField) {
                if (collect($request[$pivotField])->count()) {
                    $pivotField = (new StringHelper())->toCamel($pivotField);
                    $this->model->find($result['id'])->$pivotField()->sync(json_decode($request[$pivotField]));
                }
            }
            $response->setMessage('successful');
            $response->setData(collect($result->toArray()));
            $response->setStatus(true);
            return SmartResponse::response($response);
        } catch (QueryException $exception) {
            if (env('APP_DEBUG', false)) {
                $response->setMessage($exception->getMessage());
            }
            $response->setStatus(false);
            return SmartResponse::response($response);
        }
    }

    /**
     * Display the specdefaultied resource.
     *
     * @param  int $id
     * @return \Illuminate\Http\Response
     */
    public function show($id)
    {
        // Create Response Model
        $response = new ResponseModel();


        try {

            return SmartResponse::json(
                $this->message('successful'),
                true,
                200,
                $this->model->findOrFail($id)
            );
        } catch (ModelNotFoundException $exception) {
            return SmartResponse::json(
                $this->message('failed'),
                false,
                200,
                $exception->getMessage()
            );
        }
    }

    /**
     * Show the form for editing the specified resource.
     *
     * @param  int $id
     * @return \Illuminate\Http\JsonResponse
     */
    public function edit($id)
    {
        // Create Response Model
        $response = new ResponseModel();

        try {
            $response->setMessage('Successful');
            $response->setData($this->model
                ->where($this->model->getKeyName(), $id)
                ->with(collect($this->editLoad)->count() == 0 ? $this->indexLoad : $this->editLoad)
                ->get());
            return SmartResponse::response($response);
        } catch (ModelNotFoundException $exception) {
            $response->setData(collect($exception->getMessage()));
            $response->setError($exception->getCode());
            $response->setError(/** @scrutinizer ignore-type */ $exception->getCode());
            $response->setMessage('Failed');
            $response->setStatus(false);
            return SmartResponse::response($response);
        }
    }

    /**
     * Update the specified resource in storage.
     *
     * @param  \Illuminate\Http\Request $request
     * @param  int $id
     * @return \Illuminate\Http\JsonResponse
     */
    public function update(Request $request, $id)
    {
        // Create Response Model
        $response = new ResponseModel();

        $validationErrors = $this->checkRequestValidation($request, $this->updateValidateArray);
        if ($validationErrors != null) {

            // return response
            $response->setData(collect($validationErrors->toArray()));
            $response->setMessage("Validation Failed");
            $response->setStatus(false);
            $response->setError(99);
            return SmartResponse::response($response);
        }
        try {
            // sync many to many relation
            foreach ($this->pivotFields as $pivotField) {
                if (collect($request[$pivotField])->count()) {
                    $pivotMethod = (new StringHelper())->toCamel($pivotField);
                    $this->model->findOrFail($id)->$pivotMethod()->sync(json_decode($request[$pivotField], true));
                }
            }
            //get result of update
            $result = $this->model->findOrFail($id)->update($request->all());

            // return response
            $response->setData(collect(env('APP_DEBUG') ? $this->model->find($id) : []));
            $response->setMessage('Successful to change ' . $result . ' record');
            return SmartResponse::response($response);


        } catch (ModelNotFoundException $exception) {


            // return response
            $response->setData(collect($exception->getMessage()));
            $response->setStatus(false);
            $response->setMessage('Not found record');

            return SmartResponse::response($response);

        } catch (QueryException $exception) {
            // return response
            $response->setData(collect($exception->getMessage()));
            $response->setStatus(false);
            $response->setMessage('Failed');

            return SmartResponse::response($response);
        }
    }

    /**
     * Remove the specified resource from storage.
     *
     * @param  int $id
     * @return \Illuminate\Http\JsonResponse
     */
    public function destroy($id)
    {
        // Create Response Model
        $response = new ResponseModel();

        try {
            // return response
            $response->setData(collect($this->model->findOrFail($id)->delete()));
            $response->setMessage('Successful');

            return SmartResponse::response($response);

        } catch (ModelNotFoundException $exception) {
            // return response
            $response->setData(collect($exception->getMessage()));
            $response->setMessage('Failed');
            $response->setStatus(false);
            $response->setError($exception->getCode());
            $response->setError(/** @scrutinizer ignore-type */ $exception->getCode());

            return SmartResponse::response($response);
        }
    }
}
Alive2212 / LaravelSmartRestful

Push — master ( 3a32b0...328300 )

BaseController::index() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like
