@@ -5,68 +5,68 @@ |
||
| 5 | 5 | */ |
| 6 | 6 | class SettingsObserver { |
| 7 | 7 | |
| 8 | - public function saving($model) |
|
| 9 | - { |
|
| 10 | - // |
|
| 11 | - } |
|
| 8 | + public function saving($model) |
|
| 9 | + { |
|
| 10 | + // |
|
| 11 | + } |
|
| 12 | 12 | |
| 13 | - public function saved($model) |
|
| 14 | - { |
|
| 15 | - // |
|
| 16 | - } |
|
| 13 | + public function saved($model) |
|
| 14 | + { |
|
| 15 | + // |
|
| 16 | + } |
|
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * Prevent the creating of the settings. |
|
| 20 | - * |
|
| 21 | - * @param object $model the model beign created. |
|
| 22 | - * @return void |
|
| 23 | - */ |
|
| 24 | - public function creating($model) |
|
| 25 | - { |
|
| 26 | - \ErrorHandler::cannotCreateSetting(); |
|
| 27 | - } |
|
| 18 | + /** |
|
| 19 | + * Prevent the creating of the settings. |
|
| 20 | + * |
|
| 21 | + * @param object $model the model beign created. |
|
| 22 | + * @return void |
|
| 23 | + */ |
|
| 24 | + public function creating($model) |
|
| 25 | + { |
|
| 26 | + \ErrorHandler::cannotCreateSetting(); |
|
| 27 | + } |
|
| 28 | 28 | |
| 29 | - public function created($model) |
|
| 30 | - { |
|
| 31 | - // |
|
| 32 | - } |
|
| 29 | + public function created($model) |
|
| 30 | + { |
|
| 31 | + // |
|
| 32 | + } |
|
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * Prevent updating of the setting key. |
|
| 36 | - * |
|
| 37 | - * @param object $model the model beign updated. |
|
| 38 | - * @return void |
|
| 39 | - */ |
|
| 40 | - public function updating($model) |
|
| 41 | - { |
|
| 42 | - if ($model->getOriginal('key') !== $model->key) |
|
| 43 | - { |
|
| 44 | - \ErrorHandler::cannotUpdateSettingKey(); |
|
| 45 | - } |
|
| 46 | - } |
|
| 34 | + /** |
|
| 35 | + * Prevent updating of the setting key. |
|
| 36 | + * |
|
| 37 | + * @param object $model the model beign updated. |
|
| 38 | + * @return void |
|
| 39 | + */ |
|
| 40 | + public function updating($model) |
|
| 41 | + { |
|
| 42 | + if ($model->getOriginal('key') !== $model->key) |
|
| 43 | + { |
|
| 44 | + \ErrorHandler::cannotUpdateSettingKey(); |
|
| 45 | + } |
|
| 46 | + } |
|
| 47 | 47 | |
| 48 | - public function updated($model) |
|
| 49 | - { |
|
| 50 | - // |
|
| 51 | - } |
|
| 48 | + public function updated($model) |
|
| 49 | + { |
|
| 50 | + // |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | - public function deleting($model) |
|
| 54 | - { |
|
| 55 | - // |
|
| 56 | - } |
|
| 53 | + public function deleting($model) |
|
| 54 | + { |
|
| 55 | + // |
|
| 56 | + } |
|
| 57 | 57 | |
| 58 | - public function deleted($model) |
|
| 59 | - { |
|
| 60 | - // |
|
| 61 | - } |
|
| 58 | + public function deleted($model) |
|
| 59 | + { |
|
| 60 | + // |
|
| 61 | + } |
|
| 62 | 62 | |
| 63 | - public function restoring($model) |
|
| 64 | - { |
|
| 65 | - // |
|
| 66 | - } |
|
| 63 | + public function restoring($model) |
|
| 64 | + { |
|
| 65 | + // |
|
| 66 | + } |
|
| 67 | 67 | |
| 68 | - public function restored($model) |
|
| 69 | - { |
|
| 70 | - // |
|
| 71 | - } |
|
| 68 | + public function restored($model) |
|
| 69 | + { |
|
| 70 | + // |
|
| 71 | + } |
|
| 72 | 72 | } |
| 73 | 73 | \ No newline at end of file |
@@ -3,10 +3,10 @@ discard block |
||
| 3 | 3 | |
| 4 | 4 | class CoreConfig |
| 5 | 5 | { |
| 6 | - public function getConfig() |
|
| 7 | - { |
|
| 8 | - return [ |
|
| 9 | - 'resetLink' => '{{link_here}}', |
|
| 6 | + public function getConfig() |
|
| 7 | + { |
|
| 8 | + return [ |
|
| 9 | + 'resetLink' => '{{link_here}}', |
|
| 10 | 10 | /** |
| 11 | 11 | * Specify what relations should be used for every model. |
| 12 | 12 | */ |
@@ -180,5 +180,5 @@ discard block |
||
| 180 | 180 | ] |
| 181 | 181 | ] |
| 182 | 182 | ]; |
| 183 | - } |
|
| 183 | + } |
|
| 184 | 184 | } |
| 185 | 185 | \ No newline at end of file |
@@ -4,649 +4,649 @@ |
||
| 4 | 4 | |
| 5 | 5 | abstract class AbstractRepository implements RepositoryInterface |
| 6 | 6 | { |
| 7 | - /** |
|
| 8 | - * The model implementation. |
|
| 9 | - * |
|
| 10 | - * @var model |
|
| 11 | - */ |
|
| 12 | - public $model; |
|
| 7 | + /** |
|
| 8 | + * The model implementation. |
|
| 9 | + * |
|
| 10 | + * @var model |
|
| 11 | + */ |
|
| 12 | + public $model; |
|
| 13 | 13 | |
| 14 | - /** |
|
| 15 | - * Create new AbstractRepository instance. |
|
| 16 | - */ |
|
| 17 | - public function __construct() |
|
| 18 | - { |
|
| 19 | - $this->model = \App::make($this->getModel()); |
|
| 20 | - } |
|
| 21 | - |
|
| 22 | - /** |
|
| 23 | - * Fetch all records with relations from the storage. |
|
| 24 | - * |
|
| 25 | - * @param array $relations |
|
| 26 | - * @param string $sortBy |
|
| 27 | - * @param boolean $desc |
|
| 28 | - * @param array $columns |
|
| 29 | - * @return collection |
|
| 30 | - */ |
|
| 31 | - public function all($relations = [], $sortBy = 'created_at', $desc = 1, $columns = array('*')) |
|
| 32 | - { |
|
| 33 | - $sort = $desc ? 'desc' : 'asc'; |
|
| 34 | - return call_user_func_array("{$this->getModel()}::with", array($relations))->orderBy($sortBy, $sort)->get($columns); |
|
| 35 | - } |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * Fetch all records with relations from storage in pages |
|
| 39 | - * that matche the given query. |
|
| 40 | - * |
|
| 41 | - * @param string $query |
|
| 42 | - * @param integer $perPage |
|
| 43 | - * @param array $relations |
|
| 44 | - * @param string $sortBy |
|
| 45 | - * @param boolean $desc |
|
| 46 | - * @param array $columns |
|
| 47 | - * @return collection |
|
| 48 | - */ |
|
| 49 | - public function search($query, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = array('*')) |
|
| 50 | - { |
|
| 51 | - $model = call_user_func_array("{$this->getModel()}::with", array($relations)); |
|
| 52 | - $conditionColumns = $this->model->searchable; |
|
| 53 | - $sort = $desc ? 'desc' : 'asc'; |
|
| 54 | - |
|
| 55 | - /** |
|
| 56 | - * Construct the select conditions for the model. |
|
| 57 | - */ |
|
| 58 | - $model->where(function ($q) use ($query, $conditionColumns, $relations){ |
|
| 59 | - |
|
| 60 | - if (count($conditionColumns)) |
|
| 61 | - { |
|
| 62 | - /** |
|
| 63 | - * Use the first element in the model columns to construct the first condition. |
|
| 64 | - */ |
|
| 65 | - $q->where(\DB::raw('LOWER(' . array_shift($conditionColumns) . ')'), 'LIKE', '%' . strtolower($query) . '%'); |
|
| 66 | - } |
|
| 67 | - |
|
| 68 | - /** |
|
| 69 | - * Loop through the rest of the columns to construct or where conditions. |
|
| 70 | - */ |
|
| 71 | - foreach ($conditionColumns as $column) |
|
| 72 | - { |
|
| 73 | - $q->orWhere(\DB::raw('LOWER(' . $column . ')'), 'LIKE', '%' . strtolower($query) . '%'); |
|
| 74 | - } |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * Loop through the model relations. |
|
| 78 | - */ |
|
| 79 | - foreach ($relations as $relation) |
|
| 80 | - { |
|
| 81 | - /** |
|
| 82 | - * Remove the sub relation if exists. |
|
| 83 | - */ |
|
| 84 | - $relation = explode('.', $relation)[0]; |
|
| 85 | - |
|
| 86 | - /** |
|
| 87 | - * Try to fetch the relation repository from the core. |
|
| 88 | - */ |
|
| 89 | - if (\Core::$relation()) |
|
| 90 | - { |
|
| 91 | - /** |
|
| 92 | - * Construct the relation condition. |
|
| 93 | - */ |
|
| 94 | - $q->orWhereHas($relation, function ($subModel) use ($query, $relation){ |
|
| 95 | - |
|
| 96 | - $subModel->where(function ($q) use ($query, $relation){ |
|
| 97 | - |
|
| 98 | - /** |
|
| 99 | - * Get columns of the relation. |
|
| 100 | - */ |
|
| 101 | - $subConditionColumns = \Core::$relation()->model->searchable; |
|
| 102 | - |
|
| 103 | - if (count($subConditionColumns)) |
|
| 104 | - { |
|
| 105 | - /** |
|
| 106 | - * Use the first element in the relation model columns to construct the first condition. |
|
| 107 | - */ |
|
| 108 | - $q->where(\DB::raw('LOWER(' . array_shift($subConditionColumns) . ')'), 'LIKE', '%' . strtolower($query) . '%'); |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - /** |
|
| 112 | - * Loop through the rest of the columns to construct or where conditions. |
|
| 113 | - */ |
|
| 114 | - foreach ($subConditionColumns as $subConditionColumn) |
|
| 115 | - { |
|
| 116 | - $q->orWhere(\DB::raw('LOWER(' . $subConditionColumn . ')'), 'LIKE', '%' . strtolower($query) . '%'); |
|
| 117 | - } |
|
| 118 | - }); |
|
| 119 | - |
|
| 120 | - }); |
|
| 121 | - } |
|
| 122 | - } |
|
| 123 | - }); |
|
| 14 | + /** |
|
| 15 | + * Create new AbstractRepository instance. |
|
| 16 | + */ |
|
| 17 | + public function __construct() |
|
| 18 | + { |
|
| 19 | + $this->model = \App::make($this->getModel()); |
|
| 20 | + } |
|
| 21 | + |
|
| 22 | + /** |
|
| 23 | + * Fetch all records with relations from the storage. |
|
| 24 | + * |
|
| 25 | + * @param array $relations |
|
| 26 | + * @param string $sortBy |
|
| 27 | + * @param boolean $desc |
|
| 28 | + * @param array $columns |
|
| 29 | + * @return collection |
|
| 30 | + */ |
|
| 31 | + public function all($relations = [], $sortBy = 'created_at', $desc = 1, $columns = array('*')) |
|
| 32 | + { |
|
| 33 | + $sort = $desc ? 'desc' : 'asc'; |
|
| 34 | + return call_user_func_array("{$this->getModel()}::with", array($relations))->orderBy($sortBy, $sort)->get($columns); |
|
| 35 | + } |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * Fetch all records with relations from storage in pages |
|
| 39 | + * that matche the given query. |
|
| 40 | + * |
|
| 41 | + * @param string $query |
|
| 42 | + * @param integer $perPage |
|
| 43 | + * @param array $relations |
|
| 44 | + * @param string $sortBy |
|
| 45 | + * @param boolean $desc |
|
| 46 | + * @param array $columns |
|
| 47 | + * @return collection |
|
| 48 | + */ |
|
| 49 | + public function search($query, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = array('*')) |
|
| 50 | + { |
|
| 51 | + $model = call_user_func_array("{$this->getModel()}::with", array($relations)); |
|
| 52 | + $conditionColumns = $this->model->searchable; |
|
| 53 | + $sort = $desc ? 'desc' : 'asc'; |
|
| 54 | + |
|
| 55 | + /** |
|
| 56 | + * Construct the select conditions for the model. |
|
| 57 | + */ |
|
| 58 | + $model->where(function ($q) use ($query, $conditionColumns, $relations){ |
|
| 59 | + |
|
| 60 | + if (count($conditionColumns)) |
|
| 61 | + { |
|
| 62 | + /** |
|
| 63 | + * Use the first element in the model columns to construct the first condition. |
|
| 64 | + */ |
|
| 65 | + $q->where(\DB::raw('LOWER(' . array_shift($conditionColumns) . ')'), 'LIKE', '%' . strtolower($query) . '%'); |
|
| 66 | + } |
|
| 67 | + |
|
| 68 | + /** |
|
| 69 | + * Loop through the rest of the columns to construct or where conditions. |
|
| 70 | + */ |
|
| 71 | + foreach ($conditionColumns as $column) |
|
| 72 | + { |
|
| 73 | + $q->orWhere(\DB::raw('LOWER(' . $column . ')'), 'LIKE', '%' . strtolower($query) . '%'); |
|
| 74 | + } |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * Loop through the model relations. |
|
| 78 | + */ |
|
| 79 | + foreach ($relations as $relation) |
|
| 80 | + { |
|
| 81 | + /** |
|
| 82 | + * Remove the sub relation if exists. |
|
| 83 | + */ |
|
| 84 | + $relation = explode('.', $relation)[0]; |
|
| 85 | + |
|
| 86 | + /** |
|
| 87 | + * Try to fetch the relation repository from the core. |
|
| 88 | + */ |
|
| 89 | + if (\Core::$relation()) |
|
| 90 | + { |
|
| 91 | + /** |
|
| 92 | + * Construct the relation condition. |
|
| 93 | + */ |
|
| 94 | + $q->orWhereHas($relation, function ($subModel) use ($query, $relation){ |
|
| 95 | + |
|
| 96 | + $subModel->where(function ($q) use ($query, $relation){ |
|
| 97 | + |
|
| 98 | + /** |
|
| 99 | + * Get columns of the relation. |
|
| 100 | + */ |
|
| 101 | + $subConditionColumns = \Core::$relation()->model->searchable; |
|
| 102 | + |
|
| 103 | + if (count($subConditionColumns)) |
|
| 104 | + { |
|
| 105 | + /** |
|
| 106 | + * Use the first element in the relation model columns to construct the first condition. |
|
| 107 | + */ |
|
| 108 | + $q->where(\DB::raw('LOWER(' . array_shift($subConditionColumns) . ')'), 'LIKE', '%' . strtolower($query) . '%'); |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + /** |
|
| 112 | + * Loop through the rest of the columns to construct or where conditions. |
|
| 113 | + */ |
|
| 114 | + foreach ($subConditionColumns as $subConditionColumn) |
|
| 115 | + { |
|
| 116 | + $q->orWhere(\DB::raw('LOWER(' . $subConditionColumn . ')'), 'LIKE', '%' . strtolower($query) . '%'); |
|
| 117 | + } |
|
| 118 | + }); |
|
| 119 | + |
|
| 120 | + }); |
|
| 121 | + } |
|
| 122 | + } |
|
| 123 | + }); |
|
| 124 | 124 | |
| 125 | - return $model->orderBy($sortBy, $sort)->paginate($perPage, $columns); |
|
| 126 | - } |
|
| 125 | + return $model->orderBy($sortBy, $sort)->paginate($perPage, $columns); |
|
| 126 | + } |
|
| 127 | 127 | |
| 128 | - /** |
|
| 129 | - * Fetch all records with relations from storage in pages. |
|
| 130 | - * |
|
| 131 | - * @param integer $perPage |
|
| 132 | - * @param array $relations |
|
| 133 | - * @param string $sortBy |
|
| 134 | - * @param boolean $desc |
|
| 135 | - * @param array $columns |
|
| 136 | - * @return collection |
|
| 137 | - */ |
|
| 138 | - public function paginate($perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = array('*')) |
|
| 139 | - { |
|
| 140 | - $sort = $desc ? 'desc' : 'asc'; |
|
| 141 | - return call_user_func_array("{$this->getModel()}::with", array($relations))->orderBy($sortBy, $sort)->paginate($perPage, $columns); |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - /** |
|
| 145 | - * Fetch all records with relations based on |
|
| 146 | - * the given condition from storage in pages. |
|
| 147 | - * |
|
| 148 | - * @param array $conditions array of conditions |
|
| 149 | - * @param integer $perPage |
|
| 150 | - * @param array $relations |
|
| 151 | - * @param string $sortBy |
|
| 152 | - * @param boolean $desc |
|
| 153 | - * @param array $columns |
|
| 154 | - * @return collection |
|
| 155 | - */ |
|
| 156 | - public function paginateBy($conditions, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = array('*')) |
|
| 157 | - { |
|
| 158 | - unset($conditions['page']); |
|
| 159 | - $conditions = $this->constructConditions($conditions, $this->model); |
|
| 160 | - $sort = $desc ? 'desc' : 'asc'; |
|
| 161 | - return call_user_func_array("{$this->getModel()}::with", array($relations))->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->orderBy($sortBy, $sort)->paginate($perPage, $columns); |
|
| 162 | - } |
|
| 128 | + /** |
|
| 129 | + * Fetch all records with relations from storage in pages. |
|
| 130 | + * |
|
| 131 | + * @param integer $perPage |
|
| 132 | + * @param array $relations |
|
| 133 | + * @param string $sortBy |
|
| 134 | + * @param boolean $desc |
|
| 135 | + * @param array $columns |
|
| 136 | + * @return collection |
|
| 137 | + */ |
|
| 138 | + public function paginate($perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = array('*')) |
|
| 139 | + { |
|
| 140 | + $sort = $desc ? 'desc' : 'asc'; |
|
| 141 | + return call_user_func_array("{$this->getModel()}::with", array($relations))->orderBy($sortBy, $sort)->paginate($perPage, $columns); |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + /** |
|
| 145 | + * Fetch all records with relations based on |
|
| 146 | + * the given condition from storage in pages. |
|
| 147 | + * |
|
| 148 | + * @param array $conditions array of conditions |
|
| 149 | + * @param integer $perPage |
|
| 150 | + * @param array $relations |
|
| 151 | + * @param string $sortBy |
|
| 152 | + * @param boolean $desc |
|
| 153 | + * @param array $columns |
|
| 154 | + * @return collection |
|
| 155 | + */ |
|
| 156 | + public function paginateBy($conditions, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = array('*')) |
|
| 157 | + { |
|
| 158 | + unset($conditions['page']); |
|
| 159 | + $conditions = $this->constructConditions($conditions, $this->model); |
|
| 160 | + $sort = $desc ? 'desc' : 'asc'; |
|
| 161 | + return call_user_func_array("{$this->getModel()}::with", array($relations))->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->orderBy($sortBy, $sort)->paginate($perPage, $columns); |
|
| 162 | + } |
|
| 163 | 163 | |
| 164 | - /** |
|
| 165 | - * Save the given model to the storage. |
|
| 166 | - * |
|
| 167 | - * @param array $data |
|
| 168 | - * @param boolean $saveLog |
|
| 169 | - * @return void |
|
| 170 | - */ |
|
| 171 | - public function save(array $data, $saveLog = true) |
|
| 172 | - { |
|
| 173 | - $model = false; |
|
| 174 | - $modelClass = $this->model; |
|
| 175 | - $relations = []; |
|
| 176 | - |
|
| 177 | - \DB::transaction(function () use (&$model, &$relations, $data, $saveLog, $modelClass) { |
|
| 178 | - /** |
|
| 179 | - * If the id is present in the data then select the model for updating, |
|
| 180 | - * else create new model. |
|
| 181 | - * @var array |
|
| 182 | - */ |
|
| 183 | - $model = array_key_exists('id', $data) ? $modelClass->lockForUpdate()->find($data['id']) : new $modelClass; |
|
| 184 | - if ( ! $model) |
|
| 185 | - { |
|
| 186 | - \ErrorHandler::notFound(class_basename($modelClass) . ' with id : ' . $data['id']); |
|
| 187 | - } |
|
| 188 | - |
|
| 189 | - /** |
|
| 190 | - * Construct the model object with the given data, |
|
| 191 | - * and if there is a relation add it to relations array, |
|
| 192 | - * then save the model. |
|
| 193 | - */ |
|
| 194 | - foreach ($data as $key => $value) |
|
| 195 | - { |
|
| 196 | - /** |
|
| 197 | - * If the attribute is a relation. |
|
| 198 | - */ |
|
| 199 | - $relation = camel_case($key); |
|
| 200 | - if (method_exists($model, $relation) && \Core::$relation()) |
|
| 201 | - { |
|
| 202 | - /** |
|
| 203 | - * Check if the relation is a collection. |
|
| 204 | - */ |
|
| 205 | - if (class_basename($model->$relation) == 'Collection') |
|
| 206 | - { |
|
| 207 | - /** |
|
| 208 | - * If the relation has no value then marke the relation data |
|
| 209 | - * related to the model to be deleted. |
|
| 210 | - */ |
|
| 211 | - if ( ! $value || ! count($value)) |
|
| 212 | - { |
|
| 213 | - $relations[$relation] = 'delete'; |
|
| 214 | - } |
|
| 215 | - } |
|
| 216 | - if (is_array($value)) |
|
| 217 | - { |
|
| 218 | - /** |
|
| 219 | - * Loop through the relation data. |
|
| 220 | - */ |
|
| 221 | - foreach ($value as $attr => $val) |
|
| 222 | - { |
|
| 223 | - /** |
|
| 224 | - * Get the relation model. |
|
| 225 | - */ |
|
| 226 | - $relationBaseModel = \Core::$relation()->model; |
|
| 227 | - |
|
| 228 | - /** |
|
| 229 | - * Check if the relation is a collection. |
|
| 230 | - */ |
|
| 231 | - if (class_basename($model->$relation) == 'Collection') |
|
| 232 | - { |
|
| 233 | - /** |
|
| 234 | - * If the id is present in the data then select the relation model for updating, |
|
| 235 | - * else create new model. |
|
| 236 | - */ |
|
| 237 | - $relationModel = array_key_exists('id', $val) ? $relationBaseModel->lockForUpdate()->find($val['id']) : new $relationBaseModel; |
|
| 238 | - |
|
| 239 | - /** |
|
| 240 | - * If model doesn't exists. |
|
| 241 | - */ |
|
| 242 | - if ( ! $relationModel) |
|
| 243 | - { |
|
| 244 | - \ErrorHandler::notFound(class_basename($relationBaseModel) . ' with id : ' . $val['id']); |
|
| 245 | - } |
|
| 246 | - |
|
| 247 | - /** |
|
| 248 | - * Loop through the relation attributes. |
|
| 249 | - */ |
|
| 250 | - foreach ($val as $attr => $val) |
|
| 251 | - { |
|
| 252 | - /** |
|
| 253 | - * Prevent the sub relations or attributes not in the fillable. |
|
| 254 | - */ |
|
| 255 | - if (gettype($val) !== 'object' && gettype($val) !== 'array' && array_search($attr, $relationModel->getFillable(), true) !== false) |
|
| 256 | - { |
|
| 257 | - $relationModel->$attr = $val; |
|
| 258 | - } |
|
| 259 | - } |
|
| 260 | - |
|
| 261 | - $relations[$relation][] = $relationModel; |
|
| 262 | - } |
|
| 263 | - /** |
|
| 264 | - * If not collection. |
|
| 265 | - */ |
|
| 266 | - else |
|
| 267 | - { |
|
| 268 | - /** |
|
| 269 | - * Prevent the sub relations. |
|
| 270 | - */ |
|
| 271 | - if (gettype($val) !== 'object' && gettype($val) !== 'array') |
|
| 272 | - { |
|
| 273 | - |
|
| 274 | - /** |
|
| 275 | - * If the id is present in the data then select the relation model for updating, |
|
| 276 | - * else create new model. |
|
| 277 | - */ |
|
| 278 | - $relationModel = array_key_exists('id', $value) ? $relationBaseModel->lockForUpdate()->find($value['id']) : new $relationBaseModel; |
|
| 279 | - |
|
| 280 | - /** |
|
| 281 | - * If model doesn't exists. |
|
| 282 | - */ |
|
| 283 | - if ( ! $relationModel) |
|
| 284 | - { |
|
| 285 | - \ErrorHandler::notFound(class_basename($relationBaseModel) . ' with id : ' . $value['id']); |
|
| 286 | - } |
|
| 287 | - |
|
| 288 | - foreach ($value as $relationAttribute => $relationValue) |
|
| 289 | - { |
|
| 290 | - /** |
|
| 291 | - * Prevent attributes not in the fillable. |
|
| 292 | - */ |
|
| 293 | - if (array_search($relationAttribute, $relationModel->getFillable(), true) !== false) |
|
| 294 | - { |
|
| 295 | - $relationModel->$relationAttribute = $relationValue; |
|
| 296 | - } |
|
| 297 | - } |
|
| 298 | - |
|
| 299 | - $relations[$relation] = $relationModel; |
|
| 300 | - } |
|
| 301 | - } |
|
| 302 | - } |
|
| 303 | - } |
|
| 304 | - } |
|
| 305 | - /** |
|
| 306 | - * If the attribute isn't a relation and prevent attributes not in the fillable. |
|
| 307 | - */ |
|
| 308 | - else if (array_search($key, $model->getFillable(), true) !== false) |
|
| 309 | - { |
|
| 310 | - $model->$key = $value; |
|
| 311 | - } |
|
| 312 | - } |
|
| 313 | - /** |
|
| 314 | - * Save the model. |
|
| 315 | - */ |
|
| 316 | - $model->save(); |
|
| 317 | - |
|
| 318 | - /** |
|
| 319 | - * Loop through the relations array. |
|
| 320 | - */ |
|
| 321 | - foreach ($relations as $key => $value) |
|
| 322 | - { |
|
| 323 | - /** |
|
| 324 | - * If the relation is marked for delete then delete it. |
|
| 325 | - */ |
|
| 326 | - if ($value == 'delete' && $model->$key()->count()) |
|
| 327 | - { |
|
| 328 | - $model->$key()->delete(); |
|
| 329 | - } |
|
| 330 | - /** |
|
| 331 | - * If the relation is an array. |
|
| 332 | - */ |
|
| 333 | - else if (gettype($value) == 'array') |
|
| 334 | - { |
|
| 335 | - $ids = []; |
|
| 336 | - /** |
|
| 337 | - * Loop through the relations. |
|
| 338 | - */ |
|
| 339 | - foreach ($value as $val) |
|
| 340 | - { |
|
| 341 | - switch (class_basename($model->$key())) |
|
| 342 | - { |
|
| 343 | - /** |
|
| 344 | - * If the relation is one to many then update it's foreign key with |
|
| 345 | - * the model id and save it then add its id to ids array to delete all |
|
| 346 | - * relations who's id isn't in the ids array. |
|
| 347 | - */ |
|
| 348 | - case 'HasMany': |
|
| 349 | - $foreignKeyName = $model->$key()->getForeignKeyName(); |
|
| 350 | - $val->$foreignKeyName = $model->id; |
|
| 351 | - $val->save(); |
|
| 352 | - $ids[] = $val->id; |
|
| 353 | - break; |
|
| 354 | - |
|
| 355 | - /** |
|
| 356 | - * If the relation is many to many then add it's id to the ids array to |
|
| 357 | - * attache these ids to the model. |
|
| 358 | - */ |
|
| 359 | - case 'BelongsToMany': |
|
| 360 | - $val->save(); |
|
| 361 | - $ids[] = $val->id; |
|
| 362 | - break; |
|
| 363 | - } |
|
| 364 | - } |
|
| 365 | - switch (class_basename($model->$key())) |
|
| 366 | - { |
|
| 367 | - /** |
|
| 368 | - * If the relation is one to many then delete all |
|
| 369 | - * relations who's id isn't in the ids array. |
|
| 370 | - */ |
|
| 371 | - case 'HasMany': |
|
| 372 | - $model->$key()->whereNotIn('id', $ids)->delete(); |
|
| 373 | - break; |
|
| 374 | - |
|
| 375 | - /** |
|
| 376 | - * If the relation is many to many then |
|
| 377 | - * detach the previous data and attach |
|
| 378 | - * the ids array to the model. |
|
| 379 | - */ |
|
| 380 | - case 'BelongsToMany': |
|
| 381 | - $model->$key()->detach(); |
|
| 382 | - $model->$key()->attach($ids); |
|
| 383 | - break; |
|
| 384 | - } |
|
| 385 | - } |
|
| 386 | - /** |
|
| 387 | - * If the relation isn't array. |
|
| 388 | - */ |
|
| 389 | - else |
|
| 390 | - { |
|
| 391 | - switch (class_basename($model->$key())) |
|
| 392 | - { |
|
| 393 | - /** |
|
| 394 | - * If the relation is one to many or one to one. |
|
| 395 | - */ |
|
| 396 | - case 'HasOne': |
|
| 397 | - $foreignKeyName = $model->$key()->getForeignKeyName(); |
|
| 398 | - $value->$foreignKeyName = $model->id; |
|
| 399 | - $value->save(); |
|
| 400 | - break; |
|
| 401 | - } |
|
| 402 | - } |
|
| 403 | - } |
|
| 404 | - |
|
| 405 | - $saveLog ? \Logging::saveLog(array_key_exists('id', $data) ? 'update' : 'create', class_basename($modelClass), $this->getModel(), $model->id, $model) : false; |
|
| 406 | - }); |
|
| 164 | + /** |
|
| 165 | + * Save the given model to the storage. |
|
| 166 | + * |
|
| 167 | + * @param array $data |
|
| 168 | + * @param boolean $saveLog |
|
| 169 | + * @return void |
|
| 170 | + */ |
|
| 171 | + public function save(array $data, $saveLog = true) |
|
| 172 | + { |
|
| 173 | + $model = false; |
|
| 174 | + $modelClass = $this->model; |
|
| 175 | + $relations = []; |
|
| 176 | + |
|
| 177 | + \DB::transaction(function () use (&$model, &$relations, $data, $saveLog, $modelClass) { |
|
| 178 | + /** |
|
| 179 | + * If the id is present in the data then select the model for updating, |
|
| 180 | + * else create new model. |
|
| 181 | + * @var array |
|
| 182 | + */ |
|
| 183 | + $model = array_key_exists('id', $data) ? $modelClass->lockForUpdate()->find($data['id']) : new $modelClass; |
|
| 184 | + if ( ! $model) |
|
| 185 | + { |
|
| 186 | + \ErrorHandler::notFound(class_basename($modelClass) . ' with id : ' . $data['id']); |
|
| 187 | + } |
|
| 188 | + |
|
| 189 | + /** |
|
| 190 | + * Construct the model object with the given data, |
|
| 191 | + * and if there is a relation add it to relations array, |
|
| 192 | + * then save the model. |
|
| 193 | + */ |
|
| 194 | + foreach ($data as $key => $value) |
|
| 195 | + { |
|
| 196 | + /** |
|
| 197 | + * If the attribute is a relation. |
|
| 198 | + */ |
|
| 199 | + $relation = camel_case($key); |
|
| 200 | + if (method_exists($model, $relation) && \Core::$relation()) |
|
| 201 | + { |
|
| 202 | + /** |
|
| 203 | + * Check if the relation is a collection. |
|
| 204 | + */ |
|
| 205 | + if (class_basename($model->$relation) == 'Collection') |
|
| 206 | + { |
|
| 207 | + /** |
|
| 208 | + * If the relation has no value then marke the relation data |
|
| 209 | + * related to the model to be deleted. |
|
| 210 | + */ |
|
| 211 | + if ( ! $value || ! count($value)) |
|
| 212 | + { |
|
| 213 | + $relations[$relation] = 'delete'; |
|
| 214 | + } |
|
| 215 | + } |
|
| 216 | + if (is_array($value)) |
|
| 217 | + { |
|
| 218 | + /** |
|
| 219 | + * Loop through the relation data. |
|
| 220 | + */ |
|
| 221 | + foreach ($value as $attr => $val) |
|
| 222 | + { |
|
| 223 | + /** |
|
| 224 | + * Get the relation model. |
|
| 225 | + */ |
|
| 226 | + $relationBaseModel = \Core::$relation()->model; |
|
| 227 | + |
|
| 228 | + /** |
|
| 229 | + * Check if the relation is a collection. |
|
| 230 | + */ |
|
| 231 | + if (class_basename($model->$relation) == 'Collection') |
|
| 232 | + { |
|
| 233 | + /** |
|
| 234 | + * If the id is present in the data then select the relation model for updating, |
|
| 235 | + * else create new model. |
|
| 236 | + */ |
|
| 237 | + $relationModel = array_key_exists('id', $val) ? $relationBaseModel->lockForUpdate()->find($val['id']) : new $relationBaseModel; |
|
| 238 | + |
|
| 239 | + /** |
|
| 240 | + * If model doesn't exists. |
|
| 241 | + */ |
|
| 242 | + if ( ! $relationModel) |
|
| 243 | + { |
|
| 244 | + \ErrorHandler::notFound(class_basename($relationBaseModel) . ' with id : ' . $val['id']); |
|
| 245 | + } |
|
| 246 | + |
|
| 247 | + /** |
|
| 248 | + * Loop through the relation attributes. |
|
| 249 | + */ |
|
| 250 | + foreach ($val as $attr => $val) |
|
| 251 | + { |
|
| 252 | + /** |
|
| 253 | + * Prevent the sub relations or attributes not in the fillable. |
|
| 254 | + */ |
|
| 255 | + if (gettype($val) !== 'object' && gettype($val) !== 'array' && array_search($attr, $relationModel->getFillable(), true) !== false) |
|
| 256 | + { |
|
| 257 | + $relationModel->$attr = $val; |
|
| 258 | + } |
|
| 259 | + } |
|
| 260 | + |
|
| 261 | + $relations[$relation][] = $relationModel; |
|
| 262 | + } |
|
| 263 | + /** |
|
| 264 | + * If not collection. |
|
| 265 | + */ |
|
| 266 | + else |
|
| 267 | + { |
|
| 268 | + /** |
|
| 269 | + * Prevent the sub relations. |
|
| 270 | + */ |
|
| 271 | + if (gettype($val) !== 'object' && gettype($val) !== 'array') |
|
| 272 | + { |
|
| 273 | + |
|
| 274 | + /** |
|
| 275 | + * If the id is present in the data then select the relation model for updating, |
|
| 276 | + * else create new model. |
|
| 277 | + */ |
|
| 278 | + $relationModel = array_key_exists('id', $value) ? $relationBaseModel->lockForUpdate()->find($value['id']) : new $relationBaseModel; |
|
| 279 | + |
|
| 280 | + /** |
|
| 281 | + * If model doesn't exists. |
|
| 282 | + */ |
|
| 283 | + if ( ! $relationModel) |
|
| 284 | + { |
|
| 285 | + \ErrorHandler::notFound(class_basename($relationBaseModel) . ' with id : ' . $value['id']); |
|
| 286 | + } |
|
| 287 | + |
|
| 288 | + foreach ($value as $relationAttribute => $relationValue) |
|
| 289 | + { |
|
| 290 | + /** |
|
| 291 | + * Prevent attributes not in the fillable. |
|
| 292 | + */ |
|
| 293 | + if (array_search($relationAttribute, $relationModel->getFillable(), true) !== false) |
|
| 294 | + { |
|
| 295 | + $relationModel->$relationAttribute = $relationValue; |
|
| 296 | + } |
|
| 297 | + } |
|
| 298 | + |
|
| 299 | + $relations[$relation] = $relationModel; |
|
| 300 | + } |
|
| 301 | + } |
|
| 302 | + } |
|
| 303 | + } |
|
| 304 | + } |
|
| 305 | + /** |
|
| 306 | + * If the attribute isn't a relation and prevent attributes not in the fillable. |
|
| 307 | + */ |
|
| 308 | + else if (array_search($key, $model->getFillable(), true) !== false) |
|
| 309 | + { |
|
| 310 | + $model->$key = $value; |
|
| 311 | + } |
|
| 312 | + } |
|
| 313 | + /** |
|
| 314 | + * Save the model. |
|
| 315 | + */ |
|
| 316 | + $model->save(); |
|
| 317 | + |
|
| 318 | + /** |
|
| 319 | + * Loop through the relations array. |
|
| 320 | + */ |
|
| 321 | + foreach ($relations as $key => $value) |
|
| 322 | + { |
|
| 323 | + /** |
|
| 324 | + * If the relation is marked for delete then delete it. |
|
| 325 | + */ |
|
| 326 | + if ($value == 'delete' && $model->$key()->count()) |
|
| 327 | + { |
|
| 328 | + $model->$key()->delete(); |
|
| 329 | + } |
|
| 330 | + /** |
|
| 331 | + * If the relation is an array. |
|
| 332 | + */ |
|
| 333 | + else if (gettype($value) == 'array') |
|
| 334 | + { |
|
| 335 | + $ids = []; |
|
| 336 | + /** |
|
| 337 | + * Loop through the relations. |
|
| 338 | + */ |
|
| 339 | + foreach ($value as $val) |
|
| 340 | + { |
|
| 341 | + switch (class_basename($model->$key())) |
|
| 342 | + { |
|
| 343 | + /** |
|
| 344 | + * If the relation is one to many then update it's foreign key with |
|
| 345 | + * the model id and save it then add its id to ids array to delete all |
|
| 346 | + * relations who's id isn't in the ids array. |
|
| 347 | + */ |
|
| 348 | + case 'HasMany': |
|
| 349 | + $foreignKeyName = $model->$key()->getForeignKeyName(); |
|
| 350 | + $val->$foreignKeyName = $model->id; |
|
| 351 | + $val->save(); |
|
| 352 | + $ids[] = $val->id; |
|
| 353 | + break; |
|
| 354 | + |
|
| 355 | + /** |
|
| 356 | + * If the relation is many to many then add it's id to the ids array to |
|
| 357 | + * attache these ids to the model. |
|
| 358 | + */ |
|
| 359 | + case 'BelongsToMany': |
|
| 360 | + $val->save(); |
|
| 361 | + $ids[] = $val->id; |
|
| 362 | + break; |
|
| 363 | + } |
|
| 364 | + } |
|
| 365 | + switch (class_basename($model->$key())) |
|
| 366 | + { |
|
| 367 | + /** |
|
| 368 | + * If the relation is one to many then delete all |
|
| 369 | + * relations who's id isn't in the ids array. |
|
| 370 | + */ |
|
| 371 | + case 'HasMany': |
|
| 372 | + $model->$key()->whereNotIn('id', $ids)->delete(); |
|
| 373 | + break; |
|
| 374 | + |
|
| 375 | + /** |
|
| 376 | + * If the relation is many to many then |
|
| 377 | + * detach the previous data and attach |
|
| 378 | + * the ids array to the model. |
|
| 379 | + */ |
|
| 380 | + case 'BelongsToMany': |
|
| 381 | + $model->$key()->detach(); |
|
| 382 | + $model->$key()->attach($ids); |
|
| 383 | + break; |
|
| 384 | + } |
|
| 385 | + } |
|
| 386 | + /** |
|
| 387 | + * If the relation isn't array. |
|
| 388 | + */ |
|
| 389 | + else |
|
| 390 | + { |
|
| 391 | + switch (class_basename($model->$key())) |
|
| 392 | + { |
|
| 393 | + /** |
|
| 394 | + * If the relation is one to many or one to one. |
|
| 395 | + */ |
|
| 396 | + case 'HasOne': |
|
| 397 | + $foreignKeyName = $model->$key()->getForeignKeyName(); |
|
| 398 | + $value->$foreignKeyName = $model->id; |
|
| 399 | + $value->save(); |
|
| 400 | + break; |
|
| 401 | + } |
|
| 402 | + } |
|
| 403 | + } |
|
| 404 | + |
|
| 405 | + $saveLog ? \Logging::saveLog(array_key_exists('id', $data) ? 'update' : 'create', class_basename($modelClass), $this->getModel(), $model->id, $model) : false; |
|
| 406 | + }); |
|
| 407 | 407 | |
| 408 | - return $model->id; |
|
| 409 | - } |
|
| 408 | + return $model->id; |
|
| 409 | + } |
|
| 410 | 410 | |
| 411 | - /** |
|
| 412 | - * Update record in the storage based on the given |
|
| 413 | - * condition. |
|
| 414 | - * |
|
| 415 | - * @param var $value condition value |
|
| 416 | - * @param array $data |
|
| 417 | - * @param string $attribute condition column name |
|
| 418 | - * @return void |
|
| 419 | - */ |
|
| 420 | - public function update($value, array $data, $attribute = 'id', $saveLog = true) |
|
| 421 | - { |
|
| 422 | - if ($attribute == 'id') |
|
| 423 | - { |
|
| 424 | - $model = $this->model->lockForUpdate()->find($value); |
|
| 425 | - $model ? $model->update($data) : 0; |
|
| 426 | - $saveLog ? \Logging::saveLog('update', class_basename($this->model), $this->getModel(), $value, $model) : false; |
|
| 427 | - } |
|
| 428 | - else |
|
| 429 | - { |
|
| 430 | - call_user_func_array("{$this->getModel()}::where", array($attribute, '=', $value))->lockForUpdate()->get()->each(function ($model) use ($data, $saveLog){ |
|
| 431 | - $model->update($data); |
|
| 432 | - $saveLog ? \Logging::saveLog('update', class_basename($this->model), $this->getModel(), $model->id, $model) : false; |
|
| 433 | - }); |
|
| 434 | - } |
|
| 435 | - } |
|
| 436 | - |
|
| 437 | - /** |
|
| 438 | - * Delete record from the storage based on the given |
|
| 439 | - * condition. |
|
| 440 | - * |
|
| 441 | - * @param var $value condition value |
|
| 442 | - * @param string $attribute condition column name |
|
| 443 | - * @return void |
|
| 444 | - */ |
|
| 445 | - public function delete($value, $attribute = 'id', $saveLog = true) |
|
| 446 | - { |
|
| 447 | - if ($attribute == 'id') |
|
| 448 | - { |
|
| 449 | - \DB::transaction(function () use ($value, $attribute, &$result, $saveLog) { |
|
| 450 | - $model = $this->model->lockForUpdate()->find($value); |
|
| 451 | - if ( ! $model) |
|
| 452 | - { |
|
| 453 | - \ErrorHandler::notFound(class_basename($this->model) . ' with id : ' . $value); |
|
| 454 | - } |
|
| 411 | + /** |
|
| 412 | + * Update record in the storage based on the given |
|
| 413 | + * condition. |
|
| 414 | + * |
|
| 415 | + * @param var $value condition value |
|
| 416 | + * @param array $data |
|
| 417 | + * @param string $attribute condition column name |
|
| 418 | + * @return void |
|
| 419 | + */ |
|
| 420 | + public function update($value, array $data, $attribute = 'id', $saveLog = true) |
|
| 421 | + { |
|
| 422 | + if ($attribute == 'id') |
|
| 423 | + { |
|
| 424 | + $model = $this->model->lockForUpdate()->find($value); |
|
| 425 | + $model ? $model->update($data) : 0; |
|
| 426 | + $saveLog ? \Logging::saveLog('update', class_basename($this->model), $this->getModel(), $value, $model) : false; |
|
| 427 | + } |
|
| 428 | + else |
|
| 429 | + { |
|
| 430 | + call_user_func_array("{$this->getModel()}::where", array($attribute, '=', $value))->lockForUpdate()->get()->each(function ($model) use ($data, $saveLog){ |
|
| 431 | + $model->update($data); |
|
| 432 | + $saveLog ? \Logging::saveLog('update', class_basename($this->model), $this->getModel(), $model->id, $model) : false; |
|
| 433 | + }); |
|
| 434 | + } |
|
| 435 | + } |
|
| 436 | + |
|
| 437 | + /** |
|
| 438 | + * Delete record from the storage based on the given |
|
| 439 | + * condition. |
|
| 440 | + * |
|
| 441 | + * @param var $value condition value |
|
| 442 | + * @param string $attribute condition column name |
|
| 443 | + * @return void |
|
| 444 | + */ |
|
| 445 | + public function delete($value, $attribute = 'id', $saveLog = true) |
|
| 446 | + { |
|
| 447 | + if ($attribute == 'id') |
|
| 448 | + { |
|
| 449 | + \DB::transaction(function () use ($value, $attribute, &$result, $saveLog) { |
|
| 450 | + $model = $this->model->lockForUpdate()->find($value); |
|
| 451 | + if ( ! $model) |
|
| 452 | + { |
|
| 453 | + \ErrorHandler::notFound(class_basename($this->model) . ' with id : ' . $value); |
|
| 454 | + } |
|
| 455 | 455 | |
| 456 | - $model->delete(); |
|
| 457 | - $saveLog ? \Logging::saveLog('delete', class_basename($this->model), $this->getModel(), $value, $model) : false; |
|
| 458 | - }); |
|
| 459 | - } |
|
| 460 | - else |
|
| 461 | - { |
|
| 462 | - \DB::transaction(function () use ($value, $attribute, &$result, $saveLog) { |
|
| 463 | - call_user_func_array("{$this->getModel()}::where", array($attribute, '=', $value))->lockForUpdate()->get()->each(function ($model) use ($saveLog){ |
|
| 464 | - $model->delete(); |
|
| 465 | - $saveLog ? \Logging::saveLog('delete', class_basename($this->model), $this->getModel(), $model->id, $model) : false; |
|
| 466 | - }); |
|
| 467 | - }); |
|
| 468 | - } |
|
| 469 | - } |
|
| 456 | + $model->delete(); |
|
| 457 | + $saveLog ? \Logging::saveLog('delete', class_basename($this->model), $this->getModel(), $value, $model) : false; |
|
| 458 | + }); |
|
| 459 | + } |
|
| 460 | + else |
|
| 461 | + { |
|
| 462 | + \DB::transaction(function () use ($value, $attribute, &$result, $saveLog) { |
|
| 463 | + call_user_func_array("{$this->getModel()}::where", array($attribute, '=', $value))->lockForUpdate()->get()->each(function ($model) use ($saveLog){ |
|
| 464 | + $model->delete(); |
|
| 465 | + $saveLog ? \Logging::saveLog('delete', class_basename($this->model), $this->getModel(), $model->id, $model) : false; |
|
| 466 | + }); |
|
| 467 | + }); |
|
| 468 | + } |
|
| 469 | + } |
|
| 470 | 470 | |
| 471 | - /** |
|
| 472 | - * Fetch records from the storage based on the given |
|
| 473 | - * id. |
|
| 474 | - * |
|
| 475 | - * @param integer $id |
|
| 476 | - * @param array $relations |
|
| 477 | - * @param array $columns |
|
| 478 | - * @return object |
|
| 479 | - */ |
|
| 480 | - public function find($id, $relations = [], $columns = array('*')) |
|
| 481 | - { |
|
| 482 | - return call_user_func_array("{$this->getModel()}::with", array($relations))->find($id, $columns); |
|
| 483 | - } |
|
| 471 | + /** |
|
| 472 | + * Fetch records from the storage based on the given |
|
| 473 | + * id. |
|
| 474 | + * |
|
| 475 | + * @param integer $id |
|
| 476 | + * @param array $relations |
|
| 477 | + * @param array $columns |
|
| 478 | + * @return object |
|
| 479 | + */ |
|
| 480 | + public function find($id, $relations = [], $columns = array('*')) |
|
| 481 | + { |
|
| 482 | + return call_user_func_array("{$this->getModel()}::with", array($relations))->find($id, $columns); |
|
| 483 | + } |
|
| 484 | 484 | |
| 485 | - /** |
|
| 486 | - * Fetch records from the storage based on the given |
|
| 487 | - * condition. |
|
| 488 | - * |
|
| 489 | - * @param array $conditions array of conditions |
|
| 490 | - * @param array $relations |
|
| 491 | - * @param string $sortBy |
|
| 492 | - * @param boolean $desc |
|
| 493 | - * @param array $columns |
|
| 494 | - * @return collection |
|
| 495 | - */ |
|
| 496 | - public function findBy($conditions, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = array('*')) |
|
| 497 | - { |
|
| 498 | - $conditions = $this->constructConditions($conditions, $this->model); |
|
| 499 | - $sort = $desc ? 'desc' : 'asc'; |
|
| 500 | - return call_user_func_array("{$this->getModel()}::with", array($relations))->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->orderBy($sortBy, $sort)->get($columns); |
|
| 501 | - } |
|
| 502 | - |
|
| 503 | - /** |
|
| 504 | - * Fetch the first record from the storage based on the given |
|
| 505 | - * condition. |
|
| 506 | - * |
|
| 507 | - * @param array $conditions array of conditions |
|
| 508 | - * @param array $relations |
|
| 509 | - * @param array $columns |
|
| 510 | - * @return object |
|
| 511 | - */ |
|
| 512 | - public function first($conditions, $relations = [], $columns = array('*')) |
|
| 513 | - { |
|
| 514 | - $conditions = $this->constructConditions($conditions, $this->model); |
|
| 515 | - return call_user_func_array("{$this->getModel()}::with", array($relations))->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->first($columns); |
|
| 516 | - } |
|
| 517 | - |
|
| 518 | - /** |
|
| 519 | - * Return the deleted models in pages based on the given conditions. |
|
| 520 | - * |
|
| 521 | - * @param array $conditions array of conditions |
|
| 522 | - * @param integer $perPage |
|
| 523 | - * @param string $sortBy |
|
| 524 | - * @param boolean $desc |
|
| 525 | - * @param array $columns |
|
| 526 | - * @return collection |
|
| 527 | - */ |
|
| 528 | - public function deleted($conditions, $perPage = 15, $sortBy = 'created_at', $desc = 1, $columns = array('*')) |
|
| 529 | - { |
|
| 530 | - unset($conditions['page']); |
|
| 531 | - $conditions = $this->constructConditions($conditions, $this->model); |
|
| 532 | - $sort = $desc ? 'desc' : 'asc'; |
|
| 533 | - $model = $this->model->onlyTrashed(); |
|
| 534 | - |
|
| 535 | - if (count($conditions['conditionValues'])) |
|
| 536 | - { |
|
| 537 | - $model->whereRaw($conditions['conditionString'], $conditions['conditionValues']); |
|
| 538 | - } |
|
| 539 | - |
|
| 540 | - return $model->orderBy($sortBy, $sort)->paginate($perPage, $columns);; |
|
| 541 | - } |
|
| 542 | - |
|
| 543 | - /** |
|
| 544 | - * Restore the deleted model. |
|
| 545 | - * |
|
| 546 | - * @param integer $id |
|
| 547 | - * @return void |
|
| 548 | - */ |
|
| 549 | - public function restore($id) |
|
| 550 | - { |
|
| 551 | - $model = $this->model->onlyTrashed()->find($id); |
|
| 552 | - |
|
| 553 | - if ( ! $model) |
|
| 554 | - { |
|
| 555 | - \ErrorHandler::notFound(class_basename($this->model) . ' with id : ' . $id); |
|
| 556 | - } |
|
| 557 | - |
|
| 558 | - $model->restore(); |
|
| 559 | - } |
|
| 560 | - |
|
| 561 | - /** |
|
| 562 | - * Build the conditions recursively for the retrieving methods. |
|
| 563 | - * @param array $conditions |
|
| 564 | - * @return array |
|
| 565 | - */ |
|
| 566 | - protected function constructConditions($conditions, $model) |
|
| 567 | - { |
|
| 568 | - $conditionString = ''; |
|
| 569 | - $conditionValues = []; |
|
| 570 | - foreach ($conditions as $key => $value) |
|
| 571 | - { |
|
| 572 | - if ($key == 'and') |
|
| 573 | - { |
|
| 574 | - $conditions = $this->constructConditions($value, $model); |
|
| 575 | - $conditionString .= str_replace('{op}', 'and', $conditions['conditionString']) . ' {op} '; |
|
| 576 | - $conditionValues = array_merge($conditionValues, $conditions['conditionValues']); |
|
| 577 | - } |
|
| 578 | - else if ($key == 'or') |
|
| 579 | - { |
|
| 580 | - $conditions = $this->constructConditions($value, $model); |
|
| 581 | - $conditionString .= str_replace('{op}', 'or', $conditions['conditionString']) . ' {op} '; |
|
| 582 | - $conditionValues = array_merge($conditionValues, $conditions['conditionValues']); |
|
| 583 | - } |
|
| 584 | - else |
|
| 585 | - { |
|
| 586 | - if (is_array($value)) |
|
| 587 | - { |
|
| 588 | - $operator = $value['op']; |
|
| 589 | - if (strtolower($operator) == 'between') |
|
| 590 | - { |
|
| 591 | - $value1 = $value['val1']; |
|
| 592 | - $value2 = $value['val2']; |
|
| 593 | - } |
|
| 594 | - else |
|
| 595 | - { |
|
| 596 | - $value = array_key_exists('val', $value) ? $value['val'] : ''; |
|
| 597 | - } |
|
| 598 | - } |
|
| 599 | - else |
|
| 600 | - { |
|
| 601 | - $operator = '='; |
|
| 602 | - } |
|
| 485 | + /** |
|
| 486 | + * Fetch records from the storage based on the given |
|
| 487 | + * condition. |
|
| 488 | + * |
|
| 489 | + * @param array $conditions array of conditions |
|
| 490 | + * @param array $relations |
|
| 491 | + * @param string $sortBy |
|
| 492 | + * @param boolean $desc |
|
| 493 | + * @param array $columns |
|
| 494 | + * @return collection |
|
| 495 | + */ |
|
| 496 | + public function findBy($conditions, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = array('*')) |
|
| 497 | + { |
|
| 498 | + $conditions = $this->constructConditions($conditions, $this->model); |
|
| 499 | + $sort = $desc ? 'desc' : 'asc'; |
|
| 500 | + return call_user_func_array("{$this->getModel()}::with", array($relations))->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->orderBy($sortBy, $sort)->get($columns); |
|
| 501 | + } |
|
| 502 | + |
|
| 503 | + /** |
|
| 504 | + * Fetch the first record from the storage based on the given |
|
| 505 | + * condition. |
|
| 506 | + * |
|
| 507 | + * @param array $conditions array of conditions |
|
| 508 | + * @param array $relations |
|
| 509 | + * @param array $columns |
|
| 510 | + * @return object |
|
| 511 | + */ |
|
| 512 | + public function first($conditions, $relations = [], $columns = array('*')) |
|
| 513 | + { |
|
| 514 | + $conditions = $this->constructConditions($conditions, $this->model); |
|
| 515 | + return call_user_func_array("{$this->getModel()}::with", array($relations))->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->first($columns); |
|
| 516 | + } |
|
| 517 | + |
|
| 518 | + /** |
|
| 519 | + * Return the deleted models in pages based on the given conditions. |
|
| 520 | + * |
|
| 521 | + * @param array $conditions array of conditions |
|
| 522 | + * @param integer $perPage |
|
| 523 | + * @param string $sortBy |
|
| 524 | + * @param boolean $desc |
|
| 525 | + * @param array $columns |
|
| 526 | + * @return collection |
|
| 527 | + */ |
|
| 528 | + public function deleted($conditions, $perPage = 15, $sortBy = 'created_at', $desc = 1, $columns = array('*')) |
|
| 529 | + { |
|
| 530 | + unset($conditions['page']); |
|
| 531 | + $conditions = $this->constructConditions($conditions, $this->model); |
|
| 532 | + $sort = $desc ? 'desc' : 'asc'; |
|
| 533 | + $model = $this->model->onlyTrashed(); |
|
| 534 | + |
|
| 535 | + if (count($conditions['conditionValues'])) |
|
| 536 | + { |
|
| 537 | + $model->whereRaw($conditions['conditionString'], $conditions['conditionValues']); |
|
| 538 | + } |
|
| 539 | + |
|
| 540 | + return $model->orderBy($sortBy, $sort)->paginate($perPage, $columns);; |
|
| 541 | + } |
|
| 542 | + |
|
| 543 | + /** |
|
| 544 | + * Restore the deleted model. |
|
| 545 | + * |
|
| 546 | + * @param integer $id |
|
| 547 | + * @return void |
|
| 548 | + */ |
|
| 549 | + public function restore($id) |
|
| 550 | + { |
|
| 551 | + $model = $this->model->onlyTrashed()->find($id); |
|
| 552 | + |
|
| 553 | + if ( ! $model) |
|
| 554 | + { |
|
| 555 | + \ErrorHandler::notFound(class_basename($this->model) . ' with id : ' . $id); |
|
| 556 | + } |
|
| 557 | + |
|
| 558 | + $model->restore(); |
|
| 559 | + } |
|
| 560 | + |
|
| 561 | + /** |
|
| 562 | + * Build the conditions recursively for the retrieving methods. |
|
| 563 | + * @param array $conditions |
|
| 564 | + * @return array |
|
| 565 | + */ |
|
| 566 | + protected function constructConditions($conditions, $model) |
|
| 567 | + { |
|
| 568 | + $conditionString = ''; |
|
| 569 | + $conditionValues = []; |
|
| 570 | + foreach ($conditions as $key => $value) |
|
| 571 | + { |
|
| 572 | + if ($key == 'and') |
|
| 573 | + { |
|
| 574 | + $conditions = $this->constructConditions($value, $model); |
|
| 575 | + $conditionString .= str_replace('{op}', 'and', $conditions['conditionString']) . ' {op} '; |
|
| 576 | + $conditionValues = array_merge($conditionValues, $conditions['conditionValues']); |
|
| 577 | + } |
|
| 578 | + else if ($key == 'or') |
|
| 579 | + { |
|
| 580 | + $conditions = $this->constructConditions($value, $model); |
|
| 581 | + $conditionString .= str_replace('{op}', 'or', $conditions['conditionString']) . ' {op} '; |
|
| 582 | + $conditionValues = array_merge($conditionValues, $conditions['conditionValues']); |
|
| 583 | + } |
|
| 584 | + else |
|
| 585 | + { |
|
| 586 | + if (is_array($value)) |
|
| 587 | + { |
|
| 588 | + $operator = $value['op']; |
|
| 589 | + if (strtolower($operator) == 'between') |
|
| 590 | + { |
|
| 591 | + $value1 = $value['val1']; |
|
| 592 | + $value2 = $value['val2']; |
|
| 593 | + } |
|
| 594 | + else |
|
| 595 | + { |
|
| 596 | + $value = array_key_exists('val', $value) ? $value['val'] : ''; |
|
| 597 | + } |
|
| 598 | + } |
|
| 599 | + else |
|
| 600 | + { |
|
| 601 | + $operator = '='; |
|
| 602 | + } |
|
| 603 | 603 | |
| 604 | - if (strtolower($operator) == 'between') |
|
| 605 | - { |
|
| 606 | - $conditionString .= $key . ' >= ? and '; |
|
| 607 | - $conditionValues[] = $value1; |
|
| 608 | - |
|
| 609 | - $conditionString .= $key . ' <= ? {op} '; |
|
| 610 | - $conditionValues[] = $value2; |
|
| 611 | - } |
|
| 612 | - elseif (strtolower($operator) == 'in') |
|
| 613 | - { |
|
| 614 | - $conditionValues = array_merge($conditionValues, $value); |
|
| 615 | - $inBindingsString = rtrim(str_repeat('?,', count($value)), ','); |
|
| 616 | - $conditionString .= $key . ' in (' . rtrim($inBindingsString, ',') . ') {op} '; |
|
| 617 | - } |
|
| 618 | - elseif (strtolower($operator) == 'null') |
|
| 619 | - { |
|
| 620 | - $conditionString .= $key . ' is null {op} '; |
|
| 621 | - } |
|
| 622 | - elseif (strtolower($operator) == 'not null') |
|
| 623 | - { |
|
| 624 | - $conditionString .= $key . ' is not null {op} '; |
|
| 625 | - } |
|
| 626 | - elseif (strtolower($operator) == 'has') |
|
| 627 | - { |
|
| 628 | - $sql = $model->withTrashed()->has($key)->toSql(); |
|
| 629 | - $conditions = $this->constructConditions($value, $model->$key()->getRelated()); |
|
| 630 | - $conditionString .= rtrim(substr($sql, strpos($sql, 'exists')), ')') . ' and ' . $conditions['conditionString'] . ') {op} '; |
|
| 631 | - $conditionValues = array_merge($conditionValues, $conditions['conditionValues']); |
|
| 632 | - } |
|
| 633 | - else |
|
| 634 | - { |
|
| 635 | - $conditionString .= $key . ' ' . $operator . ' ? {op} '; |
|
| 636 | - $conditionValues[] = $value; |
|
| 637 | - } |
|
| 638 | - } |
|
| 639 | - } |
|
| 640 | - $conditionString = '(' . rtrim($conditionString, '{op} ') . ')'; |
|
| 641 | - return ['conditionString' => $conditionString, 'conditionValues' => $conditionValues]; |
|
| 642 | - } |
|
| 643 | - |
|
| 644 | - /** |
|
| 645 | - * Abstract method that return the necessary |
|
| 646 | - * information (full model namespace) |
|
| 647 | - * needed to preform the previous actions. |
|
| 648 | - * |
|
| 649 | - * @return string |
|
| 650 | - */ |
|
| 651 | - abstract protected function getModel(); |
|
| 604 | + if (strtolower($operator) == 'between') |
|
| 605 | + { |
|
| 606 | + $conditionString .= $key . ' >= ? and '; |
|
| 607 | + $conditionValues[] = $value1; |
|
| 608 | + |
|
| 609 | + $conditionString .= $key . ' <= ? {op} '; |
|
| 610 | + $conditionValues[] = $value2; |
|
| 611 | + } |
|
| 612 | + elseif (strtolower($operator) == 'in') |
|
| 613 | + { |
|
| 614 | + $conditionValues = array_merge($conditionValues, $value); |
|
| 615 | + $inBindingsString = rtrim(str_repeat('?,', count($value)), ','); |
|
| 616 | + $conditionString .= $key . ' in (' . rtrim($inBindingsString, ',') . ') {op} '; |
|
| 617 | + } |
|
| 618 | + elseif (strtolower($operator) == 'null') |
|
| 619 | + { |
|
| 620 | + $conditionString .= $key . ' is null {op} '; |
|
| 621 | + } |
|
| 622 | + elseif (strtolower($operator) == 'not null') |
|
| 623 | + { |
|
| 624 | + $conditionString .= $key . ' is not null {op} '; |
|
| 625 | + } |
|
| 626 | + elseif (strtolower($operator) == 'has') |
|
| 627 | + { |
|
| 628 | + $sql = $model->withTrashed()->has($key)->toSql(); |
|
| 629 | + $conditions = $this->constructConditions($value, $model->$key()->getRelated()); |
|
| 630 | + $conditionString .= rtrim(substr($sql, strpos($sql, 'exists')), ')') . ' and ' . $conditions['conditionString'] . ') {op} '; |
|
| 631 | + $conditionValues = array_merge($conditionValues, $conditions['conditionValues']); |
|
| 632 | + } |
|
| 633 | + else |
|
| 634 | + { |
|
| 635 | + $conditionString .= $key . ' ' . $operator . ' ? {op} '; |
|
| 636 | + $conditionValues[] = $value; |
|
| 637 | + } |
|
| 638 | + } |
|
| 639 | + } |
|
| 640 | + $conditionString = '(' . rtrim($conditionString, '{op} ') . ')'; |
|
| 641 | + return ['conditionString' => $conditionString, 'conditionValues' => $conditionValues]; |
|
| 642 | + } |
|
| 643 | + |
|
| 644 | + /** |
|
| 645 | + * Abstract method that return the necessary |
|
| 646 | + * information (full model namespace) |
|
| 647 | + * needed to preform the previous actions. |
|
| 648 | + * |
|
| 649 | + * @return string |
|
| 650 | + */ |
|
| 651 | + abstract protected function getModel(); |
|
| 652 | 652 | } |
| 653 | 653 | \ No newline at end of file |
@@ -6,298 +6,298 @@ |
||
| 6 | 6 | |
| 7 | 7 | class BaseApiController extends Controller |
| 8 | 8 | { |
| 9 | - /** |
|
| 10 | - * The config implementation. |
|
| 11 | - * |
|
| 12 | - * @var array |
|
| 13 | - */ |
|
| 14 | - protected $config; |
|
| 9 | + /** |
|
| 10 | + * The config implementation. |
|
| 11 | + * |
|
| 12 | + * @var array |
|
| 13 | + */ |
|
| 14 | + protected $config; |
|
| 15 | 15 | |
| 16 | - /** |
|
| 17 | - * The relations implementation. |
|
| 18 | - * |
|
| 19 | - * @var array |
|
| 20 | - */ |
|
| 21 | - protected $relations; |
|
| 16 | + /** |
|
| 17 | + * The relations implementation. |
|
| 18 | + * |
|
| 19 | + * @var array |
|
| 20 | + */ |
|
| 21 | + protected $relations; |
|
| 22 | 22 | |
| 23 | - /** |
|
| 24 | - * The repo implementation. |
|
| 25 | - * |
|
| 26 | - * @var array |
|
| 27 | - */ |
|
| 28 | - protected $repo; |
|
| 23 | + /** |
|
| 24 | + * The repo implementation. |
|
| 25 | + * |
|
| 26 | + * @var array |
|
| 27 | + */ |
|
| 28 | + protected $repo; |
|
| 29 | 29 | |
| 30 | - public function __construct() |
|
| 31 | - { |
|
| 32 | - $this->config = \CoreConfig::getConfig(); |
|
| 33 | - $this->model = property_exists($this, 'model') ? $this->model : false; |
|
| 34 | - $this->validationRules = property_exists($this, 'validationRules') ? $this->validationRules : false; |
|
| 35 | - $this->skipPermissionCheck = property_exists($this, 'skipPermissionCheck') ? $this->skipPermissionCheck : []; |
|
| 36 | - $this->skipLoginCheck = property_exists($this, 'skipLoginCheck') ? $this->skipLoginCheck : []; |
|
| 37 | - $this->repo = call_user_func_array("\Core::{$this->model}", []); |
|
| 38 | - $route = explode('@',\Route::currentRouteAction())[1]; |
|
| 30 | + public function __construct() |
|
| 31 | + { |
|
| 32 | + $this->config = \CoreConfig::getConfig(); |
|
| 33 | + $this->model = property_exists($this, 'model') ? $this->model : false; |
|
| 34 | + $this->validationRules = property_exists($this, 'validationRules') ? $this->validationRules : false; |
|
| 35 | + $this->skipPermissionCheck = property_exists($this, 'skipPermissionCheck') ? $this->skipPermissionCheck : []; |
|
| 36 | + $this->skipLoginCheck = property_exists($this, 'skipLoginCheck') ? $this->skipLoginCheck : []; |
|
| 37 | + $this->repo = call_user_func_array("\Core::{$this->model}", []); |
|
| 38 | + $route = explode('@',\Route::currentRouteAction())[1]; |
|
| 39 | 39 | |
| 40 | - $this->checkPermission($route); |
|
| 41 | - $this->setRelations($route); |
|
| 42 | - $this->setSessions(); |
|
| 43 | - } |
|
| 40 | + $this->checkPermission($route); |
|
| 41 | + $this->setRelations($route); |
|
| 42 | + $this->setSessions(); |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * Fetch all records with relations from storage. |
|
| 47 | - * |
|
| 48 | - * @param string $sortBy The name of the column to sort by. |
|
| 49 | - * @param boolean $desc Sort ascending or descinding (1: desc, 0: asc). |
|
| 50 | - * @return \Illuminate\Http\Response |
|
| 51 | - */ |
|
| 52 | - public function index($sortBy = 'created_at', $desc = 1) |
|
| 53 | - { |
|
| 54 | - if ($this->repo) |
|
| 55 | - { |
|
| 56 | - return \Response::json($this->repo->all($this->relations, $sortBy, $desc), 200); |
|
| 57 | - } |
|
| 58 | - } |
|
| 45 | + /** |
|
| 46 | + * Fetch all records with relations from storage. |
|
| 47 | + * |
|
| 48 | + * @param string $sortBy The name of the column to sort by. |
|
| 49 | + * @param boolean $desc Sort ascending or descinding (1: desc, 0: asc). |
|
| 50 | + * @return \Illuminate\Http\Response |
|
| 51 | + */ |
|
| 52 | + public function index($sortBy = 'created_at', $desc = 1) |
|
| 53 | + { |
|
| 54 | + if ($this->repo) |
|
| 55 | + { |
|
| 56 | + return \Response::json($this->repo->all($this->relations, $sortBy, $desc), 200); |
|
| 57 | + } |
|
| 58 | + } |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * Fetch the single object with relations from storage. |
|
| 62 | - * |
|
| 63 | - * @param integer $id Id of the requested model. |
|
| 64 | - * @return \Illuminate\Http\Response |
|
| 65 | - */ |
|
| 66 | - public function find($id) |
|
| 67 | - { |
|
| 68 | - if ($this->repo) |
|
| 69 | - { |
|
| 70 | - return \Response::json($this->repo->find($id, $this->relations), 200); |
|
| 71 | - } |
|
| 72 | - } |
|
| 60 | + /** |
|
| 61 | + * Fetch the single object with relations from storage. |
|
| 62 | + * |
|
| 63 | + * @param integer $id Id of the requested model. |
|
| 64 | + * @return \Illuminate\Http\Response |
|
| 65 | + */ |
|
| 66 | + public function find($id) |
|
| 67 | + { |
|
| 68 | + if ($this->repo) |
|
| 69 | + { |
|
| 70 | + return \Response::json($this->repo->find($id, $this->relations), 200); |
|
| 71 | + } |
|
| 72 | + } |
|
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * Paginate all records with relations from storage |
|
| 76 | - * that matche the given query. |
|
| 77 | - * |
|
| 78 | - * @param string $query The search text. |
|
| 79 | - * @param integer $perPage Number of rows per page default 15. |
|
| 80 | - * @param string $sortBy The name of the column to sort by. |
|
| 81 | - * @param boolean $desc Sort ascending or descinding (1: desc, 0: asc). |
|
| 82 | - * @return \Illuminate\Http\Response |
|
| 83 | - */ |
|
| 84 | - public function search($query = '', $perPage = 15, $sortBy = 'created_at', $desc = 1) |
|
| 85 | - { |
|
| 86 | - if ($this->repo) |
|
| 87 | - { |
|
| 88 | - return \Response::json($this->repo->search($query, $perPage, $this->relations, $sortBy, $desc), 200); |
|
| 89 | - } |
|
| 90 | - } |
|
| 74 | + /** |
|
| 75 | + * Paginate all records with relations from storage |
|
| 76 | + * that matche the given query. |
|
| 77 | + * |
|
| 78 | + * @param string $query The search text. |
|
| 79 | + * @param integer $perPage Number of rows per page default 15. |
|
| 80 | + * @param string $sortBy The name of the column to sort by. |
|
| 81 | + * @param boolean $desc Sort ascending or descinding (1: desc, 0: asc). |
|
| 82 | + * @return \Illuminate\Http\Response |
|
| 83 | + */ |
|
| 84 | + public function search($query = '', $perPage = 15, $sortBy = 'created_at', $desc = 1) |
|
| 85 | + { |
|
| 86 | + if ($this->repo) |
|
| 87 | + { |
|
| 88 | + return \Response::json($this->repo->search($query, $perPage, $this->relations, $sortBy, $desc), 200); |
|
| 89 | + } |
|
| 90 | + } |
|
| 91 | 91 | |
| 92 | - /** |
|
| 93 | - * Fetch records from the storage based on the given |
|
| 94 | - * condition. |
|
| 95 | - * |
|
| 96 | - * @param \Illuminate\Http\Request $request |
|
| 97 | - * @param string $sortBy The name of the column to sort by. |
|
| 98 | - * @param boolean $desc Sort ascending or descinding (1: desc, 0: asc). |
|
| 99 | - * @return \Illuminate\Http\Response |
|
| 100 | - */ |
|
| 101 | - public function findby(Request $request, $sortBy = 'created_at', $desc = 1) |
|
| 102 | - { |
|
| 103 | - if ($this->repo) |
|
| 104 | - { |
|
| 105 | - return \Response::json($this->repo->findBy($request->all(), $this->relations, $sortBy, $desc), 200); |
|
| 106 | - } |
|
| 107 | - } |
|
| 92 | + /** |
|
| 93 | + * Fetch records from the storage based on the given |
|
| 94 | + * condition. |
|
| 95 | + * |
|
| 96 | + * @param \Illuminate\Http\Request $request |
|
| 97 | + * @param string $sortBy The name of the column to sort by. |
|
| 98 | + * @param boolean $desc Sort ascending or descinding (1: desc, 0: asc). |
|
| 99 | + * @return \Illuminate\Http\Response |
|
| 100 | + */ |
|
| 101 | + public function findby(Request $request, $sortBy = 'created_at', $desc = 1) |
|
| 102 | + { |
|
| 103 | + if ($this->repo) |
|
| 104 | + { |
|
| 105 | + return \Response::json($this->repo->findBy($request->all(), $this->relations, $sortBy, $desc), 200); |
|
| 106 | + } |
|
| 107 | + } |
|
| 108 | 108 | |
| 109 | - /** |
|
| 110 | - * Fetch the first record from the storage based on the given |
|
| 111 | - * condition. |
|
| 112 | - * |
|
| 113 | - * @param \Illuminate\Http\Request $request |
|
| 114 | - * @return \Illuminate\Http\Response |
|
| 115 | - */ |
|
| 116 | - public function first(Request $request) |
|
| 117 | - { |
|
| 118 | - if ($this->repo) |
|
| 119 | - { |
|
| 120 | - return \Response::json($this->repo->first($request->all(), $this->relations), 200); |
|
| 121 | - } |
|
| 122 | - } |
|
| 109 | + /** |
|
| 110 | + * Fetch the first record from the storage based on the given |
|
| 111 | + * condition. |
|
| 112 | + * |
|
| 113 | + * @param \Illuminate\Http\Request $request |
|
| 114 | + * @return \Illuminate\Http\Response |
|
| 115 | + */ |
|
| 116 | + public function first(Request $request) |
|
| 117 | + { |
|
| 118 | + if ($this->repo) |
|
| 119 | + { |
|
| 120 | + return \Response::json($this->repo->first($request->all(), $this->relations), 200); |
|
| 121 | + } |
|
| 122 | + } |
|
| 123 | 123 | |
| 124 | - /** |
|
| 125 | - * Paginate all records with relations from storage. |
|
| 126 | - * |
|
| 127 | - * @param integer $perPage Number of rows per page default 15. |
|
| 128 | - * @param string $sortBy The name of the column to sort by. |
|
| 129 | - * @param boolean $desc Sort ascending or descinding (1: desc, 0: asc). |
|
| 130 | - * @return \Illuminate\Http\Response |
|
| 131 | - */ |
|
| 132 | - public function paginate($perPage = 15, $sortBy = 'created_at', $desc = 1) |
|
| 133 | - { |
|
| 134 | - if ($this->repo) |
|
| 135 | - { |
|
| 136 | - return \Response::json($this->repo->paginate($perPage, $this->relations, $sortBy, $desc), 200); |
|
| 137 | - } |
|
| 138 | - } |
|
| 124 | + /** |
|
| 125 | + * Paginate all records with relations from storage. |
|
| 126 | + * |
|
| 127 | + * @param integer $perPage Number of rows per page default 15. |
|
| 128 | + * @param string $sortBy The name of the column to sort by. |
|
| 129 | + * @param boolean $desc Sort ascending or descinding (1: desc, 0: asc). |
|
| 130 | + * @return \Illuminate\Http\Response |
|
| 131 | + */ |
|
| 132 | + public function paginate($perPage = 15, $sortBy = 'created_at', $desc = 1) |
|
| 133 | + { |
|
| 134 | + if ($this->repo) |
|
| 135 | + { |
|
| 136 | + return \Response::json($this->repo->paginate($perPage, $this->relations, $sortBy, $desc), 200); |
|
| 137 | + } |
|
| 138 | + } |
|
| 139 | 139 | |
| 140 | - /** |
|
| 141 | - * Fetch all records with relations based on |
|
| 142 | - * the given condition from storage in pages. |
|
| 143 | - * |
|
| 144 | - * @param \Illuminate\Http\Request $request |
|
| 145 | - * @param integer $perPage Number of rows per page default 15. |
|
| 146 | - * @param string $sortBy The name of the column to sort by. |
|
| 147 | - * @param boolean $desc Sort ascending or descinding (1: desc, 0: asc). |
|
| 148 | - * @return \Illuminate\Http\Response |
|
| 149 | - */ |
|
| 150 | - public function paginateby(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) |
|
| 151 | - { |
|
| 152 | - if ($this->repo) |
|
| 153 | - { |
|
| 154 | - return \Response::json($this->repo->paginateBy($request->all(), $perPage, $this->relations, $sortBy, $desc), 200); |
|
| 155 | - } |
|
| 156 | - } |
|
| 140 | + /** |
|
| 141 | + * Fetch all records with relations based on |
|
| 142 | + * the given condition from storage in pages. |
|
| 143 | + * |
|
| 144 | + * @param \Illuminate\Http\Request $request |
|
| 145 | + * @param integer $perPage Number of rows per page default 15. |
|
| 146 | + * @param string $sortBy The name of the column to sort by. |
|
| 147 | + * @param boolean $desc Sort ascending or descinding (1: desc, 0: asc). |
|
| 148 | + * @return \Illuminate\Http\Response |
|
| 149 | + */ |
|
| 150 | + public function paginateby(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) |
|
| 151 | + { |
|
| 152 | + if ($this->repo) |
|
| 153 | + { |
|
| 154 | + return \Response::json($this->repo->paginateBy($request->all(), $perPage, $this->relations, $sortBy, $desc), 200); |
|
| 155 | + } |
|
| 156 | + } |
|
| 157 | 157 | |
| 158 | - /** |
|
| 159 | - * Save the given model to storage. |
|
| 160 | - * |
|
| 161 | - * @param \Illuminate\Http\Request $request |
|
| 162 | - * @return \Illuminate\Http\Response |
|
| 163 | - */ |
|
| 164 | - public function save(Request $request) |
|
| 165 | - { |
|
| 166 | - foreach ($this->validationRules as &$rule) |
|
| 167 | - { |
|
| 168 | - if (strpos($rule, 'exists') && ! strpos($rule, 'deleted_at,NULL')) |
|
| 169 | - { |
|
| 170 | - $rule .= ',deleted_at,NULL'; |
|
| 171 | - } |
|
| 158 | + /** |
|
| 159 | + * Save the given model to storage. |
|
| 160 | + * |
|
| 161 | + * @param \Illuminate\Http\Request $request |
|
| 162 | + * @return \Illuminate\Http\Response |
|
| 163 | + */ |
|
| 164 | + public function save(Request $request) |
|
| 165 | + { |
|
| 166 | + foreach ($this->validationRules as &$rule) |
|
| 167 | + { |
|
| 168 | + if (strpos($rule, 'exists') && ! strpos($rule, 'deleted_at,NULL')) |
|
| 169 | + { |
|
| 170 | + $rule .= ',deleted_at,NULL'; |
|
| 171 | + } |
|
| 172 | 172 | |
| 173 | - if ($request->has('id')) |
|
| 174 | - { |
|
| 175 | - $rule = str_replace('{id}', $request->get('id'), $rule); |
|
| 176 | - } |
|
| 177 | - else |
|
| 178 | - { |
|
| 179 | - $rule = str_replace(',{id}', '', $rule); |
|
| 180 | - } |
|
| 181 | - } |
|
| 173 | + if ($request->has('id')) |
|
| 174 | + { |
|
| 175 | + $rule = str_replace('{id}', $request->get('id'), $rule); |
|
| 176 | + } |
|
| 177 | + else |
|
| 178 | + { |
|
| 179 | + $rule = str_replace(',{id}', '', $rule); |
|
| 180 | + } |
|
| 181 | + } |
|
| 182 | 182 | |
| 183 | - $this->validate($request, $this->validationRules); |
|
| 183 | + $this->validate($request, $this->validationRules); |
|
| 184 | 184 | |
| 185 | - if ($this->repo) |
|
| 186 | - { |
|
| 187 | - return \Response::json($this->repo->save($request->all()), 200); |
|
| 188 | - } |
|
| 189 | - } |
|
| 185 | + if ($this->repo) |
|
| 186 | + { |
|
| 187 | + return \Response::json($this->repo->save($request->all()), 200); |
|
| 188 | + } |
|
| 189 | + } |
|
| 190 | 190 | |
| 191 | - /** |
|
| 192 | - * Delete by the given id from storage. |
|
| 193 | - * |
|
| 194 | - * @param integer $id Id of the deleted model. |
|
| 195 | - * @return \Illuminate\Http\Response |
|
| 196 | - */ |
|
| 197 | - public function delete($id) |
|
| 198 | - { |
|
| 199 | - if ($this->repo) |
|
| 200 | - { |
|
| 201 | - return \Response::json($this->repo->delete($id), 200); |
|
| 202 | - } |
|
| 203 | - } |
|
| 191 | + /** |
|
| 192 | + * Delete by the given id from storage. |
|
| 193 | + * |
|
| 194 | + * @param integer $id Id of the deleted model. |
|
| 195 | + * @return \Illuminate\Http\Response |
|
| 196 | + */ |
|
| 197 | + public function delete($id) |
|
| 198 | + { |
|
| 199 | + if ($this->repo) |
|
| 200 | + { |
|
| 201 | + return \Response::json($this->repo->delete($id), 200); |
|
| 202 | + } |
|
| 203 | + } |
|
| 204 | 204 | |
| 205 | - /** |
|
| 206 | - * Return the deleted models in pages based on the given conditions. |
|
| 207 | - * |
|
| 208 | - * @param \Illuminate\Http\Request $request |
|
| 209 | - * @param integer $perPage Number of rows per page default 15. |
|
| 210 | - * @param string $sortBy The name of the column to sort by. |
|
| 211 | - * @param boolean $desc Sort ascending or descinding (1: desc, 0: asc). |
|
| 212 | - * @return \Illuminate\Http\Response |
|
| 213 | - */ |
|
| 214 | - public function deleted(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) |
|
| 215 | - { |
|
| 216 | - return \Response::json($this->repo->deleted($request->all(), $perPage, $sortBy, $desc), 200); |
|
| 217 | - } |
|
| 205 | + /** |
|
| 206 | + * Return the deleted models in pages based on the given conditions. |
|
| 207 | + * |
|
| 208 | + * @param \Illuminate\Http\Request $request |
|
| 209 | + * @param integer $perPage Number of rows per page default 15. |
|
| 210 | + * @param string $sortBy The name of the column to sort by. |
|
| 211 | + * @param boolean $desc Sort ascending or descinding (1: desc, 0: asc). |
|
| 212 | + * @return \Illuminate\Http\Response |
|
| 213 | + */ |
|
| 214 | + public function deleted(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) |
|
| 215 | + { |
|
| 216 | + return \Response::json($this->repo->deleted($request->all(), $perPage, $sortBy, $desc), 200); |
|
| 217 | + } |
|
| 218 | 218 | |
| 219 | - /** |
|
| 220 | - * Restore the deleted model. |
|
| 221 | - * |
|
| 222 | - * @param integer $id Id of the restored model. |
|
| 223 | - * @return \Illuminate\Http\Response |
|
| 224 | - */ |
|
| 225 | - public function restore($id) |
|
| 226 | - { |
|
| 227 | - if ($this->repo) |
|
| 228 | - { |
|
| 229 | - return \Response::json($this->repo->restore($id), 200); |
|
| 230 | - } |
|
| 231 | - } |
|
| 219 | + /** |
|
| 220 | + * Restore the deleted model. |
|
| 221 | + * |
|
| 222 | + * @param integer $id Id of the restored model. |
|
| 223 | + * @return \Illuminate\Http\Response |
|
| 224 | + */ |
|
| 225 | + public function restore($id) |
|
| 226 | + { |
|
| 227 | + if ($this->repo) |
|
| 228 | + { |
|
| 229 | + return \Response::json($this->repo->restore($id), 200); |
|
| 230 | + } |
|
| 231 | + } |
|
| 232 | 232 | |
| 233 | - /** |
|
| 234 | - * Check if the logged in user can do the given permission. |
|
| 235 | - * |
|
| 236 | - * @param string $permission |
|
| 237 | - * @return void |
|
| 238 | - */ |
|
| 239 | - private function checkPermission($permission) |
|
| 240 | - { |
|
| 241 | - $permission = $permission !== 'index' ? $permission : 'list'; |
|
| 242 | - if ( ! in_array($permission, $this->skipLoginCheck)) |
|
| 243 | - { |
|
| 244 | - $user = \JWTAuth::parseToken()->authenticate(); |
|
| 245 | - if ($user->blocked) |
|
| 246 | - { |
|
| 247 | - \ErrorHandler::userIsBlocked(); |
|
| 248 | - } |
|
| 233 | + /** |
|
| 234 | + * Check if the logged in user can do the given permission. |
|
| 235 | + * |
|
| 236 | + * @param string $permission |
|
| 237 | + * @return void |
|
| 238 | + */ |
|
| 239 | + private function checkPermission($permission) |
|
| 240 | + { |
|
| 241 | + $permission = $permission !== 'index' ? $permission : 'list'; |
|
| 242 | + if ( ! in_array($permission, $this->skipLoginCheck)) |
|
| 243 | + { |
|
| 244 | + $user = \JWTAuth::parseToken()->authenticate(); |
|
| 245 | + if ($user->blocked) |
|
| 246 | + { |
|
| 247 | + \ErrorHandler::userIsBlocked(); |
|
| 248 | + } |
|
| 249 | 249 | |
| 250 | - if ( ! in_array($permission, $this->skipPermissionCheck) && ! \Core::users()->can($permission, $this->model)) |
|
| 251 | - { |
|
| 252 | - \ErrorHandler::noPermissions(); |
|
| 253 | - } |
|
| 254 | - } |
|
| 255 | - } |
|
| 250 | + if ( ! in_array($permission, $this->skipPermissionCheck) && ! \Core::users()->can($permission, $this->model)) |
|
| 251 | + { |
|
| 252 | + \ErrorHandler::noPermissions(); |
|
| 253 | + } |
|
| 254 | + } |
|
| 255 | + } |
|
| 256 | 256 | |
| 257 | - /** |
|
| 258 | - * Set sessions based on the given headers in the request. |
|
| 259 | - * |
|
| 260 | - * @return void |
|
| 261 | - */ |
|
| 262 | - private function setSessions() |
|
| 263 | - { |
|
| 264 | - \Session::put('timeZoneDiff', \Request::header('time-zone-diff') ?: 0); |
|
| 257 | + /** |
|
| 258 | + * Set sessions based on the given headers in the request. |
|
| 259 | + * |
|
| 260 | + * @return void |
|
| 261 | + */ |
|
| 262 | + private function setSessions() |
|
| 263 | + { |
|
| 264 | + \Session::put('timeZoneDiff', \Request::header('time-zone-diff') ?: 0); |
|
| 265 | 265 | |
| 266 | - $locale = \Request::header('locale'); |
|
| 267 | - switch ($locale) |
|
| 268 | - { |
|
| 269 | - case 'en': |
|
| 270 | - \App::setLocale('en'); |
|
| 271 | - \Session::put('locale', 'en'); |
|
| 272 | - break; |
|
| 266 | + $locale = \Request::header('locale'); |
|
| 267 | + switch ($locale) |
|
| 268 | + { |
|
| 269 | + case 'en': |
|
| 270 | + \App::setLocale('en'); |
|
| 271 | + \Session::put('locale', 'en'); |
|
| 272 | + break; |
|
| 273 | 273 | |
| 274 | - case 'ar': |
|
| 275 | - \App::setLocale('ar'); |
|
| 276 | - \Session::put('locale', 'ar'); |
|
| 277 | - break; |
|
| 274 | + case 'ar': |
|
| 275 | + \App::setLocale('ar'); |
|
| 276 | + \Session::put('locale', 'ar'); |
|
| 277 | + break; |
|
| 278 | 278 | |
| 279 | - case 'all': |
|
| 280 | - \App::setLocale('en'); |
|
| 281 | - \Session::put('locale', 'all'); |
|
| 282 | - break; |
|
| 279 | + case 'all': |
|
| 280 | + \App::setLocale('en'); |
|
| 281 | + \Session::put('locale', 'all'); |
|
| 282 | + break; |
|
| 283 | 283 | |
| 284 | - default: |
|
| 285 | - \App::setLocale('en'); |
|
| 286 | - \Session::put('locale', 'en'); |
|
| 287 | - break; |
|
| 288 | - } |
|
| 289 | - } |
|
| 284 | + default: |
|
| 285 | + \App::setLocale('en'); |
|
| 286 | + \Session::put('locale', 'en'); |
|
| 287 | + break; |
|
| 288 | + } |
|
| 289 | + } |
|
| 290 | 290 | |
| 291 | - /** |
|
| 292 | - * Set relation based on the called api. |
|
| 293 | - * |
|
| 294 | - * @param string $route |
|
| 295 | - * @return void |
|
| 296 | - */ |
|
| 297 | - private function setRelations($route) |
|
| 298 | - { |
|
| 299 | - $route = $route !== 'index' ? $route : 'list'; |
|
| 300 | - $relations = array_key_exists($this->model, $this->config['relations']) ? $this->config['relations'][$this->model] : false; |
|
| 301 | - $this->relations = $relations && $relations[$route] ? $relations[$route] : []; |
|
| 302 | - } |
|
| 291 | + /** |
|
| 292 | + * Set relation based on the called api. |
|
| 293 | + * |
|
| 294 | + * @param string $route |
|
| 295 | + * @return void |
|
| 296 | + */ |
|
| 297 | + private function setRelations($route) |
|
| 298 | + { |
|
| 299 | + $route = $route !== 'index' ? $route : 'list'; |
|
| 300 | + $relations = array_key_exists($this->model, $this->config['relations']) ? $this->config['relations'][$this->model] : false; |
|
| 301 | + $this->relations = $relations && $relations[$route] ? $relations[$route] : []; |
|
| 302 | + } |
|
| 303 | 303 | } |
@@ -6,270 +6,270 @@ |
||
| 6 | 6 | |
| 7 | 7 | class GenerateDoc extends Command |
| 8 | 8 | { |
| 9 | - /** |
|
| 10 | - * The name and signature of the console command. |
|
| 11 | - * |
|
| 12 | - * @var string |
|
| 13 | - */ |
|
| 14 | - protected $signature = 'doc:generate'; |
|
| 9 | + /** |
|
| 10 | + * The name and signature of the console command. |
|
| 11 | + * |
|
| 12 | + * @var string |
|
| 13 | + */ |
|
| 14 | + protected $signature = 'doc:generate'; |
|
| 15 | 15 | |
| 16 | - /** |
|
| 17 | - * The console command description. |
|
| 18 | - * |
|
| 19 | - * @var string |
|
| 20 | - */ |
|
| 21 | - protected $description = 'Generate api documentation'; |
|
| 16 | + /** |
|
| 17 | + * The console command description. |
|
| 18 | + * |
|
| 19 | + * @var string |
|
| 20 | + */ |
|
| 21 | + protected $description = 'Generate api documentation'; |
|
| 22 | 22 | |
| 23 | - /** |
|
| 24 | - * Create a new command instance. |
|
| 25 | - * |
|
| 26 | - * @return void |
|
| 27 | - */ |
|
| 28 | - public function __construct() |
|
| 29 | - { |
|
| 30 | - parent::__construct(); |
|
| 31 | - } |
|
| 23 | + /** |
|
| 24 | + * Create a new command instance. |
|
| 25 | + * |
|
| 26 | + * @return void |
|
| 27 | + */ |
|
| 28 | + public function __construct() |
|
| 29 | + { |
|
| 30 | + parent::__construct(); |
|
| 31 | + } |
|
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * Execute the console command. |
|
| 35 | - * |
|
| 36 | - * @return mixed |
|
| 37 | - */ |
|
| 38 | - public function handle() |
|
| 39 | - { |
|
| 40 | - $docData = []; |
|
| 41 | - $docData['models'] = []; |
|
| 42 | - $routes = $this->getRoutes(); |
|
| 43 | - foreach ($routes as $route) |
|
| 44 | - { |
|
| 45 | - if ($route) |
|
| 46 | - { |
|
| 47 | - $actoinArray = explode('@', $route['action']); |
|
| 48 | - $controller = $actoinArray[0]; |
|
| 49 | - $method = $actoinArray[1]; |
|
| 50 | - $route['name'] = $method !== 'index' ? $method : 'list'; |
|
| 33 | + /** |
|
| 34 | + * Execute the console command. |
|
| 35 | + * |
|
| 36 | + * @return mixed |
|
| 37 | + */ |
|
| 38 | + public function handle() |
|
| 39 | + { |
|
| 40 | + $docData = []; |
|
| 41 | + $docData['models'] = []; |
|
| 42 | + $routes = $this->getRoutes(); |
|
| 43 | + foreach ($routes as $route) |
|
| 44 | + { |
|
| 45 | + if ($route) |
|
| 46 | + { |
|
| 47 | + $actoinArray = explode('@', $route['action']); |
|
| 48 | + $controller = $actoinArray[0]; |
|
| 49 | + $method = $actoinArray[1]; |
|
| 50 | + $route['name'] = $method !== 'index' ? $method : 'list'; |
|
| 51 | 51 | |
| 52 | - $reflectionClass = new \ReflectionClass($controller); |
|
| 53 | - $reflectionMethod = $reflectionClass->getMethod($method); |
|
| 54 | - $classProperties = $reflectionClass->getDefaultProperties(); |
|
| 55 | - $skipLoginCheck = array_key_exists('skipLoginCheck', $classProperties) ? $classProperties['skipLoginCheck'] : false; |
|
| 56 | - $validationRules = array_key_exists('validationRules', $classProperties) ? $classProperties['validationRules'] : false; |
|
| 52 | + $reflectionClass = new \ReflectionClass($controller); |
|
| 53 | + $reflectionMethod = $reflectionClass->getMethod($method); |
|
| 54 | + $classProperties = $reflectionClass->getDefaultProperties(); |
|
| 55 | + $skipLoginCheck = array_key_exists('skipLoginCheck', $classProperties) ? $classProperties['skipLoginCheck'] : false; |
|
| 56 | + $validationRules = array_key_exists('validationRules', $classProperties) ? $classProperties['validationRules'] : false; |
|
| 57 | 57 | |
| 58 | - $route['response'] = $this->getResponseObject($classProperties['model'], $route['name']); |
|
| 58 | + $route['response'] = $this->getResponseObject($classProperties['model'], $route['name']); |
|
| 59 | 59 | |
| 60 | - $this->processDocBlock($route, $reflectionMethod); |
|
| 61 | - $this->getHeaders($route, $reflectionClass, $method, $skipLoginCheck); |
|
| 62 | - $this->getPostData($route, $reflectionMethod, $validationRules); |
|
| 60 | + $this->processDocBlock($route, $reflectionMethod); |
|
| 61 | + $this->getHeaders($route, $reflectionClass, $method, $skipLoginCheck); |
|
| 62 | + $this->getPostData($route, $reflectionMethod, $validationRules); |
|
| 63 | 63 | |
| 64 | - preg_match('/api\/v1\/([^#]+)\//iU', $route['uri'], $module); |
|
| 65 | - preg_match('/api\/v1\/' . $module[1] . '\/([^#]+)\//iU', $route['uri'], $model); |
|
| 66 | - $docData['modules'][$module[1]][$model[1]][] = $route; |
|
| 64 | + preg_match('/api\/v1\/([^#]+)\//iU', $route['uri'], $module); |
|
| 65 | + preg_match('/api\/v1\/' . $module[1] . '\/([^#]+)\//iU', $route['uri'], $model); |
|
| 66 | + $docData['modules'][$module[1]][$model[1]][] = $route; |
|
| 67 | 67 | |
| 68 | - $this->getModels($classProperties['model'], $docData); |
|
| 69 | - } |
|
| 70 | - } |
|
| 68 | + $this->getModels($classProperties['model'], $docData); |
|
| 69 | + } |
|
| 70 | + } |
|
| 71 | 71 | |
| 72 | - $docData['errors'] = $this->getErrors(); |
|
| 73 | - \File::put(app_path('Modules/V1/Core/Resources/api.json'), json_encode($docData)); |
|
| 74 | - } |
|
| 72 | + $docData['errors'] = $this->getErrors(); |
|
| 73 | + \File::put(app_path('Modules/V1/Core/Resources/api.json'), json_encode($docData)); |
|
| 74 | + } |
|
| 75 | 75 | |
| 76 | - /** |
|
| 77 | - * Get list of all registered routes. |
|
| 78 | - * |
|
| 79 | - * @return collection |
|
| 80 | - */ |
|
| 81 | - protected function getRoutes() |
|
| 82 | - { |
|
| 83 | - return collect(\Route::getRoutes())->map(function ($route) { |
|
| 84 | - if (strpos($route->uri(), 'api/v') !== false) |
|
| 85 | - { |
|
| 86 | - return [ |
|
| 87 | - 'method' => $route->methods()[0], |
|
| 88 | - 'uri' => $route->uri(), |
|
| 89 | - 'action' => $route->getActionName() |
|
| 90 | - ]; |
|
| 91 | - } |
|
| 92 | - return false; |
|
| 93 | - })->all(); |
|
| 94 | - } |
|
| 76 | + /** |
|
| 77 | + * Get list of all registered routes. |
|
| 78 | + * |
|
| 79 | + * @return collection |
|
| 80 | + */ |
|
| 81 | + protected function getRoutes() |
|
| 82 | + { |
|
| 83 | + return collect(\Route::getRoutes())->map(function ($route) { |
|
| 84 | + if (strpos($route->uri(), 'api/v') !== false) |
|
| 85 | + { |
|
| 86 | + return [ |
|
| 87 | + 'method' => $route->methods()[0], |
|
| 88 | + 'uri' => $route->uri(), |
|
| 89 | + 'action' => $route->getActionName() |
|
| 90 | + ]; |
|
| 91 | + } |
|
| 92 | + return false; |
|
| 93 | + })->all(); |
|
| 94 | + } |
|
| 95 | 95 | |
| 96 | - /** |
|
| 97 | - * Generate headers for the given route. |
|
| 98 | - * |
|
| 99 | - * @param array &$route |
|
| 100 | - * @param object $reflectionClass |
|
| 101 | - * @param string $method |
|
| 102 | - * @param array $skipLoginCheck |
|
| 103 | - * @return void |
|
| 104 | - */ |
|
| 105 | - protected function getHeaders(&$route, $reflectionClass, $method, $skipLoginCheck) |
|
| 106 | - { |
|
| 107 | - $route['headers'] = [ |
|
| 108 | - 'Accept' => 'application/json', |
|
| 109 | - 'Content-Type' => 'application/json', |
|
| 110 | - 'locale' => 'The language of the returned data: ar, en or all.', |
|
| 111 | - 'time-zone-diff' => 'Timezone difference between UTC and Local Time', |
|
| 112 | - ]; |
|
| 96 | + /** |
|
| 97 | + * Generate headers for the given route. |
|
| 98 | + * |
|
| 99 | + * @param array &$route |
|
| 100 | + * @param object $reflectionClass |
|
| 101 | + * @param string $method |
|
| 102 | + * @param array $skipLoginCheck |
|
| 103 | + * @return void |
|
| 104 | + */ |
|
| 105 | + protected function getHeaders(&$route, $reflectionClass, $method, $skipLoginCheck) |
|
| 106 | + { |
|
| 107 | + $route['headers'] = [ |
|
| 108 | + 'Accept' => 'application/json', |
|
| 109 | + 'Content-Type' => 'application/json', |
|
| 110 | + 'locale' => 'The language of the returned data: ar, en or all.', |
|
| 111 | + 'time-zone-diff' => 'Timezone difference between UTC and Local Time', |
|
| 112 | + ]; |
|
| 113 | 113 | |
| 114 | 114 | |
| 115 | - if (! $skipLoginCheck || ! in_array($method, $skipLoginCheck)) |
|
| 116 | - { |
|
| 117 | - $route['headers']['Authrization'] = 'bearer {token}'; |
|
| 118 | - } |
|
| 119 | - } |
|
| 115 | + if (! $skipLoginCheck || ! in_array($method, $skipLoginCheck)) |
|
| 116 | + { |
|
| 117 | + $route['headers']['Authrization'] = 'bearer {token}'; |
|
| 118 | + } |
|
| 119 | + } |
|
| 120 | 120 | |
| 121 | - /** |
|
| 122 | - * Generate description and params for the given route |
|
| 123 | - * based on the docblock. |
|
| 124 | - * |
|
| 125 | - * @param array &$route |
|
| 126 | - * @param object $reflectionMethod] |
|
| 127 | - * @return void |
|
| 128 | - */ |
|
| 129 | - protected function processDocBlock(&$route, $reflectionMethod) |
|
| 130 | - { |
|
| 131 | - $factory = \phpDocumentor\Reflection\DocBlockFactory::createInstance(); |
|
| 132 | - $docblock = $factory->create($reflectionMethod->getDocComment()); |
|
| 133 | - $route['description'] = trim(preg_replace('/\s+/', ' ', $docblock->getSummary())); |
|
| 134 | - $params = $docblock->getTagsByName('param'); |
|
| 135 | - foreach ($params as $param) |
|
| 136 | - { |
|
| 137 | - $name = $param->getVariableName(); |
|
| 138 | - if ($name !== 'request') |
|
| 139 | - { |
|
| 140 | - $route['parametars'][$param->getVariableName()] = $param->getDescription()->render(); |
|
| 141 | - } |
|
| 142 | - } |
|
| 143 | - } |
|
| 121 | + /** |
|
| 122 | + * Generate description and params for the given route |
|
| 123 | + * based on the docblock. |
|
| 124 | + * |
|
| 125 | + * @param array &$route |
|
| 126 | + * @param object $reflectionMethod] |
|
| 127 | + * @return void |
|
| 128 | + */ |
|
| 129 | + protected function processDocBlock(&$route, $reflectionMethod) |
|
| 130 | + { |
|
| 131 | + $factory = \phpDocumentor\Reflection\DocBlockFactory::createInstance(); |
|
| 132 | + $docblock = $factory->create($reflectionMethod->getDocComment()); |
|
| 133 | + $route['description'] = trim(preg_replace('/\s+/', ' ', $docblock->getSummary())); |
|
| 134 | + $params = $docblock->getTagsByName('param'); |
|
| 135 | + foreach ($params as $param) |
|
| 136 | + { |
|
| 137 | + $name = $param->getVariableName(); |
|
| 138 | + if ($name !== 'request') |
|
| 139 | + { |
|
| 140 | + $route['parametars'][$param->getVariableName()] = $param->getDescription()->render(); |
|
| 141 | + } |
|
| 142 | + } |
|
| 143 | + } |
|
| 144 | 144 | |
| 145 | - /** |
|
| 146 | - * Generate post body for the given route. |
|
| 147 | - * |
|
| 148 | - * @param array &$route |
|
| 149 | - * @param object $reflectionMethod |
|
| 150 | - * @param array $validationRules |
|
| 151 | - * @return void |
|
| 152 | - */ |
|
| 153 | - protected function getPostData(&$route, $reflectionMethod, $validationRules) |
|
| 154 | - { |
|
| 155 | - if ($route['method'] == 'POST') |
|
| 156 | - { |
|
| 157 | - $body = $this->getMethodBody($reflectionMethod); |
|
| 145 | + /** |
|
| 146 | + * Generate post body for the given route. |
|
| 147 | + * |
|
| 148 | + * @param array &$route |
|
| 149 | + * @param object $reflectionMethod |
|
| 150 | + * @param array $validationRules |
|
| 151 | + * @return void |
|
| 152 | + */ |
|
| 153 | + protected function getPostData(&$route, $reflectionMethod, $validationRules) |
|
| 154 | + { |
|
| 155 | + if ($route['method'] == 'POST') |
|
| 156 | + { |
|
| 157 | + $body = $this->getMethodBody($reflectionMethod); |
|
| 158 | 158 | |
| 159 | - preg_match('/\$this->validate\(\$request,([^#]+)\);/iU', $body, $match); |
|
| 160 | - if (count($match)) |
|
| 161 | - { |
|
| 162 | - if ($match[1] == '$this->validationRules') |
|
| 163 | - { |
|
| 164 | - $route['body'] = $validationRules; |
|
| 165 | - } |
|
| 166 | - else |
|
| 167 | - { |
|
| 168 | - $route['body'] = eval('return ' . $match[1] . ';'); |
|
| 169 | - } |
|
| 159 | + preg_match('/\$this->validate\(\$request,([^#]+)\);/iU', $body, $match); |
|
| 160 | + if (count($match)) |
|
| 161 | + { |
|
| 162 | + if ($match[1] == '$this->validationRules') |
|
| 163 | + { |
|
| 164 | + $route['body'] = $validationRules; |
|
| 165 | + } |
|
| 166 | + else |
|
| 167 | + { |
|
| 168 | + $route['body'] = eval('return ' . $match[1] . ';'); |
|
| 169 | + } |
|
| 170 | 170 | |
| 171 | - foreach ($route['body'] as &$rule) |
|
| 172 | - { |
|
| 173 | - if(strpos($rule, 'unique')) |
|
| 174 | - { |
|
| 175 | - $rule = substr($rule, 0, strpos($rule, 'unique') + 6); |
|
| 176 | - } |
|
| 177 | - elseif(strpos($rule, 'exists')) |
|
| 178 | - { |
|
| 179 | - $rule = substr($rule, 0, strpos($rule, 'exists') - 1); |
|
| 180 | - } |
|
| 181 | - } |
|
| 182 | - } |
|
| 183 | - else |
|
| 184 | - { |
|
| 185 | - $route['body'] = 'conditions'; |
|
| 186 | - } |
|
| 187 | - } |
|
| 188 | - } |
|
| 171 | + foreach ($route['body'] as &$rule) |
|
| 172 | + { |
|
| 173 | + if(strpos($rule, 'unique')) |
|
| 174 | + { |
|
| 175 | + $rule = substr($rule, 0, strpos($rule, 'unique') + 6); |
|
| 176 | + } |
|
| 177 | + elseif(strpos($rule, 'exists')) |
|
| 178 | + { |
|
| 179 | + $rule = substr($rule, 0, strpos($rule, 'exists') - 1); |
|
| 180 | + } |
|
| 181 | + } |
|
| 182 | + } |
|
| 183 | + else |
|
| 184 | + { |
|
| 185 | + $route['body'] = 'conditions'; |
|
| 186 | + } |
|
| 187 | + } |
|
| 188 | + } |
|
| 189 | 189 | |
| 190 | - /** |
|
| 191 | - * Generate application errors. |
|
| 192 | - * |
|
| 193 | - * @return array |
|
| 194 | - */ |
|
| 195 | - protected function getErrors() |
|
| 196 | - { |
|
| 197 | - $errors = []; |
|
| 198 | - $reflectionClass = new \ReflectionClass('App\Modules\V1\Core\Utl\ErrorHandler'); |
|
| 199 | - foreach ($reflectionClass->getMethods() as $method) |
|
| 200 | - { |
|
| 201 | - $methodName = $method->getName(); |
|
| 202 | - $reflectionMethod = $reflectionClass->getMethod($methodName); |
|
| 203 | - $body = $this->getMethodBody($reflectionMethod); |
|
| 190 | + /** |
|
| 191 | + * Generate application errors. |
|
| 192 | + * |
|
| 193 | + * @return array |
|
| 194 | + */ |
|
| 195 | + protected function getErrors() |
|
| 196 | + { |
|
| 197 | + $errors = []; |
|
| 198 | + $reflectionClass = new \ReflectionClass('App\Modules\V1\Core\Utl\ErrorHandler'); |
|
| 199 | + foreach ($reflectionClass->getMethods() as $method) |
|
| 200 | + { |
|
| 201 | + $methodName = $method->getName(); |
|
| 202 | + $reflectionMethod = $reflectionClass->getMethod($methodName); |
|
| 203 | + $body = $this->getMethodBody($reflectionMethod); |
|
| 204 | 204 | |
| 205 | - preg_match('/\$error=\[\'status\'=>([^#]+)\,/iU', $body, $match); |
|
| 205 | + preg_match('/\$error=\[\'status\'=>([^#]+)\,/iU', $body, $match); |
|
| 206 | 206 | |
| 207 | - if (count($match)) |
|
| 208 | - { |
|
| 209 | - $errors[$match[1]][] = $methodName; |
|
| 210 | - } |
|
| 211 | - } |
|
| 207 | + if (count($match)) |
|
| 208 | + { |
|
| 209 | + $errors[$match[1]][] = $methodName; |
|
| 210 | + } |
|
| 211 | + } |
|
| 212 | 212 | |
| 213 | - return $errors; |
|
| 214 | - } |
|
| 213 | + return $errors; |
|
| 214 | + } |
|
| 215 | 215 | |
| 216 | - /** |
|
| 217 | - * Get the given method body code. |
|
| 218 | - * |
|
| 219 | - * @param object $reflectionMethod |
|
| 220 | - * @return string |
|
| 221 | - */ |
|
| 222 | - protected function getMethodBody($reflectionMethod) |
|
| 223 | - { |
|
| 224 | - $filename = $reflectionMethod->getFileName(); |
|
| 225 | - $start_line = $reflectionMethod->getStartLine() - 1; |
|
| 226 | - $end_line = $reflectionMethod->getEndLine(); |
|
| 227 | - $length = $end_line - $start_line; |
|
| 228 | - $source = file($filename); |
|
| 229 | - $body = implode("", array_slice($source, $start_line, $length)); |
|
| 230 | - $body = trim(preg_replace('/\s+/', '', $body)); |
|
| 216 | + /** |
|
| 217 | + * Get the given method body code. |
|
| 218 | + * |
|
| 219 | + * @param object $reflectionMethod |
|
| 220 | + * @return string |
|
| 221 | + */ |
|
| 222 | + protected function getMethodBody($reflectionMethod) |
|
| 223 | + { |
|
| 224 | + $filename = $reflectionMethod->getFileName(); |
|
| 225 | + $start_line = $reflectionMethod->getStartLine() - 1; |
|
| 226 | + $end_line = $reflectionMethod->getEndLine(); |
|
| 227 | + $length = $end_line - $start_line; |
|
| 228 | + $source = file($filename); |
|
| 229 | + $body = implode("", array_slice($source, $start_line, $length)); |
|
| 230 | + $body = trim(preg_replace('/\s+/', '', $body)); |
|
| 231 | 231 | |
| 232 | - return $body; |
|
| 233 | - } |
|
| 232 | + return $body; |
|
| 233 | + } |
|
| 234 | 234 | |
| 235 | - /** |
|
| 236 | - * Get example object of all availble models. |
|
| 237 | - * |
|
| 238 | - * @param string $modelName |
|
| 239 | - * @param object $docData |
|
| 240 | - * @return string |
|
| 241 | - */ |
|
| 242 | - protected function getModels($modelName, &$docData) |
|
| 243 | - { |
|
| 244 | - if ($modelName && ! array_key_exists($modelName, $docData['models'])) |
|
| 245 | - { |
|
| 246 | - $modelClass = call_user_func_array("\Core::{$modelName}", [])->modelClass; |
|
| 247 | - $model = factory($modelClass)->make(); |
|
| 248 | - $modelArr = $model->toArray(); |
|
| 235 | + /** |
|
| 236 | + * Get example object of all availble models. |
|
| 237 | + * |
|
| 238 | + * @param string $modelName |
|
| 239 | + * @param object $docData |
|
| 240 | + * @return string |
|
| 241 | + */ |
|
| 242 | + protected function getModels($modelName, &$docData) |
|
| 243 | + { |
|
| 244 | + if ($modelName && ! array_key_exists($modelName, $docData['models'])) |
|
| 245 | + { |
|
| 246 | + $modelClass = call_user_func_array("\Core::{$modelName}", [])->modelClass; |
|
| 247 | + $model = factory($modelClass)->make(); |
|
| 248 | + $modelArr = $model->toArray(); |
|
| 249 | 249 | |
| 250 | - if ( $model->trans && ! $model->trans->count()) |
|
| 251 | - { |
|
| 252 | - $modelArr['trans'] = [ |
|
| 253 | - 'en' => factory($modelClass . 'Translation')->make()->toArray() |
|
| 254 | - ]; |
|
| 255 | - } |
|
| 250 | + if ( $model->trans && ! $model->trans->count()) |
|
| 251 | + { |
|
| 252 | + $modelArr['trans'] = [ |
|
| 253 | + 'en' => factory($modelClass . 'Translation')->make()->toArray() |
|
| 254 | + ]; |
|
| 255 | + } |
|
| 256 | 256 | |
| 257 | - $docData['models'][$modelName] = json_encode($modelArr, JSON_PRETTY_PRINT); |
|
| 258 | - } |
|
| 259 | - } |
|
| 257 | + $docData['models'][$modelName] = json_encode($modelArr, JSON_PRETTY_PRINT); |
|
| 258 | + } |
|
| 259 | + } |
|
| 260 | 260 | |
| 261 | - /** |
|
| 262 | - * Get the route response object type. |
|
| 263 | - * |
|
| 264 | - * @param string $modelName |
|
| 265 | - * @param string $method |
|
| 266 | - * @return array |
|
| 267 | - */ |
|
| 268 | - protected function getResponseObject($modelName, $method) |
|
| 269 | - { |
|
| 270 | - $config = \CoreConfig::getConfig(); |
|
| 271 | - $relations = array_key_exists($modelName, $config['relations']) ? array_key_exists($method, $config['relations'][$modelName]) ? $config['relations'][$modelName] : false : false; |
|
| 261 | + /** |
|
| 262 | + * Get the route response object type. |
|
| 263 | + * |
|
| 264 | + * @param string $modelName |
|
| 265 | + * @param string $method |
|
| 266 | + * @return array |
|
| 267 | + */ |
|
| 268 | + protected function getResponseObject($modelName, $method) |
|
| 269 | + { |
|
| 270 | + $config = \CoreConfig::getConfig(); |
|
| 271 | + $relations = array_key_exists($modelName, $config['relations']) ? array_key_exists($method, $config['relations'][$modelName]) ? $config['relations'][$modelName] : false : false; |
|
| 272 | 272 | |
| 273 | - return $relations ? [$modelName => $relations && $relations[$method] ? $relations[$method] : []] : false; |
|
| 274 | - } |
|
| 273 | + return $relations ? [$modelName => $relations && $relations[$method] ? $relations[$method] : []] : false; |
|
| 274 | + } |
|
| 275 | 275 | } |