Controller::index() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/master'" - mshamaseen/laravel-repository-pattern - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( fac26f...940892 )

by Mohammad
created 2019-03-04 14:06 UTC
Controller::index() A

↳ Parent: Controller
Complexity

Conditions	4
Paths	4
Size

Total Lines	23
Code Lines	15
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	4
eloc	15
nc	4
nop	0
dl	0
loc	23
rs	9.7666
c	0
b	0
f	0
<?php
/**
 * Created by PhpStorm.
 * User: Hamza Alayed
 * Date: 12/29/18
 * Time: 9:53 AM.
 */

namespace Shamaseen\Repository\Generator\Utility;

use Illuminate\Http\JsonResponse;
filter:
    dependency_paths: ["lib/*"]
use Illuminate\Support\Collection;

/**
 * Class BaseController.
 */
class Controller extends \App\Http\Controllers\Controller
filter:
    dependency_paths: ["lib/*"]
{
    /**
     * @var ContractInterface
     */
    protected $interface;

    protected $limit = 10;

    protected $routeIndex = '';

    protected $pageTitle = '';
    protected $createRoute = '';

    protected $viewIndex = '';
    protected $viewCreate = '';
    protected $viewEdit = '';
    protected $viewShow = '';
    protected $breadcrumbs;

    protected $menu;
    protected $search;
    protected $selectedMenu = [];
    protected $isAPI = false;
    protected $trash = false;
    protected $params = [];
    /**
     * @var Request
     */
    private $request;

    /**
     * BaseController constructor.
     *
     * @param ContractInterface $interface
     * @param Request           $request
     */
    public function __construct(ContractInterface $interface, Request $request)
    {
        $this->menu = new Collection();
        $this->breadcrumbs = new Collection();

        $language = $request->header('Language', 'en');
        if (! in_array($language, \Config::get('app.locales', []))) {
            $language = 'en';
        }
        $limit = $request->get('limit', 10);

        if ((bool) $request->get('with-trash', false)) {
            $interface->withTrash();
        }
        if ((bool) $request->get('only-trash', false)) {
            $interface->trash();
        }

        $request->offsetUnset('only-trash');
        $request->offsetUnset('with-trash');

        if (in_array($limit, [20, 30, 40, 50])) {
            $this->limit = $limit;
        }

        \App::setLocale($language);
        $this->interface = $interface;
        $this->isAPI = $request->expectsJson();

        if (! $this->isAPI) {
            $this->breadcrumbs = new Collection();
            $this->search = new Collection();
            \View::share('pageTitle', $this->pageTitle.' | '.\Config::get('app.name'));
            \View::share('breadcrumbs', $this->breadcrumbs);
            \View::share('menu', $this->menu);
            \View::share('search', $this->search);
            \View::share('selectedMenu', $this->selectedMenu);
        }
        $this->request = $request;
    }

    /**
     * Display a listing of the resource.
     *
     *
     * @return \Illuminate\Http\Response
filter:
    dependency_paths: ["lib/*"]
     */
    public function index()
    {
        $data = $this->interface->simplePaginate($this->limit, $this->request->all());
        if (! $this->isAPI) {
            \View::share('pageTitle', 'List '.$this->pageTitle.' | '.\Config::get('app.name'));
            $this->breadcrumbs->put('index', [
                'link' => $this->routeIndex,
                'text' => $this->pageTitle,
            ]);

            return view($this->viewIndex, $this->params)
            return /** @scrutinizer ignore-call */ view($this->viewIndex, $this->params)
                ->with('entities', $data)
                ->with('createRoute', $this->createRoute)
                ->with('filters', $this->request->all());
        }
        if ($data->hasMorePages()) {
            return response()->json($data, JsonResponse::HTTP_PARTIAL_CONTENT);
            return /** @scrutinizer ignore-call */ response()->json($data, JsonResponse::HTTP_PARTIAL_CONTENT);
        }
        if (0 == $data->count()) {
            return response()->json($data, JsonResponse::HTTP_REQUESTED_RANGE_NOT_SATISFIABLE);
        }

        return response()->json($data, JsonResponse::HTTP_OK);
    }

    /**
     * Show the form for creating a new resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function create()
    {
        if (! $this->isAPI) {
            \View::share('pageTitle', 'Create '.$this->pageTitle.' | '.\Config::get('app.name'));
            $this->breadcrumbs->put('create', [
                'link' => $this->createRoute,
                'text' => trans('common/others.create'),
                'text' => /** @scrutinizer ignore-call */ trans('common/others.create'),
            ]);

            return view($this->viewCreate, $this->params);
            return /** @scrutinizer ignore-call */ view($this->viewCreate, $this->params);
        }

        return response()->json(null, JsonResponse::HTTP_NO_CONTENT);
        return /** @scrutinizer ignore-call */ response()->json(null, JsonResponse::HTTP_NO_CONTENT);
    }

    /**
     * Store a newly created resource in storage.
     *
     * @return \Illuminate\Http\RedirectResponse|mixed
filter:
    dependency_paths: ["lib/*"]
     */
    public function store()
    {
        $entity = $this->interface->create($this->request->except(['_token', '_method']));
        return $this->makeResponse($entity,true);
    }

    /**
     * Display the specified resource.
     *
     * @param int $entityId
     *
     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Http\Response
     */
    public function show($entityId)
    {
        $entity = $this->interface->find($entityId);
        if (! $this->isAPI) {
            if (! $entity) {

                return \Redirect::to($this->routeIndex)->with('warning', __('messages.not_found'));
                return \Redirect::to($this->routeIndex)->with('warning', /** @scrutinizer ignore-call */ __('messages.not_found'));
            }
            \View::share('pageTitle', 'View '.$this->pageTitle.' | '.\Config::get('app.name'));
            $this->breadcrumbs->put('view', [
                'link' => '',
                'text' => $entity->name ?? $entity->title ?? __('messages.view'),
            ]);

            return view($this->viewShow, $this->params)
            return /** @scrutinizer ignore-call */ view($this->viewShow, $this->params)
                ->with('entity', $entity);
        }
        if (! $entity) {

            return response()->json(null, JsonResponse::HTTP_NOT_FOUND);
            return /** @scrutinizer ignore-call */ response()->json(null, JsonResponse::HTTP_NOT_FOUND);
        }

        return response()->json(
            ['status' => true, 'message' => __('messages.success'), 'data' => $entity],
            JsonResponse::HTTP_OK
        );
    }

    /**
     * Show the form for editing the specified resource.
     *
     * @param int $entityId
     *
     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Http\Response
     */
    public function edit($entityId)
    {
        $entity = $this->interface->find($entityId);
        if (! $this->isAPI) {
            if (! $entity) {

                return \Redirect::to($this->routeIndex)->with('warning', __('messages.not_found'));
                return \Redirect::to($this->routeIndex)->with('warning', /** @scrutinizer ignore-call */ __('messages.not_found'));
            }
            $this->breadcrumbs->put('edit', [
                'link' => '',
                'text' => $entity->name ?? $entity->title ?? __('messages.view'),
            ]);

            return view($this->viewEdit, $this->params)
            return /** @scrutinizer ignore-call */ view($this->viewEdit, $this->params)
                ->with('entity', $entity);
        }

        return response()->json(null, JsonResponse::HTTP_NOT_FOUND);
        return /** @scrutinizer ignore-call */ response()->json(null, JsonResponse::HTTP_NOT_FOUND);
    }

    /**
     * Update the specified resource in storage.
     *
     * @param int $entityId
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function update($entityId)
    {
        $entity = $this->interface->update($entityId, $this->request->except(['_token', '_method']));

        return $this->makeResponse($entity,ture);

    }

    /**
     * Remove the specified resource from storage.
     *
     * @param int $entityId
     *
     * @return \Illuminate\Http\RedirectResponse
     * @throws \Exception
     */
    public function destroy($entityId)
    {
        $deleted = $this->interface->delete($entityId);

        return $this->makeResponse($deleted);
    }

    /**
     * Restore the specified resource from storage.
     *
     * @param int $entityId
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function restore($entityId)
    {
        $entity = $this->interface->restore($entityId);

        return $this->makeResponse($entity);
    }

    /**
     * Restore the specified resource from storage.
     *
     * @param int $entityId
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function forceDelete($entityId)
    {
        $entity = $this->interface->forceDelete($entityId);

        return $this->makeResponse($entity);
    }

    /**
     * Make response for web or json.
     *
     * @param mixed $entity
     * @param boolean $appendEntity
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    function makeResponse($entity,$appendEntity = false)

    {
        if (! $this->isAPI) {
            if ($entity) {
                return \Redirect::to($this->routeIndex)->with('message', __('messages.success'));
                return \Redirect::to($this->routeIndex)->with('message', /** @scrutinizer ignore-call */ __('messages.success'));
            }

            if ($entity === null) {
                return \Redirect::to($this->routeIndex)->with('warning', __('messages.not_found'));
            }

            return \Redirect::to($this->routeIndex)->with('error', __('messages.not_modified'));
        }

        if ($entity) {
            if($appendEntity)
                return response()->json(  ['status' => true, 'message' => __('messages.success'), 'data' => $entity],
                return /** @scrutinizer ignore-call */ response()->json(  ['status' => true, 'message' => __('messages.success'), 'data' => $entity],
                    JsonResponse::HTTP_OK);
            return response()->json(null, JsonResponse::HTTP_NO_CONTENT);
        }

        if ($entity === null) {
            return response()->json(null, JsonResponse::HTTP_NOT_FOUND);
        }

        return response()->json(null, JsonResponse::HTTP_NOT_MODIFIED);
    }
}

mshamaseen / laravel-repository-pattern

Push — master ( fac26f...940892 )

Controller::index() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
