SherifElfadaly / Laravel-Api-Skeleton

src/Modules/Core/AbstractRepositories/AbstractRepository.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
      */

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/Acl/Http/Controllers/UsersController.php

Doc Comments +1 added lines, -1 removed lines

@@ -268,7 +268,7 @@
      * @param  string $groupName The name of the requested group.
      * @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).
+     * @param  integer $desc     Sort ascending or descinding (1: desc, 0: asc).
      * @return \Illuminate\Http\Response
      */
     public function group(Request $request, $groupName, $perPage = false, $sortBy = 'created_at', $desc = 1)

src/Modules/Acl/Repositories/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/Http/Controllers/BaseApiController.php

Doc Comments +7 added lines, -7 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
      */
@@ -59,7 +59,7 @@ 
      * 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).
+     * @param  integer $desc   Sort ascending or descinding (1: desc, 0: asc).
      * @return \Illuminate\Http\Response
      */
     public function index($sortBy = 'created_at', $desc = 1)
@@ -85,7 +85,7 @@ 
      * @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).
+     * @param  integer $desc    Sort ascending or descinding (1: desc, 0: asc).
      * @return \Illuminate\Http\Response
      */
     public function search($query = '', $perPage = 15, $sortBy = 'created_at', $desc = 1)
@@ -99,7 +99,7 @@ 
      *
      * @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).
+     * @param  integer $desc   Sort ascending or descinding (1: desc, 0: asc).
      * @return \Illuminate\Http\Response
      */
     public function findby(Request $request, $sortBy = 'created_at', $desc = 1)
@@ -124,7 +124,7 @@ 
      *
      * @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).
+     * @param  integer $desc    Sort ascending or descinding (1: desc, 0: asc).
      * @return \Illuminate\Http\Response
      */
     public function paginate($perPage = 15, $sortBy = 'created_at', $desc = 1)
@@ -139,7 +139,7 @@ 
      * @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).
+     * @param  integer $desc    Sort ascending or descinding (1: desc, 0: asc).
      * @return \Illuminate\Http\Response
      */
     public function paginateby(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1)
@@ -189,7 +189,7 @@ 
      * @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).
+     * @param  integer $desc    Sort ascending or descinding (1: desc, 0: asc).
      * @return \Illuminate\Http\Response
      */
     public function deleted(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1)

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

Doc Comments +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
      * @param  \Illuminate\Http\Request  $request
      * @param  string  $reportName Name of the requested report
      * @param  integer $perPage    Number of rows per page default all data.
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function getReport(Request $request, $reportName, $perPage = 0)
     {