z-song /
laravel-admin
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like HasMany 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 HasMany, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 17 | class HasMany extends Field |
||
| 18 | { |
||
| 19 | /** |
||
| 20 | * Relation name. |
||
| 21 | * |
||
| 22 | * @var string |
||
| 23 | */ |
||
| 24 | protected $relationName = ''; |
||
| 25 | |||
| 26 | /** |
||
| 27 | * Form builder. |
||
| 28 | * |
||
| 29 | * @var \Closure |
||
| 30 | */ |
||
| 31 | protected $builder = null; |
||
| 32 | |||
| 33 | /** |
||
| 34 | * Form data. |
||
| 35 | * |
||
| 36 | * @var array |
||
| 37 | */ |
||
| 38 | protected $value = []; |
||
| 39 | |||
| 40 | /** |
||
| 41 | * View Mode. |
||
| 42 | * |
||
| 43 | * Supports `default` and `tab` currently. |
||
| 44 | * |
||
| 45 | * @var string |
||
| 46 | */ |
||
| 47 | protected $viewMode = 'default'; |
||
| 48 | |||
| 49 | /** |
||
| 50 | * Available views for HasMany field. |
||
| 51 | * |
||
| 52 | * @var array |
||
| 53 | */ |
||
| 54 | protected $views = [ |
||
| 55 | 'default' => 'admin::form.hasmany', |
||
| 56 | 'tab' => 'admin::form.hasmanytab', |
||
| 57 | 'table' => 'admin::form.hasmanytable', |
||
| 58 | ]; |
||
| 59 | |||
| 60 | /** |
||
| 61 | * Options for template. |
||
| 62 | * |
||
| 63 | * @var array |
||
| 64 | */ |
||
| 65 | protected $options = [ |
||
| 66 | 'allowCreate' => true, |
||
| 67 | 'allowDelete' => true, |
||
| 68 | ]; |
||
| 69 | |||
| 70 | /** |
||
| 71 | * Create a new HasMany field instance. |
||
| 72 | * |
||
| 73 | * @param $relationName |
||
| 74 | * @param array $arguments |
||
| 75 | */ |
||
| 76 | View Code Duplication | public function __construct($relationName, $arguments = []) |
|
|
|
|||
| 77 | { |
||
| 78 | $this->relationName = $relationName; |
||
| 79 | |||
| 80 | $this->column = $relationName; |
||
| 81 | |||
| 82 | if (count($arguments) == 1) { |
||
| 83 | $this->label = $this->formatLabel(); |
||
| 84 | $this->builder = $arguments[0]; |
||
| 85 | } |
||
| 86 | |||
| 87 | if (count($arguments) == 2) { |
||
| 88 | list($this->label, $this->builder) = $arguments; |
||
| 89 | } |
||
| 90 | } |
||
| 91 | |||
| 92 | /** |
||
| 93 | * Get validator for this field. |
||
| 94 | * |
||
| 95 | * @param array $input |
||
| 96 | * |
||
| 97 | * @return bool|Validator |
||
| 98 | */ |
||
| 99 | public function getValidator(array $input) |
||
| 100 | { |
||
| 101 | if (!array_key_exists($this->column, $input)) { |
||
| 102 | return false; |
||
| 103 | } |
||
| 104 | |||
| 105 | $input = array_only($input, $this->column); |
||
| 106 | |||
| 107 | $form = $this->buildNestedForm($this->column, $this->builder); |
||
| 108 | |||
| 109 | $rules = $attributes = []; |
||
| 110 | |||
| 111 | /* @var Field $field */ |
||
| 112 | foreach ($form->fields() as $field) { |
||
| 113 | if (!$fieldRules = $field->getRules()) { |
||
| 114 | continue; |
||
| 115 | } |
||
| 116 | |||
| 117 | $column = $field->column(); |
||
| 118 | |||
| 119 | if (is_array($column)) { |
||
| 120 | foreach ($column as $key => $name) { |
||
| 121 | $rules[$name.$key] = $fieldRules; |
||
| 122 | } |
||
| 123 | |||
| 124 | $this->resetInputKey($input, $column); |
||
| 125 | } else { |
||
| 126 | $rules[$column] = $fieldRules; |
||
| 127 | } |
||
| 128 | |||
| 129 | $attributes = array_merge( |
||
| 130 | $attributes, |
||
| 131 | $this->formatValidationAttribute($input, $field->label(), $column) |
||
| 132 | ); |
||
| 133 | } |
||
| 134 | |||
| 135 | array_forget($rules, NestedForm::REMOVE_FLAG_NAME); |
||
| 136 | |||
| 137 | if (empty($rules)) { |
||
| 138 | return false; |
||
| 139 | } |
||
| 140 | |||
| 141 | $newRules = []; |
||
| 142 | $newInput = []; |
||
| 143 | |||
| 144 | foreach ($rules as $column => $rule) { |
||
| 145 | foreach (array_keys($input[$this->column]) as $key) { |
||
| 146 | $newRules["{$this->column}.$key.$column"] = $rule; |
||
| 147 | if (isset($input[$this->column][$key][$column]) && |
||
| 148 | is_array($input[$this->column][$key][$column])) { |
||
| 149 | foreach ($input[$this->column][$key][$column] as $vkey => $value) { |
||
| 150 | $newInput["{$this->column}.$key.{$column}$vkey"] = $value; |
||
| 151 | } |
||
| 152 | } |
||
| 153 | } |
||
| 154 | } |
||
| 155 | |||
| 156 | if (empty($newInput)) { |
||
| 157 | $newInput = $input; |
||
| 158 | } |
||
| 159 | |||
| 160 | return Validator::make($newInput, $newRules, $this->validationMessages, $attributes); |
||
| 161 | } |
||
| 162 | |||
| 163 | /** |
||
| 164 | * Format validation attributes. |
||
| 165 | * |
||
| 166 | * @param array $input |
||
| 167 | * @param string $label |
||
| 168 | * @param string $column |
||
| 169 | * |
||
| 170 | * @return array |
||
| 171 | */ |
||
| 172 | View Code Duplication | protected function formatValidationAttribute($input, $label, $column) |
|
| 173 | { |
||
| 174 | $new = $attributes = []; |
||
| 175 | |||
| 176 | if (is_array($column)) { |
||
| 177 | foreach ($column as $index => $col) { |
||
| 178 | $new[$col.$index] = $col; |
||
| 179 | } |
||
| 180 | } |
||
| 181 | |||
| 182 | foreach (array_keys(array_dot($input)) as $key) { |
||
| 183 | if (is_string($column)) { |
||
| 184 | if (Str::endsWith($key, ".$column")) { |
||
| 185 | $attributes[$key] = $label; |
||
| 186 | } |
||
| 187 | } else { |
||
| 188 | foreach ($new as $k => $val) { |
||
| 189 | if (Str::endsWith($key, ".$k")) { |
||
| 190 | $attributes[$key] = $label."[$val]"; |
||
| 191 | } |
||
| 192 | } |
||
| 193 | } |
||
| 194 | } |
||
| 195 | |||
| 196 | return $attributes; |
||
| 197 | } |
||
| 198 | |||
| 199 | /** |
||
| 200 | * Reset input key for validation. |
||
| 201 | * |
||
| 202 | * @param array $input |
||
| 203 | * @param array $column $column is the column name array set |
||
| 204 | * |
||
| 205 | * @return void. |
||
| 206 | */ |
||
| 207 | protected function resetInputKey(array &$input, array $column) |
||
| 208 | { |
||
| 209 | /** |
||
| 210 | * flip the column name array set. |
||
| 211 | * |
||
| 212 | * for example, for the DateRange, the column like as below |
||
| 213 | * |
||
| 214 | * ["start" => "created_at", "end" => "updated_at"] |
||
| 215 | * |
||
| 216 | * to: |
||
| 217 | * |
||
| 218 | * [ "created_at" => "start", "updated_at" => "end" ] |
||
| 219 | */ |
||
| 220 | $column = array_flip($column); |
||
| 221 | |||
| 222 | /** |
||
| 223 | * $this->column is the inputs array's node name, default is the relation name. |
||
| 224 | * |
||
| 225 | * So... $input[$this->column] is the data of this column's inputs data |
||
| 226 | * |
||
| 227 | * in the HasMany relation, has many data/field set, $set is field set in the below |
||
| 228 | */ |
||
| 229 | foreach ($input[$this->column] as $index => $set) { |
||
| 230 | |||
| 231 | /* |
||
| 232 | * foreach the field set to find the corresponding $column |
||
| 233 | */ |
||
| 234 | View Code Duplication | foreach ($set as $name => $value) { |
|
| 235 | /* |
||
| 236 | * if doesn't have column name, continue to the next loop |
||
| 237 | */ |
||
| 238 | if (!array_key_exists($name, $column)) { |
||
| 239 | continue; |
||
| 240 | } |
||
| 241 | |||
| 242 | /** |
||
| 243 | * example: $newKey = created_atstart. |
||
| 244 | * |
||
| 245 | * Σ( ° △ °|||)︴ |
||
| 246 | * |
||
| 247 | * I don't know why a form need range input? Only can imagine is for range search.... |
||
| 248 | */ |
||
| 249 | $newKey = $name.$column[$name]; |
||
| 250 | |||
| 251 | /* |
||
| 252 | * set new key |
||
| 253 | */ |
||
| 254 | array_set($input, "{$this->column}.$index.$newKey", $value); |
||
| 255 | /* |
||
| 256 | * forget the old key and value |
||
| 257 | */ |
||
| 258 | array_forget($input, "{$this->column}.$index.$name"); |
||
| 259 | } |
||
| 260 | } |
||
| 261 | } |
||
| 262 | |||
| 263 | /** |
||
| 264 | * Prepare input data for insert or update. |
||
| 265 | * |
||
| 266 | * @param array $input |
||
| 267 | * |
||
| 268 | * @return array |
||
| 269 | */ |
||
| 270 | public function prepare($input) |
||
| 271 | { |
||
| 272 | $form = $this->buildNestedForm($this->column, $this->builder); |
||
| 273 | |||
| 274 | return $form->setOriginal($this->original, $this->getKeyName())->prepare($input); |
||
| 275 | } |
||
| 276 | |||
| 277 | /** |
||
| 278 | * Build a Nested form. |
||
| 279 | * |
||
| 280 | * @param string $column |
||
| 281 | * @param \Closure $builder |
||
| 282 | * @param null $key |
||
| 283 | * |
||
| 284 | * @return NestedForm |
||
| 285 | */ |
||
| 286 | protected function buildNestedForm($column, \Closure $builder, $key = null) |
||
| 287 | { |
||
| 288 | $form = new Form\NestedForm($column, $key); |
||
| 289 | |||
| 290 | $form->setForm($this->form); |
||
| 291 | |||
| 292 | call_user_func($builder, $form); |
||
| 293 | |||
| 294 | $form->hidden($this->getKeyName()); |
||
| 295 | |||
| 296 | $form->hidden(NestedForm::REMOVE_FLAG_NAME)->default(0)->addElementClass(NestedForm::REMOVE_FLAG_CLASS); |
||
| 297 | |||
| 298 | return $form; |
||
| 299 | } |
||
| 300 | |||
| 301 | /** |
||
| 302 | * Get the HasMany relation key name. |
||
| 303 | * |
||
| 304 | * @return string |
||
| 305 | */ |
||
| 306 | protected function getKeyName() |
||
| 307 | { |
||
| 308 | if (is_null($this->form)) { |
||
| 309 | return; |
||
| 310 | } |
||
| 311 | |||
| 312 | return $this->form->model()->{$this->relationName}()->getRelated()->getKeyName(); |
||
| 313 | } |
||
| 314 | |||
| 315 | /** |
||
| 316 | * Set view mode. |
||
| 317 | * |
||
| 318 | * @param string $mode currently support `tab` mode. |
||
| 319 | * |
||
| 320 | * @return $this |
||
| 321 | * |
||
| 322 | * @author Edwin Hui |
||
| 323 | */ |
||
| 324 | public function mode($mode) |
||
| 325 | { |
||
| 326 | $this->viewMode = $mode; |
||
| 327 | |||
| 328 | return $this; |
||
| 329 | } |
||
| 330 | |||
| 331 | /** |
||
| 332 | * Use tab mode to showing hasmany field. |
||
| 333 | * |
||
| 334 | * @return HasMany |
||
| 335 | */ |
||
| 336 | public function useTab() |
||
| 337 | { |
||
| 338 | return $this->mode('tab'); |
||
| 339 | } |
||
| 340 | |||
| 341 | /** |
||
| 342 | * Use table mode to showing hasmany field. |
||
| 343 | * |
||
| 344 | * @return HasMany |
||
| 345 | */ |
||
| 346 | public function useTable() |
||
| 347 | { |
||
| 348 | return $this->mode('table'); |
||
| 349 | } |
||
| 350 | |||
| 351 | /** |
||
| 352 | * Build Nested form for related data. |
||
| 353 | * |
||
| 354 | * @throws \Exception |
||
| 355 | * |
||
| 356 | * @return array |
||
| 357 | */ |
||
| 358 | protected function buildRelatedForms() |
||
| 401 | |||
| 402 | /** |
||
| 403 | * Setup script for this field in different view mode. |
||
| 404 | * |
||
| 405 | * @param string $script |
||
| 406 | * |
||
| 407 | * @return void |
||
| 408 | */ |
||
| 409 | protected function setupScript($script) |
||
| 415 | |||
| 416 | /** |
||
| 417 | * Setup default template script. |
||
| 418 | * |
||
| 419 | * @param string $templateScript |
||
| 420 | * |
||
| 421 | * @return void |
||
| 422 | */ |
||
| 423 | View Code Duplication | protected function setupScriptForDefaultView($templateScript) |
|
| 457 | |||
| 458 | /** |
||
| 459 | * Setup tab template script. |
||
| 460 | * |
||
| 461 | * @param string $templateScript |
||
| 462 | * |
||
| 463 | * @return void |
||
| 464 | */ |
||
| 465 | View Code Duplication | protected function setupScriptForTabView($templateScript) |
|
| 512 | |||
| 513 | /** |
||
| 514 | * Setup default template script. |
||
| 515 | * |
||
| 516 | * @param string $templateScript |
||
| 517 | * |
||
| 518 | * @return void |
||
| 519 | */ |
||
| 520 | View Code Duplication | protected function setupScriptForTableView($templateScript) |
|
| 521 | { |
||
| 522 | $removeClass = NestedForm::REMOVE_FLAG_CLASS; |
||
| 554 | |||
| 555 | /** |
||
| 556 | * Disable create button. |
||
| 557 | * |
||
| 558 | * @return $this |
||
| 559 | */ |
||
| 560 | public function disableCreate() |
||
| 566 | |||
| 567 | /** |
||
| 568 | * Disable delete button. |
||
| 569 | * |
||
| 570 | * @return $this |
||
| 571 | */ |
||
| 572 | public function disableDelete() |
||
| 578 | |||
| 579 | /** |
||
| 580 | * Render the `HasMany` field. |
||
| 581 | * |
||
| 582 | * @throws \Exception |
||
| 583 | * |
||
| 584 | * @return \Illuminate\View\View |
||
| 585 | */ |
||
| 586 | public function render() |
||
| 607 | |||
| 608 | /** |
||
| 609 | * Render the `HasMany` field for table style |
||
| 610 | * |
||
| 611 | * @return mixed |
||
| 612 | * @throws \Exception |
||
| 613 | */ |
||
| 614 | protected function renderTable() |
||
| 664 | } |
||
| 665 |
Loading history...
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.