SherifElfadaly / Laravel-Api-Skeleton

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

Doc Comments +17 added lines, -17 removed lines

@@ -62,8 +62,8 @@ 
      * Fetch all records with relations from model repository.
      * 
      * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function index($sortBy = 'created_at', $desc = 1) 
     {
@@ -78,7 +78,7 @@ 
      * Fetch the single object with relations from model repository.
      * 
      * @param  integer $id
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function find($id) 
     {
@@ -96,8 +96,8 @@ 
      * @param  string  $query
      * @param  integer $perPage
      * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function search($query = '', $perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -114,8 +114,8 @@ 
      * 
      * @param  \Illuminate\Http\Request  $request
      * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function findby(Request $request, $sortBy = 'created_at', $desc = 1) 
     {
@@ -131,7 +131,7 @@ 
      * condition.
      * 
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function first(Request $request) 
     {
@@ -147,8 +147,8 @@ 
      * 
      * @param  integer $perPage
      * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function paginate($perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -166,8 +166,8 @@ 
      * @param  \Illuminate\Http\Request  $request
      * @param  integer $perPage
      * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function paginateby(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -182,7 +182,7 @@ 
      * Save the given model to repository.
      * 
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function save(Request $request) 
     {
@@ -215,7 +215,7 @@ 
      * Delete by the given id from model repository.
      * 
      * @param  integer  $id
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function delete($id) 
     {
@@ -231,8 +231,8 @@ 
      * @param  \Illuminate\Http\Request  $request
      * @param  integer $perPage
      * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc
+     * @return \Illuminate\Http\JsonResponse
      */
     public function deleted(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -243,7 +243,7 @@ 
      * Restore the deleted model.
      * 
      * @param  integer  $id
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function restore($id) 
     {

Indentation +247 added lines, -247 removed lines

@@ -6,274 +6,274 @@
 
 class BaseApiController extends Controller
 {
-    /**
-     * The model implementation.
-     * 
-     * @var model
-     */
-    protected $model;
+	/**
+	 * The model implementation.
+	 * 
+	 * @var model
+	 */
+	protected $model;
 
-    /**
-     * The config implementation.
-     * 
-     * @var config
-     */
-    protected $config;
+	/**
+	 * The config implementation.
+	 * 
+	 * @var config
+	 */
+	protected $config;
 
-    public function __construct()
-    {
-        \Session::put('timeZoneDiff', \Request::header('time-zone-diff') ?: 0);
+	public function __construct()
+	{
+		\Session::put('timeZoneDiff', \Request::header('time-zone-diff') ?: 0);
 
-        $locale = \Request::header('locale');
-        switch ($locale) 
-        {
-            case 'en':
-            \App::setLocale('en');
-            \Session::put('locale', 'en');
-            break;
+		$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 'ar':
+			\App::setLocale('ar');
+			\Session::put('locale', 'ar');
+			break;
 
-            case 'all':
-            \App::setLocale('en');
-            \Session::put('locale', 'all');
-            break;
+			case 'all':
+			\App::setLocale('en');
+			\Session::put('locale', 'all');
+			break;
 
-            default:
-            \App::setLocale('en');
-            \Session::put('locale', 'en');
-            break;
-        }
+			default:
+			\App::setLocale('en');
+			\Session::put('locale', 'en');
+			break;
+		}
         
-        $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);
-    }
+		$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.
-     * 
-     * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
-     */
-    public function index($sortBy = 'created_at', $desc = 1) 
-    {
-        if ($this->model)
-        {
-            $relations = $this->relations && $this->relations['all'] ? $this->relations['all'] : [];
-            return \Response::json(call_user_func_array("\Core::{$this->model}", [])->all($relations, $sortBy, $desc), 200);
-        }
-    }
+	/**
+	 * Fetch all records with relations from model repository.
+	 * 
+	 * @param  string  $sortBy
+	 * @param  boolean $desc
+	 * @return \Illuminate\Http\Response
+	 */
+	public function index($sortBy = 'created_at', $desc = 1) 
+	{
+		if ($this->model)
+		{
+			$relations = $this->relations && $this->relations['all'] ? $this->relations['all'] : [];
+			return \Response::json(call_user_func_array("\Core::{$this->model}", [])->all($relations, $sortBy, $desc), 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);
-        }
-    }
+	/**
+	 * 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);
-        }
-    }
+	/**
+	 * 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 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);
-        }
-    }
+	/**
+	 * 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);
-        }
-    }
+	/**
+	 * 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);
-        }
-    }
+	/**
+	 * 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';
-            }
+	/**
+	 * 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);
-            }
-        }
+			if ($request->has('id')) 
+			{
+				$rule = str_replace('{id}', $request->get('id'), $rule);
+			}
+			else
+			{
+				$rule = str_replace(',{id}', '', $rule);
+			}
+		}
         
-        $this->validate($request, $this->validationRules);
+		$this->validate($request, $this->validationRules);
 
-        if ($this->model) 
-        {
-            return \Response::json(call_user_func_array("\Core::{$this->model}", [])->save($request->all()), 200);
-        }
-    }
+		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);
-        }
-    }
+	/**
+	 * 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);
+		}
+	}
 
-    /**
-     * Return the deleted models in pages based on the given conditions.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  integer $perPage
-     * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
-     */
-    public function deleted(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
-    {
-        return \Response::json(call_user_func_array("\Core::{$this->model}", [])->deleted($request->all(), $perPage, $sortBy, $desc), 200);
-    }
+	/**
+	 * Return the deleted models in pages based on the given conditions.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @param  integer $perPage
+	 * @param  string  $sortBy
+	 * @param  boolean $desc
+	 * @return \Illuminate\Http\Response
+	 */
+	public function deleted(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
+	{
+		return \Response::json(call_user_func_array("\Core::{$this->model}", [])->deleted($request->all(), $perPage, $sortBy, $desc), 200);
+	}
 
-    /**
-     * Restore the deleted model.
-     * 
-     * @param  integer  $id
-     * @return \Illuminate\Http\Response
-     */
-    public function restore($id) 
-    {
-        if ($this->model) 
-        {
-            return \Response::json(call_user_func_array("\Core::{$this->model}", [])->restore($id), 200);
-        }
-    }
+	/**
+	 * Restore the deleted model.
+	 * 
+	 * @param  integer  $id
+	 * @return \Illuminate\Http\Response
+	 */
+	public function restore($id) 
+	{
+		if ($this->model) 
+		{
+			return \Response::json(call_user_func_array("\Core::{$this->model}", [])->restore($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)) 
-        {
-            $user = \Core::users()->find(\JWTAuth::parseToken()->authenticate()->id);
-            if ($user->blocked)
-            {
-                \ErrorHandler::userIsBlocked();
-            }
+	/**
+	 * 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)) 
+		{
+			$user = \Core::users()->find(\JWTAuth::parseToken()->authenticate()->id);
+			if ($user->blocked)
+			{
+				\ErrorHandler::userIsBlocked();
+			}
             
-            if ( ! in_array($permission, $this->skipPermissionCheck) && ! \Core::users()->can($permission, $this->model))
-            {
-                \ErrorHandler::noPermissions();
-            }
-        }
-    }
+			if ( ! in_array($permission, $this->skipPermissionCheck) && ! \Core::users()->can($permission, $this->model))
+			{
+				\ErrorHandler::noPermissions();
+			}
+		}
+	}
 }

src/Modules/V1/Core/Database/Migrations/2016_01_24_123630_settings.php

Indentation +7 added lines, -7 removed lines

@@ -13,13 +13,13 @@
 	public function up()
 	{
 		Schema::create('settings', function (Blueprint $table) {
-            $table->increments('id');
-            $table->string('name',100);
-            $table->string('key',100)->unique();
-            $table->text('value')->nullable();
-            $table->softDeletes();
-            $table->timestamps();
-        });
+			$table->increments('id');
+			$table->string('name',100);
+			$table->string('key',100)->unique();
+			$table->text('value')->nullable();
+			$table->softDeletes();
+			$table->timestamps();
+		});
 	}
 
 	/**

Spacing +3 added lines, -3 removed lines

@@ -12,10 +12,10 @@
 	 */
 	public function up()
 	{
-		Schema::create('settings', function (Blueprint $table) {
+		Schema::create('settings', function(Blueprint $table) {
             $table->increments('id');
-            $table->string('name',100);
-            $table->string('key',100)->unique();
+            $table->string('name', 100);
+            $table->string('key', 100)->unique();
             $table->text('value')->nullable();
             $table->softDeletes();
             $table->timestamps();

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

Indentation +15 added lines, -15 removed lines

@@ -8,20 +8,20 @@
 
 class SettingsController extends BaseApiController
 {
-    /**
-     * The name of the model that is used by the base api controller 
-     * to preform actions like (add, edit ... etc).
-     * @var string
-     */
-    protected $model               = 'settings';
+	/**
+	 * The name of the model that is used by the base api controller 
+	 * to preform actions like (add, edit ... etc).
+	 * @var string
+	 */
+	protected $model               = 'settings';
 
-    /**
-     * The validations rules used by the base api controller
-     * to check before add.
-     * @var array
-     */
-    protected $validationRules  = [
-    'name'  => 'required|string|max:100',
-    'value' => 'required|string'
-    ];
+	/**
+	 * The validations rules used by the base api controller
+	 * to check before add.
+	 * @var array
+	 */
+	protected $validationRules  = [
+	'name'  => 'required|string|max:100',
+	'value' => 'required|string'
+	];
 }

Spacing +2 added lines, -2 removed lines

@@ -13,14 +13,14 @@
      * to preform actions like (add, edit ... etc).
      * @var string
      */
-    protected $model               = 'settings';
+    protected $model = 'settings';
 
     /**
      * The validations rules used by the base api controller
      * to check before add.
      * @var array
      */
-    protected $validationRules  = [
+    protected $validationRules = [
     'name'  => 'required|string|max:100',
     'value' => 'required|string'
     ];