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)
     {

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'
     ];

src/Modules/Core/AbstractRepositories/AbstractRepository.php

Doc Comments +8 added lines, -8 removed lines

@@ -51,7 +51,7 @@ 
      *
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -69,7 +69,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -116,7 +116,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -134,7 +134,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -391,7 +391,7 @@ 
      * @param  array   $conditions array of conditions
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -408,7 +408,7 @@ 
      *
      * @param  array   $conditions array of conditions
      * @param  array   $relations
-     * @param  array   $colunmns
+     * @param  array   $columns
      * @return object
      */
     public function first($conditions, $relations = [], $columns = array('*'))
@@ -452,9 +452,9 @@ 
      * Abstract method that is called in after
      * the save method finish.
      * 
-     * @param  object  $model
+     * @param  boolean  $model
      * @param  array   $relations
-     * @return void
+     * @return boolean
      */
     protected function afterSave($model, $relations)
     {

Spacing +22 added lines, -22 removed lines

@@ -53,26 +53,26 @@ 
         $conditionColumns = $this->model->getFillable();
         $sort             = $desc ? 'desc' : 'asc';
 
-        $model->where(function ($q) use ($query, $conditionColumns, $relations){
-            $q->where(\DB::raw('LOWER(CAST(' . array_shift($conditionColumns) . ' AS TEXT))'), 'LIKE', '%' . strtolower($query) . '%');
+        $model->where(function($q) use ($query, $conditionColumns, $relations){
+            $q->where(\DB::raw('LOWER(CAST('.array_shift($conditionColumns).' AS TEXT))'), 'LIKE', '%'.strtolower($query).'%');
             foreach ($conditionColumns as $column) 
             {
-                $q->orWhere(\DB::raw('LOWER(CAST(' . $column . ' AS TEXT))'), 'LIKE', '%' . strtolower($query) . '%');
+                $q->orWhere(\DB::raw('LOWER(CAST('.$column.' AS TEXT))'), 'LIKE', '%'.strtolower($query).'%');
             }
             foreach ($relations as $relation) 
             {
                 $relation = explode('.', $relation)[0];
                 if (\Core::$relation()) 
                 {
-                    $q->orWhereHas($relation, function ($subModel) use ($query, $relation){
+                    $q->orWhereHas($relation, function($subModel) use ($query, $relation){
 
-                        $subModel->where(function ($q) use ($query, $relation){
+                        $subModel->where(function($q) use ($query, $relation){
 
                             $subConditionColumns = \Core::$relation()->model->getFillable();
-                            $q->where(\DB::raw('LOWER(CAST(' . array_shift($subConditionColumns) . ' AS TEXT))'), 'LIKE', '%' . strtolower($query) . '%');
+                            $q->where(\DB::raw('LOWER(CAST('.array_shift($subConditionColumns).' AS TEXT))'), 'LIKE', '%'.strtolower($query).'%');
                             foreach ($subConditionColumns as $column)
                             {
-                                $q->orWhere(\DB::raw('LOWER(CAST(' . $column . ' AS TEXT))'), 'LIKE', '%' . strtolower($query) . '%');
+                                $q->orWhere(\DB::raw('LOWER(CAST('.$column.' AS TEXT))'), 'LIKE', '%'.strtolower($query).'%');
                             } 
                         });
 
@@ -134,7 +134,7 @@ 
         $relations  = [];
         $with       = [];
 
-        \DB::transaction(function () use (&$model, &$relations, &$with, $data, $saveLog, $modelClass) {
+        \DB::transaction(function() use (&$model, &$relations, &$with, $data, $saveLog, $modelClass) {
             /**
              * If the id is present in the data then select the model for updating,
              * else create new model.
@@ -143,7 +143,7 @@ 
             $model = array_key_exists('id', $data) ? $modelClass->lockForUpdate()->find($data['id']) : new $modelClass;
             if ( ! $model) 
             {
-                $error = \ErrorHandler::notFound(class_basename($modelClass) . ' with id : ' . $data['id']);
+                $error = \ErrorHandler::notFound(class_basename($modelClass).' with id : '.$data['id']);
                 abort($error['status'], $error['message']);
             }
 
@@ -175,13 +175,13 @@ 
                                 $relationModel = array_key_exists('id', $val) ? $relationBaseModel->lockForUpdate()->find($val['id']) : new $relationBaseModel;
                                 if ( ! $relationModel) 
                                 {
-                                    $error = \ErrorHandler::notFound(class_basename($relationBaseModel) . ' with id : ' . $val['id']);
+                                    $error = \ErrorHandler::notFound(class_basename($relationBaseModel).' with id : '.$val['id']);
                                     abort($error['status'], $error['message']);
                                 }
 
                                 foreach ($val as $attr => $val) 
                                 {
-                                    if (gettype($val) !== 'object' && gettype($val) !== 'array' &&  array_search($attr, $relationModel->getFillable(), true) !== false)
+                                    if (gettype($val) !== 'object' && gettype($val) !== 'array' && array_search($attr, $relationModel->getFillable(), true) !== false)
                                     {
                                         $relationModel->$attr = $val;
                                     }
@@ -195,7 +195,7 @@ 
                                     $relationModel = array_key_exists('id', $value) ? $relationBaseModel->lockForUpdate()->find($value['id']) : new $relationBaseModel;
                                     if ( ! $relationModel) 
                                     {
-                                        $error = \ErrorHandler::notFound(class_basename($relationBaseModel) . ' with id : ' . $value['id']);
+                                        $error = \ErrorHandler::notFound(class_basename($relationBaseModel).' with id : '.$value['id']);
                                         abort($error['status'], $error['message']);
                                     }
 
@@ -283,7 +283,7 @@ 
     public function saveMany(array $data)
     {
         $result = [];
-        \DB::transaction(function () use (&$result, $data) {
+        \DB::transaction(function() use (&$result, $data) {
             foreach ($data as $key => $value) 
             {
                 $result[] = $this->save($value);
@@ -309,7 +309,7 @@ 
             $model ? $model->update($data) : 0;
             $saveLog ? \Logging::saveLog('update', class_basename($this->model), $this->getModel(), $value, $model) : false;
         }
-    	call_user_func_array("{$this->getModel()}::where", array($attribute, '=', $value))->lockForUpdate()->get()->each(function ($model) use ($data, $saveLog){
+    	call_user_func_array("{$this->getModel()}::where", array($attribute, '=', $value))->lockForUpdate()->get()->each(function($model) use ($data, $saveLog){
             $model->update($data);
             $saveLog ? \Logging::saveLog('update', class_basename($this->model), $this->getModel(), $model->id, $model) : false;
         });
@@ -327,7 +327,7 @@ 
     {
     	if ($attribute == 'id') 
     	{
-            \DB::transaction(function () use ($value, $attribute, &$result, $saveLog) {
+            \DB::transaction(function() use ($value, $attribute, &$result, $saveLog) {
                 $model = $this->model->lockForUpdate()->find($value);
                 $model->delete();
                 $saveLog ? \Logging::saveLog('delete', class_basename($this->model), $this->getModel(), $value, $model) : false;
@@ -335,8 +335,8 @@ 
     	}
         else
         {
-            \DB::transaction(function () use ($value, $attribute, &$result, $saveLog) {
-                call_user_func_array("{$this->getModel()}::where", array($attribute, '=', $value))->lockForUpdate()->get()->each(function ($model){
+            \DB::transaction(function() use ($value, $attribute, &$result, $saveLog) {
+                call_user_func_array("{$this->getModel()}::where", array($attribute, '=', $value))->lockForUpdate()->get()->each(function($model) {
                     $model->delete();
                     $saveLog ? \Logging::saveLog('delete', class_basename($this->model), $this->getModel(), $model->id, $model) : false;
                 });
@@ -373,7 +373,7 @@ 
     {
         $conditions = $this->constructConditions($conditions);
         $sort       = $desc ? 'desc' : 'asc';
-        return call_user_func_array("{$this->getModel()}::with",  array($relations))->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->orderBy($sortBy, $sort)->get($columns);
+        return call_user_func_array("{$this->getModel()}::with", array($relations))->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->orderBy($sortBy, $sort)->get($columns);
     }
 
     /**
@@ -404,21 +404,21 @@ 
         {
             if ($key == 'and') 
             {
-                $conditionString  .= str_replace('{op}', 'and', $this->constructConditions($value)['conditionString']) . ' {op} ';
+                $conditionString  .= str_replace('{op}', 'and', $this->constructConditions($value)['conditionString']).' {op} ';
                 $conditionValues   = array_merge($conditionValues, $this->constructConditions($value)['conditionValues']);
             }
             else if ($key == 'or')
             {
-                $conditionString  .= str_replace('{op}', 'or', $this->constructConditions($value)['conditionString']) . ' {op} ';
+                $conditionString  .= str_replace('{op}', 'or', $this->constructConditions($value)['conditionString']).' {op} ';
                 $conditionValues   = array_merge($conditionValues, $this->constructConditions($value)['conditionValues']);
             }
             else
             {
-                $conditionString  .= $key . '=? {op} ';
+                $conditionString  .= $key.'=? {op} ';
                 $conditionValues[] = $value;
             }
         }
-        $conditionString = '(' . rtrim($conditionString, '{op} ') . ')';
+        $conditionString = '('.rtrim($conditionString, '{op} ').')';
         return ['conditionString' => $conditionString, 'conditionValues' => $conditionValues];
     }
 

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]);
     }
 

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

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()

src/Modules/Acl/Repositories/UserRepository.php

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

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

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/Database/Migrations/2015_12_20_124153_users.php

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);