SherifElfadaly / Laravel-Api-Skeleton

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

Doc Comments +2 added lines, -1 removed lines

@@ -123,6 +123,7 @@ 
      * 
      * @param  array  &$route
      * @param  object $reflectionMethod]
+     * @param \ReflectionMethod $reflectionMethod
      * @return void
      */
     protected function processDocBlock(&$route, $reflectionMethod)
@@ -145,7 +146,7 @@ 
      * Generate post body for the given route.
      * 
      * @param  array  &$route
-     * @param  object $reflectionMethod
+     * @param  \ReflectionMethod $reflectionMethod
      * @param  array  $validationRules
      * @return void
      */

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

Doc Comments +1 added lines, -1 removed lines

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

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

Doc Comments +9 added lines, -9 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
      */
@@ -164,7 +164,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -182,7 +182,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -197,7 +197,7 @@ 
     /**
      * Save the given model to the storage.
      * 
-     * @param  array   $data
+     * @param  string   $data
      * @return void
      */
     public function save(array $data)
@@ -442,7 +442,7 @@ 
      * Update record in the storage based on the given
      * condition.
      * 
-     * @param  var $value condition value
+     * @param  integer $value condition value
      * @param  array $data
      * @param  string $attribute condition column name
      * @return void
@@ -499,7 +499,7 @@ 
      * id.
      * 
      * @param  integer $id
-     * @param  array   $relations
+     * @param  string[]   $relations
      * @param  array   $columns
      * @return object
      */
@@ -515,7 +515,7 @@ 
      * @param  array   $conditions array of conditions
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -547,7 +547,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/V1/Acl/Http/Controllers/UsersController.php

Doc Comments +15 added lines, -15 removed lines

@@ -56,7 +56,7 @@ 
     /**
      * Return the logged in user account.
      * 
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function account()
     {
@@ -67,7 +67,7 @@ 
      * Block the user.
      *
      * @param  integer  $id Id of the user.
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function block($id)
     {
@@ -78,7 +78,7 @@ 
      * Unblock the user.
      *
      * @param  integer  $id Id of the user.
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function unblock($id)
     {
@@ -88,7 +88,7 @@ 
     /**
      * Logout the user.
      * 
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function logout()
     {
@@ -99,7 +99,7 @@ 
      * Handle a registration request.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function register(Request $request)
     {
@@ -116,7 +116,7 @@ 
      * Handle a login request to the application.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function login(Request $request)
     {
@@ -133,7 +133,7 @@ 
      * Handle a social login request of the none admin to the application.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function loginSocial(Request $request)
     {
@@ -150,7 +150,7 @@ 
      * Assign the given groups to the given user.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function assigngroups(Request $request)
     {
@@ -166,7 +166,7 @@ 
      * Send a reset link to the given user.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function sendreset(Request $request)
     {
@@ -179,7 +179,7 @@ 
      * Reset the given user's password.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function resetpassword(Request $request)
     {
@@ -197,7 +197,7 @@ 
      * Change the logged in user password.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function changePassword(Request $request)
     {
@@ -214,7 +214,7 @@ 
      * Refresh the expired login token.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function refreshtoken(Request $request)
     {
@@ -232,8 +232,8 @@ 
      * @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).
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc     Sort ascending or descinding (1: desc, 0: asc).
+     * @return \Illuminate\Http\JsonResponse
      */
     public function group(Request $request, $groupName, $perPage = false, $sortBy = 'created_at', $desc = 1)
     {
@@ -244,7 +244,7 @@ 
      * Save the given data to the logged in user.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function saveProfile(Request $request) 
     {