SherifElfadaly / Laravel-Api-Skeleton

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
      */

Spacing +6 added lines, -6 removed lines

@@ -59,7 +59,7 @@ 
                 $this->getPostData($route, $reflectionMethod, $validationRules);
 
                 preg_match('/api\/v1\/([^#]+)\//iU', $route['uri'], $module);
-                preg_match('/api\/v1\/' . $module[1] . '\/([^#]+)\//iU', $route['uri'], $model);
+                preg_match('/api\/v1\/'.$module[1].'\/([^#]+)\//iU', $route['uri'], $model);
                 $docData['modules'][$module[1]][$model[1]][] = $route;
             }
         }
@@ -74,7 +74,7 @@ 
      */
     protected function getRoutes()
     {
-        return collect(\Route::getRoutes())->map(function ($route) {
+        return collect(\Route::getRoutes())->map(function($route) {
             if (strpos($route->uri(), 'api/v') !== false) 
             {
                 return [
@@ -106,7 +106,7 @@ 
         ];
 
 
-        if (! $skipLoginCheck || ! in_array($method, $skipLoginCheck)) 
+        if ( ! $skipLoginCheck || ! in_array($method, $skipLoginCheck)) 
         {
             $route['headers']['Authrization'] = 'bearer {token}';
         }
@@ -159,16 +159,16 @@ 
                 }
                 else
                 {
-                    $route['body'] = eval('return ' . $match[1] . ';');
+                    $route['body'] = eval('return '.$match[1].';');
                 }
 
                 foreach ($route['body'] as &$rule) 
                 {
-                    if(strpos($rule, 'unique'))
+                    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);
                     }

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

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/Acl/Repositories/UserRepository.php

Spacing +6 added lines, -6 removed lines

@@ -26,7 +26,7 @@ 
         $user        = \Core::users()->find(\JWTAuth::parseToken()->authenticate()->id, $relations);
         foreach ($user->groups()->get() as $group)
         {
-            $group->permissions->each(function ($permission) use (&$permissions){
+            $group->permissions->each(function($permission) use (&$permissions){
                 $permissions[$permission->model][$permission->id] = $permission->name;
             });
         }
@@ -44,7 +44,7 @@ 
      * @param  boolean $user
      * @return boolean
      */
-    public function can($nameOfPermission, $model, $user = false )
+    public function can($nameOfPermission, $model, $user = false)
     {      
         $user        = $user ?: \JWTAuth::parseToken()->authenticate();
         $permissions = [];
@@ -54,7 +54,7 @@ 
             \ErrorHandler::tokenExpired();
         }
 
-        $user->groups->pluck('permissions')->each(function ($permission) use (&$permissions, $model){
+        $user->groups->pluck('permissions')->each(function($permission) use (&$permissions, $model){
             $permissions = array_merge($permissions, $permission->where('model', $model)->pluck('name')->toArray()); 
         });
         
@@ -82,7 +82,7 @@ 
      */
     public function assignGroups($user_id, $group_ids)
     {
-        \DB::transaction(function () use ($user_id, $group_ids) {
+        \DB::transaction(function() use ($user_id, $group_ids) {
             $user = $this->find($user_id);
             $user->groups()->detach();
             $user->groups()->attach($group_ids);
@@ -245,7 +245,7 @@ 
         $url   = $this->config['resetLink'];
         $token = \Password::getRepository()->create($user);
         
-        \Mail::send('Acl:resetpassword', ['user' => $user, 'url' => $url, 'token' => $token], function ($m) use ($user) {
+        \Mail::send('Acl:resetpassword', ['user' => $user, 'url' => $url, 'token' => $token], function($m) use ($user) {
             $m->to($user->email, $user->name)->subject('Your Password Reset Link');
         });
     }
@@ -259,7 +259,7 @@ 
     public function resetPassword($credentials)
     {
         $token    = false;
-        $response = \Password::reset($credentials, function ($user, $password) use (&$token) {
+        $response = \Password::reset($credentials, function($user, $password) use (&$token) {
             $user->password = bcrypt($password);
             $user->save();
 

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

Spacing +2 added lines, -2 removed lines

@@ -8,7 +8,7 @@ 
 {
 	public function index() 
 	{
-		$path       = str_replace($_SERVER['DOCUMENT_ROOT'], '',str_replace('\\', '/', __FILE__));
+		$path       = str_replace($_SERVER['DOCUMENT_ROOT'], '', str_replace('\\', '/', __FILE__));
 		$baseUrl    = str_replace('Http/Controllers/ApiDocumentController.php', '', $path);
 		$jsonDoc    = json_decode(file_get_contents(app_path('Modules/V1/Core/Resources/api.json')), true);
 		$modules    = $jsonDoc['modules'];
@@ -68,6 +68,6 @@ 
 		$reflectionClass = new \ReflectionClass($controller);
 		$classProperties = $reflectionClass->getDefaultProperties();
 		
-		return \Response::json(call_user_func_array("\Core::{$classProperties['model']}", [])->$method(), 200);;
+		return \Response::json(call_user_func_array("\Core::{$classProperties['model']}", [])->$method(), 200); ;
 	}
 }