SherifElfadaly / Laravel-Api-Skeleton

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

Doc Comments +1 added lines, -1 removed lines

@@ -199,7 +199,7 @@
     /**
      * Get the given method body code.
      *
-     * @param  object $reflectionMethod
+     * @param  \ReflectionMethod $reflectionMethod
      * @return string
      */
     protected function getMethodBody($reflectionMethod)

src/Modules/Core/Utl/ApiConsumer.php

Doc Comments -16 removed lines

@@ -28,10 +28,6 @@ 
     }
 
     /**
-     * @param  string $uri
-     * @param  array  $data
-     * @param  array  $headers
-     * @param  string $content
      * @return \Illuminate\Http\Response
      */
     public function get()
@@ -40,10 +36,6 @@ 
     }
 
     /**
-     * @param  string $uri
-     * @param  array  $data
-     * @param  array  $headers
-     * @param  string $content
      * @return \Illuminate\Http\Response
      */
     public function post()
@@ -52,10 +44,6 @@ 
     }
 
     /**
-     * @param  string $uri
-     * @param  array  $data
-     * @param  array  $headers
-     * @param  string $content
      * @return \Illuminate\Http\Response
      */
     public function put()
@@ -64,10 +52,6 @@ 
     }
 
     /**
-     * @param  string $uri
-     * @param  array  $data
-     * @param  array  $headers
-     * @param  string $content
      * @return \Illuminate\Http\Response
      */
     public function delete()

src/Modules/Core/BaseClasses/BaseRepository.php

Doc Comments +7 added lines, -7 removed lines

@@ -34,7 +34,7 @@ 
      *
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -52,7 +52,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -154,7 +154,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -172,7 +172,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -188,7 +188,7 @@ 
      * Save the given model to the storage.
      *
      * @param  array $data
-     * @return mixed
+     * @return boolean
      */
     public function save(array $data)
     {
@@ -477,7 +477,7 @@ 
      * @param  array   $conditions array of conditions
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -509,7 +509,7 @@ 
      * @param  array   $conditions array of conditions
      * @param  integer $perPage
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */

Spacing +15 added lines, -15 removed lines

@@ -21,7 +21,7 @@ 
      */
     public function __construct($model)
     {
-        $this->model  = $model;
+        $this->model = $model;
     }
 
     /**
@@ -85,7 +85,7 @@ 
         /**
          * Construct the select conditions for the model.
          */
-        $model->where(function ($q) use ($query, $conditionColumns, $relations) {
+        $model->where(function($q) use ($query, $conditionColumns, $relations) {
 
             if (count($conditionColumns)) {
                 $column = 'LOWER('.array_shift($conditionColumns).')';
@@ -127,9 +127,9 @@ 
                     /**
                      * Construct the relation condition.
                      */
-                    $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) {
 
                             /**
                              * Get columns of the relation.
@@ -215,7 +215,7 @@ 
         $model      = false;
         $relations  = [];
 
-        \DB::transaction(function () use (&$model, $relations, $data) {
+        \DB::transaction(function() use (&$model, $relations, $data) {
             
             $model     = $this->prepareModel($data);
             $relations = $this->prepareRelations($data, $model);
@@ -236,17 +236,17 @@ 
     public function delete($value, $attribute = 'id')
     {
         if ($attribute == 'id') {
-            \DB::transaction(function () use ($value) {
+            \DB::transaction(function() use ($value) {
                 $model = $this->model->lockForUpdate()->find($value);
-                if (! $model) {
+                if ( ! $model) {
                     \ErrorHandler::notFound(class_basename($this->model).' with id : '.$value);
                 }
                 
                 $model->delete();
             });
         } else {
-            \DB::transaction(function () use ($value, $attribute) {
-                $this->model->where($attribute, '=', $value)->lockForUpdate()->get()->each(function ($model) {
+            \DB::transaction(function() use ($value, $attribute) {
+                $this->model->where($attribute, '=', $value)->lockForUpdate()->get()->each(function($model) {
                     $model->delete();
                 });
             });
@@ -337,7 +337,7 @@ 
     {
         $model = $this->model->onlyTrashed()->find($id);
 
-        if (! $model) {
+        if ( ! $model) {
             \ErrorHandler::notFound(class_basename($this->model).' with id : '.$id);
         }
 
@@ -361,7 +361,7 @@ 
          * @var array
          */
         $model = Arr::has($data, 'id') ? $modelClass->lockForUpdate()->find($data['id']) : new $modelClass;
-        if (! $model) {
+        if ( ! $model) {
             \ErrorHandler::notFound(class_basename($modelClass).' with id : '.$data['id']);
         }
 
@@ -411,7 +411,7 @@ 
                      * If the relation has no value then marke the relation data
                      * related to the model to be deleted.
                      */
-                    if (! $value || ! count($value)) {
+                    if ( ! $value || ! count($value)) {
                         $relations[$relation] = 'delete';
                     }
                 }
@@ -438,7 +438,7 @@ 
                             /**
                              * If model doesn't exists.
                              */
-                            if (! $relationModel) {
+                            if ( ! $relationModel) {
                                 \ErrorHandler::notFound(class_basename($relationBaseModel).' with id : '.$val['id']);
                             }
 
@@ -469,7 +469,7 @@ 
                                 /**
                                  * If model doesn't exists.
                                  */
-                                if (! $relationModel) {
+                                if ( ! $relationModel) {
                                     \ErrorHandler::notFound(class_basename($relationBaseModel).' with id : '.$value['id']);
                                 }
 
@@ -675,7 +675,7 @@ 
         $value      = $removeLast === false ? $value : substr($value, 0, $removeLast);
         $path       = explode('->', $value);
         $field      = array_shift($path);
-        $result     = sprintf('%s->\'$.%s\'', $field, collect($path)->map(function ($part) {
+        $result     = sprintf('%s->\'$.%s\'', $field, collect($path)->map(function($part) {
             return '"'.$part.'"';
         })->implode('.'));
         

src/Modules/Core/BaseClasses/BaseApiController.php

Doc Comments +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
      * Init new object.
      *
      * @param   mixed      $repo
-     * @param   CoreConfig $config
+     * @param   \App\Modules\Core\Utl\CoreConfig $config
      * @param   string     $modelResource
      * @return  void
      */

src/Modules/Reporting/Http/Controllers/ReportController.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
      *
      * @param Request $request
      * @param  string $reportName Name of the requested report
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function getReport(Request $request, $reportName)
     {

src/Modules/PushNotificationDevices/Repositories/PushNotificationDeviceRepository.php

Doc Comments +1 added lines, -1 removed lines

@@ -21,7 +21,7 @@
      * Register the given device to the logged in user.
      *
      * @param  array $data
-     * @return void
+     * @return boolean
      */
     public function registerDevice($data)
     {

src/Modules/Users/Reppsitories/UserRepository.php

Doc Comments +2 added lines, -2 removed lines

@@ -144,7 +144,7 @@ 
      *
      * @param  array   $credentials
      * @param  boolean $skipConfirmEmail
-     * @return array
+     * @return boolean
      */
     public function register($credentials, $skipConfirmEmail = false)
     {
@@ -344,7 +344,7 @@ 
      * Save the given data to the logged in user.
      *
      * @param  array $data
-     * @return void
+     * @return boolean
      */
     public function saveProfile($data)
     {

src/Modules/Core/Console/Commands/MakeModuleCommand.php

Doc Comments +5 added lines

@@ -183,6 +183,11 @@
         }
     }
 
+    /**
+     * @param string $contents
+     *
+     * @return string
+     */
     protected function replacePlaceholders($contents)
     {
         $modelName = \Str::camel($this->container['slug']);