SherifElfadaly / Laravel-Api-Skeleton

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

Doc Comments +1 added lines, -1 removed lines

@@ -199,7 +199,7 @@
     /**
      * Get the given method body code.
      *
-     * @param  object $reflectionMethod
+     * @param  \ReflectionMethod $reflectionMethod
      * @return string
      */
     protected function getMethodBody($reflectionMethod)

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/Utl/ApiConsumer.php

Doc Comments -16 removed lines

@@ -28,10 +28,6 @@ 
     }
 
     /**
-     * @param  string $uri
-     * @param  array  $data
-     * @param  array  $headers
-     * @param  string $content
      * @return \Illuminate\Http\Response
      */
     public function get()
@@ -40,10 +36,6 @@ 
     }
 
     /**
-     * @param  string $uri
-     * @param  array  $data
-     * @param  array  $headers
-     * @param  string $content
      * @return \Illuminate\Http\Response
      */
     public function post()
@@ -52,10 +44,6 @@ 
     }
 
     /**
-     * @param  string $uri
-     * @param  array  $data
-     * @param  array  $headers
-     * @param  string $content
      * @return \Illuminate\Http\Response
      */
     public function put()
@@ -64,10 +52,6 @@ 
     }
 
     /**
-     * @param  string $uri
-     * @param  array  $data
-     * @param  array  $headers
-     * @param  string $content
      * @return \Illuminate\Http\Response
      */
     public function delete()

Indentation +214 added lines, -214 removed lines

@@ -7,218 +7,218 @@
 class ApiConsumer
 {
 
-    private $app;
-
-    private $router;
-
-    private $request;
-
-    private $disableMiddleware = false;
-
-    /**
-     * @param \Illuminate\Foundation\Application $app
-     * @param \Illuminate\Http\Request $request,
-     * @param \Illuminate\Routing\Router $router
-     */
-    public function __construct(Application $app, Request $request, LaravelRouter $router)
-    {
-        $this->app = $app;
-        $this->request = $request;
-        $this->router = $router;
-    }
-
-    /**
-     * @param  string $uri
-     * @param  array  $data
-     * @param  array  $headers
-     * @param  string $content
-     * @return \Illuminate\Http\Response
-     */
-    public function get()
-    {
-        return $this->quickCall('GET', func_get_args());
-    }
-
-    /**
-     * @param  string $uri
-     * @param  array  $data
-     * @param  array  $headers
-     * @param  string $content
-     * @return \Illuminate\Http\Response
-     */
-    public function post()
-    {
-        return $this->quickCall('POST', func_get_args());
-    }
-
-    /**
-     * @param  string $uri
-     * @param  array  $data
-     * @param  array  $headers
-     * @param  string $content
-     * @return \Illuminate\Http\Response
-     */
-    public function put()
-    {
-        return $this->quickCall('PUT', func_get_args());
-    }
-
-    /**
-     * @param  string $uri
-     * @param  array  $data
-     * @param  array  $headers
-     * @param  string $content
-     * @return \Illuminate\Http\Response
-     */
-    public function delete()
-    {
-        return $this->quickCall('DELETE', func_get_args());
-    }
-
-    /**
-     * @param  array $requests An array of requests
-     * @return array
-     */
-    public function batchRequest(array $requests)
-    {
-        foreach ($requests as $i => $request) {
-            $requests[$i] = call_user_func_array([$this, 'singleRequest'], $request);
-        }
-
-        return $requests;
-    }
-
-    /**
-     * @param  string $method
-     * @param  array  $args
-     * @return \Illuminate\Http\Response
-     */
-    public function quickCall($method, array $args)
-    {
-        array_unshift($args, $method);
-        return call_user_func_array([$this, "singleRequest"], $args);
-    }
-
-    /**
-     * @param  string $method
-     * @param  string $uri
-     * @param  array  $data
-     * @param  array  $headers
-     * @param  string $content
-     * @return \Illuminate\Http\Response
-     */
-    public function singleRequest($method, $uri, array $data = [], array $headers = [], $content = null)
-    {
-        // Save the current request so we can reset the router back to it
-        // after we've completed our internal request.
-        $currentRequest = $this->request->instance()->duplicate();
-
-        $headers = $this->overrideHeaders($currentRequest->server->getHeaders(), $headers);
-
-        if ($this->disableMiddleware) {
-            $this->app->instance('middleware.disable', true);
-        }
-
-        $response = $this->request($method, $uri, $data, $headers, $content);
-
-        if ($this->disableMiddleware) {
-            $this->app->instance('middleware.disable', false);
-        }
-
-        // Once the request has completed we reset the currentRequest of the router
-        // to match the original request.
-        $this->request->instance()->initialize(
-            $currentRequest->query->all(),
-            $currentRequest->request->all(),
-            $currentRequest->attributes->all(),
-            $currentRequest->cookies->all(),
-            $currentRequest->files->all(),
-            $currentRequest->server->all(),
-            $currentRequest->content
-        );
-
-        return $response;
-    }
-
-    private function overrideHeaders(array $default, array $headers)
-    {
-        $headers = $this->transformHeadersToUppercaseUnderscoreType($headers);
-        return array_merge($default, $headers);
-    }
-
-    public function enableMiddleware()
-    {
-        $this->disableMiddleware = false;
-    }
-
-    public function disableMiddleware()
-    {
-        $this->disableMiddleware = true;
-    }
-
-    /**
-     * @param  string $method
-     * @param  string $uri
-     * @param  array  $data
-     * @param  array  $headers
-     * @param  string $content
-     * @return \Illuminate\Http\Response
-     */
-    private function request($method, $uri, array $data = [], array $headers = [], $content = null)
-    {
-        // Create a new request object for the internal request
-        $request = $this->createRequest($method, $uri, $data, $headers, $content);
-
-        // Handle the request in the kernel and prepare a response
-        $response = $this->router->prepareResponse($request, $this->app->handle($request));
-
-        return $response;
-    }
-
-    /**
-     * @param  string $method
-     * @param  string $uri
-     * @param  array  $data
-     * @param  array  $headers
-     * @param  string $content
-     * @return \Illuminate\Http\Request
-     */
-    private function createRequest($method, $uri, array $data = [], array $headers = [], $content = null)
-    {
-        $server = $this->transformHeadersToServerVariables($headers);
-
-        return $this->request->create($uri, $method, $data, [], [], $server, $content);
-    }
-
-    private function transformHeadersToUppercaseUnderscoreType($headers)
-    {
-        $transformed = [];
-
-        foreach ($headers as $headerType => $headerValue) {
-            $headerType = strtoupper(str_replace('-', '_', $headerType));
-
-            $transformed[$headerType] = $headerValue;
-        }
-
-        return $transformed;
-    }
-
-    /**
-     * https://github.com/symfony/symfony/issues/5074
-     *
-     * @param  array $headers
-     * @return array
-     */
-    private function transformHeadersToServerVariables($headers)
-    {
-        $server = [];
-
-        foreach ($headers as $headerType => $headerValue) {
-            $headerType = 'HTTP_' . $headerType;
-
-            $server[$headerType] = $headerValue;
-        }
-
-        return $server;
-    }
+	private $app;
+
+	private $router;
+
+	private $request;
+
+	private $disableMiddleware = false;
+
+	/**
+	 * @param \Illuminate\Foundation\Application $app
+	 * @param \Illuminate\Http\Request $request,
+	 * @param \Illuminate\Routing\Router $router
+	 */
+	public function __construct(Application $app, Request $request, LaravelRouter $router)
+	{
+		$this->app = $app;
+		$this->request = $request;
+		$this->router = $router;
+	}
+
+	/**
+	 * @param  string $uri
+	 * @param  array  $data
+	 * @param  array  $headers
+	 * @param  string $content
+	 * @return \Illuminate\Http\Response
+	 */
+	public function get()
+	{
+		return $this->quickCall('GET', func_get_args());
+	}
+
+	/**
+	 * @param  string $uri
+	 * @param  array  $data
+	 * @param  array  $headers
+	 * @param  string $content
+	 * @return \Illuminate\Http\Response
+	 */
+	public function post()
+	{
+		return $this->quickCall('POST', func_get_args());
+	}
+
+	/**
+	 * @param  string $uri
+	 * @param  array  $data
+	 * @param  array  $headers
+	 * @param  string $content
+	 * @return \Illuminate\Http\Response
+	 */
+	public function put()
+	{
+		return $this->quickCall('PUT', func_get_args());
+	}
+
+	/**
+	 * @param  string $uri
+	 * @param  array  $data
+	 * @param  array  $headers
+	 * @param  string $content
+	 * @return \Illuminate\Http\Response
+	 */
+	public function delete()
+	{
+		return $this->quickCall('DELETE', func_get_args());
+	}
+
+	/**
+	 * @param  array $requests An array of requests
+	 * @return array
+	 */
+	public function batchRequest(array $requests)
+	{
+		foreach ($requests as $i => $request) {
+			$requests[$i] = call_user_func_array([$this, 'singleRequest'], $request);
+		}
+
+		return $requests;
+	}
+
+	/**
+	 * @param  string $method
+	 * @param  array  $args
+	 * @return \Illuminate\Http\Response
+	 */
+	public function quickCall($method, array $args)
+	{
+		array_unshift($args, $method);
+		return call_user_func_array([$this, "singleRequest"], $args);
+	}
+
+	/**
+	 * @param  string $method
+	 * @param  string $uri
+	 * @param  array  $data
+	 * @param  array  $headers
+	 * @param  string $content
+	 * @return \Illuminate\Http\Response
+	 */
+	public function singleRequest($method, $uri, array $data = [], array $headers = [], $content = null)
+	{
+		// Save the current request so we can reset the router back to it
+		// after we've completed our internal request.
+		$currentRequest = $this->request->instance()->duplicate();
+
+		$headers = $this->overrideHeaders($currentRequest->server->getHeaders(), $headers);
+
+		if ($this->disableMiddleware) {
+			$this->app->instance('middleware.disable', true);
+		}
+
+		$response = $this->request($method, $uri, $data, $headers, $content);
+
+		if ($this->disableMiddleware) {
+			$this->app->instance('middleware.disable', false);
+		}
+
+		// Once the request has completed we reset the currentRequest of the router
+		// to match the original request.
+		$this->request->instance()->initialize(
+			$currentRequest->query->all(),
+			$currentRequest->request->all(),
+			$currentRequest->attributes->all(),
+			$currentRequest->cookies->all(),
+			$currentRequest->files->all(),
+			$currentRequest->server->all(),
+			$currentRequest->content
+		);
+
+		return $response;
+	}
+
+	private function overrideHeaders(array $default, array $headers)
+	{
+		$headers = $this->transformHeadersToUppercaseUnderscoreType($headers);
+		return array_merge($default, $headers);
+	}
+
+	public function enableMiddleware()
+	{
+		$this->disableMiddleware = false;
+	}
+
+	public function disableMiddleware()
+	{
+		$this->disableMiddleware = true;
+	}
+
+	/**
+	 * @param  string $method
+	 * @param  string $uri
+	 * @param  array  $data
+	 * @param  array  $headers
+	 * @param  string $content
+	 * @return \Illuminate\Http\Response
+	 */
+	private function request($method, $uri, array $data = [], array $headers = [], $content = null)
+	{
+		// Create a new request object for the internal request
+		$request = $this->createRequest($method, $uri, $data, $headers, $content);
+
+		// Handle the request in the kernel and prepare a response
+		$response = $this->router->prepareResponse($request, $this->app->handle($request));
+
+		return $response;
+	}
+
+	/**
+	 * @param  string $method
+	 * @param  string $uri
+	 * @param  array  $data
+	 * @param  array  $headers
+	 * @param  string $content
+	 * @return \Illuminate\Http\Request
+	 */
+	private function createRequest($method, $uri, array $data = [], array $headers = [], $content = null)
+	{
+		$server = $this->transformHeadersToServerVariables($headers);
+
+		return $this->request->create($uri, $method, $data, [], [], $server, $content);
+	}
+
+	private function transformHeadersToUppercaseUnderscoreType($headers)
+	{
+		$transformed = [];
+
+		foreach ($headers as $headerType => $headerValue) {
+			$headerType = strtoupper(str_replace('-', '_', $headerType));
+
+			$transformed[$headerType] = $headerValue;
+		}
+
+		return $transformed;
+	}
+
+	/**
+	 * https://github.com/symfony/symfony/issues/5074
+	 *
+	 * @param  array $headers
+	 * @return array
+	 */
+	private function transformHeadersToServerVariables($headers)
+	{
+		$server = [];
+
+		foreach ($headers as $headerType => $headerValue) {
+			$headerType = 'HTTP_' . $headerType;
+
+			$server[$headerType] = $headerValue;
+		}
+
+		return $server;
+	}
 }

src/Modules/Core/BaseClasses/BaseRepository.php

Doc Comments +7 added lines, -7 removed lines

@@ -34,7 +34,7 @@ 
      *
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -52,7 +52,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -154,7 +154,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -172,7 +172,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -188,7 +188,7 @@ 
      * Save the given model to the storage.
      *
      * @param  array $data
-     * @return mixed
+     * @return boolean
      */
     public function save(array $data)
     {
@@ -477,7 +477,7 @@ 
      * @param  array   $conditions array of conditions
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -509,7 +509,7 @@ 
      * @param  array   $conditions array of conditions
      * @param  integer $perPage
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */

Indentation +662 added lines, -662 removed lines

@@ -6,679 +6,679 @@
 
 abstract class BaseRepository implements BaseRepositoryInterface
 {
-    /**
-     * The model implementation.
-     *
-     * @var object
-     */
-    public $model;
+	/**
+	 * The model implementation.
+	 *
+	 * @var object
+	 */
+	public $model;
     
-    /**
-     * Init new object.
-     *
-     * @var mixed model
-     * @return  void
-     */
-    public function __construct($model)
-    {
-        $this->model  = $model;
-    }
-
-    /**
-     * Fetch records with relations based on the given params.
-     *
-     * @param   string  $relations
-     * @param   array   $conditions
-     * @param   integer $perPage
-     * @param   string  $sortBy
-     * @param   boolean $desc
-     * @return collection
-     */
-    public function list($relations = [], $conditions = false, $perPage = 15, $sortBy = 'created_at', $desc = true)
-    {
-        unset($conditions['page']);
-        unset($conditions['perPage']);
-        unset($conditions['sortBy']);
-        unset($conditions['sort']);
-        unset($conditions['page']);
-
-        if (count($conditions)) {
-            return $this->paginateBy(['and' => $conditions], $perPage ?? 15, $relations, $sortBy ?? 'created_at', $desc ?? true);
-        }
-
-        return $this->paginate($perPage ?? 15, $relations, $sortBy ?? 'created_at', $desc ?? true);
-    }
-
-    /**
-     * Fetch all records with relations from the storage.
-     *
-     * @param  array   $relations
-     * @param  string  $sortBy
-     * @param  boolean $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function all($relations = [], $sortBy = 'created_at', $desc = 1, $columns = ['*'])
-    {
-        $sort = $desc ? 'desc' : 'asc';
-        return $this->model->with($relations)->orderBy($sortBy, $sort)->get($columns);
-    }
-
-    /**
-     * Fetch all records with relations from storage in pages
-     * that matche the given query.
-     *
-     * @param  string  $query
-     * @param  integer $perPage
-     * @param  array   $relations
-     * @param  string  $sortBy
-     * @param  boolean $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function search($query, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = ['*'])
-    {
-        $model            = $this->model->with($relations);
-        $conditionColumns = $this->model->searchable;
-        $sort             = $desc ? 'desc' : 'asc';
-
-        /**
-         * Construct the select conditions for the model.
-         */
-        $model->where(function ($q) use ($query, $conditionColumns, $relations) {
-
-            if (count($conditionColumns)) {
-                $column = 'LOWER('.array_shift($conditionColumns).')';
-                if (Str::contains($column, '->')) {
-                    $column = $this->wrapJsonSelector($column);
-                }
-
-                /**
-                 * Use the first element in the model columns to construct the first condition.
-                 */
-                $q->where(\DB::raw($column), 'LIKE', '%'.strtolower($query).'%');
-            }
-
-            /**
-             * Loop through the rest of the columns to construct or where conditions.
-             */
-            foreach ($conditionColumns as $column) {
-                $column = 'LOWER('.$column.')';
-                if (Str::contains($column, '->')) {
-                    $column = $this->wrapJsonSelector($column);
-                }
-
-                $q->orWhere(\DB::raw($column), 'LIKE', '%'.strtolower($query).'%');
-            }
-
-            /**
-             * Loop through the model relations.
-             */
-            foreach ($relations as $relation) {
-                /**
-                 * Remove the sub relation if exists.
-                 */
-                $relation = explode('.', $relation)[0];
-
-                /**
-                 * Try to fetch the relation repository from the core.
-                 */
-                if (\Core::$relation()) {
-                    /**
-                     * Construct the relation condition.
-                     */
-                    $q->orWhereHas($relation, function ($subModel) use ($query, $relation) {
-
-                        $subModel->where(function ($q) use ($query, $relation) {
-
-                            /**
-                             * Get columns of the relation.
-                             */
-                            $subConditionColumns = \Core::$relation()->model->searchable;
-
-                            if (count($subConditionColumns)) {
-                                $column = 'LOWER('.array_shift($subConditionColumns).')';
-                                if (Str::contains($column, '->')) {
-                                    $column = $this->wrapJsonSelector($column);
-                                }
-
-                                /**
-                                 * Use the first element in the relation model columns to construct the first condition.
-                                 */
-                                $q->where(\DB::raw($column), 'LIKE', '%'.strtolower($query).'%');
-                            }
-
-                            /**
-                             * Loop through the rest of the columns to construct or where conditions.
-                             */
-                            foreach ($subConditionColumns as $subConditionColumn) {
-                                $column = 'LOWER('.$subConditionColumn.')';
-                                if (Str::contains($column, '->')) {
-                                    $column = $this->wrapJsonSelector($column);
-                                }
+	/**
+	 * Init new object.
+	 *
+	 * @var mixed model
+	 * @return  void
+	 */
+	public function __construct($model)
+	{
+		$this->model  = $model;
+	}
+
+	/**
+	 * Fetch records with relations based on the given params.
+	 *
+	 * @param   string  $relations
+	 * @param   array   $conditions
+	 * @param   integer $perPage
+	 * @param   string  $sortBy
+	 * @param   boolean $desc
+	 * @return collection
+	 */
+	public function list($relations = [], $conditions = false, $perPage = 15, $sortBy = 'created_at', $desc = true)
+	{
+		unset($conditions['page']);
+		unset($conditions['perPage']);
+		unset($conditions['sortBy']);
+		unset($conditions['sort']);
+		unset($conditions['page']);
+
+		if (count($conditions)) {
+			return $this->paginateBy(['and' => $conditions], $perPage ?? 15, $relations, $sortBy ?? 'created_at', $desc ?? true);
+		}
+
+		return $this->paginate($perPage ?? 15, $relations, $sortBy ?? 'created_at', $desc ?? true);
+	}
+
+	/**
+	 * Fetch all records with relations from the storage.
+	 *
+	 * @param  array   $relations
+	 * @param  string  $sortBy
+	 * @param  boolean $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function all($relations = [], $sortBy = 'created_at', $desc = 1, $columns = ['*'])
+	{
+		$sort = $desc ? 'desc' : 'asc';
+		return $this->model->with($relations)->orderBy($sortBy, $sort)->get($columns);
+	}
+
+	/**
+	 * Fetch all records with relations from storage in pages
+	 * that matche the given query.
+	 *
+	 * @param  string  $query
+	 * @param  integer $perPage
+	 * @param  array   $relations
+	 * @param  string  $sortBy
+	 * @param  boolean $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function search($query, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = ['*'])
+	{
+		$model            = $this->model->with($relations);
+		$conditionColumns = $this->model->searchable;
+		$sort             = $desc ? 'desc' : 'asc';
+
+		/**
+		 * Construct the select conditions for the model.
+		 */
+		$model->where(function ($q) use ($query, $conditionColumns, $relations) {
+
+			if (count($conditionColumns)) {
+				$column = 'LOWER('.array_shift($conditionColumns).')';
+				if (Str::contains($column, '->')) {
+					$column = $this->wrapJsonSelector($column);
+				}
+
+				/**
+				 * Use the first element in the model columns to construct the first condition.
+				 */
+				$q->where(\DB::raw($column), 'LIKE', '%'.strtolower($query).'%');
+			}
+
+			/**
+			 * Loop through the rest of the columns to construct or where conditions.
+			 */
+			foreach ($conditionColumns as $column) {
+				$column = 'LOWER('.$column.')';
+				if (Str::contains($column, '->')) {
+					$column = $this->wrapJsonSelector($column);
+				}
+
+				$q->orWhere(\DB::raw($column), 'LIKE', '%'.strtolower($query).'%');
+			}
+
+			/**
+			 * Loop through the model relations.
+			 */
+			foreach ($relations as $relation) {
+				/**
+				 * Remove the sub relation if exists.
+				 */
+				$relation = explode('.', $relation)[0];
+
+				/**
+				 * Try to fetch the relation repository from the core.
+				 */
+				if (\Core::$relation()) {
+					/**
+					 * Construct the relation condition.
+					 */
+					$q->orWhereHas($relation, function ($subModel) use ($query, $relation) {
+
+						$subModel->where(function ($q) use ($query, $relation) {
+
+							/**
+							 * Get columns of the relation.
+							 */
+							$subConditionColumns = \Core::$relation()->model->searchable;
+
+							if (count($subConditionColumns)) {
+								$column = 'LOWER('.array_shift($subConditionColumns).')';
+								if (Str::contains($column, '->')) {
+									$column = $this->wrapJsonSelector($column);
+								}
+
+								/**
+								 * Use the first element in the relation model columns to construct the first condition.
+								 */
+								$q->where(\DB::raw($column), 'LIKE', '%'.strtolower($query).'%');
+							}
+
+							/**
+							 * Loop through the rest of the columns to construct or where conditions.
+							 */
+							foreach ($subConditionColumns as $subConditionColumn) {
+								$column = 'LOWER('.$subConditionColumn.')';
+								if (Str::contains($column, '->')) {
+									$column = $this->wrapJsonSelector($column);
+								}
                                 
-                                $q->orWhere(\DB::raw($column), 'LIKE', '%'.strtolower($query).'%');
-                            }
-                        });
-                    });
-                }
-            }
-        });
+								$q->orWhere(\DB::raw($column), 'LIKE', '%'.strtolower($query).'%');
+							}
+						});
+					});
+				}
+			}
+		});
         
-        return $model->orderBy($sortBy, $sort)->paginate($perPage, $columns);
-    }
+		return $model->orderBy($sortBy, $sort)->paginate($perPage, $columns);
+	}
     
-    /**
-     * Fetch all records with relations from storage in pages.
-     *
-     * @param  integer $perPage
-     * @param  array   $relations
-     * @param  string  $sortBy
-     * @param  boolean $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function paginate($perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = ['*'])
-    {
-        $sort = $desc ? 'desc' : 'asc';
-        return $this->model->with($relations)->orderBy($sortBy, $sort)->paginate($perPage, $columns);
-    }
-
-    /**
-     * Fetch all records with relations based on
-     * the given condition from storage in pages.
-     *
-     * @param  array   $conditions array of conditions
-     * @param  integer $perPage
-     * @param  array   $relations
-     * @param  string  $sortBy
-     * @param  boolean $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function paginateBy($conditions, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = ['*'])
-    {
-        $conditions = $this->constructConditions($conditions, $this->model);
-        $sort       = $desc ? 'desc' : 'asc';
-        return $this->model->with($relations)->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->orderBy($sortBy, $sort)->paginate($perPage, $columns);
-    }
+	/**
+	 * Fetch all records with relations from storage in pages.
+	 *
+	 * @param  integer $perPage
+	 * @param  array   $relations
+	 * @param  string  $sortBy
+	 * @param  boolean $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function paginate($perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = ['*'])
+	{
+		$sort = $desc ? 'desc' : 'asc';
+		return $this->model->with($relations)->orderBy($sortBy, $sort)->paginate($perPage, $columns);
+	}
+
+	/**
+	 * Fetch all records with relations based on
+	 * the given condition from storage in pages.
+	 *
+	 * @param  array   $conditions array of conditions
+	 * @param  integer $perPage
+	 * @param  array   $relations
+	 * @param  string  $sortBy
+	 * @param  boolean $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function paginateBy($conditions, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = ['*'])
+	{
+		$conditions = $this->constructConditions($conditions, $this->model);
+		$sort       = $desc ? 'desc' : 'asc';
+		return $this->model->with($relations)->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->orderBy($sortBy, $sort)->paginate($perPage, $columns);
+	}
     
-    /**
-     * Save the given model to the storage.
-     *
-     * @param  array $data
-     * @return mixed
-     */
-    public function save(array $data)
-    {
-        \Session::put('locale', 'all');
-        $model      = false;
-        $relations  = [];
-
-        \DB::transaction(function () use (&$model, $relations, $data) {
+	/**
+	 * Save the given model to the storage.
+	 *
+	 * @param  array $data
+	 * @return mixed
+	 */
+	public function save(array $data)
+	{
+		\Session::put('locale', 'all');
+		$model      = false;
+		$relations  = [];
+
+		\DB::transaction(function () use (&$model, $relations, $data) {
             
-            $model     = $this->prepareModel($data);
-            $relations = $this->prepareRelations($data, $model);
-            $model     = $this->saveModel($model, $relations);
-        });
+			$model     = $this->prepareModel($data);
+			$relations = $this->prepareRelations($data, $model);
+			$model     = $this->saveModel($model, $relations);
+		});
             
-        return $model;
-    }
-
-    /**
-     * Delete record from the storage based on the given
-     * condition.
-     *
-     * @param  var $value condition value
-     * @param  string $attribute condition column name
-     * @return void
-     */
-    public function delete($value, $attribute = 'id')
-    {
-        if ($attribute == 'id') {
-            \DB::transaction(function () use ($value) {
-                $model = $this->model->lockForUpdate()->find($value);
-                if (! $model) {
-                    \ErrorHandler::notFound(class_basename($this->model).' with id : '.$value);
-                }
+		return $model;
+	}
+
+	/**
+	 * Delete record from the storage based on the given
+	 * condition.
+	 *
+	 * @param  var $value condition value
+	 * @param  string $attribute condition column name
+	 * @return void
+	 */
+	public function delete($value, $attribute = 'id')
+	{
+		if ($attribute == 'id') {
+			\DB::transaction(function () use ($value) {
+				$model = $this->model->lockForUpdate()->find($value);
+				if (! $model) {
+					\ErrorHandler::notFound(class_basename($this->model).' with id : '.$value);
+				}
                 
-                $model->delete();
-            });
-        } else {
-            \DB::transaction(function () use ($value, $attribute) {
-                $this->model->where($attribute, '=', $value)->lockForUpdate()->get()->each(function ($model) {
-                    $model->delete();
-                });
-            });
-        }
-    }
+				$model->delete();
+			});
+		} else {
+			\DB::transaction(function () use ($value, $attribute) {
+				$this->model->where($attribute, '=', $value)->lockForUpdate()->get()->each(function ($model) {
+					$model->delete();
+				});
+			});
+		}
+	}
     
-    /**
-     * Fetch records from the storage based on the given
-     * id.
-     *
-     * @param  integer $id
-     * @param  string[]   $relations
-     * @param  array   $columns
-     * @return object
-     */
-    public function find($id, $relations = [], $columns = ['*'])
-    {
-        return $this->model->with($relations)->find($id, $columns);
-    }
+	/**
+	 * Fetch records from the storage based on the given
+	 * id.
+	 *
+	 * @param  integer $id
+	 * @param  string[]   $relations
+	 * @param  array   $columns
+	 * @return object
+	 */
+	public function find($id, $relations = [], $columns = ['*'])
+	{
+		return $this->model->with($relations)->find($id, $columns);
+	}
     
-    /**
-     * Fetch records from the storage based on the given
-     * condition.
-     *
-     * @param  array   $conditions array of conditions
-     * @param  array   $relations
-     * @param  string  $sortBy
-     * @param  boolean $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function findBy($conditions, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = ['*'])
-    {
-        $conditions = $this->constructConditions($conditions, $this->model);
-        $sort       = $desc ? 'desc' : 'asc';
-        return $this->model->with($relations)->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->orderBy($sortBy, $sort)->get($columns);
-    }
-
-    /**
-     * Fetch the first record from the storage based on the given
-     * condition.
-     *
-     * @param  array   $conditions array of conditions
-     * @param  array   $relations
-     * @param  array   $columns
-     * @return object
-     */
-    public function first($conditions, $relations = [], $columns = ['*'])
-    {
-        $conditions = $this->constructConditions($conditions, $this->model);
-        return $this->model->with($relations)->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->first($columns);
-    }
-
-    /**
-     * Return the deleted models in pages based on the given conditions.
-     *
-     * @param  array   $conditions array of conditions
-     * @param  integer $perPage
-     * @param  string  $sortBy
-     * @param  boolean $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function deleted($conditions, $perPage = 15, $sortBy = 'created_at', $desc = 1, $columns = ['*'])
-    {
-        unset($conditions['page']);
-        unset($conditions['perPage']);
-        unset($conditions['sortBy']);
-        unset($conditions['sort']);
-        $conditions = $this->constructConditions($conditions, $this->model);
-        $sort       = $desc ? 'desc' : 'asc';
-        $model      = $this->model->onlyTrashed();
-
-        if (count($conditions['conditionValues'])) {
-            $model->whereRaw($conditions['conditionString'], $conditions['conditionValues']);
-        }
-
-        return $model->orderBy($sortBy, $sort)->paginate($perPage, $columns);
-    }
-
-    /**
-     * Restore the deleted model.
-     *
-     * @param  integer $id
-     * @return void
-     */
-    public function restore($id)
-    {
-        $model = $this->model->onlyTrashed()->find($id);
-
-        if (! $model) {
-            \ErrorHandler::notFound(class_basename($this->model).' with id : '.$id);
-        }
-
-        $model->restore();
-    }
-
-    /**
-     * Fill the model with the given data.
-     *
-     * @param   array  $data
-     *
-     * @return  object
-     */
-    public function prepareModel($data)
-    {
-        $modelClass = $this->model;
-
-        /**
-         * If the id is present in the data then select the model for updating,
-         * else create new model.
-         * @var array
-         */
-        $model = Arr::has($data, 'id') ? $modelClass->lockForUpdate()->find($data['id']) : new $modelClass;
-        if (! $model) {
-            \ErrorHandler::notFound(class_basename($modelClass).' with id : '.$data['id']);
-        }
-
-        /**
-         * Construct the model object with the given data,
-         * and if there is a relation add it to relations array,
-         * then save the model.
-         */
-        foreach ($data as $key => $value) {
-            if (array_search($key, $model->getFillable(), true) !== false) {
-                /**
-                 * If the attribute isn't a relation and prevent attributes not in the fillable.
-                 */
-                $model->$key = $value;
-            }
-        }
-
-        return $model;
-    }
+	/**
+	 * Fetch records from the storage based on the given
+	 * condition.
+	 *
+	 * @param  array   $conditions array of conditions
+	 * @param  array   $relations
+	 * @param  string  $sortBy
+	 * @param  boolean $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function findBy($conditions, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = ['*'])
+	{
+		$conditions = $this->constructConditions($conditions, $this->model);
+		$sort       = $desc ? 'desc' : 'asc';
+		return $this->model->with($relations)->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->orderBy($sortBy, $sort)->get($columns);
+	}
+
+	/**
+	 * Fetch the first record from the storage based on the given
+	 * condition.
+	 *
+	 * @param  array   $conditions array of conditions
+	 * @param  array   $relations
+	 * @param  array   $columns
+	 * @return object
+	 */
+	public function first($conditions, $relations = [], $columns = ['*'])
+	{
+		$conditions = $this->constructConditions($conditions, $this->model);
+		return $this->model->with($relations)->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->first($columns);
+	}
+
+	/**
+	 * Return the deleted models in pages based on the given conditions.
+	 *
+	 * @param  array   $conditions array of conditions
+	 * @param  integer $perPage
+	 * @param  string  $sortBy
+	 * @param  boolean $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function deleted($conditions, $perPage = 15, $sortBy = 'created_at', $desc = 1, $columns = ['*'])
+	{
+		unset($conditions['page']);
+		unset($conditions['perPage']);
+		unset($conditions['sortBy']);
+		unset($conditions['sort']);
+		$conditions = $this->constructConditions($conditions, $this->model);
+		$sort       = $desc ? 'desc' : 'asc';
+		$model      = $this->model->onlyTrashed();
+
+		if (count($conditions['conditionValues'])) {
+			$model->whereRaw($conditions['conditionString'], $conditions['conditionValues']);
+		}
+
+		return $model->orderBy($sortBy, $sort)->paginate($perPage, $columns);
+	}
+
+	/**
+	 * Restore the deleted model.
+	 *
+	 * @param  integer $id
+	 * @return void
+	 */
+	public function restore($id)
+	{
+		$model = $this->model->onlyTrashed()->find($id);
+
+		if (! $model) {
+			\ErrorHandler::notFound(class_basename($this->model).' with id : '.$id);
+		}
+
+		$model->restore();
+	}
+
+	/**
+	 * Fill the model with the given data.
+	 *
+	 * @param   array  $data
+	 *
+	 * @return  object
+	 */
+	public function prepareModel($data)
+	{
+		$modelClass = $this->model;
+
+		/**
+		 * If the id is present in the data then select the model for updating,
+		 * else create new model.
+		 * @var array
+		 */
+		$model = Arr::has($data, 'id') ? $modelClass->lockForUpdate()->find($data['id']) : new $modelClass;
+		if (! $model) {
+			\ErrorHandler::notFound(class_basename($modelClass).' with id : '.$data['id']);
+		}
+
+		/**
+		 * Construct the model object with the given data,
+		 * and if there is a relation add it to relations array,
+		 * then save the model.
+		 */
+		foreach ($data as $key => $value) {
+			if (array_search($key, $model->getFillable(), true) !== false) {
+				/**
+				 * If the attribute isn't a relation and prevent attributes not in the fillable.
+				 */
+				$model->$key = $value;
+			}
+		}
+
+		return $model;
+	}
     
-    /**
-     * Prepare related models based on the given data for the given model.
-     *
-     * @param   array  $data
-     * @param   object $model
-     *
-     * @return  array
-     */
-    public function prepareRelations($data, $model)
-    {
-        /**
-         * Construct the model object with the given data,
-         * and if there is a relation add it to relations array,
-         * then save the model.
-         */
-        foreach ($data as $key => $value) {
-            /**
-             * If the attribute is a relation.
-             */
-            $relation = \Str::camel($key);
-            if (method_exists($model, $relation) && \Core::$relation()) {
-                /**
-                 * Check if the relation is a collection.
-                 */
-                if (class_basename($model->$relation) == 'Collection') {
-                    /**
-                     * If the relation has no value then marke the relation data
-                     * related to the model to be deleted.
-                     */
-                    if (! $value || ! count($value)) {
-                        $relations[$relation] = 'delete';
-                    }
-                }
-                if (is_array($value)) {
-                    /**
-                     * Loop through the relation data.
-                     */
-                    foreach ($value as $attr => $val) {
-                        /**
-                         * Get the relation model.
-                         */
-                        $relationBaseModel = \Core::$relation()->model;
-
-                        /**
-                         * Check if the relation is a collection.
-                         */
-                        if (class_basename($model->$relation) == 'Collection') {
-                            /**
-                             * If the id is present in the data then select the relation model for updating,
-                             * else create new model.
-                             */
-                            $relationModel = Arr::has($val, 'id') ? $relationBaseModel->lockForUpdate()->find($val['id']) : new $relationBaseModel;
-
-                            /**
-                             * If model doesn't exists.
-                             */
-                            if (! $relationModel) {
-                                \ErrorHandler::notFound(class_basename($relationBaseModel).' with id : '.$val['id']);
-                            }
-
-                            /**
-                             * Loop through the relation attributes.
-                             */
-                            foreach ($val as $attr => $val) {
-                                /**
-                                 * Prevent the sub relations or attributes not in the fillable.
-                                 */
-                                if (gettype($val) !== 'object' && gettype($val) !== 'array' && array_search($attr, $relationModel->getFillable(), true) !== false) {
-                                    $relationModel->$attr = $val;
-                                }
-                            }
-
-                            $relations[$relation][] = $relationModel;
-                        } else {
-                            /**
-                             * Prevent the sub relations.
-                             */
-                            if (gettype($val) !== 'object' && gettype($val) !== 'array') {
-                                /**
-                                 * If the id is present in the data then select the relation model for updating,
-                                 * else create new model.
-                                 */
-                                $relationModel = Arr::has($value, 'id') ? $relationBaseModel->lockForUpdate()->find($value['id']) : new $relationBaseModel;
-
-                                /**
-                                 * If model doesn't exists.
-                                 */
-                                if (! $relationModel) {
-                                    \ErrorHandler::notFound(class_basename($relationBaseModel).' with id : '.$value['id']);
-                                }
-
-                                foreach ($value as $relationAttribute => $relationValue) {
-                                    /**
-                                     * Prevent attributes not in the fillable.
-                                     */
-                                    if (array_search($relationAttribute, $relationModel->getFillable(), true) !== false) {
-                                        $relationModel->$relationAttribute = $relationValue;
-                                    }
-                                }
-
-                                $relations[$relation] = $relationModel;
-                            }
-                        }
-                    }
-                }
-            }
-        }
-
-        return $relations;
-    }
-
-    /**
-     * Save the model with related models.
-     *
-     * @param   object  $model
-     * @param   array   $relations
-     *
-     * @return  object
-     */
-    public function saveModel($model, $relations)
-    {
-
-        /**
-         * Loop through the relations array.
-         */
-        foreach ($relations as $key => $value) {
-            /**
-             * If the relation is marked for delete then delete it.
-             */
-            if ($value == 'delete' && $model->$key()->count()) {
-                $model->$key()->delete();
-            } elseif (gettype($value) == 'array') {
-                /**
-                 * Save the model.
-                 */
-                $model->save();
-                $ids = [];
-
-                /**
-                 * Loop through the relations.
-                 */
-                foreach ($value as $val) {
-                    switch (class_basename($model->$key())) {
-                        /**
-                         * If the relation is one to many then update it's foreign key with
-                         * the model id and save it then add its id to ids array to delete all
-                         * relations who's id isn't in the ids array.
-                         */
-                        case 'HasMany':
-                            $foreignKeyName       = $model->$key()->getForeignKeyName();
-                            $val->$foreignKeyName = $model->id;
-                            $val->save();
-                            $ids[] = $val->id;
-                            break;
-
-                        /**
-                         * If the relation is many to many then add it's id to the ids array to
-                         * attache these ids to the model.
-                         */
-                        case 'BelongsToMany':
-                            $val->save();
-                            $ids[] = $val->id;
-                            break;
-                    }
-                }
-                switch (class_basename($model->$key())) {
-                    /**
-                     * If the relation is one to many then delete all
-                     * relations who's id isn't in the ids array.
-                     */
-                    case 'HasMany':
-                        $model->$key()->whereNotIn('id', $ids)->delete();
-                        break;
-
-                    /**
-                     * If the relation is many to many then
-                     * detach the previous data and attach
-                     * the ids array to the model.
-                     */
-                    case 'BelongsToMany':
-                        $model->$key()->detach();
-                        $model->$key()->attach($ids);
-                        break;
-                }
-            } else {
-                switch (class_basename($model->$key())) {
-                    /**
-                     * If the relation is one to one.
-                     */
-                    case 'HasOne':
-                        /**
-                         * Save the model.
-                         */
-                        $model->save();
-                        $foreignKeyName         = $model->$key()->getForeignKeyName();
-                        $value->$foreignKeyName = $model->id;
-                        $value->save();
-                        break;
-                    case 'BelongsTo':
-                        /**
-                         * Save the model.
-                         */
-                        $value->save();
-                        $model->$key()->associate($value);
-                        break;
-                }
-            }
-        }
-
-        /**
-         * Save the model.
-         */
-        $model->save();
-
-        return $model;
-    }
-
-    /**
-     * Build the conditions recursively for the retrieving methods.
-     * @param  array $conditions
-     * @return array
-     */
-    protected function constructConditions($conditions, $model)
-    {
-        $conditionString = '';
-        $conditionValues = [];
-        foreach ($conditions as $key => $value) {
-            if (Str::contains($key, '->')) {
-                $key = $this->wrapJsonSelector($key);
-            }
-
-            if ($key == 'and') {
-                $conditions       = $this->constructConditions($value, $model);
-                $conditionString .= str_replace('{op}', 'and', $conditions['conditionString']).' {op} ';
-                $conditionValues  = array_merge($conditionValues, $conditions['conditionValues']);
-            } elseif ($key == 'or') {
-                $conditions       = $this->constructConditions($value, $model);
-                $conditionString .= str_replace('{op}', 'or', $conditions['conditionString']).' {op} ';
-                $conditionValues  = array_merge($conditionValues, $conditions['conditionValues']);
-            } else {
-                if (is_array($value)) {
-                    $operator = $value['op'];
-                    if (strtolower($operator) == 'between') {
-                        $value1 = $value['val1'];
-                        $value2 = $value['val2'];
-                    } else {
-                        $value = Arr::get($value, 'val', '');
-                    }
-                } else {
-                    $operator = '=';
-                }
+	/**
+	 * Prepare related models based on the given data for the given model.
+	 *
+	 * @param   array  $data
+	 * @param   object $model
+	 *
+	 * @return  array
+	 */
+	public function prepareRelations($data, $model)
+	{
+		/**
+		 * Construct the model object with the given data,
+		 * and if there is a relation add it to relations array,
+		 * then save the model.
+		 */
+		foreach ($data as $key => $value) {
+			/**
+			 * If the attribute is a relation.
+			 */
+			$relation = \Str::camel($key);
+			if (method_exists($model, $relation) && \Core::$relation()) {
+				/**
+				 * Check if the relation is a collection.
+				 */
+				if (class_basename($model->$relation) == 'Collection') {
+					/**
+					 * If the relation has no value then marke the relation data
+					 * related to the model to be deleted.
+					 */
+					if (! $value || ! count($value)) {
+						$relations[$relation] = 'delete';
+					}
+				}
+				if (is_array($value)) {
+					/**
+					 * Loop through the relation data.
+					 */
+					foreach ($value as $attr => $val) {
+						/**
+						 * Get the relation model.
+						 */
+						$relationBaseModel = \Core::$relation()->model;
+
+						/**
+						 * Check if the relation is a collection.
+						 */
+						if (class_basename($model->$relation) == 'Collection') {
+							/**
+							 * If the id is present in the data then select the relation model for updating,
+							 * else create new model.
+							 */
+							$relationModel = Arr::has($val, 'id') ? $relationBaseModel->lockForUpdate()->find($val['id']) : new $relationBaseModel;
+
+							/**
+							 * If model doesn't exists.
+							 */
+							if (! $relationModel) {
+								\ErrorHandler::notFound(class_basename($relationBaseModel).' with id : '.$val['id']);
+							}
+
+							/**
+							 * Loop through the relation attributes.
+							 */
+							foreach ($val as $attr => $val) {
+								/**
+								 * Prevent the sub relations or attributes not in the fillable.
+								 */
+								if (gettype($val) !== 'object' && gettype($val) !== 'array' && array_search($attr, $relationModel->getFillable(), true) !== false) {
+									$relationModel->$attr = $val;
+								}
+							}
+
+							$relations[$relation][] = $relationModel;
+						} else {
+							/**
+							 * Prevent the sub relations.
+							 */
+							if (gettype($val) !== 'object' && gettype($val) !== 'array') {
+								/**
+								 * If the id is present in the data then select the relation model for updating,
+								 * else create new model.
+								 */
+								$relationModel = Arr::has($value, 'id') ? $relationBaseModel->lockForUpdate()->find($value['id']) : new $relationBaseModel;
+
+								/**
+								 * If model doesn't exists.
+								 */
+								if (! $relationModel) {
+									\ErrorHandler::notFound(class_basename($relationBaseModel).' with id : '.$value['id']);
+								}
+
+								foreach ($value as $relationAttribute => $relationValue) {
+									/**
+									 * Prevent attributes not in the fillable.
+									 */
+									if (array_search($relationAttribute, $relationModel->getFillable(), true) !== false) {
+										$relationModel->$relationAttribute = $relationValue;
+									}
+								}
+
+								$relations[$relation] = $relationModel;
+							}
+						}
+					}
+				}
+			}
+		}
+
+		return $relations;
+	}
+
+	/**
+	 * Save the model with related models.
+	 *
+	 * @param   object  $model
+	 * @param   array   $relations
+	 *
+	 * @return  object
+	 */
+	public function saveModel($model, $relations)
+	{
+
+		/**
+		 * Loop through the relations array.
+		 */
+		foreach ($relations as $key => $value) {
+			/**
+			 * If the relation is marked for delete then delete it.
+			 */
+			if ($value == 'delete' && $model->$key()->count()) {
+				$model->$key()->delete();
+			} elseif (gettype($value) == 'array') {
+				/**
+				 * Save the model.
+				 */
+				$model->save();
+				$ids = [];
+
+				/**
+				 * Loop through the relations.
+				 */
+				foreach ($value as $val) {
+					switch (class_basename($model->$key())) {
+						/**
+						 * If the relation is one to many then update it's foreign key with
+						 * the model id and save it then add its id to ids array to delete all
+						 * relations who's id isn't in the ids array.
+						 */
+						case 'HasMany':
+							$foreignKeyName       = $model->$key()->getForeignKeyName();
+							$val->$foreignKeyName = $model->id;
+							$val->save();
+							$ids[] = $val->id;
+							break;
+
+						/**
+						 * If the relation is many to many then add it's id to the ids array to
+						 * attache these ids to the model.
+						 */
+						case 'BelongsToMany':
+							$val->save();
+							$ids[] = $val->id;
+							break;
+					}
+				}
+				switch (class_basename($model->$key())) {
+					/**
+					 * If the relation is one to many then delete all
+					 * relations who's id isn't in the ids array.
+					 */
+					case 'HasMany':
+						$model->$key()->whereNotIn('id', $ids)->delete();
+						break;
+
+					/**
+					 * If the relation is many to many then
+					 * detach the previous data and attach
+					 * the ids array to the model.
+					 */
+					case 'BelongsToMany':
+						$model->$key()->detach();
+						$model->$key()->attach($ids);
+						break;
+				}
+			} else {
+				switch (class_basename($model->$key())) {
+					/**
+					 * If the relation is one to one.
+					 */
+					case 'HasOne':
+						/**
+						 * Save the model.
+						 */
+						$model->save();
+						$foreignKeyName         = $model->$key()->getForeignKeyName();
+						$value->$foreignKeyName = $model->id;
+						$value->save();
+						break;
+					case 'BelongsTo':
+						/**
+						 * Save the model.
+						 */
+						$value->save();
+						$model->$key()->associate($value);
+						break;
+				}
+			}
+		}
+
+		/**
+		 * Save the model.
+		 */
+		$model->save();
+
+		return $model;
+	}
+
+	/**
+	 * Build the conditions recursively for the retrieving methods.
+	 * @param  array $conditions
+	 * @return array
+	 */
+	protected function constructConditions($conditions, $model)
+	{
+		$conditionString = '';
+		$conditionValues = [];
+		foreach ($conditions as $key => $value) {
+			if (Str::contains($key, '->')) {
+				$key = $this->wrapJsonSelector($key);
+			}
+
+			if ($key == 'and') {
+				$conditions       = $this->constructConditions($value, $model);
+				$conditionString .= str_replace('{op}', 'and', $conditions['conditionString']).' {op} ';
+				$conditionValues  = array_merge($conditionValues, $conditions['conditionValues']);
+			} elseif ($key == 'or') {
+				$conditions       = $this->constructConditions($value, $model);
+				$conditionString .= str_replace('{op}', 'or', $conditions['conditionString']).' {op} ';
+				$conditionValues  = array_merge($conditionValues, $conditions['conditionValues']);
+			} else {
+				if (is_array($value)) {
+					$operator = $value['op'];
+					if (strtolower($operator) == 'between') {
+						$value1 = $value['val1'];
+						$value2 = $value['val2'];
+					} else {
+						$value = Arr::get($value, 'val', '');
+					}
+				} else {
+					$operator = '=';
+				}
                 
-                if (strtolower($operator) == 'between') {
-                    $conditionString  .= $key.' >= ? and ';
-                    $conditionValues[] = $value1;
-
-                    $conditionString  .= $key.' <= ? {op} ';
-                    $conditionValues[] = $value2;
-                } elseif (strtolower($operator) == 'in') {
-                    $conditionValues  = array_merge($conditionValues, $value);
-                    $inBindingsString = rtrim(str_repeat('?,', count($value)), ',');
-                    $conditionString .= $key.' in ('.rtrim($inBindingsString, ',').') {op} ';
-                } elseif (strtolower($operator) == 'null') {
-                    $conditionString .= $key.' is null {op} ';
-                } elseif (strtolower($operator) == 'not null') {
-                    $conditionString .= $key.' is not null {op} ';
-                } elseif (strtolower($operator) == 'has') {
-                    $sql              = $model->withTrashed()->has($key)->toSql();
-                    $conditions       = $this->constructConditions($value, $model->$key()->getRelated());
-                    $conditionString .= rtrim(substr($sql, strpos($sql, 'exists')), ')').' and '.$conditions['conditionString'].') {op} ';
-                    $conditionValues  = array_merge($conditionValues, $conditions['conditionValues']);
-                } else {
-                    $conditionString  .= $key.' '.$operator.' ? {op} ';
-                    $conditionValues[] = $value;
-                }
-            }
-        }
-        $conditionString = '('.rtrim($conditionString, '{op} ').')';
-        return ['conditionString' => $conditionString, 'conditionValues' => $conditionValues];
-    }
-
-    /**
-     * Wrap the given JSON selector.
-     *
-     * @param  string  $value
-     * @return string
-     */
-    protected function wrapJsonSelector($value)
-    {
-        $removeLast = strpos($value, ')');
-        $value      = $removeLast === false ? $value : substr($value, 0, $removeLast);
-        $path       = explode('->', $value);
-        $field      = array_shift($path);
-        $result     = sprintf('%s->\'$.%s\'', $field, collect($path)->map(function ($part) {
-            return '"'.$part.'"';
-        })->implode('.'));
+				if (strtolower($operator) == 'between') {
+					$conditionString  .= $key.' >= ? and ';
+					$conditionValues[] = $value1;
+
+					$conditionString  .= $key.' <= ? {op} ';
+					$conditionValues[] = $value2;
+				} elseif (strtolower($operator) == 'in') {
+					$conditionValues  = array_merge($conditionValues, $value);
+					$inBindingsString = rtrim(str_repeat('?,', count($value)), ',');
+					$conditionString .= $key.' in ('.rtrim($inBindingsString, ',').') {op} ';
+				} elseif (strtolower($operator) == 'null') {
+					$conditionString .= $key.' is null {op} ';
+				} elseif (strtolower($operator) == 'not null') {
+					$conditionString .= $key.' is not null {op} ';
+				} elseif (strtolower($operator) == 'has') {
+					$sql              = $model->withTrashed()->has($key)->toSql();
+					$conditions       = $this->constructConditions($value, $model->$key()->getRelated());
+					$conditionString .= rtrim(substr($sql, strpos($sql, 'exists')), ')').' and '.$conditions['conditionString'].') {op} ';
+					$conditionValues  = array_merge($conditionValues, $conditions['conditionValues']);
+				} else {
+					$conditionString  .= $key.' '.$operator.' ? {op} ';
+					$conditionValues[] = $value;
+				}
+			}
+		}
+		$conditionString = '('.rtrim($conditionString, '{op} ').')';
+		return ['conditionString' => $conditionString, 'conditionValues' => $conditionValues];
+	}
+
+	/**
+	 * Wrap the given JSON selector.
+	 *
+	 * @param  string  $value
+	 * @return string
+	 */
+	protected function wrapJsonSelector($value)
+	{
+		$removeLast = strpos($value, ')');
+		$value      = $removeLast === false ? $value : substr($value, 0, $removeLast);
+		$path       = explode('->', $value);
+		$field      = array_shift($path);
+		$result     = sprintf('%s->\'$.%s\'', $field, collect($path)->map(function ($part) {
+			return '"'.$part.'"';
+		})->implode('.'));
         
-        return $removeLast === false ? $result : $result.')';
-    }
+		return $removeLast === false ? $result : $result.')';
+	}
 }

Spacing +15 added lines, -15 removed lines

@@ -21,7 +21,7 @@ 
      */
     public function __construct($model)
     {
-        $this->model  = $model;
+        $this->model = $model;
     }
 
     /**
@@ -85,7 +85,7 @@ 
         /**
          * Construct the select conditions for the model.
          */
-        $model->where(function ($q) use ($query, $conditionColumns, $relations) {
+        $model->where(function($q) use ($query, $conditionColumns, $relations) {
 
             if (count($conditionColumns)) {
                 $column = 'LOWER('.array_shift($conditionColumns).')';
@@ -127,9 +127,9 @@ 
                     /**
                      * Construct the relation condition.
                      */
-                    $q->orWhereHas($relation, function ($subModel) use ($query, $relation) {
+                    $q->orWhereHas($relation, function($subModel) use ($query, $relation) {
 
-                        $subModel->where(function ($q) use ($query, $relation) {
+                        $subModel->where(function($q) use ($query, $relation) {
 
                             /**
                              * Get columns of the relation.
@@ -215,7 +215,7 @@ 
         $model      = false;
         $relations  = [];
 
-        \DB::transaction(function () use (&$model, $relations, $data) {
+        \DB::transaction(function() use (&$model, $relations, $data) {
             
             $model     = $this->prepareModel($data);
             $relations = $this->prepareRelations($data, $model);
@@ -236,17 +236,17 @@ 
     public function delete($value, $attribute = 'id')
     {
         if ($attribute == 'id') {
-            \DB::transaction(function () use ($value) {
+            \DB::transaction(function() use ($value) {
                 $model = $this->model->lockForUpdate()->find($value);
-                if (! $model) {
+                if ( ! $model) {
                     \ErrorHandler::notFound(class_basename($this->model).' with id : '.$value);
                 }
                 
                 $model->delete();
             });
         } else {
-            \DB::transaction(function () use ($value, $attribute) {
-                $this->model->where($attribute, '=', $value)->lockForUpdate()->get()->each(function ($model) {
+            \DB::transaction(function() use ($value, $attribute) {
+                $this->model->where($attribute, '=', $value)->lockForUpdate()->get()->each(function($model) {
                     $model->delete();
                 });
             });
@@ -337,7 +337,7 @@ 
     {
         $model = $this->model->onlyTrashed()->find($id);
 
-        if (! $model) {
+        if ( ! $model) {
             \ErrorHandler::notFound(class_basename($this->model).' with id : '.$id);
         }
 
@@ -361,7 +361,7 @@ 
          * @var array
          */
         $model = Arr::has($data, 'id') ? $modelClass->lockForUpdate()->find($data['id']) : new $modelClass;
-        if (! $model) {
+        if ( ! $model) {
             \ErrorHandler::notFound(class_basename($modelClass).' with id : '.$data['id']);
         }
 
@@ -411,7 +411,7 @@ 
                      * If the relation has no value then marke the relation data
                      * related to the model to be deleted.
                      */
-                    if (! $value || ! count($value)) {
+                    if ( ! $value || ! count($value)) {
                         $relations[$relation] = 'delete';
                     }
                 }
@@ -438,7 +438,7 @@ 
                             /**
                              * If model doesn't exists.
                              */
-                            if (! $relationModel) {
+                            if ( ! $relationModel) {
                                 \ErrorHandler::notFound(class_basename($relationBaseModel).' with id : '.$val['id']);
                             }
 
@@ -469,7 +469,7 @@ 
                                 /**
                                  * If model doesn't exists.
                                  */
-                                if (! $relationModel) {
+                                if ( ! $relationModel) {
                                     \ErrorHandler::notFound(class_basename($relationBaseModel).' with id : '.$value['id']);
                                 }
 
@@ -675,7 +675,7 @@ 
         $value      = $removeLast === false ? $value : substr($value, 0, $removeLast);
         $path       = explode('->', $value);
         $field      = array_shift($path);
-        $result     = sprintf('%s->\'$.%s\'', $field, collect($path)->map(function ($part) {
+        $result     = sprintf('%s->\'$.%s\'', $field, collect($path)->map(function($part) {
             return '"'.$part.'"';
         })->implode('.'));
         

src/Modules/Core/BaseClasses/BaseApiController.php

Doc Comments +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
      * Init new object.
      *
      * @param   mixed      $repo
-     * @param   CoreConfig $config
+     * @param   \App\Modules\Core\Utl\CoreConfig $config
      * @param   string     $modelResource
      * @return  void
      */

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/Reporting/Http/Controllers/ReportController.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
      *
      * @param Request $request
      * @param  string $reportName Name of the requested report
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function getReport(Request $request, $reportName)
     {

Indentation +28 added lines, -28 removed lines

@@ -9,34 +9,34 @@
 
 class ReportController extends BaseApiController
 {
-    /**
-     * List of all route actions that the base api controller
-     * will skip permissions check for them.
-     * @var array
-     */
-    protected $skipPermissionCheck = ['getReport'];
+	/**
+	 * List of all route actions that the base api controller
+	 * will skip permissions check for them.
+	 * @var array
+	 */
+	protected $skipPermissionCheck = ['getReport'];
 
-    /**
-     * Init new object.
-     *
-     * @param   ReportRepository $repo
-     * @param   CoreConfig       $config
-     * @return  void
-     */
-    public function __construct(ReportRepository $repo, CoreConfig $config)
-    {
-        parent::__construct($repo, $config, 'App\Modules\Reporting\Http\Resources\Report');
-    }
+	/**
+	 * Init new object.
+	 *
+	 * @param   ReportRepository $repo
+	 * @param   CoreConfig       $config
+	 * @return  void
+	 */
+	public function __construct(ReportRepository $repo, CoreConfig $config)
+	{
+		parent::__construct($repo, $config, 'App\Modules\Reporting\Http\Resources\Report');
+	}
 
-    /**
-     * Render the given report name with the given conditions.
-     *
-     * @param Request $request
-     * @param  string $reportName Name of the requested report
-     * @return \Illuminate\Http\Response
-     */
-    public function getReport(Request $request, $reportName)
-    {
-        return \Response::json($this->repo->getReport($reportName, $request->all(), $request->query('perPage')), 200);
-    }
+	/**
+	 * Render the given report name with the given conditions.
+	 *
+	 * @param Request $request
+	 * @param  string $reportName Name of the requested report
+	 * @return \Illuminate\Http\Response
+	 */
+	public function getReport(Request $request, $reportName)
+	{
+		return \Response::json($this->repo->getReport($reportName, $request->all(), $request->query('perPage')), 200);
+	}
 }

src/Modules/Groups/Routes/api.php

Unused Use Statements -2 removed lines

@@ -1,7 +1,5 @@
 <?php
 
-use Illuminate\Http\Request;
-
 /*
 |--------------------------------------------------------------------------
 | API Routes

src/Modules/Permissions/Routes/api.php

Unused Use Statements -2 removed lines

@@ -1,7 +1,5 @@
 <?php
 
-use Illuminate\Http\Request;
-
 /*
 |--------------------------------------------------------------------------
 | API Routes

src/Modules/PushNotificationDevices/Repositories/PushNotificationDeviceRepository.php

Doc Comments +1 added lines, -1 removed lines

@@ -21,7 +21,7 @@
      * Register the given device to the logged in user.
      *
      * @param  array $data
-     * @return void
+     * @return boolean
      */
     public function registerDevice($data)
     {

Indentation +49 added lines, -49 removed lines

@@ -8,60 +8,60 @@
 
 class PushNotificationDeviceRepository extends BaseRepository
 {
-    /**
-     * Init new object.
-     *
-     * @param   PushNotificationDevice $model
-     * @return  void
-     */
-    public function __construct(PushNotificationDevice $model)
-    {
-        parent::__construct($model);
-    }
+	/**
+	 * Init new object.
+	 *
+	 * @param   PushNotificationDevice $model
+	 * @return  void
+	 */
+	public function __construct(PushNotificationDevice $model)
+	{
+		parent::__construct($model);
+	}
 
-    /**
-     * Register the given device to the logged in user.
-     *
-     * @param  array $data
-     * @return void
-     */
-    public function registerDevice($data)
-    {
-        $data['access_token'] = \Auth::user()->token();
-        $data['user_id']      = \Auth::id();
-        $device               = $this->model->where('device_token', $data['device_token'])->
-                                              where('user_id', $data['user_id'])->
-                                              first();
+	/**
+	 * Register the given device to the logged in user.
+	 *
+	 * @param  array $data
+	 * @return void
+	 */
+	public function registerDevice($data)
+	{
+		$data['access_token'] = \Auth::user()->token();
+		$data['user_id']      = \Auth::id();
+		$device               = $this->model->where('device_token', $data['device_token'])->
+											  where('user_id', $data['user_id'])->
+											  first();
 
-        if ($device) {
-            $data['id'] = $device->id;
-        }
+		if ($device) {
+			$data['id'] = $device->id;
+		}
 
-        return $this->save($data);
-    }
+		return $this->save($data);
+	}
 
-    /**
-     * Generate the given message data.
-     *
-     * @param  string $title
-     * @param  string $message
-     * @param  array  $data
-     * @return void
-     */
-    public function generateMessageData($title, $message, $data = [])
-    {
-        $optionBuilder       = new OptionsBuilder();
-        $notificationBuilder = new PayloadNotificationBuilder($title);
-        $dataBuilder         = new PayloadDataBuilder();
+	/**
+	 * Generate the given message data.
+	 *
+	 * @param  string $title
+	 * @param  string $message
+	 * @param  array  $data
+	 * @return void
+	 */
+	public function generateMessageData($title, $message, $data = [])
+	{
+		$optionBuilder       = new OptionsBuilder();
+		$notificationBuilder = new PayloadNotificationBuilder($title);
+		$dataBuilder         = new PayloadDataBuilder();
 
-        $optionBuilder->setTimeToLive(60 * 20);
-        $notificationBuilder->setBody($message);
-        $dataBuilder->addData($data);
+		$optionBuilder->setTimeToLive(60 * 20);
+		$notificationBuilder->setBody($message);
+		$dataBuilder->addData($data);
 
-        $options             = $optionBuilder->build();
-        $notification        = $notificationBuilder->build();
-        $data                = $dataBuilder->build();
+		$options             = $optionBuilder->build();
+		$notification        = $notificationBuilder->build();
+		$data                = $dataBuilder->build();
 
-        return compact('options', 'notification', 'data');
-    }
+		return compact('options', 'notification', 'data');
+	}
 }

src/Modules/PushNotificationDevices/Routes/api.php

Unused Use Statements -2 removed lines

@@ -1,7 +1,5 @@
 <?php
 
-use Illuminate\Http\Request;
-
 /*
 |--------------------------------------------------------------------------
 | API Routes