SherifElfadaly / Laravel-Api-Skeleton

src/Modules/Acl/Http/Controllers/UsersController.php

Doc Comments +5 added lines, -5 removed lines

@@ -41,7 +41,7 @@ 
     /**
      * Return the logged in user account.
      * 
-     * @return object
+     * @return \Illuminate\Http\JsonResponse
      */
     public function getAccount()
     {
@@ -52,7 +52,7 @@ 
     /**
      * Logout the user.
      * 
-     * @return void
+     * @return \Illuminate\Http\JsonResponse
      */
     public function getLogout()
     {
@@ -63,7 +63,7 @@ 
      * Handle a registration request.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function postRegister(Request $request)
     {
@@ -76,7 +76,7 @@ 
      * Handle a login request to the application.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function postLogin(Request $request)
     {
@@ -96,7 +96,7 @@ 
      * Handle an assign groups to user request.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function postAssigngroups(Request $request)
     {

Unused Use Statements -1 removed lines

@@ -1,7 +1,6 @@
 <?php
 namespace App\Modules\Acl\Http\Controllers;
 
-use Illuminate\Foundation\Http\FormRequest;
 use App\Modules\Core\Http\Controllers\BaseApiController;
 use Illuminate\Http\Request;
 

Braces +1 added lines, -2 removed lines

@@ -84,8 +84,7 @@
         {
             $relations = $this->relations && $this->relations['find'] ? $this->relations['find'] : [];
             return \Response::json(call_user_func_array("\Core::{$this->model}", [])->find(\Auth::id(), $relations), 200);
-        }
-        else
+        } else
         {
             $error = $this->errorHandler->loginFailed();
             abort($error['status'], $error['message']);

Spacing +2 added lines, -2 removed lines

@@ -12,7 +12,7 @@ 
      * to preform actions like (add, edit ... etc).
      * @var string
      */
-    protected $model               = 'users';
+    protected $model = 'users';
 
     /**
      * List of all route actions that the base api controller
@@ -33,7 +33,7 @@ 
      * to check before add.
      * @var array
      */
-    protected $validationRules  = [
+    protected $validationRules = [
     'email'    => 'required|email|unique:users,email,{id}',
     'password' => 'min:6'
     ];

Indentation +93 added lines, -93 removed lines

@@ -7,108 +7,108 @@
 
 class UsersController 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               = 'users';
+	/**
+	 * The name of the model that is used by the base api controller 
+	 * to preform actions like (add, edit ... etc).
+	 * @var string
+	 */
+	protected $model               = 'users';
 
-    /**
-     * List of all route actions that the base api controller
-     * will skip permissions check for them.
-     * @var array
-     */
-    protected $skipPermissionCheck = ['account', 'logout'];
+	/**
+	 * List of all route actions that the base api controller
+	 * will skip permissions check for them.
+	 * @var array
+	 */
+	protected $skipPermissionCheck = ['account', 'logout'];
 
-    /**
-     * List of all route actions that the base api controller
-     * will skip login check for them.
-     * @var array
-     */
-    protected $skipLoginCheck = ['login', 'register'];
+	/**
+	 * List of all route actions that the base api controller
+	 * will skip login check for them.
+	 * @var array
+	 */
+	protected $skipLoginCheck = ['login', 'register'];
 
-    /**
-     * The validations rules used by the base api controller
-     * to check before add.
-     * @var array
-     */
-    protected $validationRules  = [
-    'email'    => 'required|email|unique:users,email,{id}',
-    'password' => 'min:6'
-    ];
+	/**
+	 * The validations rules used by the base api controller
+	 * to check before add.
+	 * @var array
+	 */
+	protected $validationRules  = [
+	'email'    => 'required|email|unique:users,email,{id}',
+	'password' => 'min:6'
+	];
 
-    /**
-     * Return the logged in user account.
-     * 
-     * @return object
-     */
-    public function getAccount()
-    {
-       $relations = $this->relations && $this->relations['find'] ? $this->relations['find'] : [];
-       return \Response::json(call_user_func_array("\Core::{$this->model}", [])->find(\JWTAuth::parseToken()->authenticate()->id, $relations), 200);
-    }
+	/**
+	 * Return the logged in user account.
+	 * 
+	 * @return object
+	 */
+	public function getAccount()
+	{
+	   $relations = $this->relations && $this->relations['find'] ? $this->relations['find'] : [];
+	   return \Response::json(call_user_func_array("\Core::{$this->model}", [])->find(\JWTAuth::parseToken()->authenticate()->id, $relations), 200);
+	}
 
-    /**
-     * Logout the user.
-     * 
-     * @return void
-     */
-    public function getLogout()
-    {
-        return \Response::json(\JWTAuth::invalidate(\JWTAuth::getToken()), 200);
-    }
+	/**
+	 * Logout the user.
+	 * 
+	 * @return void
+	 */
+	public function getLogout()
+	{
+		return \Response::json(\JWTAuth::invalidate(\JWTAuth::getToken()), 200);
+	}
 
-    /**
-     * Handle a registration request.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function postRegister(Request $request)
-    {
-        $this->validate($request, ['email' => 'required|email|unique:users,email,{id}', 'password' => 'required|min:6']);
+	/**
+	 * Handle a registration request.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function postRegister(Request $request)
+	{
+		$this->validate($request, ['email' => 'required|email|unique:users,email,{id}', 'password' => 'required|min:6']);
 
-        $credentials = $request->only('email', 'password');
-        $token       = \JWTAuth::fromUser(\Core::users()->model->create($credentials));
-        return \Response::json($token, 200);
-    }
+		$credentials = $request->only('email', 'password');
+		$token       = \JWTAuth::fromUser(\Core::users()->model->create($credentials));
+		return \Response::json($token, 200);
+	}
 
-    /**
-     * Handle a login request to the application.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function postLogin(Request $request)
-    {
-        $credentials = $request->only('email', 'password');
+	/**
+	 * Handle a login request to the application.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function postLogin(Request $request)
+	{
+		$credentials = $request->only('email', 'password');
 
-        if ($token = \JWTAuth::attempt($credentials))
-        {
-            $relations = $this->relations && $this->relations['find'] ? $this->relations['find'] : [];
-            return \Response::json($token, 200);
-        }
-        else
-        {
-            $error = \ErrorHandler::loginFailed();
-            abort($error['status'], $error['message']);
-        }
-    }
+		if ($token = \JWTAuth::attempt($credentials))
+		{
+			$relations = $this->relations && $this->relations['find'] ? $this->relations['find'] : [];
+			return \Response::json($token, 200);
+		}
+		else
+		{
+			$error = \ErrorHandler::loginFailed();
+			abort($error['status'], $error['message']);
+		}
+	}
 
-    /**
-     * Handle an assign groups to user request.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function postAssigngroups(Request $request)
-    {
-        $this->validate($request, [
-            'group_ids' => 'required|exists:groups,id', 
-            'user_id'   => 'required|exists:users,id'
-            ]);
+	/**
+	 * Handle an assign groups to user request.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function postAssigngroups(Request $request)
+	{
+		$this->validate($request, [
+			'group_ids' => 'required|exists:groups,id', 
+			'user_id'   => 'required|exists:users,id'
+			]);
 
-        return \Response::json(\Core::users()->assignGroups($request->get('user_id'), $request->get('group_ids')), 200);
-    }
+		return \Response::json(\Core::users()->assignGroups($request->get('user_id'), $request->get('group_ids')), 200);
+	}
 }

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

Doc Comments +13 added lines, -15 removed lines

@@ -54,9 +54,7 @@ 
     /**
      * Fetch all records with relations from model repository.
      * 
-     * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function getIndex() 
     {
@@ -71,7 +69,7 @@ 
      * Fetch the single object with relations from model repository.
      * 
      * @param  integer $id
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function getFind($id) 
     {
@@ -89,8 +87,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 getSearch($query = '', $perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -107,8 +105,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 postFindby(Request $request, $sortBy = 'created_at', $desc = 1) 
     {
@@ -124,7 +122,7 @@ 
      * condition.
      * 
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function postFirst(Request $request) 
     {
@@ -140,8 +138,8 @@ 
      * 
      * @param  integer $perPage
      * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function getPaginate($perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -159,8 +157,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 postPaginateby(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -175,7 +173,7 @@ 
      * Save the given model to repository.
      * 
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function postSave(Request $request) 
     {
@@ -208,7 +206,7 @@ 
      * Delete by the given id from model repository.
      * 
      * @param  integer  $id
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function getDelete($id) 
     {

Spacing +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
         $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];
+        $route                     = explode('@', \Route::currentRouteAction())[1];
         $this->checkPermission(explode('_', snake_case($route))[1]);
     }
 

Braces +2 added lines, -4 removed lines

@@ -190,8 +190,7 @@ 
             if ($request->has('id')) 
             {
                 $rule = str_replace('{id}', $request->get('id'), $rule);
-            }
-            else
+            } else
             {
                 $rule = str_replace(',{id}', '', $rule);
             }
@@ -232,8 +231,7 @@ 
         {
             $error = $this->errorHandler->notFound('method');
             abort($error['status'], $error['message']);
-        }
-        else if ( ! in_array($permission, $this->skipLoginCheck)) 
+        } else if ( ! in_array($permission, $this->skipLoginCheck)) 
         {
             \JWTAuth::parseToken()->authenticate();
             if ( ! in_array($permission, $this->skipPermissionCheck) && ! \Core::users()->can($permission, $this->model))

Indentation +217 added lines, -217 removed lines

@@ -6,223 +6,223 @@
 
 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(explode('_', snake_case($route))[1]);
-    }
-
-    /**
-     * Fetch all records with relations from model repository.
-     * 
-     * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
-     */
-    public function getIndex() 
-    {
-        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 getFind($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 getSearch($query = '', $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}", [])->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 postFindby(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 postFirst(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 getPaginate($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 postPaginateby(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 postSave(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(explode('_', snake_case($route))[1]);
+	}
+
+	/**
+	 * Fetch all records with relations from model repository.
+	 * 
+	 * @param  string  $sortBy
+	 * @param  boolean $desc
+	 * @return \Illuminate\Http\Response
+	 */
+	public function getIndex() 
+	{
+		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 getFind($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 getSearch($query = '', $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}", [])->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 postFindby(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 postFirst(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 getPaginate($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 postPaginateby(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 postSave(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 getDelete($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 ($permission == 'method') 
-        {
-            $error = \ErrorHandler::notFound('method');
-            abort($error['status'], $error['message']);
-        }
-        else if ( ! in_array($permission, $this->skipLoginCheck)) 
-        {
-            \JWTAuth::parseToken()->authenticate();
-            if ( ! in_array($permission, $this->skipPermissionCheck) && ! \Core::users()->can($permission, $this->model))
-            {
-                $error = \ErrorHandler::noPermissions();
-                abort($error['status'], $error['message']);
-            }
-        }
-    }
+		$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 getDelete($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 ($permission == 'method') 
+		{
+			$error = \ErrorHandler::notFound('method');
+			abort($error['status'], $error['message']);
+		}
+		else if ( ! in_array($permission, $this->skipLoginCheck)) 
+		{
+			\JWTAuth::parseToken()->authenticate();
+			if ( ! in_array($permission, $this->skipPermissionCheck) && ! \Core::users()->can($permission, $this->model))
+			{
+				$error = \ErrorHandler::noPermissions();
+				abort($error['status'], $error['message']);
+			}
+		}
+	}
 }

src/Modules/Core/Interfaces/RepositoryInterface.php

Doc Comments +5 added lines, -6 removed lines

@@ -7,7 +7,7 @@ 
      * 
      * @param  array  $relations
      * @param  array   $sortBy
-     * @param  array   $desc
+     * @param  integer   $desc
      * @param  array  $columns
      * @return collection
      */
@@ -21,7 +21,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  array   $sortBy
-     * @param  array   $desc
+     * @param  integer   $desc
      * @param  array   $columns
      * @return collection
      */
@@ -33,7 +33,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  array   $sortBy
-     * @param  array   $desc
+     * @param  integer   $desc
      * @param  array   $columns
      * @return collection
      */
@@ -47,7 +47,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  array   $sortBy
-     * @param  array   $desc
+     * @param  integer   $desc
      * @param  array   $columns
      * @return collection
      */
@@ -109,7 +109,7 @@ 
      * @param  array   $conditions array of conditions
      * @param  array   $relations
      * @param  array   $sortBy
-     * @param  array   $desc
+     * @param  integer   $desc
      * @param  array   $columns
      * @return collection
      */
@@ -120,7 +120,6 @@ 
      * condition.
      * 
      * @param  array   $conditions array of conditions
-     * @param  [type]  $value condition value
      * @param  array   $relations
      * @param  array   $columns
      * @return object

Indentation +106 added lines, -106 removed lines

@@ -3,127 +3,127 @@
 interface RepositoryInterface
 {
 	/**
-     * Fetch all records with relations from the storage.
-     * 
-     * @param  array  $relations
-     * @param  array   $sortBy
-     * @param  array   $desc
-     * @param  array  $columns
-     * @return collection
-     */
+	 * Fetch all records with relations from the storage.
+	 * 
+	 * @param  array  $relations
+	 * @param  array   $sortBy
+	 * @param  array   $desc
+	 * @param  array  $columns
+	 * @return collection
+	 */
 	public function all($relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
  	
-    /**
-     * Fetch all records with relations from storage in pages 
-     * that matche the given query.
-     * 
-     * @param  string  $query
-     * @param  integer $perPage
-     * @param  array   $relations
-     * @param  array   $sortBy
-     * @param  array   $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function search($query, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
+	/**
+	 * Fetch all records with relations from storage in pages 
+	 * that matche the given query.
+	 * 
+	 * @param  string  $query
+	 * @param  integer $perPage
+	 * @param  array   $relations
+	 * @param  array   $sortBy
+	 * @param  array   $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function search($query, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
 
 	/**
-     * Fetch all records with relations from storage in pages.
-     * 
-     * @param  integer $perPage
-     * @param  array   $relations
-     * @param  array   $sortBy
-     * @param  array   $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function paginate($perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
+	 * Fetch all records with relations from storage in pages.
+	 * 
+	 * @param  integer $perPage
+	 * @param  array   $relations
+	 * @param  array   $sortBy
+	 * @param  array   $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function paginate($perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
  	
 	/**
-     * Fetch all records with relations based on
-     * the given condition from storage in pages.
-     * 
-     * @param  array   $conditions array of conditions
-     * @param  integer $perPage
-     * @param  array   $relations
-     * @param  array   $sortBy
-     * @param  array   $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function paginateBy($conditions, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
+	 * Fetch all records with relations based on
+	 * the given condition from storage in pages.
+	 * 
+	 * @param  array   $conditions array of conditions
+	 * @param  integer $perPage
+	 * @param  array   $relations
+	 * @param  array   $sortBy
+	 * @param  array   $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function paginateBy($conditions, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
 
-     /**
-     * Save the given model/models to the storage.
-     * 
-     * @param  array   $data
-     * @param  boolean $saveLog
-     * @return object
-     */
-    public function save(array $data, $saveLog = true);
+	 /**
+	  * Save the given model/models to the storage.
+	  * 
+	  * @param  array   $data
+	  * @param  boolean $saveLog
+	  * @return object
+	  */
+	public function save(array $data, $saveLog = true);
  	
-    /**
-     * Insert multiple records to the storage.
-     * 
-     * @param  array   $data
-     * @return array
-     */
-    public function saveMany(array $data);
+	/**
+	 * Insert multiple records to the storage.
+	 * 
+	 * @param  array   $data
+	 * @return array
+	 */
+	public function saveMany(array $data);
 
 	/**
-     * Update record in the storage based on the given
-     * condition.
-     * 
-     * @param  [type] $value condition value
-     * @param  array $data
-     * @param  string $attribute condition column name
-     * @return integer affected rows
-     */
-    public function update($value, array $data, $attribute = 'id');
+	 * Update record in the storage based on the given
+	 * condition.
+	 * 
+	 * @param  [type] $value condition value
+	 * @param  array $data
+	 * @param  string $attribute condition column name
+	 * @return integer affected rows
+	 */
+	public function update($value, array $data, $attribute = 'id');
  	
 	/**
-     * Delete record from the storage based on the given
-     * condition.
-     * 
-     * @param  [type] $value condition value
-     * @param  string $attribute condition column name
-     * @return integer affected rows
-     */
-    public function delete($value, $attribute = 'id');
+	 * Delete record from the storage based on the given
+	 * condition.
+	 * 
+	 * @param  [type] $value condition value
+	 * @param  string $attribute condition column name
+	 * @return integer affected rows
+	 */
+	public function delete($value, $attribute = 'id');
  	
 	/**
-     * Fetch records from the storage based on the given
-     * id.
-     * 
-     * @param  integer $id
-     * @param  array   $relations
-     * @param  array   $columns
-     * @return object
-     */
-    public function find($id, $relations = [], $columns = array('*'));
+	 * Fetch records from the storage based on the given
+	 * id.
+	 * 
+	 * @param  integer $id
+	 * @param  array   $relations
+	 * @param  array   $columns
+	 * @return object
+	 */
+	public function find($id, $relations = [], $columns = array('*'));
  	
 	/**
-     * Fetch records from the storage based on the given
-     * condition.
-     * 
-     * @param  array   $conditions array of conditions
-     * @param  array   $relations
-     * @param  array   $sortBy
-     * @param  array   $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function findBy($conditions, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
+	 * Fetch records from the storage based on the given
+	 * condition.
+	 * 
+	 * @param  array   $conditions array of conditions
+	 * @param  array   $relations
+	 * @param  array   $sortBy
+	 * @param  array   $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function findBy($conditions, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
 
-    /**
-     * Fetch the first record fro the storage based on the given
-     * condition.
-     * 
-     * @param  array   $conditions array of conditions
-     * @param  [type]  $value condition value
-     * @param  array   $relations
-     * @param  array   $columns
-     * @return object
-     */
-    public function first($conditions, $relations = [], $columns = array('*'));
+	/**
+	 * Fetch the first record fro the storage based on the given
+	 * condition.
+	 * 
+	 * @param  array   $conditions array of conditions
+	 * @param  [type]  $value condition value
+	 * @param  array   $relations
+	 * @param  array   $columns
+	 * @return object
+	 */
+	public function first($conditions, $relations = [], $columns = array('*'));
 }
\ No newline at end of file

src/Modules/Acl/AclGroup.php

Spacing +3 added lines, -3 removed lines

@@ -3,7 +3,7 @@ 
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\SoftDeletes;
 
-class AclGroup extends Model{
+class AclGroup extends Model {
 
     use SoftDeletes;
     protected $table    = 'groups';
@@ -29,12 +29,12 @@ 
 
     public function users()
     {
-        return $this->belongsToMany('\App\Modules\Acl\AclUser','users_groups','group_id','user_id')->whereNull('users_groups.deleted_at')->withTimestamps();
+        return $this->belongsToMany('\App\Modules\Acl\AclUser', 'users_groups', 'group_id', 'user_id')->whereNull('users_groups.deleted_at')->withTimestamps();
     }
 
     public function permissions()
     {
-        return $this->belongsToMany('\App\Modules\Acl\AclPermission','groups_permissions','group_id','permission_id')->whereNull('groups_permissions.deleted_at')->withTimestamps();
+        return $this->belongsToMany('\App\Modules\Acl\AclPermission', 'groups_permissions', 'group_id', 'permission_id')->whereNull('groups_permissions.deleted_at')->withTimestamps();
     }
 
     public static function boot()

Indentation +37 added lines, -37 removed lines

@@ -5,41 +5,41 @@
 
 class AclGroup extends Model{
 
-    use SoftDeletes;
-    protected $table    = 'groups';
-    protected $dates    = ['created_at', 'updated_at', 'deleted_at'];
-    protected $hidden   = ['deleted_at'];
-    protected $guarded  = ['id'];
-    protected $fillable = ['name'];
-
-    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 getDeletedAtAttribute($value)
-    {
-        return \Carbon\Carbon::parse($value)->addHours(\Session::get('timeZoneDiff'))->toDateTimeString();
-    }
-
-    public function users()
-    {
-        return $this->belongsToMany('\App\Modules\Acl\AclUser','users_groups','group_id','user_id')->whereNull('users_groups.deleted_at')->withTimestamps();
-    }
-
-    public function permissions()
-    {
-        return $this->belongsToMany('\App\Modules\Acl\AclPermission','groups_permissions','group_id','permission_id')->whereNull('groups_permissions.deleted_at')->withTimestamps();
-    }
-
-    public static function boot()
-    {
-        parent::boot();
-        parent::observe(\App::make('App\Modules\Acl\ModelObservers\AclGroupObserver'));
-    }
+	use SoftDeletes;
+	protected $table    = 'groups';
+	protected $dates    = ['created_at', 'updated_at', 'deleted_at'];
+	protected $hidden   = ['deleted_at'];
+	protected $guarded  = ['id'];
+	protected $fillable = ['name'];
+
+	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 getDeletedAtAttribute($value)
+	{
+		return \Carbon\Carbon::parse($value)->addHours(\Session::get('timeZoneDiff'))->toDateTimeString();
+	}
+
+	public function users()
+	{
+		return $this->belongsToMany('\App\Modules\Acl\AclUser','users_groups','group_id','user_id')->whereNull('users_groups.deleted_at')->withTimestamps();
+	}
+
+	public function permissions()
+	{
+		return $this->belongsToMany('\App\Modules\Acl\AclPermission','groups_permissions','group_id','permission_id')->whereNull('groups_permissions.deleted_at')->withTimestamps();
+	}
+
+	public static function boot()
+	{
+		parent::boot();
+		parent::observe(\App::make('App\Modules\Acl\ModelObservers\AclGroupObserver'));
+	}
 }

src/Modules/Acl/Repositories/UserRepository.php

Indentation +1 added lines, -1 removed lines

@@ -61,6 +61,6 @@
 			$user->groups()->attach($group_ids);
 		});
 
-        return \Core::users()->find($user_id);
+		return \Core::users()->find($user_id);
 	}
 }

Spacing +3 added lines, -3 removed lines

@@ -23,11 +23,11 @@ 
 	 * @param  boolean $user
 	 * @return boolean
 	 */
-	public function can($nameOfPermission, $model, $user = false )
+	public function can($nameOfPermission, $model, $user = false)
 	{		
 		$user        = $user ?: \Auth::user();
 		$permissions = [];
-		\Core::users()->find($user->id, ['groups.permissions'])->groups->lists('permissions')->each(function ($permission) use (&$permissions, $model){
+		\Core::users()->find($user->id, ['groups.permissions'])->groups->lists('permissions')->each(function($permission) use (&$permissions, $model){
 			$permissions = array_merge($permissions, $permission->where('model', $model)->lists('name')->toArray()); 
 		});
 		
@@ -55,7 +55,7 @@ 
 	 */
 	public function assignGroups($user_id, $group_ids)
 	{
-		\DB::transaction(function () use ($user_id, $group_ids) {
+		\DB::transaction(function() use ($user_id, $group_ids) {
 			$user = \Core::users()->find($user_id);
 			$user->groups()->detach();
 			$user->groups()->attach($group_ids);

src/Modules/Acl/Repositories/GroupRepository.php

Indentation +1 added lines, -1 removed lines

@@ -29,6 +29,6 @@
 			$group->permissions()->attach($permission_ids);
 		});
 
-        return \Core::groups()->find($group_id);
+		return \Core::groups()->find($group_id);
 	}
 }

Spacing +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
 	 */
 	public function assignPermissions($group_id, $permission_ids)
 	{
-		\DB::transaction(function () use ($group_id, $permission_ids) {
+		\DB::transaction(function() use ($group_id, $permission_ids) {
 			$group = \Core::groups()->find($group_id);
 			$group->permissions()->detach();
 			$group->permissions()->attach($permission_ids);

src/Modules/Acl/Http/Controllers/GroupsController.php

Indentation +28 added lines, -28 removed lines

@@ -8,35 +8,35 @@
 
 class GroupsController 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               = 'groups';
+	/**
+	 * The name of the model that is used by the base api controller 
+	 * to preform actions like (add, edit ... etc).
+	 * @var string
+	 */
+	protected $model               = 'groups';
 
-    /**
-     * The validations rules used by the base api controller
-     * to check before add.
-     * @var array
-     */
-    protected $validationRules  = [
-    'name' => 'required|string|max:100|unique:groups,name,{id}'
-    ];
+	/**
+	 * The validations rules used by the base api controller
+	 * to check before add.
+	 * @var array
+	 */
+	protected $validationRules  = [
+	'name' => 'required|string|max:100|unique:groups,name,{id}'
+	];
 
-    /**
-     * Handle an assign permissions to group request.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function postAssignpermissions(Request $request)
-    {
-        $this->validate($request, [
-            'permission_ids' => 'required|exists:permissions,id', 
-            'group_id'       => 'required|exists:groups,id'
-            ]);
+	/**
+	 * Handle an assign permissions to group request.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function postAssignpermissions(Request $request)
+	{
+		$this->validate($request, [
+			'permission_ids' => 'required|exists:permissions,id', 
+			'group_id'       => 'required|exists:groups,id'
+			]);
 
-        return \Response::json(\Core::groups()->assignPermissions($request->get('group_id'), $request->get('permission_ids')), 200);
-    }
+		return \Response::json(\Core::groups()->assignPermissions($request->get('group_id'), $request->get('permission_ids')), 200);
+	}
 }

Spacing +2 added lines, -2 removed lines

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

src/Modules/Acl/Http/Controllers/PermissionsController.php

Indentation +6 added lines, -6 removed lines

@@ -7,10 +7,10 @@
 
 class PermissionsController 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 = 'permissions';
+	/**
+	 * The name of the model that is used by the base api controller 
+	 * to preform actions like (add, edit ... etc).
+	 * @var string
+	 */
+	protected $model = 'permissions';
 }

src/Modules/Acl/Database/Migrations/2015_12_20_124153_users.php

Indentation +11 added lines, -11 removed lines

@@ -13,17 +13,17 @@
 	public function up()
 	{
 		Schema::create('users', function (Blueprint $table) {
-            $table->increments('id');
-            $table->string('first_name',100)->nullable();
-            $table->string('last_name',100)->nullable();
-            $table->string('user_name',100)->nullable();
-            $table->text('address')->nullable();
-            $table->string('email')->unique();
-            $table->string('password', 60);
-            $table->softDeletes();
-            $table->rememberToken();
-            $table->timestamps();
-        });
+			$table->increments('id');
+			$table->string('first_name',100)->nullable();
+			$table->string('last_name',100)->nullable();
+			$table->string('user_name',100)->nullable();
+			$table->text('address')->nullable();
+			$table->string('email')->unique();
+			$table->string('password', 60);
+			$table->softDeletes();
+			$table->rememberToken();
+			$table->timestamps();
+		});
 	}
 
 	/**

Spacing +4 added lines, -4 removed lines

@@ -12,11 +12,11 @@
 	 */
 	public function up()
 	{
-		Schema::create('users', function (Blueprint $table) {
+		Schema::create('users', function(Blueprint $table) {
             $table->increments('id');
-            $table->string('first_name',100)->nullable();
-            $table->string('last_name',100)->nullable();
-            $table->string('user_name',100)->nullable();
+            $table->string('first_name', 100)->nullable();
+            $table->string('last_name', 100)->nullable();
+            $table->string('user_name', 100)->nullable();
             $table->text('address')->nullable();
             $table->string('email')->unique();
             $table->string('password', 60);