SherifElfadaly / Laravel-Api-Skeleton

src/Modules/V1/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('*'))

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

Doc Comments +1 added lines, -1 removed lines

@@ -202,7 +202,7 @@
      * Reset the given user's password.
      *
      * @param  array  $credentials
-     * @return integer
+     * @return false|null
      */
     public function resetPassword($credentials)
     {

Braces +8 added lines, -16 removed lines

@@ -76,24 +76,19 @@ 
         if ( ! $user = $this->first(['email' => $credentials['email']])) 
         {
             \ErrorHandler::loginFailed();
-        }
-        else if ($adminLogin && $user->groups->lists('name')->search('Admin', true) === false) 
+        } else if ($adminLogin && $user->groups->lists('name')->search('Admin', true) === false) 
         {
             \ErrorHandler::loginFailed();
-        }
-        else if ( ! $adminLogin && $user->groups->lists('name')->search('Admin', true) !== false) 
+        } else if ( ! $adminLogin && $user->groups->lists('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();
         }
@@ -118,8 +113,7 @@ 
         {
             $data = ['email' => $user->email, 'password' => ''];
             return $this->register($data);
-        }
-        else
+        } else
         {
             return $this->login(['email' => $registeredUser->email, 'password' => ''], false);
         }
@@ -161,12 +155,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->lists('name')->search('Admin', true) !== false) 
+        } else if ($user->groups->lists('name')->search('Admin', true) !== false) 
         {
             \ErrorHandler::noPermissions();
         }

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

Doc Comments +13 added lines, -13 removed lines

@@ -37,7 +37,7 @@ 
     /**
      * Fetch all records with relations from model repository.
      * 
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function getIndex() 
     {
@@ -52,7 +52,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) 
     {
@@ -70,8 +70,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) 
     {
@@ -88,8 +88,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) 
     {
@@ -105,7 +105,7 @@ 
      * condition.
      * 
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function postFirst(Request $request) 
     {
@@ -121,8 +121,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) 
     {
@@ -140,8 +140,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) 
     {
@@ -156,7 +156,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) 
     {
@@ -189,7 +189,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 +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 +7 added lines, -7 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
      */
@@ -174,7 +174,7 @@ 
      * 
      * @param  array   $data
      * @param  boolean $saveLog
-     * @return object
+     * @return boolean
      */
     public function save(array $data, $saveLog = true)
     {
@@ -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
      */

Braces +4 added lines, -8 removed lines

@@ -430,8 +430,7 @@ 
             $model = $this->model->lockForUpdate()->find($value);
             $model ? $model->update($data) : 0;
             $saveLog ? $this->logs->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);
@@ -462,8 +461,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){
@@ -536,13 +534,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/V1/Notifications/Repositories/NotificationRepository.php

Doc Comments +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
      * Set the notification notified to true.
      * 
      * @param  integer  $id
-     * @return object
+     * @return boolean
      */
     public function notified($id)
     {