App\Modules\Core\BaseClasses\BaseApiController

Complexity

Total Complexity

35

Size/Duplication

Total Lines	204
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	16	4
A	index()	0	4	1
A	find()	0	4	1
A	delete()	0	4	1
A	deleted()	0	4	1
A	restore()	0	4	1
B	checkPermission()	0	22	10
A	setSessions()	0	27	5
A	setRelations()	0	6	4
B	updateLocaleAndTimezone()	0	19	7

<?php

namespace App\Modules\Core\BaseClasses;

use App\Http\Controllers\Controller;
use Illuminate\Http\Request;
use Illuminate\Support\Arr;
use App\Modules\Core\Http\Resources\General as GeneralResource;

class BaseApiController extends Controller
{
    /**
     * The config implementation.
     *
     * @var array
     */
    protected $config;

    /**
     * The relations implementation.
     *
     * @var array
     */
    protected $relations;

    /**
     * The repo implementation.
     *
     * @var object
     */
    protected $repo;

    /**
     * Init new object.
     *
     * @param   mixed      $repo
     * @param   CoreConfig $config
     * @param   string     $modelResource
     * @return  void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct($repo, $config, $modelResource)
    {
        $this->repo = $repo;
        $this->modelResource = $modelResource;
        $this->config = $config->getConfig();
        $this->modelName = explode('\\', get_called_class());
        $this->modelName = lcfirst(str_replace('Controller', '', end($this->modelName)));
        $this->validationRules = property_exists($this, 'validationRules') ? $this->validationRules : false;
        $this->skipPermissionCheck = property_exists($this, 'skipPermissionCheck') ? $this->skipPermissionCheck : [];
        $this->skipLoginCheck = property_exists($this, 'skipLoginCheck') ? $this->skipLoginCheck : [];
        $route = explode('@', \Route::currentRouteAction())[1];

        $this->setSessions();
        $this->checkPermission($route);
        $this->setRelations($route);
    }

    /**
     * Fetch all records with relations from storage.
     *
     * @param Request $request
     * @return \Illuminate\Http\Response
     */
    public function index(Request $request)
    {
        return $this->modelResource::collection($this->repo->list($this->relations, $request->query(), $request->query('perPage'), $request->query('sortBy'), $request->query('desc')));
    }

    /**
     * Fetch the single object with relations from storage.
     *
     * @param  integer $id Id of the requested model.
     * @return \Illuminate\Http\Response
     */
    public function find($id)
    {
        return new $this->modelResource($this->repo->find($id, $this->relations));
    }

    /**
     * Delete by the given id from storage.
     *
     * @param  integer $id Id of the deleted model.
     * @return \Illuminate\Http\Response
     */
    public function delete($id)
    {
        return new GeneralResource($this->repo->delete($id));
    }

    /**
     * Return the deleted models in pages based on the given conditions.
     *
     * @param Request $request
     * @return \Illuminate\Http\Response
     */
    public function deleted(Request $request)
    {
        return $this->modelResource::collection($this->repo->deleted($request->all(), $request->query('perPage'), $request->query('sortBy'), $request->query('desc')));
    }

    /**
     * Restore the deleted model.
     *
     * @param  integer $id Id of the restored model.
     * @return \Illuminate\Http\Response
     */
    public function restore($id)
    {
        return new GeneralResource($this->repo->restore($id));
    }

    /**
     * Check if the logged in user can do the given permission.
     *
     * @param  string $permission
     * @return void
     */
    private function checkPermission($permission)
    {
        \Auth::shouldUse('api');
        $this->middleware('auth:api', ['except' => $this->skipLoginCheck]);
        
        if (! in_array($permission, $this->skipLoginCheck) && $user = \Auth::user()) {
            $user             = \Auth::user();
            $permission       = $permission !== 'index' ? $permission : 'list';
            $isPasswordClient = $user->token()->client->password_client;
            $this->updateLocaleAndTimezone($user);

            if ($user->blocked) {
                \ErrorHandler::userIsBlocked();
            }

            if ($isPasswordClient && (in_array($permission, $this->skipPermissionCheck) || \Core::users()->can($permission, $this->modelName))) {
            } elseif (! $isPasswordClient && $user->tokenCan($this->modelName.'-'.$permission)) {
            } else {
                \ErrorHandler::noPermissions();
            }
        }
    }

    /**
     * Set sessions based on the given headers in the request.
     *
     * @return void
     */
    private function setSessions()
    {
        \Session::put('time-zone', \Request::header('time-zone') ?: 0);

        $locale = \Request::header('locale');
        switch ($locale) {
            case 'en':
                \App::setLocale('en');
                \Session::put('locale', 'en');
                break;

            case 'ar':
                \App::setLocale('ar');
                \Session::put('locale', 'ar');
                break;

            case 'all':
                \App::setLocale('en');
                \Session::put('locale', 'all');
                break;

            default:
                \App::setLocale('en');
                \Session::put('locale', 'en');
                break;
        }
    }

    /**
     * Set relation based on the called api.
     *
     * @param  string $route
     * @return void
     */
    private function setRelations($route)
    {
        $route           = $route !== 'index' ? $route : 'list';
        $relations       = Arr::get($this->config['relations'], $this->modelName, false);
        $this->relations = $relations && isset($relations[$route]) ? $relations[$route] : [];
    }

    /**
     * Update the logged in user locale and time zone.
     *
     * @param  object $user
     * @return void
     */
    private function updateLocaleAndTimezone($user)
    {
        $update   = false;
        $locale   = \Session::get('locale');
        $timezone = \Session::get('time-zone');
        if ($locale && $locale !== 'all' && $locale !== $user->locale) {
            $user->locale = $locale;
            $update       = true;
        }

        if ($timezone && $timezone !== $user->timezone) {
            $user->timezone = $timezone;
            $update       = true;
        }

        if ($update) {
            $user->save();
        }
    }
}