Laravel-Backpack /
CRUD
We could not synchronize checks via GitHub's checks API since Scrutinizer's GitHub App is not installed for this repository.
Complex classes like Fields 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. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
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 Fields, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 5 | trait Fields |
||
| 6 | { |
||
| 7 | // ------------ |
||
| 8 | // FIELDS |
||
| 9 | // ------------ |
||
| 10 | |||
| 11 | /** |
||
| 12 | * Add a field to the create/update form or both. |
||
| 13 | * |
||
| 14 | * @param string $form The form to add the field to (create/update/both) |
||
| 15 | */ |
||
| 16 | 60 | public function addField($field, $form = 'both') |
|
| 17 | { |
||
| 18 | // if the field_definition_array array is a string, it means the programmer was lazy and has only passed the name |
||
|
|
|||
| 19 | // set some default values, so the field will still work |
||
| 20 | 60 | if (is_string($field)) { |
|
| 21 | 4 | $complete_field_array['name'] = $field; |
|
| 22 | 4 | } else { |
|
| 23 | 56 | $complete_field_array = $field; |
|
| 24 | } |
||
| 25 | |||
| 26 | // if this is a relation type field and no corresponding model was specified, get it from the relation method |
||
| 27 | // defined in the main model |
||
| 28 | 60 | if (isset($complete_field_array['entity']) && ! isset($complete_field_array['model'])) { |
|
| 29 | 8 | $complete_field_array['model'] = $this->getRelationModel($complete_field_array['entity']); |
|
| 30 | 8 | } |
|
| 31 | |||
| 32 | // if the label is missing, we should set it |
||
| 33 | 60 | if (! isset($complete_field_array['label'])) { |
|
| 34 | 42 | $complete_field_array['label'] = ucfirst($complete_field_array['name']); |
|
| 35 | 41 | } |
|
| 36 | |||
| 37 | // if the field type is missing, we should set it |
||
| 38 | 59 | if (! isset($complete_field_array['type'])) { |
|
| 39 | 55 | $complete_field_array['type'] = $this->getFieldTypeFromDbColumnType($complete_field_array['name']); |
|
| 40 | 55 | } |
|
| 41 | |||
| 42 | // if a tab was mentioned, we should enable it |
||
| 43 | 59 | if (isset($complete_field_array['tab'])) { |
|
| 44 | 7 | if (! $this->tabsEnabled()) { |
|
| 45 | 7 | $this->enableTabs(); |
|
| 46 | 7 | } |
|
| 47 | 7 | } |
|
| 48 | |||
| 49 | // store the field information into the correct variable on the CRUD object |
||
| 50 | 59 | switch (strtolower($form)) { |
|
| 51 | 59 | case 'create': |
|
| 52 | 10 | $this->create_fields[$complete_field_array['name']] = $complete_field_array; |
|
| 53 | 10 | break; |
|
| 54 | |||
| 55 | 51 | case 'update': |
|
| 56 | 11 | $this->update_fields[$complete_field_array['name']] = $complete_field_array; |
|
| 57 | 11 | break; |
|
| 58 | |||
| 59 | 40 | default: |
|
| 60 | 41 | $this->create_fields[$complete_field_array['name']] = $complete_field_array; |
|
| 61 | 40 | $this->update_fields[$complete_field_array['name']] = $complete_field_array; |
|
| 62 | 40 | break; |
|
| 63 | 59 | } |
|
| 64 | |||
| 65 | 59 | return $this; |
|
| 66 | } |
||
| 67 | |||
| 68 | 54 | public function addFields($fields, $form = 'both') |
|
| 69 | { |
||
| 70 | 54 | if (count($fields)) { |
|
| 71 | 54 | foreach ($fields as $field) { |
|
| 72 | 54 | $this->addField($field, $form); |
|
| 73 | 53 | } |
|
| 74 | 53 | } |
|
| 75 | 53 | } |
|
| 76 | |||
| 77 | /** |
||
| 78 | * Move the most recently added field after the given target field. |
||
| 79 | * |
||
| 80 | * @param string $targetFieldName The target field name. |
||
| 81 | * @param string $form The CRUD form. Can be 'create', 'update' or 'both'. Default is 'both'. |
||
| 82 | */ |
||
| 83 | 6 | public function afterField($targetFieldName, $form = 'both') |
|
| 87 | |||
| 88 | /** |
||
| 89 | * Move the most recently added field before the given target field. |
||
| 90 | * |
||
| 91 | * @param string $targetFieldName The target field name. |
||
| 92 | * @param string $form The CRUD form. Can be 'create', 'update' or 'both'. Default is 'both'. |
||
| 93 | */ |
||
| 94 | 7 | public function beforeField($targetFieldName, $form = 'both') |
|
| 98 | |||
| 99 | /** |
||
| 100 | * Move the most recently added field from a given form before or after the given target field. Default is before. |
||
| 101 | * |
||
| 102 | * @param string $targetFieldName The target field name. |
||
| 103 | * @param string $form The CRUD form. Can be 'create', 'update' or 'both'. Default is 'both'. |
||
| 104 | * @param bool $before If true, the field will be moved before the target field, otherwise it will be moved after it. |
||
| 105 | */ |
||
| 106 | 13 | protected function moveFieldInForm($targetFieldName, $form = 'both', $before = true) |
|
| 107 | { |
||
| 108 | switch ($form) { |
||
| 109 | 13 | case 'create': |
|
| 110 | 2 | $this->moveField($this->create_fields, $targetFieldName, $before); |
|
| 111 | 2 | break; |
|
| 112 | 11 | case 'update': |
|
| 113 | 2 | $this->moveField($this->update_fields, $targetFieldName, $before); |
|
| 114 | 2 | break; |
|
| 115 | 9 | default: |
|
| 116 | 9 | $this->moveField($this->create_fields, $targetFieldName, $before); |
|
| 117 | 9 | $this->moveField($this->update_fields, $targetFieldName, $before); |
|
| 118 | 9 | break; |
|
| 119 | 9 | } |
|
| 120 | 13 | } |
|
| 121 | |||
| 122 | /** |
||
| 123 | * Move the most recently added field before or after the given target field. Default is before. |
||
| 124 | * |
||
| 125 | * @param array $fields The form fields. |
||
| 126 | * @param string $targetFieldName The target field name. |
||
| 127 | * @param bool $before If true, the field will be moved before the target field, otherwise it will be moved after it. |
||
| 128 | */ |
||
| 129 | 13 | private function moveField(&$fields, $targetFieldName, $before = true) |
|
| 130 | { |
||
| 131 | 13 | if (array_key_exists($targetFieldName, $fields)) { |
|
| 132 | 11 | $targetFieldPosition = $before ? array_search($targetFieldName, array_keys($fields)) |
|
| 133 | 11 | : array_search($targetFieldName, array_keys($fields)) + 1; |
|
| 134 | |||
| 135 | 11 | if ($targetFieldPosition >= (count($fields) - 1)) { |
|
| 136 | // target field name is same as element |
||
| 137 | 3 | return; |
|
| 138 | } |
||
| 139 | |||
| 140 | 9 | $element = array_pop($fields); |
|
| 141 | 9 | $beginningArrayPart = array_slice($fields, 0, $targetFieldPosition, true); |
|
| 142 | 9 | $endingArrayPart = array_slice($fields, $targetFieldPosition, null, true); |
|
| 143 | |||
| 144 | 9 | $fields = array_merge($beginningArrayPart, [$element['name'] => $element], $endingArrayPart); |
|
| 145 | 9 | } |
|
| 146 | 11 | } |
|
| 147 | |||
| 148 | /** |
||
| 149 | * Remove a certain field from the create/update/both forms by its name. |
||
| 150 | * |
||
| 151 | * @param string $name Field name (as defined with the addField() procedure) |
||
| 152 | * @param string $form update/create/both |
||
| 153 | */ |
||
| 154 | 4 | public function removeField($name, $form = 'both') |
|
| 155 | { |
||
| 156 | 4 | switch (strtolower($form)) { |
|
| 157 | 4 | case 'create': |
|
| 158 | 1 | array_forget($this->create_fields, $name); |
|
| 159 | 1 | break; |
|
| 160 | |||
| 161 | 3 | case 'update': |
|
| 162 | 1 | array_forget($this->update_fields, $name); |
|
| 163 | 1 | break; |
|
| 164 | |||
| 165 | 2 | default: |
|
| 166 | 2 | array_forget($this->create_fields, $name); |
|
| 167 | 2 | array_forget($this->update_fields, $name); |
|
| 168 | 2 | break; |
|
| 169 | 4 | } |
|
| 170 | 4 | } |
|
| 171 | |||
| 172 | /** |
||
| 173 | * Remove many fields from the create/update/both forms by their name. |
||
| 174 | * |
||
| 175 | * @param array $array_of_names A simple array of the names of the fields to be removed. |
||
| 176 | * @param string $form update/create/both |
||
| 177 | */ |
||
| 178 | 4 | public function removeFields($array_of_names, $form = 'both') |
|
| 179 | { |
||
| 180 | 4 | if (! empty($array_of_names)) { |
|
| 181 | 4 | foreach ($array_of_names as $name) { |
|
| 182 | 4 | $this->removeField($name, $form); |
|
| 183 | 4 | } |
|
| 184 | 4 | } |
|
| 185 | 4 | } |
|
| 186 | |||
| 187 | /** |
||
| 188 | * Set label for a specific field. |
||
| 189 | * |
||
| 190 | * @param string $field |
||
| 191 | * @param string $label |
||
| 192 | */ |
||
| 193 | public function setFieldLabel($field, $label) |
||
| 194 | { |
||
| 195 | if (isset($this->create_fields[$field])) { |
||
| 196 | $this->create_fields[$field]['label'] = $label; |
||
| 197 | } |
||
| 198 | if (isset($this->update_fields[$field])) { |
||
| 199 | $this->update_fields[$field]['label'] = $label; |
||
| 200 | } |
||
| 201 | } |
||
| 202 | |||
| 203 | /** |
||
| 204 | * Check if field is the first of its type in the given fields array. |
||
| 205 | * It's used in each field_type.blade.php to determine wether to push the css and js content or not (we only need to push the js and css for a field the first time it's loaded in the form, not any subsequent times). |
||
| 206 | * |
||
| 207 | * @param array $field The current field being tested if it's the first of its type. |
||
| 208 | * @param array $fields_array All the fields in that particular form. |
||
| 209 | * |
||
| 210 | * @return bool true/false |
||
| 211 | */ |
||
| 212 | 3 | public function checkIfFieldIsFirstOfItsType($field, $fields_array) |
|
| 222 | |||
| 223 | /** |
||
| 224 | * Order the fields in a certain way. |
||
| 225 | * |
||
| 226 | * @param [string] Column name. |
||
| 227 | * @param [attributes and values array] |
||
| 228 | */ |
||
| 229 | public function setFieldOrder($fields) |
||
| 233 | |||
| 234 | // ALIAS of setFieldOrder($fields) |
||
| 235 | public function setFieldsOrder($fields) |
||
| 239 | |||
| 240 | /** |
||
| 241 | * Decode attributes that are casted as array/object/json in the model. |
||
| 242 | * So that they are not json_encoded twice before they are stored in the db |
||
| 243 | * (once by Backpack in front-end, once by Laravel Attribute Casting). |
||
| 244 | */ |
||
| 245 | 6 | public function decodeJsonCastedAttributes($data, $form, $id = false) |
|
| 246 | { |
||
| 247 | // get the right fields according to the form type (create/update) |
||
| 248 | 6 | $fields = $this->getFields($form, $id); |
|
| 249 | 5 | $casted_attributes = $this->model->getCastedAttributes(); |
|
| 250 | |||
| 251 | 5 | foreach ($fields as $field) { |
|
| 252 | |||
| 253 | // Test the field is castable |
||
| 254 | 5 | if (isset($field['name']) && array_key_exists($field['name'], $casted_attributes)) { |
|
| 255 | |||
| 256 | // Handle JSON field types |
||
| 257 | 5 | $jsonCastables = ['array', 'object', 'json']; |
|
| 258 | 5 | $fieldCasting = $casted_attributes[$field['name']]; |
|
| 259 | |||
| 260 | 5 | if (in_array($fieldCasting, $jsonCastables) && isset($data[$field['name']]) && ! empty($data[$field['name']]) && ! is_array($data[$field['name']])) { |
|
| 261 | try { |
||
| 262 | $data[$field['name']] = json_decode($data[$field['name']]); |
||
| 263 | } catch (Exception $e) { |
||
| 264 | $data[$field['name']] = []; |
||
| 265 | } |
||
| 266 | } |
||
| 267 | 5 | } |
|
| 268 | 5 | } |
|
| 269 | |||
| 270 | 5 | return $data; |
|
| 271 | } |
||
| 272 | |||
| 273 | 9 | public function getCurrentFields() |
|
| 281 | |||
| 282 | // ------------ |
||
| 283 | // TONE FUNCTIONS - UNDOCUMENTED, UNTESTED, SOME MAY BE USED |
||
| 284 | // ------------ |
||
| 285 | // TODO: check them |
||
| 286 | |||
| 287 | public function orderFields($order) |
||
| 291 | } |
||
| 292 |
Loading history...
Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.