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

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

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

Braces +7 added lines, -14 removed lines

@@ -213,8 +213,7 @@ 
                                     }
                                 }
                                 $relations[$relation][] = $relationModel;
-                            }
-                            else
+                            } else
                             {
                                 if (gettype($val) !== 'object' && gettype($val) !== 'array') 
                                 {
@@ -234,8 +233,7 @@ 
                             }
                         }
                     }
-                }
-                else if (array_search($key, $model->getFillable(), true) !== false)
+                } else if (array_search($key, $model->getFillable(), true) !== false)
                 {
                     $model->$key = $value;   
                 }
@@ -247,8 +245,7 @@ 
                 if ($value == 'delete' && $model->$key()->count())
                 {
                     $model->$key()->delete();
-                }
-                else if (gettype($value) == 'array') 
+                } else if (gettype($value) == 'array') 
                 {
                     $ids = [];
                     foreach ($value as $val) 
@@ -279,8 +276,7 @@ 
                             $model->$key()->attach($ids);
                             break;
                     }
-                }
-                else
+                } else
                 {
                     switch (class_basename($model->$key())) 
                     {
@@ -358,8 +354,7 @@ 
                 $model->delete();
                 $saveLog ? $this->logs->saveLog('delete', class_basename($this->model), $this->getModel(), $value, $model) : false;
             });
-    	}
-        else
+    	} else
         {
             \DB::transaction(function () use ($value, $attribute, &$result, $saveLog) {
                 call_user_func_array("{$this->getModel()}::where", array($attribute, '=', $value))->lockForUpdate()->get()->each(function ($model){
@@ -432,13 +427,11 @@ 
             {
                 $conditionString  .= str_replace('{op}', 'and', $this->constructConditions($value)['conditionString']) . ' {op} ';
                 $conditionValues   = array_merge($conditionValues, $this->constructConditions($value)['conditionValues']);
-            }
-            else if ($key == 'or')
+            } else if ($key == 'or')
             {
                 $conditionString  .= str_replace('{op}', 'or', $this->constructConditions($value)['conditionString']) . ' {op} ';
                 $conditionValues   = array_merge($conditionValues, $this->constructConditions($value)['conditionValues']);
-            }
-            else
+            } else
             {
                 $conditionString  .= $key . '=? {op} ';
                 $conditionValues[] = $value;

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

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

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/Reporting/Repositories/ReportRepository.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,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('*'))