SherifElfadaly / Laravel-Api-Skeleton

src/Modules/Core/BaseClasses/BaseRepository.php

Indentation +588 added lines, -588 removed lines

@@ -8,605 +8,605 @@
 
 abstract class BaseRepository implements BaseRepositoryInterface
 {
-    /**
-     * @var object
-     */
-    public $model;
+	/**
+	 * @var object
+	 */
+	public $model;
     
-    /**
-     * Init new object.
-     *
-     * @var mixed model
-     * @return  void
-     */
-    public function __construct($model)
-    {
-        $this->model  = $model;
-    }
-
-    /**
-     * 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);
-    }
+	/**
+	 * Init new object.
+	 *
+	 * @var mixed model
+	 * @return  void
+	 */
+	public function __construct($model)
+	{
+		$this->model  = $model;
+	}
+
+	/**
+	 * 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.
-     *
-     * @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);
-    }
-
-    /**
-     * Count all records based on the given condition from storage.
-     *
-     * @param  array   $conditions array of conditions
-     * @return collection
-     */
-    public function count($conditions = false)
-    {
-        if($conditions) {
-            $conditions = $this->constructConditions($conditions, $this->model);
-            return $this->model->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->count();
-        }
+	/**
+	 * 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);
+	}
+
+	/**
+	 * Count all records based on the given condition from storage.
+	 *
+	 * @param  array   $conditions array of conditions
+	 * @return collection
+	 */
+	public function count($conditions = false)
+	{
+		if($conditions) {
+			$conditions = $this->constructConditions($conditions, $this->model);
+			return $this->model->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->count();
+		}
         
-        return $this->model->count();
-    }
-
-    /**
-     * Pluck column based on the given condition from storage.
-     *
-     * @param  array   $conditions array of conditions
-     * @param  string   $column
-     * @return collection
-     */
-    public function pluck($conditions, $column)
-    {
-        $conditions = $this->constructConditions($conditions, $this->model);
-        return $this->model->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->pluck($column);
-    }
+		return $this->model->count();
+	}
+
+	/**
+	 * Pluck column based on the given condition from storage.
+	 *
+	 * @param  array   $conditions array of conditions
+	 * @param  string   $column
+	 * @return collection
+	 */
+	public function pluck($conditions, $column)
+	{
+		$conditions = $this->constructConditions($conditions, $this->model);
+		return $this->model->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->pluck($column);
+	}
     
-    /**
-     * Save the given model to the storage.
-     *
-     * @param  array $data
-     * @return mixed
-     */
-    public function save(array $data)
-    {
-        $local = \Session::get('locale');
-        \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)
+	{
+		$local = \Session::get('locale');
+		\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);
-        });
-        \Session::put('locale', $local);
+			$model     = $this->prepareModel($data);
+			$relations = $this->prepareRelations($data, $model);
+			$model     = $this->saveModel($model, $relations);
+		});
+		\Session::put('locale', $local);
         
-        if (count($relations)) {
-            $model->load(...array_keys($relations));
-        }
+		if (count($relations)) {
+			$model->load(...array_keys($relations));
+		}
 
-        return $model;
-    }
+		return $model;
+	}
     
-    /**
-     * Insert the given model/models to the storage.
-     *
-     * @param  array $data
-     * @return mixed
-     */
-    public function insert(array $data)
-    {
-        return $this->model->insert($data);
-    }
-
-    /**
-     * 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')
-    {
-        \DB::transaction(function () use ($value, $attribute) {
-            $this->model->where($attribute, '=', $value)->lockForUpdate()->get()->each(function ($model) {
-                $model->delete();
-            });
-        });
-    }
+	/**
+	 * Insert the given model/models to the storage.
+	 *
+	 * @param  array $data
+	 * @return mixed
+	 */
+	public function insert(array $data)
+	{
+		return $this->model->insert($data);
+	}
+
+	/**
+	 * 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')
+	{
+		\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) {
-            \Errors::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) {
-            \Errors::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) {
+			\Errors::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) {
+			\Errors::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)
-    {
-        /**
-         * Init the relation array
-         *
-         * @var array
-         */
-        $relations = [];
-
-        /**
-         * 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 (! is_array($val)) {
-                                $relationModel = $relationBaseModel->lockForUpdate()->find($val);
-                            } else {
-                                /**
-                                 * 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) {
-                                \Errors::notFound(class_basename($relationBaseModel).' with id : '.$val['id']);
-                            }
-
-                            if (is_array($val)) {
-                                /**
-                                 * 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;
-                                    } elseif (gettype($val) !== 'object' && gettype($val) !== 'array' && $attr !== 'id') {
-                                        $extra[$attr] = $val;
-                                    }
-                                }
-                            }
-
-                            if (isset($extra)) {
-                                $relationModel->extra = $extra;
-                            }
-                            $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) {
-                                    \Errors::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':
-                            $extra = $val->extra;
-                            unset($val->extra);
-                            $val->save();
-                            $ids[$val->id] = $extra ?? [];
-                            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)
+	{
+		/**
+		 * Init the relation array
+		 *
+		 * @var array
+		 */
+		$relations = [];
+
+		/**
+		 * 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 (! is_array($val)) {
+								$relationModel = $relationBaseModel->lockForUpdate()->find($val);
+							} else {
+								/**
+								 * 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) {
+								\Errors::notFound(class_basename($relationBaseModel).' with id : '.$val['id']);
+							}
+
+							if (is_array($val)) {
+								/**
+								 * 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;
+									} elseif (gettype($val) !== 'object' && gettype($val) !== 'array' && $attr !== 'id') {
+										$extra[$attr] = $val;
+									}
+								}
+							}
+
+							if (isset($extra)) {
+								$relationModel->extra = $extra;
+							}
+							$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) {
+									\Errors::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':
+							$extra = $val->extra;
+							unset($val->extra);
+							$val->save();
+							$ids[$val->id] = $extra ?? [];
+							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()->withoutGlobalScopes()->has($key)->toSql();
-                    $bindings         = $model->withTrashed()->withoutGlobalScopes()->has($key)->getBindings();
-                    $conditions       = $this->constructConditions($value, $model->$key()->getRelated());
-                    $conditionString .= substr(substr($sql, strpos($sql, 'exists')), 0, -1).' and '.$conditions['conditionString'].') {op} ';
-                    $conditionValues  = array_merge($conditionValues, $bindings);
-                    $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()->withoutGlobalScopes()->has($key)->toSql();
+					$bindings         = $model->withTrashed()->withoutGlobalScopes()->has($key)->getBindings();
+					$conditions       = $this->constructConditions($value, $model->$key()->getRelated());
+					$conditionString .= substr(substr($sql, strpos($sql, 'exists')), 0, -1).' and '.$conditions['conditionString'].') {op} ';
+					$conditionValues  = array_merge($conditionValues, $bindings);
+					$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 +12 added lines, -12 removed lines

@@ -21,7 +21,7 @@ 
      */
     public function __construct($model)
     {
-        $this->model  = $model;
+        $this->model = $model;
     }
 
     /**
@@ -82,7 +82,7 @@ 
      */
     public function count($conditions = false)
     {
-        if($conditions) {
+        if ($conditions) {
             $conditions = $this->constructConditions($conditions, $this->model);
             return $this->model->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->count();
         }
@@ -116,7 +116,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);
@@ -152,8 +152,8 @@ 
      */
     public function delete($value, $attribute = 'id')
     {
-        \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();
             });
         });
@@ -243,7 +243,7 @@ 
     {
         $model = $this->model->onlyTrashed()->find($id);
 
-        if (! $model) {
+        if ( ! $model) {
             \Errors::notFound(class_basename($this->model).' with id : '.$id);
         }
 
@@ -267,7 +267,7 @@ 
          * @var array
          */
         $model = Arr::has($data, 'id') ? $modelClass->lockForUpdate()->find($data['id']) : new $modelClass;
-        if (! $model) {
+        if ( ! $model) {
             \Errors::notFound(class_basename($modelClass).' with id : '.$data['id']);
         }
 
@@ -324,7 +324,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';
                     }
                 }
@@ -342,7 +342,7 @@ 
                          * Check if the relation is a collection.
                          */
                         if (class_basename($model->$relation) == 'Collection') {
-                            if (! is_array($val)) {
+                            if ( ! is_array($val)) {
                                 $relationModel = $relationBaseModel->lockForUpdate()->find($val);
                             } else {
                                 /**
@@ -355,7 +355,7 @@ 
                             /**
                              * If model doesn't exists.
                              */
-                            if (! $relationModel) {
+                            if ( ! $relationModel) {
                                 \Errors::notFound(class_basename($relationBaseModel).' with id : '.$val['id']);
                             }
 
@@ -393,7 +393,7 @@ 
                                 /**
                                  * If model doesn't exists.
                                  */
-                                if (! $relationModel) {
+                                if ( ! $relationModel) {
                                     \Errors::notFound(class_basename($relationBaseModel).' with id : '.$value['id']);
                                 }
 
@@ -603,7 +603,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/Console/Commands/GenerateDocCommand.php

Indentation +302 added lines, -302 removed lines

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

src/Modules/Roles/Http/Requests/StoreRole.php

Indentation +21 added lines, -21 removed lines

@@ -6,26 +6,26 @@
 
 class StoreRole extends FormRequest
 {
-    /**
-     * Determine if the user is authorized to make this request.
-     *
-     * @return bool
-     */
-    public function authorize()
-    {
-        return true;
-    }
+	/**
+	 * Determine if the user is authorized to make this request.
+	 *
+	 * @return bool
+	 */
+	public function authorize()
+	{
+		return true;
+	}
 
-    /**
-     * Get the validation rules that apply to the request.
-     *
-     * @return array
-     */
-    public function rules()
-    {
-        $requiredOrNullable = request()->isMethod('PATCH') ? 'nullable' : 'required' . '';
-        return [
-            'name' => $requiredOrNullable . '|string|max:100|unique:roles,name,' . $this->route('id')
-        ];
-    }
+	/**
+	 * Get the validation rules that apply to the request.
+	 *
+	 * @return array
+	 */
+	public function rules()
+	{
+		$requiredOrNullable = request()->isMethod('PATCH') ? 'nullable' : 'required' . '';
+		return [
+			'name' => $requiredOrNullable . '|string|max:100|unique:roles,name,' . $this->route('id')
+		];
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -23,9 +23,9 @@
      */
     public function rules()
     {
-        $requiredOrNullable = request()->isMethod('PATCH') ? 'nullable' : 'required' . '';
+        $requiredOrNullable = request()->isMethod('PATCH') ? 'nullable' : 'required'.'';
         return [
-            'name' => $requiredOrNullable . '|string|max:100|unique:roles,name,' . $this->route('id')
+            'name' => $requiredOrNullable.'|string|max:100|unique:roles,name,'.$this->route('id')
         ];
     }
 }

src/Modules/OauthClients/Http/Requests/StoreOauthClient.php

Indentation +24 added lines, -24 removed lines

@@ -6,29 +6,29 @@
 
 class StoreOauthClient extends FormRequest
 {
-    /**
-     * Determine if the user is authorized to make this request.
-     *
-     * @return bool
-     */
-    public function authorize()
-    {
-        return true;
-    }
+	/**
+	 * Determine if the user is authorized to make this request.
+	 *
+	 * @return bool
+	 */
+	public function authorize()
+	{
+		return true;
+	}
 
-    /**
-     * Get the validation rules that apply to the request.
-     *
-     * @return array
-     */
-    public function rules()
-    {
-        $requiredOrNullable = request()->isMethod('PATCH') ? 'nullable' : 'required' . '';
-        return [
-            'name'     => $requiredOrNullable . '|max:255',
-            'redirect' => $requiredOrNullable . '|url',
-            'user_id'  => $requiredOrNullable . '|exists:users,id',
-            'revoked'  => 'boolean'
-        ];
-    }
+	/**
+	 * Get the validation rules that apply to the request.
+	 *
+	 * @return array
+	 */
+	public function rules()
+	{
+		$requiredOrNullable = request()->isMethod('PATCH') ? 'nullable' : 'required' . '';
+		return [
+			'name'     => $requiredOrNullable . '|max:255',
+			'redirect' => $requiredOrNullable . '|url',
+			'user_id'  => $requiredOrNullable . '|exists:users,id',
+			'revoked'  => 'boolean'
+		];
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -23,11 +23,11 @@
      */
     public function rules()
     {
-        $requiredOrNullable = request()->isMethod('PATCH') ? 'nullable' : 'required' . '';
+        $requiredOrNullable = request()->isMethod('PATCH') ? 'nullable' : 'required'.'';
         return [
-            'name'     => $requiredOrNullable . '|max:255',
-            'redirect' => $requiredOrNullable . '|url',
-            'user_id'  => $requiredOrNullable . '|exists:users,id',
+            'name'     => $requiredOrNullable.'|max:255',
+            'redirect' => $requiredOrNullable.'|url',
+            'user_id'  => $requiredOrNullable.'|exists:users,id',
             'revoked'  => 'boolean'
         ];
     }

src/Modules/Users/Http/Requests/StoreUser.php

Indentation +23 added lines, -23 removed lines

@@ -6,28 +6,28 @@
 
 class StoreUser extends FormRequest
 {
-    /**
-     * Determine if the user is authorized to make this request.
-     *
-     * @return bool
-     */
-    public function authorize()
-    {
-        return true;
-    }
+	/**
+	 * Determine if the user is authorized to make this request.
+	 *
+	 * @return bool
+	 */
+	public function authorize()
+	{
+		return true;
+	}
 
-    /**
-     * Get the validation rules that apply to the request.
-     *
-     * @return array
-     */
-    public function rules()
-    {
-        $requiredOrNullable = request()->isMethod('PATCH') ? 'nullable' : 'required' . '';
-        return [
-            'name'     => 'nullable|string',
-            'email'    => $requiredOrNullable . '|email|unique:users,email,' . $this->route('id'),
-            'password' => 'nullable|min:6'
-        ];
-    }
+	/**
+	 * Get the validation rules that apply to the request.
+	 *
+	 * @return array
+	 */
+	public function rules()
+	{
+		$requiredOrNullable = request()->isMethod('PATCH') ? 'nullable' : 'required' . '';
+		return [
+			'name'     => 'nullable|string',
+			'email'    => $requiredOrNullable . '|email|unique:users,email,' . $this->route('id'),
+			'password' => 'nullable|min:6'
+		];
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -23,10 +23,10 @@
      */
     public function rules()
     {
-        $requiredOrNullable = request()->isMethod('PATCH') ? 'nullable' : 'required' . '';
+        $requiredOrNullable = request()->isMethod('PATCH') ? 'nullable' : 'required'.'';
         return [
             'name'     => 'nullable|string',
-            'email'    => $requiredOrNullable . '|email|unique:users,email,' . $this->route('id'),
+            'email'    => $requiredOrNullable.'|email|unique:users,email,'.$this->route('id'),
             'password' => 'nullable|min:6'
         ];
     }

src/Modules/PushNotificationDevices/Http/Requests/StorePushNotificationDevice.php

Indentation +22 added lines, -22 removed lines

@@ -6,27 +6,27 @@
 
 class StorePushNotificationDevice extends FormRequest
 {
-    /**
-     * Determine if the user is authorized to make this request.
-     *
-     * @return bool
-     */
-    public function authorize()
-    {
-        return true;
-    }
+	/**
+	 * Determine if the user is authorized to make this request.
+	 *
+	 * @return bool
+	 */
+	public function authorize()
+	{
+		return true;
+	}
 
-    /**
-     * Get the validation rules that apply to the request.
-     *
-     * @return array
-     */
-    public function rules()
-    {
-        $requiredOrNullable = request()->isMethod('PATCH') ? 'nullable' : 'required' . '';
-        return [
-            'device_token' => $requiredOrNullable . '|string|max:255',
-            'user_id'      => $requiredOrNullable . '|exists:users,id'
-        ];
-    }
+	/**
+	 * Get the validation rules that apply to the request.
+	 *
+	 * @return array
+	 */
+	public function rules()
+	{
+		$requiredOrNullable = request()->isMethod('PATCH') ? 'nullable' : 'required' . '';
+		return [
+			'device_token' => $requiredOrNullable . '|string|max:255',
+			'user_id'      => $requiredOrNullable . '|exists:users,id'
+		];
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -23,10 +23,10 @@
      */
     public function rules()
     {
-        $requiredOrNullable = request()->isMethod('PATCH') ? 'nullable' : 'required' . '';
+        $requiredOrNullable = request()->isMethod('PATCH') ? 'nullable' : 'required'.'';
         return [
-            'device_token' => $requiredOrNullable . '|string|max:255',
-            'user_id'      => $requiredOrNullable . '|exists:users,id'
+            'device_token' => $requiredOrNullable.'|string|max:255',
+            'user_id'      => $requiredOrNullable.'|exists:users,id'
         ];
     }
 }