SherifElfadaly / Laravel-Api-Skeleton

src/Modules/V1/Core/Http/Controllers/BaseApiController.php

Indentation +209 added lines, -209 removed lines

@@ -6,215 +6,215 @@
 
 class BaseApiController extends Controller
 {
-    /**
-     * The model implementation.
-     * 
-     * @var model
-     */
-    protected $model;
-
-    /**
-     * The config implementation.
-     * 
-     * @var config
-     */
-    protected $config;
-
-    public function __construct()
-    {
-        \Session::set('timeZoneDiff', \Request::header('time-zone-diff') ?: 0);
+	/**
+	 * The model implementation.
+	 * 
+	 * @var model
+	 */
+	protected $model;
+
+	/**
+	 * The config implementation.
+	 * 
+	 * @var config
+	 */
+	protected $config;
+
+	public function __construct()
+	{
+		\Session::set('timeZoneDiff', \Request::header('time-zone-diff') ?: 0);
         
-        $this->config              = \CoreConfig::getConfig();
-        $this->model               = property_exists($this, 'model') ? $this->model : false;
-        $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 : [];
-        $this->relations           = array_key_exists($this->model, $this->config['relations']) ? $this->config['relations'][$this->model] : false;
-        $route                     = explode('@',\Route::currentRouteAction())[1];
-        $this->checkPermission($route);
-    }
-
-    /**
-     * Fetch all records with relations from model repository.
-     * 
-     * @return \Illuminate\Http\Response
-     */
-    public function index() 
-    {
-        if ($this->model)
-        {
-            $relations = $this->relations && $this->relations['all'] ? $this->relations['all'] : [];
-            return \Response::json(call_user_func_array("\Core::{$this->model}", [])->all($relations), 200);
-        }
-    }
-
-    /**
-     * Fetch the single object with relations from model repository.
-     * 
-     * @param  integer $id
-     * @return \Illuminate\Http\Response
-     */
-    public function find($id) 
-    {
-        if ($this->model) 
-        {
-            $relations = $this->relations && $this->relations['find'] ? $this->relations['find'] : [];
-            return \Response::json(call_user_func_array("\Core::{$this->model}", [])->find($id, $relations), 200);
-        }
-    }
-
-    /**
-     * Paginate all records with relations from model repository
-     * that matche the given query.
-     * 
-     * @param  string  $query
-     * @param  integer $perPage
-     * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
-     */
-    public function search($query = '', $perPage = 15, $sortBy = 'created_at', $desc = 1) 
-    {
-        if ($this->model) 
-        {
-            $relations = $this->relations && $this->relations['search'] ? $this->relations['search'] : [];
-            return \Response::json(call_user_func_array("\Core::{$this->model}", [])->search($query, $perPage, $relations, $sortBy, $desc), 200);
-        }
-    }
-
-    /**
-     * Fetch records from the storage based on the given
-     * condition.
-     * 
-     * @param  \Illuminate\Http\Request  $request
-     * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
-     */
-    public function findby(Request $request, $sortBy = 'created_at', $desc = 1) 
-    {
-        if ($this->model) 
-        {
-            $relations = $this->relations && $this->relations['findBy'] ? $this->relations['findBy'] : [];
-            return \Response::json(call_user_func_array("\Core::{$this->model}", [])->findBy($request->all(), $relations, $sortBy, $desc), 200);
-        }
-    }
-
-    /**
-     * Fetch the first record from the storage based on the given
-     * condition.
-     * 
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function first(Request $request) 
-    {
-        if ($this->model) 
-        {
-            $relations = $this->relations && $this->relations['first'] ? $this->relations['first'] : [];
-            return \Response::json(call_user_func_array("\Core::{$this->model}", [])->first($request->all(), $relations), 200);
-        }
-    }
-
-    /**
-     * Paginate all records with relations from model repository.
-     * 
-     * @param  integer $perPage
-     * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
-     */
-    public function paginate($perPage = 15, $sortBy = 'created_at', $desc = 1) 
-    {
-        if ($this->model) 
-        {
-            $relations = $this->relations && $this->relations['paginate'] ? $this->relations['paginate'] : [];
-            return \Response::json(call_user_func_array("\Core::{$this->model}", [])->paginate($perPage, $relations, $sortBy, $desc), 200);
-        }
-    }
-
-    /**
-     * Fetch all records with relations based on
-     * the given condition from storage in pages.
-     * 
-     * @param  \Illuminate\Http\Request  $request
-     * @param  integer $perPage
-     * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
-     */
-    public function paginateby(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
-    {
-        if ($this->model) 
-        {
-            $relations = $this->relations && $this->relations['paginateBy'] ? $this->relations['paginateBy'] : [];
-            return \Response::json(call_user_func_array("\Core::{$this->model}", [])->paginateBy($request->all(), $perPage, $relations, $sortBy, $desc), 200);
-        }
-    }
-
-    /**
-     * Save the given model to repository.
-     * 
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function save(Request $request) 
-    {
-        foreach ($this->validationRules as &$rule) 
-        {
-            if (strpos($rule, 'exists') && ! strpos($rule, 'deleted_at,NULL')) 
-            {
-                $rule .= ',deleted_at,NULL';
-            }
-
-            if ($request->has('id')) 
-            {
-                $rule = str_replace('{id}', $request->get('id'), $rule);
-            }
-            else
-            {
-                $rule = str_replace(',{id}', '', $rule);
-            }
-        }
+		$this->config              = \CoreConfig::getConfig();
+		$this->model               = property_exists($this, 'model') ? $this->model : false;
+		$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 : [];
+		$this->relations           = array_key_exists($this->model, $this->config['relations']) ? $this->config['relations'][$this->model] : false;
+		$route                     = explode('@',\Route::currentRouteAction())[1];
+		$this->checkPermission($route);
+	}
+
+	/**
+	 * Fetch all records with relations from model repository.
+	 * 
+	 * @return \Illuminate\Http\Response
+	 */
+	public function index() 
+	{
+		if ($this->model)
+		{
+			$relations = $this->relations && $this->relations['all'] ? $this->relations['all'] : [];
+			return \Response::json(call_user_func_array("\Core::{$this->model}", [])->all($relations), 200);
+		}
+	}
+
+	/**
+	 * Fetch the single object with relations from model repository.
+	 * 
+	 * @param  integer $id
+	 * @return \Illuminate\Http\Response
+	 */
+	public function find($id) 
+	{
+		if ($this->model) 
+		{
+			$relations = $this->relations && $this->relations['find'] ? $this->relations['find'] : [];
+			return \Response::json(call_user_func_array("\Core::{$this->model}", [])->find($id, $relations), 200);
+		}
+	}
+
+	/**
+	 * Paginate all records with relations from model repository
+	 * that matche the given query.
+	 * 
+	 * @param  string  $query
+	 * @param  integer $perPage
+	 * @param  string  $sortBy
+	 * @param  boolean $desc
+	 * @return \Illuminate\Http\Response
+	 */
+	public function search($query = '', $perPage = 15, $sortBy = 'created_at', $desc = 1) 
+	{
+		if ($this->model) 
+		{
+			$relations = $this->relations && $this->relations['search'] ? $this->relations['search'] : [];
+			return \Response::json(call_user_func_array("\Core::{$this->model}", [])->search($query, $perPage, $relations, $sortBy, $desc), 200);
+		}
+	}
+
+	/**
+	 * Fetch records from the storage based on the given
+	 * condition.
+	 * 
+	 * @param  \Illuminate\Http\Request  $request
+	 * @param  string  $sortBy
+	 * @param  boolean $desc
+	 * @return \Illuminate\Http\Response
+	 */
+	public function findby(Request $request, $sortBy = 'created_at', $desc = 1) 
+	{
+		if ($this->model) 
+		{
+			$relations = $this->relations && $this->relations['findBy'] ? $this->relations['findBy'] : [];
+			return \Response::json(call_user_func_array("\Core::{$this->model}", [])->findBy($request->all(), $relations, $sortBy, $desc), 200);
+		}
+	}
+
+	/**
+	 * Fetch the first record from the storage based on the given
+	 * condition.
+	 * 
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function first(Request $request) 
+	{
+		if ($this->model) 
+		{
+			$relations = $this->relations && $this->relations['first'] ? $this->relations['first'] : [];
+			return \Response::json(call_user_func_array("\Core::{$this->model}", [])->first($request->all(), $relations), 200);
+		}
+	}
+
+	/**
+	 * Paginate all records with relations from model repository.
+	 * 
+	 * @param  integer $perPage
+	 * @param  string  $sortBy
+	 * @param  boolean $desc
+	 * @return \Illuminate\Http\Response
+	 */
+	public function paginate($perPage = 15, $sortBy = 'created_at', $desc = 1) 
+	{
+		if ($this->model) 
+		{
+			$relations = $this->relations && $this->relations['paginate'] ? $this->relations['paginate'] : [];
+			return \Response::json(call_user_func_array("\Core::{$this->model}", [])->paginate($perPage, $relations, $sortBy, $desc), 200);
+		}
+	}
+
+	/**
+	 * Fetch all records with relations based on
+	 * the given condition from storage in pages.
+	 * 
+	 * @param  \Illuminate\Http\Request  $request
+	 * @param  integer $perPage
+	 * @param  string  $sortBy
+	 * @param  boolean $desc
+	 * @return \Illuminate\Http\Response
+	 */
+	public function paginateby(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
+	{
+		if ($this->model) 
+		{
+			$relations = $this->relations && $this->relations['paginateBy'] ? $this->relations['paginateBy'] : [];
+			return \Response::json(call_user_func_array("\Core::{$this->model}", [])->paginateBy($request->all(), $perPage, $relations, $sortBy, $desc), 200);
+		}
+	}
+
+	/**
+	 * Save the given model to repository.
+	 * 
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function save(Request $request) 
+	{
+		foreach ($this->validationRules as &$rule) 
+		{
+			if (strpos($rule, 'exists') && ! strpos($rule, 'deleted_at,NULL')) 
+			{
+				$rule .= ',deleted_at,NULL';
+			}
+
+			if ($request->has('id')) 
+			{
+				$rule = str_replace('{id}', $request->get('id'), $rule);
+			}
+			else
+			{
+				$rule = str_replace(',{id}', '', $rule);
+			}
+		}
         
-        $this->validate($request, $this->validationRules);
-
-        if ($this->model) 
-        {
-            return \Response::json(call_user_func_array("\Core::{$this->model}", [])->save($request->all()), 200);
-        }
-    }
-
-    /**
-     * Delete by the given id from model repository.
-     * 
-     * @param  integer  $id
-     * @return \Illuminate\Http\Response
-     */
-    public function delete($id) 
-    {
-        if ($this->model) 
-        {
-            return \Response::json(call_user_func_array("\Core::{$this->model}", [])->delete($id), 200);
-        }
-    }
-
-    /**
-     * Check if the logged in user can do the given permission.
-     * 
-     * @param  string $permission
-     * @return void
-     */
-    private function checkPermission($permission)
-    {
-        $permission = $permission !== 'index' ? $permission : 'list';
-        if ( ! in_array($permission, $this->skipLoginCheck)) 
-        {
-            \JWTAuth::parseToken()->authenticate();
-            if ( ! in_array($permission, $this->skipPermissionCheck) && ! \Core::users()->can($permission, $this->model))
-            {
-                \ErrorHandler::noPermissions();
-            }
-        }
-    }
+		$this->validate($request, $this->validationRules);
+
+		if ($this->model) 
+		{
+			return \Response::json(call_user_func_array("\Core::{$this->model}", [])->save($request->all()), 200);
+		}
+	}
+
+	/**
+	 * Delete by the given id from model repository.
+	 * 
+	 * @param  integer  $id
+	 * @return \Illuminate\Http\Response
+	 */
+	public function delete($id) 
+	{
+		if ($this->model) 
+		{
+			return \Response::json(call_user_func_array("\Core::{$this->model}", [])->delete($id), 200);
+		}
+	}
+
+	/**
+	 * Check if the logged in user can do the given permission.
+	 * 
+	 * @param  string $permission
+	 * @return void
+	 */
+	private function checkPermission($permission)
+	{
+		$permission = $permission !== 'index' ? $permission : 'list';
+		if ( ! in_array($permission, $this->skipLoginCheck)) 
+		{
+			\JWTAuth::parseToken()->authenticate();
+			if ( ! in_array($permission, $this->skipPermissionCheck) && ! \Core::users()->can($permission, $this->model))
+			{
+				\ErrorHandler::noPermissions();
+			}
+		}
+	}
 }

src/Modules/V1/Core/Settings.php

Indentation +24 added lines, -24 removed lines

@@ -5,32 +5,32 @@
 
 class Settings extends Model{
 
-    use SoftDeletes;
-    protected $table    = 'settings';
-    protected $dates    = ['created_at', 'updated_at', 'deleted_at'];
-    protected $hidden   = ['deleted_at'];
-    protected $guarded  = ['id', 'key'];
-    protected $fillable = ['name','value'];
-    public $searchable  = ['name', 'value', 'key'];
+	use SoftDeletes;
+	protected $table    = 'settings';
+	protected $dates    = ['created_at', 'updated_at', 'deleted_at'];
+	protected $hidden   = ['deleted_at'];
+	protected $guarded  = ['id', 'key'];
+	protected $fillable = ['name','value'];
+	public $searchable  = ['name', 'value', 'key'];
     
-    public function getCreatedAtAttribute($value)
-    {
-        return \Carbon\Carbon::parse($value)->addHours(\Session::get('timeZoneDiff'))->toDateTimeString();
-    }
+	public function getCreatedAtAttribute($value)
+	{
+		return \Carbon\Carbon::parse($value)->addHours(\Session::get('timeZoneDiff'))->toDateTimeString();
+	}
 
-    public function getUpdatedAtAttribute($value)
-    {
-        return \Carbon\Carbon::parse($value)->addHours(\Session::get('timeZoneDiff'))->toDateTimeString();
-    }
+	public function getUpdatedAtAttribute($value)
+	{
+		return \Carbon\Carbon::parse($value)->addHours(\Session::get('timeZoneDiff'))->toDateTimeString();
+	}
 
-    public function getDeletedAtAttribute($value)
-    {
-        return \Carbon\Carbon::parse($value)->addHours(\Session::get('timeZoneDiff'))->toDateTimeString();
-    }
+	public function getDeletedAtAttribute($value)
+	{
+		return \Carbon\Carbon::parse($value)->addHours(\Session::get('timeZoneDiff'))->toDateTimeString();
+	}
 
-    public static function boot()
-    {
-        parent::boot();
-        parent::observe(\App::make('App\Modules\V1\Core\ModelObservers\SettingsObserver'));
-    }
+	public static function boot()
+	{
+		parent::boot();
+		parent::observe(\App::make('App\Modules\V1\Core\ModelObservers\SettingsObserver'));
+	}
 }