Laravel-Backpack /
CRUD
We could not synchronize checks via GitHub's checks API since Scrutinizer's GitHub App is not installed for this repository.
| Total Complexity | 65 |
| Total Lines | 325 |
| Duplicated Lines | 0 % |
| Changes | 3 | ||
| Bugs | 1 | Features | 0 |
Complex classes like ColumnsProtectedMethods often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use ColumnsProtectedMethods, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 8 | trait ColumnsProtectedMethods |
||
| 9 | { |
||
| 10 | /** |
||
| 11 | * Add a column to the current operation, using the Setting API. |
||
| 12 | * |
||
| 13 | * @param array $column Column definition array. |
||
| 14 | */ |
||
| 15 | protected function addColumnToOperationSettings($column) |
||
| 16 | { |
||
| 17 | $allColumns = $this->columns(); |
||
|
Bug
introduced
by
|
|||
| 18 | $allColumns = Arr::add($allColumns, $column['key'], $column); |
||
| 19 | |||
| 20 | $this->setOperationSetting('columns', $allColumns); |
||
| 21 | } |
||
| 22 | |||
| 23 | /** |
||
| 24 | * If a column priority has not been defined, provide a default one. |
||
| 25 | * |
||
| 26 | * @param array $column Column definition array. |
||
| 27 | * @return array Proper array defining the column. |
||
| 28 | */ |
||
| 29 | protected function makeSureColumnHasPriority($column) |
||
| 30 | { |
||
| 31 | $columns_count = $this->countColumnsWithoutActions(); |
||
| 32 | $assumed_priority = $columns_count ? $columns_count : 0; |
||
| 33 | |||
| 34 | $column['priority'] = $column['priority'] ?? $assumed_priority; |
||
| 35 | |||
| 36 | return $column; |
||
| 37 | } |
||
| 38 | |||
| 39 | /** |
||
| 40 | * If the field definition array is actually a string, it means the programmer was lazy |
||
| 41 | * and has only passed the name of the column. Turn that into a proper array. |
||
| 42 | * |
||
| 43 | * @param array $column Column definition array. |
||
| 44 | * @return array Proper array defining the column. |
||
| 45 | */ |
||
| 46 | protected function makeSureColumnHasName($column) |
||
| 47 | { |
||
| 48 | if (is_string($column)) { |
||
| 49 | $column = ['name' => $column]; |
||
| 50 | } |
||
| 51 | |||
| 52 | if (is_array($column) && ! isset($column['name'])) { |
||
| 53 | $column['name'] = 'anonymous_column_'.Str::random(5); |
||
| 54 | } |
||
| 55 | |||
| 56 | return $column; |
||
| 57 | } |
||
| 58 | |||
| 59 | /** |
||
| 60 | * If a column array is missing the "label" attribute, an ugly error would be show. |
||
| 61 | * So we add the field Name as a label - it's better than nothing. |
||
| 62 | * |
||
| 63 | * @param array $column Column definition array. |
||
| 64 | * @return array Proper array defining the column. |
||
| 65 | */ |
||
| 66 | protected function makeSureColumnHasLabel($column) |
||
| 73 | } |
||
| 74 | |||
| 75 | /** |
||
| 76 | * If a column definition is missing the type, set a default. |
||
| 77 | * |
||
| 78 | * @param array $column Column definition array. |
||
| 79 | * @return array Column definition array with type. |
||
| 80 | */ |
||
| 81 | protected function makeSureColumnHasType($column) |
||
| 82 | { |
||
| 83 | // Do not alter type if it has been set by developer |
||
| 84 | if (isset($column['type'])) { |
||
| 85 | return $column; |
||
| 86 | } |
||
| 87 | |||
| 88 | // Set text as default column type |
||
| 89 | $column['type'] = 'text'; |
||
| 90 | |||
| 91 | if (method_exists($this->model, 'translationEnabledForModel') && $this->model->translationEnabledForModel() && array_key_exists($column['name'], $this->model->getTranslations())) { |
||
| 92 | return $column; |
||
| 93 | } |
||
| 94 | |||
| 95 | $could_be_relation = Arr::get($column, 'entity', false) !== false; |
||
| 96 | |||
| 97 | if ($could_be_relation) { |
||
| 98 | $column['type'] = $this->inferFieldTypeFromRelationType($column['relation_type']); |
||
| 99 | } |
||
| 100 | |||
| 101 | if (in_array($column['name'], $this->model->getDates())) { |
||
| 102 | $column['type'] = 'datetime'; |
||
| 103 | } |
||
| 104 | |||
| 105 | if ($this->model->hasCast($column['name'])) { |
||
| 106 | $attributeType = $this->model->getCasts()[$column['name']]; |
||
| 107 | |||
| 108 | switch ($attributeType) { |
||
| 109 | case 'array': |
||
| 110 | case 'encrypted:array': |
||
| 111 | case 'collection': |
||
| 112 | case 'encrypted:collection': |
||
| 113 | $column['type'] = 'array'; |
||
| 114 | break; |
||
| 115 | case 'json': |
||
| 116 | case 'object': |
||
| 117 | $column['type'] = 'json'; |
||
| 118 | break; |
||
| 119 | case 'bool': |
||
| 120 | case 'boolean': |
||
| 121 | $column['type'] = 'check'; |
||
| 122 | break; |
||
| 123 | case 'date': |
||
| 124 | $column['type'] = 'date'; |
||
| 125 | break; |
||
| 126 | case 'datetime': |
||
| 127 | $column['type'] = 'datetime'; |
||
| 128 | break; |
||
| 129 | case 'double': |
||
| 130 | case 'float': |
||
| 131 | case 'int': |
||
| 132 | case 'integer': |
||
| 133 | case 'real': |
||
| 134 | case 'timestamp': |
||
| 135 | $column['type'] = 'number'; |
||
| 136 | break; |
||
| 137 | } |
||
| 138 | } |
||
| 139 | |||
| 140 | return $column; |
||
| 141 | } |
||
| 142 | |||
| 143 | /** |
||
| 144 | * If a column definition is missing the key, set the default. |
||
| 145 | * The key is used when storing all columns using the Settings API, |
||
| 146 | * it is used as the "key" of the associative array that holds all columns. |
||
| 147 | * |
||
| 148 | * @param array $column Column definition array. |
||
| 149 | * @return array Column definition array with key. |
||
| 150 | */ |
||
| 151 | protected function makeSureColumnHasKey($column) |
||
| 158 | } |
||
| 159 | |||
| 160 | /** |
||
| 161 | * If a column definition is missing the wrapper element, set the default (empty). |
||
| 162 | * The wrapper is the HTML element that wrappes around the column text. |
||
| 163 | * By defining this array a developer can wrap the text into an anchor (link), |
||
| 164 | * span, div or whatever they want. |
||
| 165 | * |
||
| 166 | * @param array $column Column definition array. |
||
| 167 | * @return array Column definition array with wrapper. |
||
| 168 | */ |
||
| 169 | protected function makeSureColumnHasWrapper($column) |
||
| 176 | } |
||
| 177 | |||
| 178 | protected function makeSureColumnHasEntity($column) |
||
| 179 | { |
||
| 180 | if (isset($column['entity'])) { |
||
| 181 | return $column; |
||
| 182 | } |
||
| 183 | |||
| 184 | // if the name is an array it's definitely not a relationship |
||
| 185 | if (is_array($column['name'])) { |
||
| 186 | return $column; |
||
| 187 | } |
||
| 188 | |||
| 189 | // if the name is dot notation it might be a relationship |
||
| 190 | if (strpos($column['name'], '.') !== false) { |
||
| 191 | $possibleMethodName = Str::before($column['name'], '.'); |
||
| 192 | |||
| 193 | // if the first part of the string exists as method, |
||
| 194 | // it is a relationship |
||
| 195 | if (method_exists($this->model, $possibleMethodName)) { |
||
| 196 | |||
| 197 | // if it has parameters it's not a relation method. |
||
| 198 | $column['entity'] = $this->modelMethodHasParameters($this->model, $possibleMethodName) ? false : $column['name']; |
||
| 199 | |||
| 200 | $parts = explode('.', $column['entity']); |
||
| 201 | |||
| 202 | $attribute_in_relation = false; |
||
| 203 | |||
| 204 | $model = $this->model; |
||
| 205 | |||
| 206 | // here we are going to iterate through all relation parts to check |
||
| 207 | // if the attribute is present in the relation string. |
||
| 208 | foreach ($parts as $i => $part) { |
||
| 209 | try { |
||
| 210 | $model = $model->$part()->getRelated(); |
||
| 211 | } catch (\Exception $e) { |
||
| 212 | $attribute_in_relation = true; |
||
| 213 | } |
||
| 214 | } |
||
| 215 | // if the user setup the attribute in relation string, we are not going to infer that attribute from model |
||
| 216 | // instead we get the defined attribute by the user. |
||
| 217 | if ($attribute_in_relation) { |
||
| 218 | $column['attribute'] = $column['attribute'] ?? end($parts); |
||
| 219 | } |
||
| 220 | |||
| 221 | return $column; |
||
| 222 | } |
||
| 223 | } |
||
| 224 | |||
| 225 | // if there's a method on the model with this name |
||
| 226 | if (method_exists($this->model, $column['name'])) { |
||
| 227 | |||
| 228 | // if it has parameters it's not a relation method. |
||
| 229 | $column['entity'] = $this->modelMethodHasParameters($this->model, $column['name']) ? false : $column['name']; |
||
| 230 | |||
| 231 | return $column; |
||
| 232 | } |
||
| 233 | |||
| 234 | // if the name ends with _id and that method exists, |
||
| 235 | // we can probably use it as an entity |
||
| 236 | if (Str::endsWith($column['name'], '_id')) { |
||
| 237 | $possibleMethodName = Str::replaceLast('_id', '', $column['name']); |
||
| 238 | |||
| 239 | if (method_exists($this->model, $possibleMethodName)) { |
||
| 240 | |||
| 241 | // if it has parameters it's not a relation method. |
||
| 242 | $column['entity'] = $this->modelMethodHasParameters($this->model, $possibleMethodName) ? false : $possibleMethodName; |
||
| 243 | |||
| 244 | return $column; |
||
| 245 | } |
||
| 246 | } |
||
| 247 | |||
| 248 | return $column; |
||
| 249 | } |
||
| 250 | |||
| 251 | /** |
||
| 252 | * If an entity has been defined for the column, but no model, |
||
| 253 | * determine the model from that relationship. |
||
| 254 | * |
||
| 255 | * @param array $column Column definition array. |
||
| 256 | * @return array Column definition array with model. |
||
| 257 | */ |
||
| 258 | protected function makeSureColumnHasModel($column) |
||
| 267 | } |
||
| 268 | |||
| 269 | /** |
||
| 270 | * If an entity has been defined for the column, but no relation type, |
||
| 271 | * determine the relation type from that relationship. |
||
| 272 | * |
||
| 273 | * @param array $column Column definition array. |
||
| 274 | * @return array Column definition array with model. |
||
| 275 | */ |
||
| 276 | protected function makeSureColumnHasRelationType($column) |
||
| 277 | { |
||
| 278 | if (isset($column['entity']) && $column['entity'] !== false) { |
||
| 279 | $column['relation_type'] = $column['relation_type'] ?? $this->inferRelationTypeFromRelationship($column); |
||
| 280 | } |
||
| 281 | |||
| 282 | return $column; |
||
| 283 | } |
||
| 284 | |||
| 285 | /** |
||
| 286 | * Move the most recently added column before or after the given target column. Default is before. |
||
| 287 | * |
||
| 288 | * @param string|array $targetColumn The target column name or array. |
||
| 289 | * @param bool $before If true, the column will be moved before the target column, otherwise it will be moved after it. |
||
| 290 | */ |
||
| 291 | protected function moveColumn($targetColumn, $before = true) |
||
| 292 | { |
||
| 293 | // TODO: this and the moveField method from the Fields trait should be refactored into a single method and moved |
||
| 294 | // into a common class |
||
| 295 | $targetColumnName = is_array($targetColumn) ? $targetColumn['name'] : $targetColumn; |
||
| 296 | $columnsArray = $this->columns(); |
||
| 297 | |||
| 298 | if (array_key_exists($targetColumnName, $columnsArray)) { |
||
| 299 | $targetColumnPosition = $before ? array_search($targetColumnName, array_keys($columnsArray)) : |
||
| 300 | array_search($targetColumnName, array_keys($columnsArray)) + 1; |
||
| 301 | |||
| 302 | $element = array_pop($columnsArray); |
||
| 303 | $beginningPart = array_slice($columnsArray, 0, $targetColumnPosition, true); |
||
| 304 | $endingArrayPart = array_slice($columnsArray, $targetColumnPosition, null, true); |
||
| 305 | |||
| 306 | $columnsArray = array_merge($beginningPart, [$element['name'] => $element], $endingArrayPart); |
||
| 307 | $this->setOperationSetting('columns', $columnsArray); |
||
| 308 | } |
||
| 309 | } |
||
| 310 | |||
| 311 | /** |
||
| 312 | * Check if the column exists in the database, as a DB column. |
||
| 313 | * |
||
| 314 | * @param string $table |
||
| 315 | * @param string $name |
||
| 316 | * @return bool |
||
| 317 | */ |
||
| 318 | protected function hasDatabaseColumn($table, $name) |
||
| 333 | } |
||
| 334 | } |
||
| 335 |
Loading history...
