SherifElfadaly / Laravel-Api-Skeleton

src/Modules/Reporting/Database/Seeds/ReportsTableSeeder.php

Indentation +36 added lines, -36 removed lines

@@ -6,40 +6,40 @@
 
 class ReportsTableSeeder extends Seeder
 {
-    /**
-     * Run the database seeds.
-     *
-     * @return void
-     */
-    public function run()
-    {
-        /**
-         * Insert the permissions related to settings table.
-         */
-        \DB::table('permissions')->insert(
-            [
-                /**
-                 * Reports model permissions.
-                 */
-                [
-                'name'       => 'index',
-                'model'      => 'report',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ],
-                [
-                'name'       => 'show',
-                'model'      => 'report',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ],
-                [
-                'name'       => 'admin_count',
-                'model'      => 'report',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ]
-            ]
-        );
-    }
+	/**
+	 * Run the database seeds.
+	 *
+	 * @return void
+	 */
+	public function run()
+	{
+		/**
+		 * Insert the permissions related to settings table.
+		 */
+		\DB::table('permissions')->insert(
+			[
+				/**
+				 * Reports model permissions.
+				 */
+				[
+				'name'       => 'index',
+				'model'      => 'report',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'show',
+				'model'      => 'report',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'admin_count',
+				'model'      => 'report',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				]
+			]
+		);
+	}
 }

src/Modules/Reporting/Routes/api.php

Indentation +3 added lines, -3 removed lines

@@ -13,7 +13,7 @@
 
 Route::group(['prefix' => 'reports'], function () {
         
-    Route::get('/', 'ReportController@index');
-    Route::get('/{id}', 'ReportController@show');
-    Route::post('get/{reportName}', 'ReportController@getReport');
+	Route::get('/', 'ReportController@index');
+	Route::get('/{id}', 'ReportController@show');
+	Route::post('get/{reportName}', 'ReportController@getReport');
 });

Spacing +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
 |
 */
 
-Route::group(['prefix' => 'reports'], function () {
+Route::group(['prefix' => 'reports'], function() {
         
     Route::get('/', 'ReportController@index');
     Route::get('/{id}', 'ReportController@show');

src/Modules/PushNotificationDevices/Http/Controllers/PushNotificationDeviceController.php

Indentation +38 added lines, -38 removed lines

@@ -8,46 +8,46 @@
 
 class PushNotificationDeviceController extends BaseApiController
 {
-    /**
-     * Path of the sotre form request.
-     *
-     * @var string
-     */
-    protected $storeFormRequest = 'App\Modules\Users\Http\PushNotificationDevices\StorePushNotificationDevice';
+	/**
+	 * Path of the sotre form request.
+	 *
+	 * @var string
+	 */
+	protected $storeFormRequest = 'App\Modules\Users\Http\PushNotificationDevices\StorePushNotificationDevice';
 
-    /**
-     * Path of the model resource
-     *
-     * @var string
-     */
-    protected $modelResource = 'App\Modules\PushNotificationDevices\Http\Resources\PushNotificationDevice';
+	/**
+	 * Path of the model resource
+	 *
+	 * @var string
+	 */
+	protected $modelResource = 'App\Modules\PushNotificationDevices\Http\Resources\PushNotificationDevice';
 
-    /**
-     * List of all route actions that the base api controller
-     * will skip permissions check for them.
-     * @var array
-     */
-    protected $skipPermissionCheck = ['registerDevice'];
+	/**
+	 * List of all route actions that the base api controller
+	 * will skip permissions check for them.
+	 * @var array
+	 */
+	protected $skipPermissionCheck = ['registerDevice'];
 
-    /**
-     * Init new object.
-     *
-     * @param   PushNotificationDeviceService $service
-     * @return  void
-     */
-    public function __construct(PushNotificationDeviceService $service)
-    {
-        parent::__construct($service);
-    }
+	/**
+	 * Init new object.
+	 *
+	 * @param   PushNotificationDeviceService $service
+	 * @return  void
+	 */
+	public function __construct(PushNotificationDeviceService $service)
+	{
+		parent::__construct($service);
+	}
 
-    /**
-     * Register the given device to the logged in user.
-     *
-     * @param RegisterDevice $request
-     * @return \Illuminate\Http\Response
-     */
-    public function registerDevice(RegisterDevice $request)
-    {
-        return new $this->modelResource($this->service->registerDevice($request->all()));
-    }
+	/**
+	 * Register the given device to the logged in user.
+	 *
+	 * @param RegisterDevice $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function registerDevice(RegisterDevice $request)
+	{
+		return new $this->modelResource($this->service->registerDevice($request->all()));
+	}
 }

src/Modules/Core/Database/Seeds/SettingsTableSeeder.php

Indentation +48 added lines, -48 removed lines

@@ -6,52 +6,52 @@
 
 class SettingsTableSeeder extends Seeder
 {
-    /**
-     * Run the database seeds.
-     *
-     * @return void
-     */
-    public function run()
-    {
-        /**
-         * Insert the permissions related to settings table.
-         */
-        \DB::table('permissions')->insert(
-            [
-                /**
-                 * Settings model permissions.
-                 */
-                [
-                'name'       => 'index',
-                'model'      => 'setting',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ],
-                [
-                'name'       => 'show',
-                'model'      => 'setting',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ],
-                [
-                'name'       => 'update',
-                'model'      => 'setting',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ],
-                [
-                'name'       => 'destroy',
-                'model'      => 'setting',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ],
-                [
-                'name'       => 'saveMany',
-                'model'      => 'setting',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ]
-            ]
-        );
-    }
+	/**
+	 * Run the database seeds.
+	 *
+	 * @return void
+	 */
+	public function run()
+	{
+		/**
+		 * Insert the permissions related to settings table.
+		 */
+		\DB::table('permissions')->insert(
+			[
+				/**
+				 * Settings model permissions.
+				 */
+				[
+				'name'       => 'index',
+				'model'      => 'setting',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'show',
+				'model'      => 'setting',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'update',
+				'model'      => 'setting',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'destroy',
+				'model'      => 'setting',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'saveMany',
+				'model'      => 'setting',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				]
+			]
+		);
+	}
 }

src/Modules/Core/Http/Controllers/SettingController.php

Indentation +32 added lines, -32 removed lines

@@ -9,39 +9,39 @@
 
 class SettingController extends BaseApiController
 {
-    /**
-     * Path of the sotre form request.
-     *
-     * @var string
-     */
-    protected $storeFormRequest = 'App\Modules\Core\Http\Requests\StoreSetting';
+	/**
+	 * Path of the sotre form request.
+	 *
+	 * @var string
+	 */
+	protected $storeFormRequest = 'App\Modules\Core\Http\Requests\StoreSetting';
 
-    /**
-     * Path of the model resource
-     *
-     * @var string
-     */
-    protected $modelResource = 'App\Modules\Core\Http\Resources\Setting';
+	/**
+	 * Path of the model resource
+	 *
+	 * @var string
+	 */
+	protected $modelResource = 'App\Modules\Core\Http\Resources\Setting';
 
-    /**
-     * Init new object.
-     *
-     * @param   SettingService $service
-     * @return  void
-     */
-    public function __construct(SettingService $service)
-    {
-        parent::__construct($service);
-    }
+	/**
+	 * Init new object.
+	 *
+	 * @param   SettingService $service
+	 * @return  void
+	 */
+	public function __construct(SettingService $service)
+	{
+		parent::__construct($service);
+	}
 
-    /**
-     * Save list of settings.
-     *
-     * @param Request $request
-     * @return \Illuminate\Http\Response
-     */
-    public function saveMany(Request $request)
-    {
-        return new GeneralResource($this->service->saveMany($request->all()));
-    }
+	/**
+	 * Save list of settings.
+	 *
+	 * @param Request $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function saveMany(Request $request)
+	{
+		return new GeneralResource($this->service->saveMany($request->all()));
+	}
 }

src/Modules/Core/Http/Requests/StoreSetting.php

Indentation +20 added lines, -20 removed lines

@@ -6,25 +6,25 @@
 
 class StoreSetting extends FormRequest
 {
-    /**
-     * Determine if the user is authorized to make this request.
-     *
-     * @return bool
-     */
-    public function authorize()
-    {
-        return true;
-    }
+	/**
+	 * Determine if the user is authorized to make this request.
+	 *
+	 * @return bool
+	 */
+	public function authorize()
+	{
+		return true;
+	}
 
-    /**
-     * Get the validation rules that apply to the request.
-     *
-     * @return array
-     */
-    public function rules()
-    {
-        return [
-            'value' => 'required|string'
-        ];
-    }
+	/**
+	 * Get the validation rules that apply to the request.
+	 *
+	 * @return array
+	 */
+	public function rules()
+	{
+		return [
+			'value' => 'required|string'
+		];
+	}
 }

src/Modules/Core/Routes/api.php

Spacing +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
 |
 */
 
-Route::group(['prefix' => 'settings'], function () {
+Route::group(['prefix' => 'settings'], function() {
 
     Route::get('/', 'SettingController@index');
     Route::get('{id}', 'SettingController@show');

Indentation +4 added lines, -4 removed lines

@@ -13,8 +13,8 @@
 
 Route::group(['prefix' => 'settings'], function () {
 
-    Route::get('/', 'SettingController@index');
-    Route::get('{id}', 'SettingController@show');
-    Route::patch('{id}', 'SettingController@update');
-    Route::post('save/many', 'SettingController@saveMany');
+	Route::get('/', 'SettingController@index');
+	Route::get('{id}', 'SettingController@show');
+	Route::patch('{id}', 'SettingController@update');
+	Route::post('save/many', 'SettingController@saveMany');
 });

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

Doc Comments +2 added lines, -1 removed lines

@@ -207,7 +207,7 @@ 
     /**
      * Get the given method body code.
      *
-     * @param  object $reflectionMethod
+     * @param  \ReflectionMethod $reflectionMethod
      * @return string
      */
     protected function getMethodBody($reflectionMethod)
@@ -228,6 +228,7 @@ 
      *
      * @param  string $modelName
      * @param  array  $docData
+     * @param \ReflectionClass $reflectionClass
      * @return string
      */
     protected function getModels($modelName, &$docData, $reflectionClass)

Spacing +7 added lines, -7 removed lines

@@ -92,7 +92,7 @@ 
      */
     protected function getRoutes()
     {
-        return collect(\Route::getRoutes())->map(function ($route) {
+        return collect(\Route::getRoutes())->map(function($route) {
             if (strpos($route->uri(), 'api/') !== false) {
                 return [
                     'method' => $route->methods()[0],
@@ -123,7 +123,7 @@ 
         ];
 
 
-        if (! $skipLoginCheck || ! in_array($method, $skipLoginCheck)) {
+        if ( ! $skipLoginCheck || ! in_array($method, $skipLoginCheck)) {
             $route['headers']['Authorization'] = 'Bearer {token}';
         }
     }
@@ -181,7 +181,7 @@ 
         if ($className) {
             $reflectionClass  = new \ReflectionClass($className);
         } elseif (in_array($reflectionMethod->getName(), ['store', 'update'])) {
-            $className = 'App\\Modules\\' . ucfirst($module) . '\\Http\\Requests\\Store'  . ucfirst($modelName);
+            $className = 'App\\Modules\\'.ucfirst($module).'\\Http\\Requests\\Store'.ucfirst($modelName);
             $reflectionClass  = new \ReflectionClass($className);
         }
 
@@ -208,8 +208,8 @@ 
     {
         $errors = [];
         foreach (\Module::all() as $module) {
-            $nameSpace = 'App\\Modules\\' . $module['basename'];
-            $class = $nameSpace . '\\Errors\\'  . $module['basename'] . 'Errors';
+            $nameSpace = 'App\\Modules\\'.$module['basename'];
+            $class = $nameSpace.'\\Errors\\'.$module['basename'].'Errors';
             $reflectionClass = new \ReflectionClass($class);
             foreach ($reflectionClass->getMethods() as $method) {
                 $methodName       = $method->name;
@@ -257,7 +257,7 @@ 
     {
         if ($modelName && ! Arr::has($docData['models'], $modelName)) {
             $repo = call_user_func_array("\Core::{$modelName}", []);
-            if (! $repo) {
+            if ( ! $repo) {
                 return;
             }
             
@@ -275,7 +275,7 @@ 
                 $body = $this->getMethodBody($reflectionMethod);
                 foreach ($relationMethods as $relationMethod) {
                     $relation = $reflectionMethod->getName();
-                    if (strpos($body, '$this->' . $relationMethod) && $relation !== 'morphedByMany') {
+                    if (strpos($body, '$this->'.$relationMethod) && $relation !== 'morphedByMany') {
                         $relations[] = $relation;
                         break;
                     }

Indentation +302 added lines, -302 removed lines

@@ -8,308 +8,308 @@
 
 class GenerateDocCommand extends Command
 {
-    /**
-     * The name and signature of the console command.
-     *
-     * @var string
-     */
-    protected $signature = 'doc:generate';
-
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
-    protected $description = 'Generate api documentation';
-
-    /**
-     * @var ReprotService
-     */
-    protected $reportService;
-
-    /**
-     * Init new object.
-     *
-     * @return  void
-     */
-    public function __construct(ReportService $reportService)
-    {
-        $this->reportService = $reportService;
-        parent::__construct();
-    }
-
-    /**
-     * Execute the console command.
-     *
-     * @return mixed
-     */
-    public function handle()
-    {
-        $docData           = [];
-        $docData['models'] = [];
-        $routes            = $this->getRoutes();
-        foreach ($routes as $route) {
-            if ($route) {
-                $actoinArray = explode('@', $route['action']);
-                if (Arr::get($actoinArray, 1, false)) {
-                    $prefix = $route['prefix'];
-                    $module = \Str::camel(str_replace('/', '_', str_replace('api', '', $prefix)));
-                    if ($prefix === 'telescope') {
-                        continue;
-                    }
-
-                    $controller       = $actoinArray[0];
-                    $method           = $actoinArray[1];
-                    $route['name']    = $method;
-                    $reflectionClass  = new \ReflectionClass($controller);
-                    $reflectionMethod = $reflectionClass->getMethod($method);
-                    $classProperties  = $reflectionClass->getDefaultProperties();
-                    $skipLoginCheck   = Arr::get($classProperties, 'skipLoginCheck', false);
-                    $modelName        = explode('\\', $controller);
-                    $modelName        = lcfirst(str_replace('Controller', '', end($modelName)));
-
-                    $this->processDocBlock($route, $reflectionMethod);
-                    $this->getHeaders($route, $method, $skipLoginCheck);
-                    $this->getPostData($route, $reflectionMethod, explode('\\', $reflectionClass->getName())[2], $modelName);
-
-                    $route['response'] = $this->getResponseObject($modelName, $route['name'], $route['returnDocBlock']);
-                    $docData['modules'][$module][] = $route;
-
-                    $this->getModels($modelName, $docData, $reflectionClass);
-                }
-            }
-        }
+	/**
+	 * The name and signature of the console command.
+	 *
+	 * @var string
+	 */
+	protected $signature = 'doc:generate';
+
+	/**
+	 * The console command description.
+	 *
+	 * @var string
+	 */
+	protected $description = 'Generate api documentation';
+
+	/**
+	 * @var ReprotService
+	 */
+	protected $reportService;
+
+	/**
+	 * Init new object.
+	 *
+	 * @return  void
+	 */
+	public function __construct(ReportService $reportService)
+	{
+		$this->reportService = $reportService;
+		parent::__construct();
+	}
+
+	/**
+	 * Execute the console command.
+	 *
+	 * @return mixed
+	 */
+	public function handle()
+	{
+		$docData           = [];
+		$docData['models'] = [];
+		$routes            = $this->getRoutes();
+		foreach ($routes as $route) {
+			if ($route) {
+				$actoinArray = explode('@', $route['action']);
+				if (Arr::get($actoinArray, 1, false)) {
+					$prefix = $route['prefix'];
+					$module = \Str::camel(str_replace('/', '_', str_replace('api', '', $prefix)));
+					if ($prefix === 'telescope') {
+						continue;
+					}
+
+					$controller       = $actoinArray[0];
+					$method           = $actoinArray[1];
+					$route['name']    = $method;
+					$reflectionClass  = new \ReflectionClass($controller);
+					$reflectionMethod = $reflectionClass->getMethod($method);
+					$classProperties  = $reflectionClass->getDefaultProperties();
+					$skipLoginCheck   = Arr::get($classProperties, 'skipLoginCheck', false);
+					$modelName        = explode('\\', $controller);
+					$modelName        = lcfirst(str_replace('Controller', '', end($modelName)));
+
+					$this->processDocBlock($route, $reflectionMethod);
+					$this->getHeaders($route, $method, $skipLoginCheck);
+					$this->getPostData($route, $reflectionMethod, explode('\\', $reflectionClass->getName())[2], $modelName);
+
+					$route['response'] = $this->getResponseObject($modelName, $route['name'], $route['returnDocBlock']);
+					$docData['modules'][$module][] = $route;
+
+					$this->getModels($modelName, $docData, $reflectionClass);
+				}
+			}
+		}
         
-        $docData['errors']  = $this->getErrors();
-        $docData['reports'] = $this->reportService->all();
-        \File::put(app_path('Modules/Core/Resources/api.json'), json_encode($docData));
-    }
-
-    /**
-     * Get list of all registered routes.
-     *
-     * @return collection
-     */
-    protected function getRoutes()
-    {
-        return collect(\Route::getRoutes())->map(function ($route) {
-            if (strpos($route->uri(), 'api/') !== false) {
-                return [
-                    'method' => $route->methods()[0],
-                    'uri'    => $route->uri(),
-                    'action' => $route->getActionName(),
-                    'prefix' => $route->getPrefix()
-                ];
-            }
-            return false;
-        })->all();
-    }
-
-    /**
-     * Generate headers for the given route.
-     *
-     * @param  array  &$route
-     * @param  string $method
-     * @param  array  $skipLoginCheck
-     * @return void
-     */
-    protected function getHeaders(&$route, $method, $skipLoginCheck)
-    {
-        $route['headers'] = [
-        'Accept'         => 'application/json',
-        'Content-Type'   => 'application/json',
-        'Accept-Language' => 'The language of the returned data: ar, en or all.',
-        'time-zone'       => 'Your locale time zone',
-        ];
-
-
-        if (! $skipLoginCheck || ! in_array($method, $skipLoginCheck)) {
-            $route['headers']['Authorization'] = 'Bearer {token}';
-        }
-    }
-
-    /**
-     * Generate description and params for the given route
-     * based on the docblock.
-     *
-     * @param  array  &$route
-     * @param  \ReflectionMethod $reflectionMethod
-     * @return void
-     */
-    protected function processDocBlock(&$route, $reflectionMethod)
-    {
-        $factory                 = \phpDocumentor\Reflection\DocBlockFactory::createInstance();
-        $docblock                = $factory->create($reflectionMethod->getDocComment());
-        $route['description']    = trim(preg_replace('/\s+/', ' ', $docblock->getSummary()));
-        $params                  = $docblock->getTagsByName('param');
-        $route['returnDocBlock'] = $docblock->getTagsByName('return')[0]->getType()->getFqsen()->getName();
-
-        foreach ($params as $param) {
-            $name = $param->getVariableName();
-            if ($name == 'perPage') {
-                $route['parametars'][$name] = 'perPage? number of records per page default 15';
-            } elseif ($name == 'sortBy') {
-                $route['parametars'][$name] = 'sortBy? sort column default created_at';
-            } elseif ($name == 'desc') {
-                $route['parametars'][$name] = 'desc? sort descending or ascending default is descending';
-            } elseif ($name !== 'request') {
-                $route['parametars'][$name] = $param->getDescription()->render();
-            }
-        }
-
-        if ($route['name'] === 'index') {
-            $route['parametars']['perPage'] = 'perPage? number of records per page default 15';
-            $route['parametars']['sortBy']  = 'sortBy? sort column default created_at';
-            $route['parametars']['desc']    = 'desc? sort descending or ascending default is descending';
-            $route['parametars']['trashed'] = 'trashed? retreive trashed or not default not';
-        }
-    }
-
-    /**
-     * Generate post body for the given route.
-     *
-     * @param  array  &$route
-     * @param  \ReflectionMethod $reflectionMethod
-     * @param  string $module
-     * @param  string $modelName
-     * @return void
-     */
-    protected function getPostData(&$route, $reflectionMethod, $module, $modelName)
-    {
-        request()->setMethod($route['method']);
-        $parameters = $reflectionMethod->getParameters();
-        $className = optional(optional(\Arr::get($parameters, 0))->getType())->getName();
-        if ($className) {
-            $reflectionClass  = new \ReflectionClass($className);
-        } elseif (in_array($reflectionMethod->getName(), ['store', 'update'])) {
-            $className = 'App\\Modules\\' . ucfirst($module) . '\\Http\\Requests\\Store'  . ucfirst($modelName);
-            $reflectionClass  = new \ReflectionClass($className);
-        }
-
-        if (isset($reflectionClass) && $reflectionClass->hasMethod('rules')) {
-            $reflectionMethod = $reflectionClass->getMethod('rules');
-            $route['body'] = $reflectionMethod->invoke(new $className);
-
-            foreach ($route['body'] as &$rule) {
-                if (strpos($rule, 'unique')) {
-                    $rule = substr($rule, 0, strpos($rule, 'unique') + 6);
-                } elseif (strpos($rule, 'exists')) {
-                    $rule = substr($rule, 0, strpos($rule, 'exists') - 1);
-                }
-            }
-        }
-    }
-
-    /**
-     * Generate application errors.
-     *
-     * @return array
-     */
-    protected function getErrors()
-    {
-        $errors = [];
-        foreach (\Module::all() as $module) {
-            $nameSpace = 'App\\Modules\\' . $module['basename'];
-            $class = $nameSpace . '\\Errors\\'  . $module['basename'] . 'Errors';
-            $reflectionClass = new \ReflectionClass($class);
-            foreach ($reflectionClass->getMethods() as $method) {
-                $methodName       = $method->name;
-                $reflectionMethod = $reflectionClass->getMethod($methodName);
-                $body             = $this->getMethodBody($reflectionMethod);
-
-                preg_match('/abort\(([^#]+)\,/iU', $body, $match);
-
-                if (count($match)) {
-                    $errors[$match[1]][] = $methodName;
-                }
-            }
-        }
-
-        return $errors;
-    }
-
-    /**
-     * Get the given method body code.
-     *
-     * @param  object $reflectionMethod
-     * @return string
-     */
-    protected function getMethodBody($reflectionMethod)
-    {
-        $filename   = $reflectionMethod->getFileName();
-        $start_line = $reflectionMethod->getStartLine() - 1;
-        $end_line   = $reflectionMethod->getEndLine();
-        $length     = $end_line - $start_line;
-        $source     = file($filename);
-        $body       = implode("", array_slice($source, $start_line, $length));
-        $body       = trim(preg_replace('/\s+/', '', $body));
-
-        return $body;
-    }
-
-    /**
-     * Get example object of all availble models.
-     *
-     * @param  string $modelName
-     * @param  array  $docData
-     * @return string
-     */
-    protected function getModels($modelName, &$docData, $reflectionClass)
-    {
-        if ($modelName && ! Arr::has($docData['models'], $modelName)) {
-            $repo = call_user_func_array("\Core::{$modelName}", []);
-            if (! $repo) {
-                return;
-            }
+		$docData['errors']  = $this->getErrors();
+		$docData['reports'] = $this->reportService->all();
+		\File::put(app_path('Modules/Core/Resources/api.json'), json_encode($docData));
+	}
+
+	/**
+	 * Get list of all registered routes.
+	 *
+	 * @return collection
+	 */
+	protected function getRoutes()
+	{
+		return collect(\Route::getRoutes())->map(function ($route) {
+			if (strpos($route->uri(), 'api/') !== false) {
+				return [
+					'method' => $route->methods()[0],
+					'uri'    => $route->uri(),
+					'action' => $route->getActionName(),
+					'prefix' => $route->getPrefix()
+				];
+			}
+			return false;
+		})->all();
+	}
+
+	/**
+	 * Generate headers for the given route.
+	 *
+	 * @param  array  &$route
+	 * @param  string $method
+	 * @param  array  $skipLoginCheck
+	 * @return void
+	 */
+	protected function getHeaders(&$route, $method, $skipLoginCheck)
+	{
+		$route['headers'] = [
+		'Accept'         => 'application/json',
+		'Content-Type'   => 'application/json',
+		'Accept-Language' => 'The language of the returned data: ar, en or all.',
+		'time-zone'       => 'Your locale time zone',
+		];
+
+
+		if (! $skipLoginCheck || ! in_array($method, $skipLoginCheck)) {
+			$route['headers']['Authorization'] = 'Bearer {token}';
+		}
+	}
+
+	/**
+	 * Generate description and params for the given route
+	 * based on the docblock.
+	 *
+	 * @param  array  &$route
+	 * @param  \ReflectionMethod $reflectionMethod
+	 * @return void
+	 */
+	protected function processDocBlock(&$route, $reflectionMethod)
+	{
+		$factory                 = \phpDocumentor\Reflection\DocBlockFactory::createInstance();
+		$docblock                = $factory->create($reflectionMethod->getDocComment());
+		$route['description']    = trim(preg_replace('/\s+/', ' ', $docblock->getSummary()));
+		$params                  = $docblock->getTagsByName('param');
+		$route['returnDocBlock'] = $docblock->getTagsByName('return')[0]->getType()->getFqsen()->getName();
+
+		foreach ($params as $param) {
+			$name = $param->getVariableName();
+			if ($name == 'perPage') {
+				$route['parametars'][$name] = 'perPage? number of records per page default 15';
+			} elseif ($name == 'sortBy') {
+				$route['parametars'][$name] = 'sortBy? sort column default created_at';
+			} elseif ($name == 'desc') {
+				$route['parametars'][$name] = 'desc? sort descending or ascending default is descending';
+			} elseif ($name !== 'request') {
+				$route['parametars'][$name] = $param->getDescription()->render();
+			}
+		}
+
+		if ($route['name'] === 'index') {
+			$route['parametars']['perPage'] = 'perPage? number of records per page default 15';
+			$route['parametars']['sortBy']  = 'sortBy? sort column default created_at';
+			$route['parametars']['desc']    = 'desc? sort descending or ascending default is descending';
+			$route['parametars']['trashed'] = 'trashed? retreive trashed or not default not';
+		}
+	}
+
+	/**
+	 * Generate post body for the given route.
+	 *
+	 * @param  array  &$route
+	 * @param  \ReflectionMethod $reflectionMethod
+	 * @param  string $module
+	 * @param  string $modelName
+	 * @return void
+	 */
+	protected function getPostData(&$route, $reflectionMethod, $module, $modelName)
+	{
+		request()->setMethod($route['method']);
+		$parameters = $reflectionMethod->getParameters();
+		$className = optional(optional(\Arr::get($parameters, 0))->getType())->getName();
+		if ($className) {
+			$reflectionClass  = new \ReflectionClass($className);
+		} elseif (in_array($reflectionMethod->getName(), ['store', 'update'])) {
+			$className = 'App\\Modules\\' . ucfirst($module) . '\\Http\\Requests\\Store'  . ucfirst($modelName);
+			$reflectionClass  = new \ReflectionClass($className);
+		}
+
+		if (isset($reflectionClass) && $reflectionClass->hasMethod('rules')) {
+			$reflectionMethod = $reflectionClass->getMethod('rules');
+			$route['body'] = $reflectionMethod->invoke(new $className);
+
+			foreach ($route['body'] as &$rule) {
+				if (strpos($rule, 'unique')) {
+					$rule = substr($rule, 0, strpos($rule, 'unique') + 6);
+				} elseif (strpos($rule, 'exists')) {
+					$rule = substr($rule, 0, strpos($rule, 'exists') - 1);
+				}
+			}
+		}
+	}
+
+	/**
+	 * Generate application errors.
+	 *
+	 * @return array
+	 */
+	protected function getErrors()
+	{
+		$errors = [];
+		foreach (\Module::all() as $module) {
+			$nameSpace = 'App\\Modules\\' . $module['basename'];
+			$class = $nameSpace . '\\Errors\\'  . $module['basename'] . 'Errors';
+			$reflectionClass = new \ReflectionClass($class);
+			foreach ($reflectionClass->getMethods() as $method) {
+				$methodName       = $method->name;
+				$reflectionMethod = $reflectionClass->getMethod($methodName);
+				$body             = $this->getMethodBody($reflectionMethod);
+
+				preg_match('/abort\(([^#]+)\,/iU', $body, $match);
+
+				if (count($match)) {
+					$errors[$match[1]][] = $methodName;
+				}
+			}
+		}
+
+		return $errors;
+	}
+
+	/**
+	 * Get the given method body code.
+	 *
+	 * @param  object $reflectionMethod
+	 * @return string
+	 */
+	protected function getMethodBody($reflectionMethod)
+	{
+		$filename   = $reflectionMethod->getFileName();
+		$start_line = $reflectionMethod->getStartLine() - 1;
+		$end_line   = $reflectionMethod->getEndLine();
+		$length     = $end_line - $start_line;
+		$source     = file($filename);
+		$body       = implode("", array_slice($source, $start_line, $length));
+		$body       = trim(preg_replace('/\s+/', '', $body));
+
+		return $body;
+	}
+
+	/**
+	 * Get example object of all availble models.
+	 *
+	 * @param  string $modelName
+	 * @param  array  $docData
+	 * @return string
+	 */
+	protected function getModels($modelName, &$docData, $reflectionClass)
+	{
+		if ($modelName && ! Arr::has($docData['models'], $modelName)) {
+			$repo = call_user_func_array("\Core::{$modelName}", []);
+			if (! $repo) {
+				return;
+			}
             
-            $modelClass = get_class($repo->model);
-            $model      = factory($modelClass)->make();
-
-            $property = $reflectionClass->getProperty('modelResource');
-            $property->setAccessible(true);
-            $modelResource = $property->getValue(\App::make($reflectionClass->getName()));
-
-            $relations = [];
-            $relationMethods = ['hasOne', 'hasMany', 'belongsTo', 'belongsToMany', 'morphToMany', 'morphTo'];
-            $reflector = new \ReflectionClass($model);
-            foreach ($reflector->getMethods() as $reflectionMethod) {
-                $body = $this->getMethodBody($reflectionMethod);
-                foreach ($relationMethods as $relationMethod) {
-                    $relation = $reflectionMethod->getName();
-                    if (strpos($body, '$this->' . $relationMethod) && $relation !== 'morphedByMany') {
-                        $relations[] = $relation;
-                        break;
-                    }
-                }
-            }
-
-            $modelResource = new $modelResource($model->load($relations));
-            $modelArr      = $modelResource->toArray([]);
-
-            foreach ($modelArr as $key => $attr) {
-                if (is_object($attr) && property_exists($attr, 'resource') && $attr->resource instanceof \Illuminate\Http\Resources\MissingValue) {
-                    unset($modelArr[$key]);
-                }
-            }
-
-            $docData['models'][$modelName] = json_encode($modelArr, JSON_PRETTY_PRINT);
-        }
-    }
-
-    /**
-     * Get the route response object type.
-     *
-     * @param  string $modelName
-     * @param  string $method
-     * @param  string $returnDocBlock
-     * @return array
-     */
-    protected function getResponseObject($modelName, $method, $returnDocBlock)
-    {
-        $relations = config('core.relations');
-        $relations = Arr::has($relations, $modelName) ? Arr::has($relations[$modelName], $method) ? $relations[$modelName] : false : false;
-        $modelName = call_user_func_array("\Core::{$returnDocBlock}", []) ? $returnDocBlock : $modelName;
-
-        return $relations ? [$modelName => $relations && $relations[$method] ? $relations[$method] : []] : false;
-    }
+			$modelClass = get_class($repo->model);
+			$model      = factory($modelClass)->make();
+
+			$property = $reflectionClass->getProperty('modelResource');
+			$property->setAccessible(true);
+			$modelResource = $property->getValue(\App::make($reflectionClass->getName()));
+
+			$relations = [];
+			$relationMethods = ['hasOne', 'hasMany', 'belongsTo', 'belongsToMany', 'morphToMany', 'morphTo'];
+			$reflector = new \ReflectionClass($model);
+			foreach ($reflector->getMethods() as $reflectionMethod) {
+				$body = $this->getMethodBody($reflectionMethod);
+				foreach ($relationMethods as $relationMethod) {
+					$relation = $reflectionMethod->getName();
+					if (strpos($body, '$this->' . $relationMethod) && $relation !== 'morphedByMany') {
+						$relations[] = $relation;
+						break;
+					}
+				}
+			}
+
+			$modelResource = new $modelResource($model->load($relations));
+			$modelArr      = $modelResource->toArray([]);
+
+			foreach ($modelArr as $key => $attr) {
+				if (is_object($attr) && property_exists($attr, 'resource') && $attr->resource instanceof \Illuminate\Http\Resources\MissingValue) {
+					unset($modelArr[$key]);
+				}
+			}
+
+			$docData['models'][$modelName] = json_encode($modelArr, JSON_PRETTY_PRINT);
+		}
+	}
+
+	/**
+	 * Get the route response object type.
+	 *
+	 * @param  string $modelName
+	 * @param  string $method
+	 * @param  string $returnDocBlock
+	 * @return array
+	 */
+	protected function getResponseObject($modelName, $method, $returnDocBlock)
+	{
+		$relations = config('core.relations');
+		$relations = Arr::has($relations, $modelName) ? Arr::has($relations[$modelName], $method) ? $relations[$modelName] : false : false;
+		$modelName = call_user_func_array("\Core::{$returnDocBlock}", []) ? $returnDocBlock : $modelName;
+
+		return $relations ? [$modelName => $relations && $relations[$method] ? $relations[$method] : []] : false;
+	}
 }

files/Kernel.php

Indentation +32 added lines, -32 removed lines

@@ -11,39 +11,39 @@
 

 class Kernel extends ConsoleKernel

 {

-    /**

-     * The Artisan commands provided by your application.

-     *

-     * @var array

-     */

-    protected $commands = [

-        GenerateDocCommand::class,

-        PassportInstallCommand::class,

-        MakeNotificationsCommand::class,

-        MakeModuleCommand::class

-    ];

+	/**

+	 * The Artisan commands provided by your application.

+	 *

+	 * @var array

+	 */

+	protected $commands = [

+		GenerateDocCommand::class,

+		PassportInstallCommand::class,

+		MakeNotificationsCommand::class,

+		MakeModuleCommand::class

+	];

 

-    /**

-     * Define the application's command schedule.

-     *

-     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule

-     * @return void

-     */

-    protected function schedule(Schedule $schedule)

-    {

-        // $schedule->command('inspire')

-        //          ->hourly();

-    }

+	/**

+	 * Define the application's command schedule.

+	 *

+	 * @param  \Illuminate\Console\Scheduling\Schedule  $schedule

+	 * @return void

+	 */

+	protected function schedule(Schedule $schedule)

+	{

+		// $schedule->command('inspire')

+		//          ->hourly();

+	}

 

-    /**

-     * Register the commands for the application.

-     *

-     * @return void

-     */

-    protected function commands()

-    {

-        $this->load(__DIR__.'/Commands');

+	/**

+	 * Register the commands for the application.

+	 *

+	 * @return void

+	 */

+	protected function commands()

+	{

+		$this->load(__DIR__.'/Commands');

 

-        require base_path('routes/console.php');

-    }

+		require base_path('routes/console.php');

+	}

 }