SherifElfadaly / Laravel-Api-Skeleton

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

Braces +1 added lines, -2 removed lines

@@ -170,8 +170,7 @@
             if ($request->has('id')) 
             {
                 $rule = str_replace('{id}', $request->get('id'), $rule);
-            }
-            else
+            } else
             {
                 $rule = str_replace(',{id}', '', $rule);
             }

Doc Comments +17 added lines, -17 removed lines

@@ -45,8 +45,8 @@ 
      * Fetch all records with relations from storage.
      * 
      * @param  string  $sortBy The name of the column to sort by.
-     * @param  boolean $desc   Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc   Sort ascending or descinding (1: desc, 0: asc).
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function index($sortBy = 'created_at', $desc = 1) 
     {
@@ -60,7 +60,7 @@ 
      * Fetch the single object with relations from storage.
      * 
      * @param  integer $id Id of the requested model.
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function find($id) 
     {
@@ -77,8 +77,8 @@ 
      * @param  string  $query   The search text.
      * @param  integer $perPage Number of rows per page default 15.
      * @param  string  $sortBy  The name of the column to sort by.
-     * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc    Sort ascending or descinding (1: desc, 0: asc).
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function search($query = '', $perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -94,8 +94,8 @@ 
      * 
      * @param  \Illuminate\Http\Request  $request
      * @param  string  $sortBy The name of the column to sort by.
-     * @param  boolean $desc   Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc   Sort ascending or descinding (1: desc, 0: asc).
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function findby(Request $request, $sortBy = 'created_at', $desc = 1) 
     {
@@ -110,7 +110,7 @@ 
      * condition.
      * 
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function first(Request $request) 
     {
@@ -125,8 +125,8 @@ 
      * 
      * @param  integer $perPage Number of rows per page default 15.
      * @param  string  $sortBy  The name of the column to sort by.
-     * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc    Sort ascending or descinding (1: desc, 0: asc).
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function paginate($perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -143,8 +143,8 @@ 
      * @param  \Illuminate\Http\Request  $request
      * @param  integer $perPage Number of rows per page default 15.
      * @param  string  $sortBy  The name of the column to sort by.
-     * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc    Sort ascending or descinding (1: desc, 0: asc).
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function paginateby(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -158,7 +158,7 @@ 
      * Save the given model to storage.
      * 
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function save(Request $request) 
     {
@@ -191,7 +191,7 @@ 
      * Delete by the given id from storage.
      * 
      * @param  integer $id Id of the deleted model.
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function delete($id) 
     {
@@ -207,8 +207,8 @@ 
      * @param  \Illuminate\Http\Request  $request
      * @param  integer $perPage Number of rows per page default 15.
      * @param  string  $sortBy  The name of the column to sort by.
-     * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc    Sort ascending or descinding (1: desc, 0: asc).
+     * @return \Illuminate\Http\JsonResponse
      */
     public function deleted(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -219,7 +219,7 @@ 
      * Restore the deleted model.
      * 
      * @param  integer $id Id of the restored model.
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function restore($id) 
     {

src/Modules/V1/Reporting/Repositories/ReportRepository.php

Braces +2 added lines, -4 removed lines

@@ -38,8 +38,7 @@ 
         if ( ! $report) 
         {
             \ErrorHandler::notFound('report');
-        }
-        else if ( ! \Core::users()->can($report->view_name, 'reports'))
+        } else if ( ! \Core::users()->can($report->view_name, 'reports'))
         {
             \ErrorHandler::noPermissions();
         }
@@ -60,8 +59,7 @@ 
         if ($perPage) 
         {
             return $report->paginate($perPage);
-        }
-        else
+        } else
         {
             return $report->get();  
         }

src/Modules/V1/Acl/Repositories/UserRepository.php

Braces +8 added lines, -16 removed lines

@@ -103,24 +103,19 @@ 
         if ( ! $user = $this->first(['email' => $credentials['email']])) 
         {
             \ErrorHandler::loginFailed();
-        }
-        else if ($adminLogin && $user->groups->pluck('name')->search('Admin', true) === false) 
+        } else if ($adminLogin && $user->groups->pluck('name')->search('Admin', true) === false) 
         {
             \ErrorHandler::loginFailed();
-        }
-        else if ( ! $adminLogin && $user->groups->pluck('name')->search('Admin', true) !== false) 
+        } else if ( ! $adminLogin && $user->groups->pluck('name')->search('Admin', true) !== false) 
         {
             \ErrorHandler::loginFailed();
-        }
-        else if ($user->blocked)
+        } else if ($user->blocked)
         {
             \ErrorHandler::userIsBlocked();
-        }
-        else if ($token = \JWTAuth::attempt($credentials))
+        } else if ($token = \JWTAuth::attempt($credentials))
         {
             return ['token' => $token];
-        }
-        else
+        } else
         {
             \ErrorHandler::loginFailed();
         }
@@ -146,8 +141,7 @@ 
         {
             $data = ['email' => $user->email, 'password' => ''];
             return $this->register($data);
-        }
-        else
+        } else
         {
             if ( ! \Auth::attempt(['email' => $registeredUser->email, 'password' => '']))
             {
@@ -193,12 +187,10 @@ 
         if ( ! $this->hasGroup('Admin'))
         {
             \ErrorHandler::noPermissions();
-        }
-        else if (\JWTAuth::parseToken()->authenticate()->id == $user_id)
+        } else if (\JWTAuth::parseToken()->authenticate()->id == $user_id)
         {
             \ErrorHandler::noPermissions();
-        }
-        else if ($user->groups->pluck('name')->search('Admin', true) !== false) 
+        } else if ($user->groups->pluck('name')->search('Admin', true) !== false) 
         {
             \ErrorHandler::noPermissions();
         }

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

Braces +1 added lines, -2 removed lines

@@ -170,8 +170,7 @@
             if ($request->has('id')) 
             {
                 $rule = str_replace('{id}', $request->get('id'), $rule);
-            }
-            else
+            } else
             {
                 $rule = str_replace(',{id}', '', $rule);
             }

src/Modules/V1/Core/AbstractRepositories/AbstractRepository.php

Doc Comments +8 added lines, -8 removed lines

@@ -32,7 +32,7 @@ 
      *
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -50,7 +50,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -139,7 +139,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -157,7 +157,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -418,7 +418,7 @@ 
      * Update record in the storage based on the given
      * condition.
      * 
-     * @param  var $value condition value
+     * @param  boolean $value condition value
      * @param  array $data
      * @param  string $attribute condition column name
      * @return void
@@ -479,7 +479,7 @@ 
      * id.
      * 
      * @param  integer $id
-     * @param  array   $relations
+     * @param  string[]   $relations
      * @param  array   $columns
      * @return object
      */
@@ -495,7 +495,7 @@ 
      * @param  array   $conditions array of conditions
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -527,7 +527,7 @@ 
      * @param  array   $conditions array of conditions
      * @param  integer $perPage
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */

Braces +11 added lines, -22 removed lines

@@ -432,8 +432,7 @@ 
             $model = $this->model->lockForUpdate()->find($value);
             $model ? $model->update($data) : 0;
             $saveLog ? \Logging::saveLog('update', class_basename($this->model), $this->getModel(), $value, $model) : false;
-        }
-        else
+        } else
         {
             call_user_func_array("{$this->getModel()}::where", array($attribute, '=', $value))->lockForUpdate()->get()->each(function ($model) use ($data, $saveLog){
                 $model->update($data);
@@ -464,8 +463,7 @@ 
                 $model->delete();
                 $saveLog ? \Logging::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) use ($saveLog){
@@ -582,14 +580,12 @@ 
                 $conditions       = $this->constructConditions($value, $model);
                 $conditionString .= str_replace('{op}', 'and', $conditions['conditionString']) . ' {op} ';
                 $conditionValues  = array_merge($conditionValues, $conditions['conditionValues']);
-            }
-            else if ($key == 'or')
+            } else if ($key == 'or')
             {
                 $conditions       = $this->constructConditions($value, $model);
                 $conditionString .= str_replace('{op}', 'or', $conditions['conditionString']) . ' {op} ';
                 $conditionValues  = array_merge($conditionValues, $conditions['conditionValues']);
-            }
-            else
+            } else
             {
                 if (is_array($value)) 
                 {
@@ -598,13 +594,11 @@ 
                     {
                         $value1 = $value['val1'];
                         $value2 = $value['val2'];
-                    }
-                    else
+                    } else
                     {
                         $value = array_key_exists('val', $value) ? $value['val'] : '';
                     }
-                }
-                else
+                } else
                 {
                     $operator = '=';
                 }
@@ -616,29 +610,24 @@ 
 
                     $conditionString  .= $key . ' <= ? {op} ';
                     $conditionValues[] = $value2;
-                }
-                elseif (strtolower($operator) == 'in') 
+                } elseif (strtolower($operator) == 'in') 
                 {
                     $conditionValues  = array_merge($conditionValues, $value);
                     $inBindingsString = rtrim(str_repeat('?,', count($value)), ',');
                     $conditionString .= $key . ' in (' . rtrim($inBindingsString, ',') . ') {op} ';
-                }
-                elseif (strtolower($operator) == 'null') 
+                } elseif (strtolower($operator) == 'null') 
                 {
                     $conditionString .= $key . ' is null {op} ';
-                }
-                elseif (strtolower($operator) == 'not null') 
+                } elseif (strtolower($operator) == 'not null') 
                 {
                     $conditionString .= $key . ' is not null {op} ';
-                }
-                elseif (strtolower($operator) == 'has') 
+                } elseif (strtolower($operator) == 'has') 
                 {
                     $sql              = $model->withTrashed()->has($key)->toSql();
                     $conditions       = $this->constructConditions($value, $model->$key()->getRelated());
                     $conditionString .= rtrim(substr($sql, strpos($sql, 'exists')), ')') . ' and ' . $conditions['conditionString'] . ') {op} ';
                     $conditionValues  = array_merge($conditionValues, $conditions['conditionValues']);
-                }
-                else
+                } else
                 {
                     $conditionString  .= $key . ' ' . $operator . ' ? {op} ';
                     $conditionValues[] = $value;

src/Modules/V1/Core/Console/Commands/GenerateDoc.php

Doc Comments +3 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
      * Generate headers for the given route.
      * 
      * @param  array  &$route
-     * @param  object $reflectionClass
+     * @param  \ReflectionClass $reflectionClass
      * @param  string $method
      * @param  array  $skipLoginCheck
      * @return void
@@ -118,6 +118,7 @@ 
      * 
      * @param  array  &$route
      * @param  object $reflectionMethod]
+     * @param \ReflectionMethod $reflectionMethod
      * @return void
      */
     protected function processDocBlock(&$route, $reflectionMethod)
@@ -140,7 +141,7 @@ 
      * Generate post body for the given route.
      * 
      * @param  array  &$route
-     * @param  object $reflectionMethod
+     * @param  \ReflectionMethod $reflectionMethod
      * @param  array  $validationRules
      * @return void
      */

Braces +3 added lines, -6 removed lines

@@ -156,8 +156,7 @@ 
                 if ($match[1] == '$this->validationRules')
                 {
                     $route['body'] = $validationRules;
-                }
-                else
+                } else
                 {
                     $route['body'] = eval('return ' . $match[1] . ';');
                 }
@@ -167,14 +166,12 @@ 
                     if(strpos($rule, 'unique'))
                     {
                         $rule = substr($rule, 0, strpos($rule, 'unique') + 6);
-                    }
-                    elseif(strpos($rule, 'exists'))
+                    } elseif(strpos($rule, 'exists'))
                     {
                         $rule = substr($rule, 0, strpos($rule, 'exists') - 1);
                     }
                 }
-            }
-            else
+            } else
             {
                 $route['body'] = 'conditions';
             }

src/Modules/V1/Core/Decorators/CachingDecorator.php

Braces +2 added lines, -4 removed lines

@@ -68,8 +68,7 @@ 
             return $this->cache->tags([$this->cacheTag])->rememberForever($cacheKey, function() use ($arguments, $name) {
                 return call_user_func_array([$this->repo, $name], $arguments);
             });
-        }
-        else if ($this->cacheConfig)
+        } else if ($this->cacheConfig)
         {
             $this->cache->tags($this->cacheConfig)->flush();
             return call_user_func_array([$this->repo, $name], $arguments);
@@ -93,8 +92,7 @@ 
         if ($cacheConfig && in_array($name, $cacheConfig['cache']))
         {
             $this->cacheConfig = 'cache';
-        }
-        else if ($cacheConfig && isset($cacheConfig['clear'][$name]))
+        } else if ($cacheConfig && isset($cacheConfig['clear'][$name]))
         {
             $this->cacheConfig = $cacheConfig['clear'][$name];
         }

src/Modules/V1/Notifications/Jobs/PushNotifications.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
     /**
      * Create a new job instance.
      *
+     * @param \LaravelFCM\Message\Options $option
+     * @param \LaravelFCM\Message\PayloadNotification $notification
+     * @param \LaravelFCM\Message\PayloadData $data
      * @return void
      */
     public function __construct($option, $notification, $data, $tokens)

src/Modules/V1/Notifications/Repositories/PushNotificationDeviceRepository.php

Doc Comments -3 removed lines

@@ -21,9 +21,6 @@
     /**
      * Set the notification notified to all.
      *
-     * @param  array  $users_ids
-     * @param  string $title
-     * @param  string $message
      * @param  string $data
      * @return void
      */