SherifElfadaly / Laravel-Api-Skeleton

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

Indentation +223 added lines, -223 removed lines

@@ -7,255 +7,255 @@
 
 class GenerateDoc extends Command
 {
-    /**
-     * The name and signature of the console command.
-     *
-     * @var string
-     */
-    protected $signature = 'doc:generate';
+	/**
+	 * 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';
+	/**
+	 * The console command description.
+	 *
+	 * @var string
+	 */
+	protected $description = 'Generate api documentation';
 
-    /**
-     * Init new object.
-     *
-     * @return  void
-     */
-    public function __construct()
-    {
-        parent::__construct();
-    }
+	/**
+	 * Init new object.
+	 *
+	 * @return  void
+	 */
+	public function __construct()
+	{
+		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)) {
-                    $controller       = $actoinArray[0];
-                    $method           = $actoinArray[1];
-                    $route['name']    = $method !== 'index' ? $method : 'list';
+	/**
+	 * 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)) {
+					$controller       = $actoinArray[0];
+					$method           = $actoinArray[1];
+					$route['name']    = $method !== 'index' ? $method : 'list';
                     
-                    $reflectionClass  = new \ReflectionClass($controller);
-                    $reflectionMethod = $reflectionClass->getMethod($method);
-                    $classProperties  = $reflectionClass->getDefaultProperties();
-                    $skipLoginCheck   = Arr::get($classProperties, 'skipLoginCheck', false);
-                    $validationRules  = Arr::get($classProperties, 'validationRules', false);
+					$reflectionClass  = new \ReflectionClass($controller);
+					$reflectionMethod = $reflectionClass->getMethod($method);
+					$classProperties  = $reflectionClass->getDefaultProperties();
+					$skipLoginCheck   = Arr::get($classProperties, 'skipLoginCheck', false);
+					$validationRules  = Arr::get($classProperties, 'validationRules', false);
 
-                    dd($classProperties);
-                    $this->processDocBlock($route, $reflectionMethod);
-                    $this->getHeaders($route, $method, $skipLoginCheck);
-                    $this->getPostData($route, $reflectionMethod, $validationRules);
+					dd($classProperties);
+					$this->processDocBlock($route, $reflectionMethod);
+					$this->getHeaders($route, $method, $skipLoginCheck);
+					$this->getPostData($route, $reflectionMethod, $validationRules);
 
-                    $route['response'] = $this->getResponseObject($classProperties['model'], $route['name'], $route['returnDocBlock']);
+					$route['response'] = $this->getResponseObject($classProperties['model'], $route['name'], $route['returnDocBlock']);
 
-                    preg_match('/api\/([^#]+)\//iU', $route['uri'], $module);
-                    $docData['modules'][$module[1]][substr($route['prefix'], strlen('/api/'.$module[1].'/') - 1)][] = $route;
+					preg_match('/api\/([^#]+)\//iU', $route['uri'], $module);
+					$docData['modules'][$module[1]][substr($route['prefix'], strlen('/api/'.$module[1].'/') - 1)][] = $route;
 
-                    $this->getModels($classProperties['model'], $docData);
-                }
-            }
-        }
+					$this->getModels($classProperties['model'], $docData);
+				}
+			}
+		}
         
-        $docData['errors']  = $this->getErrors();
-        $docData['reports'] = \Core::reports()->all();
-        \File::put(app_path('Modules/Core/Resources/api.json'), json_encode($docData));
-    }
+		$docData['errors']  = $this->getErrors();
+		$docData['reports'] = \Core::reports()->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();
-    }
+	/**
+	 * 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',
-        'locale'       => 'The language of the returned data: ar, en or all.',
-        'time-zone'    => 'Your locale time zone',
-        ];
+	/**
+	 * 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',
+		'locale'       => '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}';
-        }
-    }
+		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 !== 'request') {
-                $route['parametars'][$param->getVariableName()] = $param->getDescription()->render();
-            }
-        }
-    }
+	/**
+	 * 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 !== 'request') {
+				$route['parametars'][$param->getVariableName()] = $param->getDescription()->render();
+			}
+		}
+	}
 
-    /**
-     * Generate post body for the given route.
-     *
-     * @param  array  &$route
-     * @param  \ReflectionMethod $reflectionMethod
-     * @param  array  $validationRules
-     * @return void
-     */
-    protected function getPostData(&$route, $reflectionMethod, $validationRules)
-    {
-        if ($route['method'] == 'POST') {
-            $body = $this->getMethodBody($reflectionMethod);
+	/**
+	 * Generate post body for the given route.
+	 *
+	 * @param  array  &$route
+	 * @param  \ReflectionMethod $reflectionMethod
+	 * @param  array  $validationRules
+	 * @return void
+	 */
+	protected function getPostData(&$route, $reflectionMethod, $validationRules)
+	{
+		if ($route['method'] == 'POST') {
+			$body = $this->getMethodBody($reflectionMethod);
 
-            preg_match('/\$this->validate\(\$request,([^#]+)\);/iU', $body, $match);
-            if (count($match)) {
-                if ($match[1] == '$this->validationRules') {
-                    $route['body'] = $validationRules;
-                } else {
-                    $route['body'] = eval('return '.str_replace(',\'.$request->get(\'id\')', ',{id}\'', $match[1]).';');
-                }
+			preg_match('/\$this->validate\(\$request,([^#]+)\);/iU', $body, $match);
+			if (count($match)) {
+				if ($match[1] == '$this->validationRules') {
+					$route['body'] = $validationRules;
+				} else {
+					$route['body'] = eval('return '.str_replace(',\'.$request->get(\'id\')', ',{id}\'', $match[1]).';');
+				}
 
-                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);
-                    }
-                }
-            } else {
-                $route['body'] = 'conditions';
-            }
-        }
-    }
+				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);
+					}
+				}
+			} else {
+				$route['body'] = 'conditions';
+			}
+		}
+	}
 
-    /**
-     * Generate application errors.
-     *
-     * @return array
-     */
-    protected function getErrors()
-    {
-        $errors          = [];
-        $reflectionClass = new \ReflectionClass('App\Modules\Core\Utl\ErrorHandler');
-        foreach ($reflectionClass->getMethods() as $method) {
-            $methodName       = $method->name;
-            $reflectionMethod = $reflectionClass->getMethod($methodName);
-            $body             = $this->getMethodBody($reflectionMethod);
+	/**
+	 * Generate application errors.
+	 *
+	 * @return array
+	 */
+	protected function getErrors()
+	{
+		$errors          = [];
+		$reflectionClass = new \ReflectionClass('App\Modules\Core\Utl\ErrorHandler');
+		foreach ($reflectionClass->getMethods() as $method) {
+			$methodName       = $method->name;
+			$reflectionMethod = $reflectionClass->getMethod($methodName);
+			$body             = $this->getMethodBody($reflectionMethod);
 
-            preg_match('/\$error=\[\'status\'=>([^#]+)\,/iU', $body, $match);
+			preg_match('/\$error=\[\'status\'=>([^#]+)\,/iU', $body, $match);
 
-            if (count($match)) {
-                $errors[$match[1]][] = $methodName;
-            }
-        }
+			if (count($match)) {
+				$errors[$match[1]][] = $methodName;
+			}
+		}
 
-        return $errors;
-    }
+		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));
+	/**
+	 * 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;
-    }
+		return $body;
+	}
 
-    /**
-     * Get example object of all availble models.
-     *
-     * @param  string $modelName
-     * @param  array  $docData
-     * @return string
-     */
-    protected function getModels($modelName, &$docData)
-    {
-        if ($modelName && ! Arr::has($docData['models'], $modelName)) {
-            $modelClass = call_user_func_array("\Core::{$modelName}", [])->modelClass;
-            $model      = factory($modelClass)->make();
-            $modelArr   = $model->toArray();
+	/**
+	 * Get example object of all availble models.
+	 *
+	 * @param  string $modelName
+	 * @param  array  $docData
+	 * @return string
+	 */
+	protected function getModels($modelName, &$docData)
+	{
+		if ($modelName && ! Arr::has($docData['models'], $modelName)) {
+			$modelClass = call_user_func_array("\Core::{$modelName}", [])->modelClass;
+			$model      = factory($modelClass)->make();
+			$modelArr   = $model->toArray();
 
-            if ($model->trans && ! $model->trans->count()) {
-                $modelArr['trans'] = [
-                    'en' => factory($modelClass.'Translation')->make()->toArray()
-                ];
-            }
+			if ($model->trans && ! $model->trans->count()) {
+				$modelArr['trans'] = [
+					'en' => factory($modelClass.'Translation')->make()->toArray()
+				];
+			}
 
-            $docData['models'][$modelName] = json_encode($modelArr, JSON_PRETTY_PRINT);
-        }
-    }
+			$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)
-    {
-        $config    = \CoreConfig::getConfig();
-        $relations = Arr::has($config['relations'], $modelName) ? Arr::has($config['relations'][$modelName], $method) ? $config['relations'][$modelName] : false : false;
-        $modelName = call_user_func_array("\Core::{$returnDocBlock}", []) ? $returnDocBlock : $modelName;
+	/**
+	 * Get the route response object type.
+	 *
+	 * @param  string $modelName
+	 * @param  string $method
+	 * @param  string $returnDocBlock
+	 * @return array
+	 */
+	protected function getResponseObject($modelName, $method, $returnDocBlock)
+	{
+		$config    = \CoreConfig::getConfig();
+		$relations = Arr::has($config['relations'], $modelName) ? Arr::has($config['relations'][$modelName], $method) ? $config['relations'][$modelName] : false : false;
+		$modelName = call_user_func_array("\Core::{$returnDocBlock}", []) ? $returnDocBlock : $modelName;
 
-        return $relations ? [$modelName => $relations && $relations[$method] ? $relations[$method] : []] : false;
-    }
+		return $relations ? [$modelName => $relations && $relations[$method] ? $relations[$method] : []] : false;
+	}
 }

src/Modules/Core/Routes/api.php

Indentation +7 added lines, -7 removed lines

@@ -13,11 +13,11 @@
 
 Route::group(['prefix' => 'settings'], function () {
         
-    Route::get('/', 'SettingController@index');
-    Route::get('/{id}', 'SettingController@find');
-    Route::put('/', 'SettingController@update');
-    Route::delete('/{id}', 'SettingController@delete');
-    Route::get('list/deleted', 'SettingController@deleted');
-    Route::patch('restore/{id}', 'SettingController@restore');
-    Route::post('save/many', 'SettingController@saveMany');
+	Route::get('/', 'SettingController@index');
+	Route::get('/{id}', 'SettingController@find');
+	Route::put('/', 'SettingController@update');
+	Route::delete('/{id}', 'SettingController@delete');
+	Route::get('list/deleted', 'SettingController@deleted');
+	Route::patch('restore/{id}', 'SettingController@restore');
+	Route::post('save/many', 'SettingController@saveMany');
 });
\ No newline at end of file

src/Modules/Core/Providers/ModuleServiceProvider.php

Indentation +48 added lines, -48 removed lines

@@ -6,53 +6,53 @@
 
 class ModuleServiceProvider extends ServiceProvider
 {
-    /**
-     * Bootstrap the module services.
-     *
-     * @return void
-     */
-    public function boot()
-    {
-        $this->loadTranslationsFrom(__DIR__.'/../Resources/Lang', 'core');
-        $this->loadViewsFrom(__DIR__.'/../Resources/Views', 'core');
-
-        $this->loadMigrationsFrom(module_path('core', 'Database/Migrations', 'app'));
-        $this->loadFactoriesFrom(module_path('core', 'Database/Factories', 'app'));
-    }
-
-    /**
-     * Register the module services.
-     *
-     * @return void
-     */
-    public function register()
-    {
-        //Bind Core Facade to the Service Container
-        $this->app->singleton('Core', function () {
-            return new \App\Modules\Core\Core;
-        });
-
-        //Bind ErrorHandler Facade to the Service Container
-        $this->app->singleton('ErrorHandler', function () {
-            return new \App\Modules\Core\Utl\ErrorHandler;
-        });
-
-        //Bind CoreConfig Facade to the Service Container
-        $this->app->singleton('CoreConfig', function () {
-            return new \App\Modules\Core\Utl\CoreConfig;
-        });
-
-        //Bind Media Facade to the Service Container
-        $this->app->singleton('Media', function () {
-            return new \App\Modules\Core\Utl\Media;
-        });
-
-        //Bind ApiConsumer Facade to the Service Container
-        $this->app->singleton('ApiConsumer', function () {
-            $app = app();
-            return new \App\Modules\Core\Utl\ApiConsumer($app, $app['request'], $app['router']);
-        });
+	/**
+	 * Bootstrap the module services.
+	 *
+	 * @return void
+	 */
+	public function boot()
+	{
+		$this->loadTranslationsFrom(__DIR__.'/../Resources/Lang', 'core');
+		$this->loadViewsFrom(__DIR__.'/../Resources/Views', 'core');
+
+		$this->loadMigrationsFrom(module_path('core', 'Database/Migrations', 'app'));
+		$this->loadFactoriesFrom(module_path('core', 'Database/Factories', 'app'));
+	}
+
+	/**
+	 * Register the module services.
+	 *
+	 * @return void
+	 */
+	public function register()
+	{
+		//Bind Core Facade to the Service Container
+		$this->app->singleton('Core', function () {
+			return new \App\Modules\Core\Core;
+		});
+
+		//Bind ErrorHandler Facade to the Service Container
+		$this->app->singleton('ErrorHandler', function () {
+			return new \App\Modules\Core\Utl\ErrorHandler;
+		});
+
+		//Bind CoreConfig Facade to the Service Container
+		$this->app->singleton('CoreConfig', function () {
+			return new \App\Modules\Core\Utl\CoreConfig;
+		});
+
+		//Bind Media Facade to the Service Container
+		$this->app->singleton('Media', function () {
+			return new \App\Modules\Core\Utl\Media;
+		});
+
+		//Bind ApiConsumer Facade to the Service Container
+		$this->app->singleton('ApiConsumer', function () {
+			$app = app();
+			return new \App\Modules\Core\Utl\ApiConsumer($app, $app['request'], $app['router']);
+		});
         
-        $this->app->register(RouteServiceProvider::class);
-    }
+		$this->app->register(RouteServiceProvider::class);
+	}
 }

src/Modules/Core/Decorators/CachingDecorator.php

Indentation +100 added lines, -100 removed lines

@@ -5,116 +5,116 @@
 
 class CachingDecorator
 {
-    /**
-     * The repo implementation.
-     *
-     * @var string
-     */
-    public $repo;
+	/**
+	 * The repo implementation.
+	 *
+	 * @var string
+	 */
+	public $repo;
 
-    /**
-     * The cache implementation.
-     *
-     * @var object
-     */
-    protected $cache;
+	/**
+	 * The cache implementation.
+	 *
+	 * @var object
+	 */
+	protected $cache;
 
-    /**
-     * The modelKey implementation.
-     *
-     * @var string
-     */
-    public $modelKey;
+	/**
+	 * The modelKey implementation.
+	 *
+	 * @var string
+	 */
+	public $modelKey;
 
-    /**
-     * The model implementation.
-     *
-     * @var string
-     */
-    public $model;
+	/**
+	 * The model implementation.
+	 *
+	 * @var string
+	 */
+	public $model;
 
-    /**
-     * The modelClass implementation.
-     *
-     * @var string
-     */
-    public $modelClass;
+	/**
+	 * The modelClass implementation.
+	 *
+	 * @var string
+	 */
+	public $modelClass;
 
-    /**
-     * The cacheConfig implementation.
-     *
-     * @var mixed
-     */
-    public $cacheConfig;
+	/**
+	 * The cacheConfig implementation.
+	 *
+	 * @var mixed
+	 */
+	public $cacheConfig;
 
-    /**
-     * The cacheTag implementation.
-     *
-     * @var string
-     */
-    public $cacheTag;
+	/**
+	 * The cacheTag implementation.
+	 *
+	 * @var string
+	 */
+	public $cacheTag;
     
-    /**
-     * Init new object.
-     *
-     * @param  string $repo
-     * @param  Cache  $cache
-     *
-     * @return  void
-     */
-    public function __construct($repo, Cache $cache)
-    {
-        $this->repo       = $repo;
-        $this->cache      = $cache;
-        $this->model      = $this->repo->model;
-        $this->modelClass = get_class($this->model);
-        $repoClass        = explode('\\', get_class($this->repo));
-        $repoName         = end($repoClass);
-        $this->cacheTag   = lcfirst(substr($repoName, 0, strpos($repoName, 'Repository')));
-    }
+	/**
+	 * Init new object.
+	 *
+	 * @param  string $repo
+	 * @param  Cache  $cache
+	 *
+	 * @return  void
+	 */
+	public function __construct($repo, Cache $cache)
+	{
+		$this->repo       = $repo;
+		$this->cache      = $cache;
+		$this->model      = $this->repo->model;
+		$this->modelClass = get_class($this->model);
+		$repoClass        = explode('\\', get_class($this->repo));
+		$repoName         = end($repoClass);
+		$this->cacheTag   = lcfirst(substr($repoName, 0, strpos($repoName, 'Repository')));
+	}
 
-    /**
-     * Handle the cache mechanism for the called method
-     * based the configurations.
-     *
-     * @param  string $name the called method name
-     * @param  array  $arguments the method arguments
-     * @return object
-     */
-    public function __call($name, $arguments)
-    {
-        $this->setCacheConfig($name);
+	/**
+	 * Handle the cache mechanism for the called method
+	 * based the configurations.
+	 *
+	 * @param  string $name the called method name
+	 * @param  array  $arguments the method arguments
+	 * @return object
+	 */
+	public function __call($name, $arguments)
+	{
+		$this->setCacheConfig($name);
 
-        if ($this->cacheConfig && $this->cacheConfig == 'cache') {
-            $page     = \Request::get('page') !== null ? \Request::get('page') : '1';
-            $cacheKey = $name.$page.\Session::get('locale').serialize($arguments);
-            return $this->cache->tags([$this->cacheTag])->rememberForever($cacheKey, function () use ($arguments, $name) {
-                return call_user_func_array([$this->repo, $name], $arguments);
-            });
-        } elseif ($this->cacheConfig) {
-            $this->cache->tags($this->cacheConfig)->flush();
-            return call_user_func_array([$this->repo, $name], $arguments);
-        }
+		if ($this->cacheConfig && $this->cacheConfig == 'cache') {
+			$page     = \Request::get('page') !== null ? \Request::get('page') : '1';
+			$cacheKey = $name.$page.\Session::get('locale').serialize($arguments);
+			return $this->cache->tags([$this->cacheTag])->rememberForever($cacheKey, function () use ($arguments, $name) {
+				return call_user_func_array([$this->repo, $name], $arguments);
+			});
+		} elseif ($this->cacheConfig) {
+			$this->cache->tags($this->cacheConfig)->flush();
+			return call_user_func_array([$this->repo, $name], $arguments);
+		}
 
-        return call_user_func_array([$this->repo, $name], $arguments);
-    }
+		return call_user_func_array([$this->repo, $name], $arguments);
+	}
 
-    /**
-     * Set cache config based on the called method.
-     *
-     * @param  string $name
-     * @return void
-     */
-    private function setCacheConfig($name)
-    {
-        $config            = \CoreConfig::getConfig();
-        $cacheConfig       = Arr::get($config['cacheConfig'], $this->cacheTag, false);
-        $this->cacheConfig = false;
+	/**
+	 * Set cache config based on the called method.
+	 *
+	 * @param  string $name
+	 * @return void
+	 */
+	private function setCacheConfig($name)
+	{
+		$config            = \CoreConfig::getConfig();
+		$cacheConfig       = Arr::get($config['cacheConfig'], $this->cacheTag, false);
+		$this->cacheConfig = false;
 
-        if ($cacheConfig && in_array($name, $cacheConfig['cache'])) {
-            $this->cacheConfig = 'cache';
-        } elseif ($cacheConfig && isset($cacheConfig['clear'][$name])) {
-            $this->cacheConfig = $cacheConfig['clear'][$name];
-        }
-    }
+		if ($cacheConfig && in_array($name, $cacheConfig['cache'])) {
+			$this->cacheConfig = 'cache';
+		} elseif ($cacheConfig && isset($cacheConfig['clear'][$name])) {
+			$this->cacheConfig = $cacheConfig['clear'][$name];
+		}
+	}
 }

src/Modules/Core/BaseClasses/BaseApiController.php

Indentation +199 added lines, -199 removed lines

@@ -10,204 +10,204 @@
 
 class BaseApiController extends Controller
 {
-    /**
-     * The config implementation.
-     *
-     * @var array
-     */
-    protected $config;
-
-    /**
-     * The relations implementation.
-     *
-     * @var array
-     */
-    protected $relations;
-
-    /**
-     * The repo implementation.
-     *
-     * @var object
-     */
-    protected $repo;
-
-    /**
-     * Init new object.
-     *
-     * @param   mixed      $repo
-     * @param   CoreConfig $config
-     * @param   string     $modelResource
-     * @return  void
-     */
-    public function __construct($repo, $config, $modelResource)
-    {
-        $this->repo = new CachingDecorator($repo, \App::make('Illuminate\Contracts\Cache\Repository'));
-        $this->modelResource = $modelResource;
-        $this->config = $config->getConfig();
-        $this->modelName = explode('\\', get_called_class());
-        $this->modelName = lcfirst(str_replace('Controller', '', end($this->modelName)));
-        $this->validationRules = property_exists($this, 'validationRules') ? $this->validationRules : false;
-        $this->skipPermissionCheck = property_exists($this, 'skipPermissionCheck') ? $this->skipPermissionCheck : [];
-        $this->skipLoginCheck = property_exists($this, 'skipLoginCheck') ? $this->skipLoginCheck : [];
-        $route = explode('@', \Route::currentRouteAction())[1];
-
-        $this->setSessions();
-        $this->checkPermission($route);
-        $this->setRelations($route);
-    }
-
-    /**
-     * Fetch all records with relations from storage.
-     *
-     * @param Request $request
-     * @return \Illuminate\Http\Response
-     */
-    public function index(Request $request)
-    {
-        return $this->modelResource::collection($this->repo->list($this->relations, $request->query(), $request->query('perPage'), $request->query('sortBy'), $request->query('desc')));
-    }
-
-    /**
-     * Fetch the single object with relations from storage.
-     *
-     * @param  integer $id Id of the requested model.
-     * @return \Illuminate\Http\Response
-     */
-    public function find($id)
-    {
-        return new $this->modelResource($this->repo->find($id, $this->relations));
-    }
-
-    /**
-     * Delete by the given id from storage.
-     *
-     * @param  integer $id Id of the deleted model.
-     * @return \Illuminate\Http\Response
-     */
-    public function delete($id)
-    {
-        return new GeneralResource($this->repo->delete($id));
-    }
-
-    /**
-     * Return the deleted models in pages based on the given conditions.
-     *
-     * @param Request $request
-     * @return \Illuminate\Http\Response
-     */
-    public function deleted(Request $request)
-    {
-        return $this->modelResource::collection($this->repo->deleted($request->all(), $request->query('perPage'), $request->query('sortBy'), $request->query('desc')));
-    }
-
-    /**
-     * Restore the deleted model.
-     *
-     * @param  integer $id Id of the restored model.
-     * @return \Illuminate\Http\Response
-     */
-    public function restore($id)
-    {
-        return new GeneralResource($this->repo->restore($id));
-    }
-
-    /**
-     * Check if the logged in user can do the given permission.
-     *
-     * @param  string $permission
-     * @return void
-     */
-    private function checkPermission($permission)
-    {
-        \Auth::shouldUse('api');
-        $this->middleware('auth:api', ['except' => $this->skipLoginCheck]);
+	/**
+	 * The config implementation.
+	 *
+	 * @var array
+	 */
+	protected $config;
+
+	/**
+	 * The relations implementation.
+	 *
+	 * @var array
+	 */
+	protected $relations;
+
+	/**
+	 * The repo implementation.
+	 *
+	 * @var object
+	 */
+	protected $repo;
+
+	/**
+	 * Init new object.
+	 *
+	 * @param   mixed      $repo
+	 * @param   CoreConfig $config
+	 * @param   string     $modelResource
+	 * @return  void
+	 */
+	public function __construct($repo, $config, $modelResource)
+	{
+		$this->repo = new CachingDecorator($repo, \App::make('Illuminate\Contracts\Cache\Repository'));
+		$this->modelResource = $modelResource;
+		$this->config = $config->getConfig();
+		$this->modelName = explode('\\', get_called_class());
+		$this->modelName = lcfirst(str_replace('Controller', '', end($this->modelName)));
+		$this->validationRules = property_exists($this, 'validationRules') ? $this->validationRules : false;
+		$this->skipPermissionCheck = property_exists($this, 'skipPermissionCheck') ? $this->skipPermissionCheck : [];
+		$this->skipLoginCheck = property_exists($this, 'skipLoginCheck') ? $this->skipLoginCheck : [];
+		$route = explode('@', \Route::currentRouteAction())[1];
+
+		$this->setSessions();
+		$this->checkPermission($route);
+		$this->setRelations($route);
+	}
+
+	/**
+	 * Fetch all records with relations from storage.
+	 *
+	 * @param Request $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function index(Request $request)
+	{
+		return $this->modelResource::collection($this->repo->list($this->relations, $request->query(), $request->query('perPage'), $request->query('sortBy'), $request->query('desc')));
+	}
+
+	/**
+	 * Fetch the single object with relations from storage.
+	 *
+	 * @param  integer $id Id of the requested model.
+	 * @return \Illuminate\Http\Response
+	 */
+	public function find($id)
+	{
+		return new $this->modelResource($this->repo->find($id, $this->relations));
+	}
+
+	/**
+	 * Delete by the given id from storage.
+	 *
+	 * @param  integer $id Id of the deleted model.
+	 * @return \Illuminate\Http\Response
+	 */
+	public function delete($id)
+	{
+		return new GeneralResource($this->repo->delete($id));
+	}
+
+	/**
+	 * Return the deleted models in pages based on the given conditions.
+	 *
+	 * @param Request $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function deleted(Request $request)
+	{
+		return $this->modelResource::collection($this->repo->deleted($request->all(), $request->query('perPage'), $request->query('sortBy'), $request->query('desc')));
+	}
+
+	/**
+	 * Restore the deleted model.
+	 *
+	 * @param  integer $id Id of the restored model.
+	 * @return \Illuminate\Http\Response
+	 */
+	public function restore($id)
+	{
+		return new GeneralResource($this->repo->restore($id));
+	}
+
+	/**
+	 * Check if the logged in user can do the given permission.
+	 *
+	 * @param  string $permission
+	 * @return void
+	 */
+	private function checkPermission($permission)
+	{
+		\Auth::shouldUse('api');
+		$this->middleware('auth:api', ['except' => $this->skipLoginCheck]);
         
-        if (! in_array($permission, $this->skipLoginCheck) && $user = \Auth::user()) {
-            $user             = \Auth::user();
-            $isPasswordClient = $user->token()->client->password_client;
-            $this->updateLocaleAndTimezone($user);
-
-            if ($user->blocked) {
-                \ErrorHandler::userIsBlocked();
-            }
-
-            if ($isPasswordClient && (in_array($permission, $this->skipPermissionCheck) || \Core::users()->can($permission, $this->modelName))) {
-            } elseif (! $isPasswordClient && $user->tokenCan($this->modelName.'-'.$permission)) {
-            } else {
-                \ErrorHandler::noPermissions();
-            }
-        }
-    }
-
-    /**
-     * Set sessions based on the given headers in the request.
-     *
-     * @return void
-     */
-    private function setSessions()
-    {
-        \Session::put('time-zone', \Request::header('time-zone') ?: 0);
-
-        $locale = \Request::header('locale');
-        switch ($locale) {
-            case 'en':
-                \App::setLocale('en');
-                \Session::put('locale', 'en');
-                break;
-
-            case 'ar':
-                \App::setLocale('ar');
-                \Session::put('locale', 'ar');
-                break;
-
-            case 'all':
-                \App::setLocale('en');
-                \Session::put('locale', 'all');
-                break;
-
-            default:
-                \App::setLocale('en');
-                \Session::put('locale', 'en');
-                break;
-        }
-    }
-
-    /**
-     * Set relation based on the called api.
-     *
-     * @param  string $route
-     * @return void
-     */
-    private function setRelations($route)
-    {
-        $route           = $route !== 'index' ? $route : 'list';
-        $relations       = Arr::get($this->config['relations'], $this->modelName, false);
-        $this->relations = $relations && isset($relations[$route]) ? $relations[$route] : [];
-    }
-
-    /**
-     * Update the logged in user locale and time zone.
-     *
-     * @param  object $user
-     * @return void
-     */
-    private function updateLocaleAndTimezone($user)
-    {
-        $update   = false;
-        $locale   = \Session::get('locale');
-        $timezone = \Session::get('time-zone');
-        if ($locale && $locale !== 'all' && $locale !== $user->locale) {
-            $user->locale = $locale;
-            $update       = true;
-        }
-
-        if ($timezone && $timezone !== $user->timezone) {
-            $user->timezone = $timezone;
-            $update       = true;
-        }
-
-        if ($update) {
-            $user->save();
-        }
-    }
+		if (! in_array($permission, $this->skipLoginCheck) && $user = \Auth::user()) {
+			$user             = \Auth::user();
+			$isPasswordClient = $user->token()->client->password_client;
+			$this->updateLocaleAndTimezone($user);
+
+			if ($user->blocked) {
+				\ErrorHandler::userIsBlocked();
+			}
+
+			if ($isPasswordClient && (in_array($permission, $this->skipPermissionCheck) || \Core::users()->can($permission, $this->modelName))) {
+			} elseif (! $isPasswordClient && $user->tokenCan($this->modelName.'-'.$permission)) {
+			} else {
+				\ErrorHandler::noPermissions();
+			}
+		}
+	}
+
+	/**
+	 * Set sessions based on the given headers in the request.
+	 *
+	 * @return void
+	 */
+	private function setSessions()
+	{
+		\Session::put('time-zone', \Request::header('time-zone') ?: 0);
+
+		$locale = \Request::header('locale');
+		switch ($locale) {
+			case 'en':
+				\App::setLocale('en');
+				\Session::put('locale', 'en');
+				break;
+
+			case 'ar':
+				\App::setLocale('ar');
+				\Session::put('locale', 'ar');
+				break;
+
+			case 'all':
+				\App::setLocale('en');
+				\Session::put('locale', 'all');
+				break;
+
+			default:
+				\App::setLocale('en');
+				\Session::put('locale', 'en');
+				break;
+		}
+	}
+
+	/**
+	 * Set relation based on the called api.
+	 *
+	 * @param  string $route
+	 * @return void
+	 */
+	private function setRelations($route)
+	{
+		$route           = $route !== 'index' ? $route : 'list';
+		$relations       = Arr::get($this->config['relations'], $this->modelName, false);
+		$this->relations = $relations && isset($relations[$route]) ? $relations[$route] : [];
+	}
+
+	/**
+	 * Update the logged in user locale and time zone.
+	 *
+	 * @param  object $user
+	 * @return void
+	 */
+	private function updateLocaleAndTimezone($user)
+	{
+		$update   = false;
+		$locale   = \Session::get('locale');
+		$timezone = \Session::get('time-zone');
+		if ($locale && $locale !== 'all' && $locale !== $user->locale) {
+			$user->locale = $locale;
+			$update       = true;
+		}
+
+		if ($timezone && $timezone !== $user->timezone) {
+			$user->timezone = $timezone;
+			$update       = true;
+		}
+
+		if ($update) {
+			$user->save();
+		}
+	}
 }

src/Modules/Core/Http/Resources/Setting.php

Indentation +26 added lines, -26 removed lines

@@ -6,32 +6,32 @@
 
 class Setting extends JsonResource
 {
-    /**
-     * Indicates if the resource's collection keys should be preserved.
-     *
-     * @var bool
-     */
-    public $preserveKeys = true;
+	/**
+	 * Indicates if the resource's collection keys should be preserved.
+	 *
+	 * @var bool
+	 */
+	public $preserveKeys = true;
 
-    /**
-     * Transform the resource into an array.
-     *
-     * @param Request $request
-     * @return array
-     */
-    public function toArray($request)
-    {
-        if (! $this->resource) {
-            return [];
-        }
+	/**
+	 * Transform the resource into an array.
+	 *
+	 * @param Request $request
+	 * @return array
+	 */
+	public function toArray($request)
+	{
+		if (! $this->resource) {
+			return [];
+		}
 
-        return [
-            'id' => $this->id,
-            'name' => $this->name,
-            'value' => $this->value,
-            'key' => $this->key,
-            'created_at' => $this->created_at,
-            'updated_at' => $this->updated_at,
-        ];
-    }
+		return [
+			'id' => $this->id,
+			'name' => $this->name,
+			'value' => $this->value,
+			'key' => $this->key,
+			'created_at' => $this->created_at,
+			'updated_at' => $this->updated_at,
+		];
+	}
 }

src/Modules/Reporting/Routes/api.php

Indentation +8 added lines, -8 removed lines

@@ -13,12 +13,12 @@
 
 Route::group(['prefix' => 'reports'], function () {
         
-    Route::get('/', 'ReportController@index');
-    Route::get('/{id}', 'ReportController@find');
-    Route::post('/', 'ReportController@insert');
-    Route::put('/', 'ReportController@update');
-    Route::delete('/{id}', 'ReportController@delete');
-    Route::get('list/deleted', 'ReportController@deleted');
-    Route::patch('restore/{id}', 'ReportController@restore');
-    Route::post('get/{reportName}', 'ReportController@getReport');
+	Route::get('/', 'ReportController@index');
+	Route::get('/{id}', 'ReportController@find');
+	Route::post('/', 'ReportController@insert');
+	Route::put('/', 'ReportController@update');
+	Route::delete('/{id}', 'ReportController@delete');
+	Route::get('list/deleted', 'ReportController@deleted');
+	Route::patch('restore/{id}', 'ReportController@restore');
+	Route::post('get/{reportName}', 'ReportController@getReport');
 });
\ No newline at end of file

src/Modules/Reporting/Providers/ModuleServiceProvider.php

Indentation +21 added lines, -21 removed lines

@@ -6,27 +6,27 @@
 
 class ModuleServiceProvider extends ServiceProvider
 {
-    /**
-     * Bootstrap the module services.
-     *
-     * @return void
-     */
-    public function boot()
-    {
-        $this->loadTranslationsFrom(__DIR__.'/../Resources/Lang', 'reporting');
-        $this->loadViewsFrom(__DIR__.'/../Resources/Views', 'reporting');
+	/**
+	 * Bootstrap the module services.
+	 *
+	 * @return void
+	 */
+	public function boot()
+	{
+		$this->loadTranslationsFrom(__DIR__.'/../Resources/Lang', 'reporting');
+		$this->loadViewsFrom(__DIR__.'/../Resources/Views', 'reporting');
 
-        $this->loadMigrationsFrom(module_path('reporting', 'Database/Migrations', 'app'));
-        $this->loadFactoriesFrom(module_path('reporting', 'Database/Factories', 'app'));
-    }
+		$this->loadMigrationsFrom(module_path('reporting', 'Database/Migrations', 'app'));
+		$this->loadFactoriesFrom(module_path('reporting', 'Database/Factories', 'app'));
+	}
 
-    /**
-     * Register the module services.
-     *
-     * @return void
-     */
-    public function register()
-    {
-        $this->app->register(RouteServiceProvider::class);
-    }
+	/**
+	 * Register the module services.
+	 *
+	 * @return void
+	 */
+	public function register()
+	{
+		$this->app->register(RouteServiceProvider::class);
+	}
 }

src/Modules/Reporting/Http/Resources/Report.php

Indentation +19 added lines, -19 removed lines

@@ -6,24 +6,24 @@
 
 class Report extends JsonResource
 {
-    /**
-     * Transform the resource into an array.
-     *
-     * @param Request $request
-     * @return array
-     */
-    public function toArray($request)
-    {
-        if (! $this->resource) {
-            return [];
-        }
+	/**
+	 * Transform the resource into an array.
+	 *
+	 * @param Request $request
+	 * @return array
+	 */
+	public function toArray($request)
+	{
+		if (! $this->resource) {
+			return [];
+		}
 
-        return [
-            'id' => $this->id,
-            'report_name' => $this->report_name,
-            'view_name' => $this->view_name,
-            'created_at' => $this->created_at,
-            'updated_at' => $this->updated_at,
-        ];
-    }
+		return [
+			'id' => $this->id,
+			'report_name' => $this->report_name,
+			'view_name' => $this->view_name,
+			'created_at' => $this->created_at,
+			'updated_at' => $this->updated_at,
+		];
+	}
 }