SherifElfadaly / Laravel-Api-Skeleton

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

Indentation +248 added lines, -248 removed lines

@@ -6,283 +6,283 @@
 
 class BaseApiController extends Controller
 {
-    /**
-     * The config implementation.
-     * 
-     * @var array
-     */
-    protected $config;
+	/**
+	 * The config implementation.
+	 * 
+	 * @var array
+	 */
+	protected $config;
 
-    /**
-     * The relations implementation.
-     * 
-     * @var array
-     */
-    protected $relations;
+	/**
+	 * The relations implementation.
+	 * 
+	 * @var array
+	 */
+	protected $relations;
 
-    /**
-     * The repo implementation.
-     * 
-     * @var object
-     */
-    protected $repo;
+	/**
+	 * The repo implementation.
+	 * 
+	 * @var object
+	 */
+	protected $repo;
 
-    public function __construct()
-    {        
-        $this->config              = \CoreConfig::getConfig();
-        $this->model               = property_exists($this, 'model') ? $this->model : false;
-        $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];
+	public function __construct()
+	{        
+		$this->config              = \CoreConfig::getConfig();
+		$this->model               = property_exists($this, 'model') ? $this->model : false;
+		$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->middleware(function ($request, $next) {
+		$this->middleware(function ($request, $next) {
             
-            $this->repo = call_user_func_array("\Core::{$this->model}", []);            
-            return $next($request);
-        });
+			$this->repo = call_user_func_array("\Core::{$this->model}", []);            
+			return $next($request);
+		});
 
-        $this->checkPermission($route);
-        $this->setRelations($route);
-        $this->setSessions();
-    }
+		$this->checkPermission($route);
+		$this->setRelations($route);
+		$this->setSessions();
+	}
 
-    /**
-     * Fetch all records with relations from storage.
-     * 
-     * @param  string  $sortBy The name of the column to sort by.
-     * @param  boolean $desc   Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
-     */
-    public function index($sortBy = 'created_at', $desc = 1) 
-    {
-        return \Response::json($this->repo->all($this->relations, $sortBy, $desc), 200);
-    }
+	/**
+	 * Fetch all records with relations from storage.
+	 * 
+	 * @param  string  $sortBy The name of the column to sort by.
+	 * @param  boolean $desc   Sort ascending or descinding (1: desc, 0: asc).
+	 * @return \Illuminate\Http\Response
+	 */
+	public function index($sortBy = 'created_at', $desc = 1) 
+	{
+		return \Response::json($this->repo->all($this->relations, $sortBy, $desc), 200);
+	}
 
-    /**
-     * 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 \Response::json($this->repo->find($id, $this->relations), 200);
-    }
+	/**
+	 * 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 \Response::json($this->repo->find($id, $this->relations), 200);
+	}
 
-    /**
-     * Paginate all records with relations from storage
-     * that matche the given query.
-     * 
-     * @param  string  $query   The search text.
-     * @param  integer $perPage Number of rows per page default 15.
-     * @param  string  $sortBy  The name of the column to sort by.
-     * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
-     */
-    public function search($query = '', $perPage = 15, $sortBy = 'created_at', $desc = 1) 
-    {
-        return \Response::json($this->repo->search($query, $perPage, $this->relations, $sortBy, $desc), 200);
-    }
+	/**
+	 * Paginate all records with relations from storage
+	 * that matche the given query.
+	 * 
+	 * @param  string  $query   The search text.
+	 * @param  integer $perPage Number of rows per page default 15.
+	 * @param  string  $sortBy  The name of the column to sort by.
+	 * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
+	 * @return \Illuminate\Http\Response
+	 */
+	public function search($query = '', $perPage = 15, $sortBy = 'created_at', $desc = 1) 
+	{
+		return \Response::json($this->repo->search($query, $perPage, $this->relations, $sortBy, $desc), 200);
+	}
 
-    /**
-     * Fetch records from the storage based on the given
-     * condition.
-     * 
-     * @param  \Illuminate\Http\Request  $request
-     * @param  string  $sortBy The name of the column to sort by.
-     * @param  boolean $desc   Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
-     */
-    public function findby(Request $request, $sortBy = 'created_at', $desc = 1) 
-    {
-        return \Response::json($this->repo->findBy($request->all(), $this->relations, $sortBy, $desc), 200);
-    }
+	/**
+	 * Fetch records from the storage based on the given
+	 * condition.
+	 * 
+	 * @param  \Illuminate\Http\Request  $request
+	 * @param  string  $sortBy The name of the column to sort by.
+	 * @param  boolean $desc   Sort ascending or descinding (1: desc, 0: asc).
+	 * @return \Illuminate\Http\Response
+	 */
+	public function findby(Request $request, $sortBy = 'created_at', $desc = 1) 
+	{
+		return \Response::json($this->repo->findBy($request->all(), $this->relations, $sortBy, $desc), 200);
+	}
 
-    /**
-     * Fetch the first record from the storage based on the given
-     * condition.
-     * 
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function first(Request $request) 
-    {
-        return \Response::json($this->repo->first($request->all(), $this->relations), 200);
-    }
+	/**
+	 * Fetch the first record from the storage based on the given
+	 * condition.
+	 * 
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function first(Request $request) 
+	{
+		return \Response::json($this->repo->first($request->all(), $this->relations), 200);
+	}
 
-    /**
-     * Paginate all records with relations from storage.
-     * 
-     * @param  integer $perPage Number of rows per page default 15.
-     * @param  string  $sortBy  The name of the column to sort by.
-     * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
-     */
-    public function paginate($perPage = 15, $sortBy = 'created_at', $desc = 1) 
-    {
-        return \Response::json($this->repo->paginate($perPage, $this->relations, $sortBy, $desc), 200);
-    }
+	/**
+	 * Paginate all records with relations from storage.
+	 * 
+	 * @param  integer $perPage Number of rows per page default 15.
+	 * @param  string  $sortBy  The name of the column to sort by.
+	 * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
+	 * @return \Illuminate\Http\Response
+	 */
+	public function paginate($perPage = 15, $sortBy = 'created_at', $desc = 1) 
+	{
+		return \Response::json($this->repo->paginate($perPage, $this->relations, $sortBy, $desc), 200);
+	}
 
-    /**
-     * Fetch all records with relations based on
-     * the given condition from storage in pages.
-     * 
-     * @param  \Illuminate\Http\Request  $request
-     * @param  integer $perPage Number of rows per page default 15.
-     * @param  string  $sortBy  The name of the column to sort by.
-     * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
-     */
-    public function paginateby(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
-    {
-        return \Response::json($this->repo->paginateBy($request->all(), $perPage, $this->relations, $sortBy, $desc), 200);
-    }
+	/**
+	 * Fetch all records with relations based on
+	 * the given condition from storage in pages.
+	 * 
+	 * @param  \Illuminate\Http\Request  $request
+	 * @param  integer $perPage Number of rows per page default 15.
+	 * @param  string  $sortBy  The name of the column to sort by.
+	 * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
+	 * @return \Illuminate\Http\Response
+	 */
+	public function paginateby(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
+	{
+		return \Response::json($this->repo->paginateBy($request->all(), $perPage, $this->relations, $sortBy, $desc), 200);
+	}
 
-    /**
-     * Save the given model to storage.
-     * 
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function save(Request $request) 
-    {
-        foreach ($this->validationRules as &$rule) 
-        {
-            if (strpos($rule, 'exists') && ! strpos($rule, 'deleted_at,NULL')) 
-            {
-                $rule .= ',deleted_at,NULL';
-            }
+	/**
+	 * Save the given model to storage.
+	 * 
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function save(Request $request) 
+	{
+		foreach ($this->validationRules as &$rule) 
+		{
+			if (strpos($rule, 'exists') && ! strpos($rule, 'deleted_at,NULL')) 
+			{
+				$rule .= ',deleted_at,NULL';
+			}
 
-            if ($request->has('id')) 
-            {
-                $rule = str_replace('{id}', $request->get('id'), $rule);
-            }
-            else
-            {
-                $rule = str_replace(',{id}', '', $rule);
-            }
-        }
+			if ($request->has('id')) 
+			{
+				$rule = str_replace('{id}', $request->get('id'), $rule);
+			}
+			else
+			{
+				$rule = str_replace(',{id}', '', $rule);
+			}
+		}
         
-        $this->validate($request, $this->validationRules);
+		$this->validate($request, $this->validationRules);
 
-        return \Response::json($this->repo->save($request->all()), 200);
-    }
+		return \Response::json($this->repo->save($request->all()), 200);
+	}
 
-    /**
-     * Delete by the given id from storage.
-     * 
-     * @param  integer $id Id of the deleted model.
-     * @return \Illuminate\Http\Response
-     */
-    public function delete($id) 
-    {
-        return \Response::json($this->repo->delete($id), 200);
-    }
+	/**
+	 * Delete by the given id from storage.
+	 * 
+	 * @param  integer $id Id of the deleted model.
+	 * @return \Illuminate\Http\Response
+	 */
+	public function delete($id) 
+	{
+		return \Response::json($this->repo->delete($id), 200);
+	}
 
-    /**
-     * Return the deleted models in pages based on the given conditions.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  integer $perPage Number of rows per page default 15.
-     * @param  string  $sortBy  The name of the column to sort by.
-     * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
-     */
-    public function deleted(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
-    {
-        return \Response::json($this->repo->deleted($request->all(), $perPage, $sortBy, $desc), 200);
-    }
+	/**
+	 * Return the deleted models in pages based on the given conditions.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @param  integer $perPage Number of rows per page default 15.
+	 * @param  string  $sortBy  The name of the column to sort by.
+	 * @param  boolean $desc    Sort ascending or descinding (1: desc, 0: asc).
+	 * @return \Illuminate\Http\Response
+	 */
+	public function deleted(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
+	{
+		return \Response::json($this->repo->deleted($request->all(), $perPage, $sortBy, $desc), 200);
+	}
 
-    /**
-     * Restore the deleted model.
-     * 
-     * @param  integer $id Id of the restored model.
-     * @return \Illuminate\Http\Response
-     */
-    public function restore($id) 
-    {
-        return \Response::json($this->repo->restore($id), 200);
-    }
+	/**
+	 * Restore the deleted model.
+	 * 
+	 * @param  integer $id Id of the restored model.
+	 * @return \Illuminate\Http\Response
+	 */
+	public function restore($id) 
+	{
+		return \Response::json($this->repo->restore($id), 200);
+	}
 
-    /**
-     * 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]);
+	/**
+	 * 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 (\Auth::user() && ! in_array($permission, $this->skipLoginCheck))
-        {
-            $user             = \Auth::user();
-            $permission       = $permission !== 'index' ? $permission : 'list';
-            $isPasswordClient = $user->token()->client->password_client;
+		if (\Auth::user() && ! in_array($permission, $this->skipLoginCheck))
+		{
+			$user             = \Auth::user();
+			$permission       = $permission !== 'index' ? $permission : 'list';
+			$isPasswordClient = $user->token()->client->password_client;
 
-            if ($user->blocked)
-            {
-                \ErrorHandler::userIsBlocked();
-            }
+			if ($user->blocked)
+			{
+				\ErrorHandler::userIsBlocked();
+			}
 
-            if ($isPasswordClient && (in_array($permission, $this->skipPermissionCheck) || \Core::users()->can($permission, $this->model)))
-            {}
-            elseif ( ! $isPasswordClient && $user->tokenCan($this->model . '-' . $permission)) 
-            {}
-            else
-            {
+			if ($isPasswordClient && (in_array($permission, $this->skipPermissionCheck) || \Core::users()->can($permission, $this->model)))
+			{}
+			elseif ( ! $isPasswordClient && $user->tokenCan($this->model . '-' . $permission)) 
+			{}
+			else
+			{
 
-                \ErrorHandler::noPermissions();
-            }
-        }
-    }
+				\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);
+	/**
+	 * 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;
+		$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 'ar':
+			\App::setLocale('ar');
+			\Session::put('locale', 'ar');
+			break;
 
-            case 'all':
-            \App::setLocale('en');
-            \Session::put('locale', 'all');
-            break;
+			case 'all':
+			\App::setLocale('en');
+			\Session::put('locale', 'all');
+			break;
 
-            default:
-            \App::setLocale('en');
-            \Session::put('locale', 'en');
-            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       = array_key_exists($this->model, $this->config['relations']) ? $this->config['relations'][$this->model] : false;
-        $this->relations = $relations && isset($relations[$route]) ? $relations[$route] : [];
-    }
+	/**
+	 * Set relation based on the called api.
+	 * 
+	 * @param  string $route
+	 * @return void
+	 */
+	private function setRelations($route)
+	{
+		$route           = $route !== 'index' ? $route : 'list';
+		$relations       = array_key_exists($this->model, $this->config['relations']) ? $this->config['relations'][$this->model] : false;
+		$this->relations = $relations && isset($relations[$route]) ? $relations[$route] : [];
+	}
 }

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

Indentation +243 added lines, -243 removed lines

@@ -6,275 +6,275 @@
 
 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';
 
-    /**
-     * Create a new command instance.
-     *
-     * @return void
-     */
-    public function __construct()
-    {
-        parent::__construct();
-    }
+	/**
+	 * Create a new command instance.
+	 *
+	 * @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(array_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(array_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   = array_key_exists('skipLoginCheck', $classProperties) ? $classProperties['skipLoginCheck'] : false;
-                    $validationRules  = array_key_exists('validationRules', $classProperties) ? $classProperties['validationRules'] : false;
+					$reflectionClass  = new \ReflectionClass($controller);
+					$reflectionMethod = $reflectionClass->getMethod($method);
+					$classProperties  = $reflectionClass->getDefaultProperties();
+					$skipLoginCheck   = array_key_exists('skipLoginCheck', $classProperties) ? $classProperties['skipLoginCheck'] : false;
+					$validationRules  = array_key_exists('validationRules', $classProperties) ? $classProperties['validationRules'] : false;
 
-                    $this->processDocBlock($route, $reflectionMethod);
-                    $this->getHeaders($route, $method, $skipLoginCheck);
-                    $this->getPostData($route, $reflectionMethod, $validationRules);
+					$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();
-        \File::put(app_path('Modules/Core/Resources/api.json'), json_encode($docData));
-    }
+		$docData['errors'] = $this->getErrors();
+		\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  object $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  object $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  object $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  object $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->getName();
-            $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->getName();
+			$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 && ! array_key_exists($modelName, $docData['models'])) 
-        {
-            $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 && ! array_key_exists($modelName, $docData['models'])) 
+		{
+			$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 = array_key_exists($modelName, $config['relations']) ? array_key_exists($method, $config['relations'][$modelName]) ? $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 = array_key_exists($modelName, $config['relations']) ? array_key_exists($method, $config['relations'][$modelName]) ? $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;
+	}
 }