SherifElfadaly / Laravel-Api-Skeleton

src/Modules/Core/Http/Middleware/CheckPermissions.php

Indentation +58 added lines, -58 removed lines

@@ -11,68 +11,68 @@
 
 class CheckPermissions
 {
-    protected $route;
-    protected $auth;
-    protected $authMiddleware;
-    protected $userService;
-    protected $arr;
+	protected $route;
+	protected $auth;
+	protected $authMiddleware;
+	protected $userService;
+	protected $arr;
     
-    /**
-     * Init new object.
-     *
-     * @param   Route          $route
-     * @param   Auth           $auth
-     * @param   AuthMiddleware $authMiddleware
-     * @param   UserService    $userService
-     * @param   Arr            $arr
-     *
-     * @return  void
-     */
-    public function __construct(Route $route, Auth $auth, AuthMiddleware $authMiddleware, UserService $userService, Arr $arr)
-    {
-        $this->route = $route;
-        $this->auth = $auth;
-        $this->authMiddleware = $authMiddleware;
-        $this->userService = $userService;
-        $this->arr = $arr;
-    }
+	/**
+	 * Init new object.
+	 *
+	 * @param   Route          $route
+	 * @param   Auth           $auth
+	 * @param   AuthMiddleware $authMiddleware
+	 * @param   UserService    $userService
+	 * @param   Arr            $arr
+	 *
+	 * @return  void
+	 */
+	public function __construct(Route $route, Auth $auth, AuthMiddleware $authMiddleware, UserService $userService, Arr $arr)
+	{
+		$this->route = $route;
+		$this->auth = $auth;
+		$this->authMiddleware = $authMiddleware;
+		$this->userService = $userService;
+		$this->arr = $arr;
+	}
 
-    /**
-     * Handle an incoming request.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  \Closure  $next
-     * @return mixed
-     */
-    public function handle($request, Closure $next)
-    {
-        $routeActions        = explode('@', $this->route->currentRouteAction());
-        $reflectionClass     = new \ReflectionClass($routeActions[0]);
-        $classProperties     = $reflectionClass->getDefaultProperties();
-        $skipPermissionCheck = $this->arr->get($classProperties, 'skipPermissionCheck', []);
-        $skipLoginCheck      = $this->arr->get($classProperties, 'skipLoginCheck', []);
-        $modelName           = explode('\\', $routeActions[0]);
-        $modelName           = lcfirst(str_replace('Controller', '', end($modelName)));
-        $permission          = $routeActions[1];
+	/**
+	 * Handle an incoming request.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @param  \Closure  $next
+	 * @return mixed
+	 */
+	public function handle($request, Closure $next)
+	{
+		$routeActions        = explode('@', $this->route->currentRouteAction());
+		$reflectionClass     = new \ReflectionClass($routeActions[0]);
+		$classProperties     = $reflectionClass->getDefaultProperties();
+		$skipPermissionCheck = $this->arr->get($classProperties, 'skipPermissionCheck', []);
+		$skipLoginCheck      = $this->arr->get($classProperties, 'skipLoginCheck', []);
+		$modelName           = explode('\\', $routeActions[0]);
+		$modelName           = lcfirst(str_replace('Controller', '', end($modelName)));
+		$permission          = $routeActions[1];
 
-        $this->auth->shouldUse('api');
-        if (! in_array($permission, $skipLoginCheck)) {
-            $this->authMiddleware->handle($request, function ($request) use ($modelName, $skipPermissionCheck, $permission) {
-                $user             = $this->auth->user();
-                $isPasswordClient = $user->token()->client->password_client;
+		$this->auth->shouldUse('api');
+		if (! in_array($permission, $skipLoginCheck)) {
+			$this->authMiddleware->handle($request, function ($request) use ($modelName, $skipPermissionCheck, $permission) {
+				$user             = $this->auth->user();
+				$isPasswordClient = $user->token()->client->password_client;
     
-                if ($user->blocked) {
-                    \Errors::userIsBlocked();
-                }
+				if ($user->blocked) {
+					\Errors::userIsBlocked();
+				}
     
-                if ($isPasswordClient && (in_array($permission, $skipPermissionCheck) || $this->userService->can($permission, $modelName))) {
-                } elseif (! $isPasswordClient && $user->tokenCan($modelName.'-'.$permission)) {
-                } else {
-                    \Errors::noPermissions();
-                }
-            });
-        }
+				if ($isPasswordClient && (in_array($permission, $skipPermissionCheck) || $this->userService->can($permission, $modelName))) {
+				} elseif (! $isPasswordClient && $user->tokenCan($modelName.'-'.$permission)) {
+				} else {
+					\Errors::noPermissions();
+				}
+			});
+		}
 
-        return $next($request);
-    }
+		return $next($request);
+	}
 }

src/Modules/Core/Resources/Lang/en/errors.php

Indentation +10 added lines, -10 removed lines

@@ -2,15 +2,15 @@
 
 return [
     
-    /**
-     * Here goes your error messages.
-     */
-    'connectionError'         => 'Connection error',
-    'redisNotRunning'         => 'Your redis notification server is\'t running',
-    'dbQueryError'            => 'Please check the given inputes',
-    'cannotCreateSetting'     => 'Can\'t create setting',
-    'cannotUpdateSettingKey'  => 'Can\'t update setting key',
-    'notFound'                => 'The requested :replace not found',
-    'cannotUploadImage'       => 'Can\'t upload the given image'
+	/**
+	 * Here goes your error messages.
+	 */
+	'connectionError'         => 'Connection error',
+	'redisNotRunning'         => 'Your redis notification server is\'t running',
+	'dbQueryError'            => 'Please check the given inputes',
+	'cannotCreateSetting'     => 'Can\'t create setting',
+	'cannotUpdateSettingKey'  => 'Can\'t update setting key',
+	'notFound'                => 'The requested :replace not found',
+	'cannotUploadImage'       => 'Can\'t upload the given image'
 
 ];

src/Modules/Core/Resources/Lang/ar/errors.php

Indentation +10 added lines, -10 removed lines

@@ -2,15 +2,15 @@
 
 return [
     
-    /**
-     * Here goes your error messages.
-     */
-    'connectionError'         => 'خطأ في الاتصال',
-    'redisNotRunning'         => 'سيرفير الاشعارات لايعمل',
-    'dbQueryError'            => 'خطا في البيانات',
-    'cannotCreateSetting'     => 'لا يمكن اضافة اعدادات',
-    'cannotUpdateSettingKey'  => 'لا يمكن تعديل اعدادات',
-    'notFound'                => 'ال :replace المطلوب غير موجود',
-    'cannotUploadImage'       => 'لا يمكن رفع هذه الصورة'
+	/**
+	 * Here goes your error messages.
+	 */
+	'connectionError'         => 'خطأ في الاتصال',
+	'redisNotRunning'         => 'سيرفير الاشعارات لايعمل',
+	'dbQueryError'            => 'خطا في البيانات',
+	'cannotCreateSetting'     => 'لا يمكن اضافة اعدادات',
+	'cannotUpdateSettingKey'  => 'لا يمكن تعديل اعدادات',
+	'notFound'                => 'ال :replace المطلوب غير موجود',
+	'cannotUploadImage'       => 'لا يمكن رفع هذه الصورة'
 
 ];

src/Modules/Core/Setting.php

Indentation +15 added lines, -15 removed lines

@@ -9,21 +9,21 @@
 class Setting extends Model
 {
 
-    use SoftDeletes;
-    protected $table = 'settings';
-    protected $dates = ['created_at', 'updated_at', 'deleted_at'];
-    protected $hidden = ['deleted_at'];
-    protected $guarded = ['id', 'key'];
-    public $fillable = ['name', 'value'];
+	use SoftDeletes;
+	protected $table = 'settings';
+	protected $dates = ['created_at', 'updated_at', 'deleted_at'];
+	protected $hidden = ['deleted_at'];
+	protected $guarded = ['id', 'key'];
+	public $fillable = ['name', 'value'];
     
-    public function newCollection(array $models = [])
-    {
-        return parent::newCollection($models)->keyBy('key');
-    }
+	public function newCollection(array $models = [])
+	{
+		return parent::newCollection($models)->keyBy('key');
+	}
 
-    public static function boot()
-    {
-        parent::boot();
-        Setting::observe(SettingsObserver::class);
-    }
+	public static function boot()
+	{
+		parent::boot();
+		Setting::observe(SettingsObserver::class);
+	}
 }

src/Modules/Core/BaseClasses/BaseApiController.php

Indentation +95 added lines, -95 removed lines

@@ -9,109 +9,109 @@
 
 class BaseApiController extends Controller
 {
-    /**
-     * Array of eager loaded relations.
-     *
-     * @var array
-     */
-    protected $relations;
+	/**
+	 * Array of eager loaded relations.
+	 *
+	 * @var array
+	 */
+	protected $relations;
 
-    /**
-     * @var object
-     */
-    protected $service;
+	/**
+	 * @var object
+	 */
+	protected $service;
 
-    /**
-     * Path of the model resource.
-     *
-     * @var string
-     */
-    protected $modelResource;
+	/**
+	 * Path of the model resource.
+	 *
+	 * @var string
+	 */
+	protected $modelResource;
 
-    /**
-     * Path of the sotre form request.
-     *
-     * @var string
-     */
-    protected $storeFormRequest;
+	/**
+	 * Path of the sotre form request.
+	 *
+	 * @var string
+	 */
+	protected $storeFormRequest;
 
-    /**
-     * Init new object.
-     *
-     * @param   mixed      $service
-     * @return  void
-     */
-    public function __construct($service)
-    {
-        $this->service = new CachingDecorator($service, \App::make('Illuminate\Contracts\Cache\Repository'));
-    }
+	/**
+	 * Init new object.
+	 *
+	 * @param   mixed      $service
+	 * @return  void
+	 */
+	public function __construct($service)
+	{
+		$this->service = new CachingDecorator($service, \App::make('Illuminate\Contracts\Cache\Repository'));
+	}
 
-    /**
-     * Fetch all records with relations from storage.
-     *
-     * @param Request $request
-     * @return \Illuminate\Http\Response
-     */
-    public function index(Request $request)
-    {
-        return $this->modelResource::collection($this->service->list($request->relations, $request->query(), $request->query('perPage'), $request->query('sortBy'), $request->query('desc'), $request->query('trashed')));
-    }
+	/**
+	 * Fetch all records with relations from storage.
+	 *
+	 * @param Request $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function index(Request $request)
+	{
+		return $this->modelResource::collection($this->service->list($request->relations, $request->query(), $request->query('perPage'), $request->query('sortBy'), $request->query('desc'), $request->query('trashed')));
+	}
 
-    /**
-     * Fetch the single object with relations from storage.
-     *
-     * @param  Request $request
-     * @param  integer $id Id of the requested model.
-     * @return \Illuminate\Http\Response
-     */
-    public function show(Request $request, $id)
-    {
-        return new $this->modelResource($this->service->find($id, $request->relations));
-    }
+	/**
+	 * Fetch the single object with relations from storage.
+	 *
+	 * @param  Request $request
+	 * @param  integer $id Id of the requested model.
+	 * @return \Illuminate\Http\Response
+	 */
+	public function show(Request $request, $id)
+	{
+		return new $this->modelResource($this->service->find($id, $request->relations));
+	}
 
-    /**
-     * Insert the given model to storage.
-     *
-     * @return \Illuminate\Http\Response
-     */
-    public function store()
-    {
-        $data = \App::make($this->storeFormRequest)->validated();
-        return new $this->modelResource($this->service->save($data));
-    }
+	/**
+	 * Insert the given model to storage.
+	 *
+	 * @return \Illuminate\Http\Response
+	 */
+	public function store()
+	{
+		$data = \App::make($this->storeFormRequest)->validated();
+		return new $this->modelResource($this->service->save($data));
+	}
 
-    /**
-     * Update the given model to storage.
-     *
-     * @param integer   $id
-     * @return \Illuminate\Http\Response
-     */
-    public function update($id)
-    {
-        $data = \App::make($this->storeFormRequest)->validated();
-        $data['id'] = $id;
-        return new $this->modelResource($this->service->save($data));
-    }
+	/**
+	 * Update the given model to storage.
+	 *
+	 * @param integer   $id
+	 * @return \Illuminate\Http\Response
+	 */
+	public function update($id)
+	{
+		$data = \App::make($this->storeFormRequest)->validated();
+		$data['id'] = $id;
+		return new $this->modelResource($this->service->save($data));
+	}
 
-    /**
-     * Delete by the given id from storage.
-     *
-     * @param  integer $id Id of the deleted model.
-     * @return \Illuminate\Http\Response
-     */
-    public function destroy($id)
-    {
-        return new GeneralResource($this->service->delete($id));
-    }
+	/**
+	 * Delete by the given id from storage.
+	 *
+	 * @param  integer $id Id of the deleted model.
+	 * @return \Illuminate\Http\Response
+	 */
+	public function destroy($id)
+	{
+		return new GeneralResource($this->service->delete($id));
+	}
 
-    /**
-     * Restore the deleted model.
-     *
-     * @param  integer $id Id of the restored model.
-     * @return \Illuminate\Http\Response
-     */
-    public function restore($id)
-    {
-        return new GeneralResource($this->service->restore($id));
-    }
+	/**
+	 * Restore the deleted model.
+	 *
+	 * @param  integer $id Id of the restored model.
+	 * @return \Illuminate\Http\Response
+	 */
+	public function restore($id)
+	{
+		return new GeneralResource($this->service->restore($id));
+	}
 }

src/Modules/Core/Database/Migrations/2016_01_24_123630_settings.php

Indentation +25 added lines, -25 removed lines

@@ -5,30 +5,30 @@
 
 class Settings extends Migration
 {
-    /**
-     * Run the migrations.
-     *
-     * @return void
-     */
-    public function up()
-    {
-        Schema::create('settings', function (Blueprint $table) {
-            increments('id');
-            $table->string('name', 100);
-            $table->string('key', 100)->unique();
-            $table->text('value')->nullable();
-            $table->softDeletes();
-            $table->timestamps();
-        });
-    }
+	/**
+	 * Run the migrations.
+	 *
+	 * @return void
+	 */
+	public function up()
+	{
+		Schema::create('settings', function (Blueprint $table) {
+			increments('id');
+			$table->string('name', 100);
+			$table->string('key', 100)->unique();
+			$table->text('value')->nullable();
+			$table->softDeletes();
+			$table->timestamps();
+		});
+	}
 
-    /**
-     * Reverse the migrations.
-     *
-     * @return void
-     */
-    public function down()
-    {
-        Schema::dropIfExists('settings');
-    }
+	/**
+	 * Reverse the migrations.
+	 *
+	 * @return void
+	 */
+	public function down()
+	{
+		Schema::dropIfExists('settings');
+	}
 }

src/Modules/Core/Utl/Media.php

Indentation +59 added lines, -59 removed lines

@@ -4,70 +4,70 @@
 
 class Media
 {
-    /**
-     * Upload the given image.
-     *
-     * @param  object  $image
-     * @param  string  $dir
-     * @return string
-     */
-    public function uploadImage($image, $dir)
-    {
-        $image = \Image::make($image);
-        return $this->saveImage($image, $dir);
-    }
+	/**
+	 * Upload the given image.
+	 *
+	 * @param  object  $image
+	 * @param  string  $dir
+	 * @return string
+	 */
+	public function uploadImage($image, $dir)
+	{
+		$image = \Image::make($image);
+		return $this->saveImage($image, $dir);
+	}
 
-    /**
-     * Upload the given image.
-     *
-     * @param  object  $image
-     * @param  string  $dir
-     * @return string
-     */
-    public function uploadImageBas64($image, $dir)
-    {
-        if (! strlen($image)) {
-            return null;
-        }
+	/**
+	 * Upload the given image.
+	 *
+	 * @param  object  $image
+	 * @param  string  $dir
+	 * @return string
+	 */
+	public function uploadImageBas64($image, $dir)
+	{
+		if (! strlen($image)) {
+			return null;
+		}
 
-        if(filter_var($image, FILTER_VALIDATE_URL)) {
-            return $image;
-        }
+		if(filter_var($image, FILTER_VALIDATE_URL)) {
+			return $image;
+		}
         
-        try {
-            $base  = base64_decode(preg_replace('#^data:image/\w+;base64,#i', '', $image));
-            $image = \Image::make($base);
-        } catch (\Exception $e) {
-            \Errors::cannotUploadImage();
-        }
+		try {
+			$base  = base64_decode(preg_replace('#^data:image/\w+;base64,#i', '', $image));
+			$image = \Image::make($base);
+		} catch (\Exception $e) {
+			\Errors::cannotUploadImage();
+		}
 
-        return $this->saveImage($image, $dir);
-    }
+		return $this->saveImage($image, $dir);
+	}
 
-    /**
-     * Delete the given image.
-     *
-     * @param  object $path
-     * @return void
-     */
-    public function deleteImage($path)
-    {
-        \Storage::delete($path);
-    }
+	/**
+	 * Delete the given image.
+	 *
+	 * @param  object $path
+	 * @return void
+	 */
+	public function deleteImage($path)
+	{
+		\Storage::delete($path);
+	}
 
-    /**
-     * Save the given image.
-     *
-     * @param  object  $image
-     * @param  string  $dir
-     * @return string
-     */
-    protected function saveImage($image, $dir)
-    {
-        $imageName = 'image'.uniqid().time().'.jpg';
-        $path      = 'public'.DIRECTORY_SEPARATOR.'uploads'.DIRECTORY_SEPARATOR.$dir.DIRECTORY_SEPARATOR.$imageName;
-        \Storage::put($path, $image->stream());
+	/**
+	 * Save the given image.
+	 *
+	 * @param  object  $image
+	 * @param  string  $dir
+	 * @return string
+	 */
+	protected function saveImage($image, $dir)
+	{
+		$imageName = 'image'.uniqid().time().'.jpg';
+		$path      = 'public'.DIRECTORY_SEPARATOR.'uploads'.DIRECTORY_SEPARATOR.$dir.DIRECTORY_SEPARATOR.$imageName;
+		\Storage::put($path, $image->stream());
 
-        return $path;
-    }
+		return $path;
+	}
 }

src/Modules/Core/Errors/CoreErrors.php

Indentation +34 added lines, -34 removed lines

@@ -4,38 +4,38 @@
 
 class CoreErrors
 {
-    public function connectionError()
-    {
-        abort(500, trans('core::errors.connectionError'));
-    }
-
-    public function redisNotRunning()
-    {
-        abort(500, trans('core::errors.redisNotRunning'));
-    }
-
-    public function dbQueryError()
-    {
-        abort(500, trans('core::errors.dbQueryError'));
-    }
-
-    public function cannotCreateSetting()
-    {
-        abort(400, trans('core::errors.cannotCreateSetting'));
-    }
-
-    public function cannotUpdateSettingKey()
-    {
-        abort(400, trans('core::errors.cannotUpdateSettingKey'));
-    }
-
-    public function notFound($text)
-    {
-        abort(404, trans('core::errors.notFound', ['replace' => $text]));
-    }
-
-    public function cannotUploadImage()
-    {
-        abort(400, trans('core::errors.cannotUploadImage'));
-    }
+	public function connectionError()
+	{
+		abort(500, trans('core::errors.connectionError'));
+	}
+
+	public function redisNotRunning()
+	{
+		abort(500, trans('core::errors.redisNotRunning'));
+	}
+
+	public function dbQueryError()
+	{
+		abort(500, trans('core::errors.dbQueryError'));
+	}
+
+	public function cannotCreateSetting()
+	{
+		abort(400, trans('core::errors.cannotCreateSetting'));
+	}
+
+	public function cannotUpdateSettingKey()
+	{
+		abort(400, trans('core::errors.cannotUpdateSettingKey'));
+	}
+
+	public function notFound($text)
+	{
+		abort(404, trans('core::errors.notFound', ['replace' => $text]));
+	}
+
+	public function cannotUploadImage()
+	{
+		abort(400, trans('core::errors.cannotUploadImage'));
+	}
 }

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

Indentation +301 added lines, -301 removed lines

@@ -8,307 +8,307 @@
 
 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)
-    {
-        $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)
+	{
+		$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;
+	}
 }