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 Form 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 Form, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 71 | class Form |
||
| 72 | { |
||
| 73 | /** |
||
| 74 | * Eloquent model of the form. |
||
| 75 | * |
||
| 76 | * @var Model |
||
| 77 | */ |
||
| 78 | protected $model; |
||
| 79 | |||
| 80 | /** |
||
| 81 | * @var \Illuminate\Validation\Validator |
||
| 82 | */ |
||
| 83 | protected $validator; |
||
| 84 | |||
| 85 | /** |
||
| 86 | * @var Builder |
||
| 87 | */ |
||
| 88 | protected $builder; |
||
| 89 | |||
| 90 | /** |
||
| 91 | * Submitted callback. |
||
| 92 | * |
||
| 93 | * @var Closure |
||
| 94 | */ |
||
| 95 | protected $submitted; |
||
| 96 | |||
| 97 | /** |
||
| 98 | * Saving callback. |
||
| 99 | * |
||
| 100 | * @var Closure |
||
| 101 | */ |
||
| 102 | protected $saving; |
||
| 103 | |||
| 104 | /** |
||
| 105 | * Saved callback. |
||
| 106 | * |
||
| 107 | * @var Closure |
||
| 108 | */ |
||
| 109 | protected $saved; |
||
| 110 | |||
| 111 | /** |
||
| 112 | * Data for save to current model from input. |
||
| 113 | * |
||
| 114 | * @var array |
||
| 115 | */ |
||
| 116 | protected $updates = []; |
||
| 117 | |||
| 118 | /** |
||
| 119 | * Data for save to model's relations from input. |
||
| 120 | * |
||
| 121 | * @var array |
||
| 122 | */ |
||
| 123 | protected $relations = []; |
||
| 124 | |||
| 125 | /** |
||
| 126 | * Input data. |
||
| 127 | * |
||
| 128 | * @var array |
||
| 129 | */ |
||
| 130 | protected $inputs = []; |
||
| 131 | |||
| 132 | /** |
||
| 133 | * Available fields. |
||
| 134 | * |
||
| 135 | * @var array |
||
| 136 | */ |
||
| 137 | public static $availableFields = []; |
||
| 138 | |||
| 139 | /** |
||
| 140 | * Ignored saving fields. |
||
| 141 | * |
||
| 142 | * @var array |
||
| 143 | */ |
||
| 144 | protected $ignored = []; |
||
| 145 | |||
| 146 | /** |
||
| 147 | * Collected field assets. |
||
| 148 | * |
||
| 149 | * @var array |
||
| 150 | */ |
||
| 151 | protected static $collectedAssets = []; |
||
| 152 | |||
| 153 | /** |
||
| 154 | * @var Form\Tab |
||
| 155 | */ |
||
| 156 | protected $tab = null; |
||
| 157 | |||
| 158 | /** |
||
| 159 | * Remove flag in `has many` form. |
||
| 160 | */ |
||
| 161 | const REMOVE_FLAG_NAME = '_remove_'; |
||
| 162 | |||
| 163 | /** |
||
| 164 | * Field rows in form. |
||
| 165 | * |
||
| 166 | * @var array |
||
| 167 | */ |
||
| 168 | public $rows = []; |
||
| 169 | |||
| 170 | /** |
||
| 171 | * Create a new form instance. |
||
| 172 | * |
||
| 173 | * @param $model |
||
| 174 | * @param \Closure $callback |
||
| 175 | */ |
||
| 176 | public function __construct($model, Closure $callback) |
||
| 184 | |||
| 185 | /** |
||
| 186 | * @param Field $field |
||
| 187 | * |
||
| 188 | * @return $this |
||
| 189 | */ |
||
| 190 | public function pushField(Field $field) |
||
| 198 | |||
| 199 | /** |
||
| 200 | * @return Model |
||
| 201 | */ |
||
| 202 | public function model() |
||
| 206 | |||
| 207 | /** |
||
| 208 | * @return Builder |
||
| 209 | */ |
||
| 210 | public function builder() |
||
| 214 | |||
| 215 | /** |
||
| 216 | * Generate a edit form. |
||
| 217 | * |
||
| 218 | * @param $id |
||
| 219 | * |
||
| 220 | * @return $this |
||
| 221 | */ |
||
| 222 | public function edit($id) |
||
| 231 | |||
| 232 | /** |
||
| 233 | * @param $id |
||
| 234 | * |
||
| 235 | * @return $this |
||
| 236 | */ |
||
| 237 | public function view($id) |
||
| 246 | |||
| 247 | /** |
||
| 248 | * Use tab to split form. |
||
| 249 | * |
||
| 250 | * @param string $title |
||
| 251 | * @param Closure $content |
||
| 252 | * |
||
| 253 | * @return $this |
||
| 254 | */ |
||
| 255 | public function tab($title, Closure $content, $active = false) |
||
| 261 | |||
| 262 | /** |
||
| 263 | * Get Tab instance. |
||
| 264 | * |
||
| 265 | * @return Tab |
||
| 266 | */ |
||
| 267 | public function getTab() |
||
| 275 | |||
| 276 | /** |
||
| 277 | * Destroy data entity and remove files. |
||
| 278 | * |
||
| 279 | * @param $id |
||
| 280 | * |
||
| 281 | * @return mixed |
||
| 282 | */ |
||
| 283 | public function destroy($id) |
||
| 297 | |||
| 298 | /** |
||
| 299 | * Remove files or images in record. |
||
| 300 | * |
||
| 301 | * @param $id |
||
| 302 | */ |
||
| 303 | protected function deleteFilesAndImages($id) |
||
| 316 | |||
| 317 | /** |
||
| 318 | * Store a new record. |
||
| 319 | * |
||
| 320 | * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector|\Illuminate\Http\JsonResponse |
||
| 321 | */ |
||
| 322 | public function store() |
||
| 357 | |||
| 358 | /** |
||
| 359 | * Get RedirectResponse after store. |
||
| 360 | * |
||
| 361 | * @return \Illuminate\Http\RedirectResponse |
||
| 362 | */ |
||
| 363 | View Code Duplication | protected function redirectAfterStore() |
|
| 371 | |||
| 372 | /** |
||
| 373 | * Get ajax response. |
||
| 374 | * |
||
| 375 | * @param string $message |
||
| 376 | * |
||
| 377 | * @return bool|\Illuminate\Http\JsonResponse |
||
| 378 | */ |
||
| 379 | protected function ajaxResponse($message) |
||
| 393 | |||
| 394 | /** |
||
| 395 | * Prepare input data for insert or update. |
||
| 396 | * |
||
| 397 | * @param array $data |
||
| 398 | * |
||
| 399 | * @return mixed |
||
| 400 | */ |
||
| 401 | protected function prepare($data = []) |
||
| 417 | |||
| 418 | /** |
||
| 419 | * Remove ignored fields from input. |
||
| 420 | * |
||
| 421 | * @param array $input |
||
| 422 | * |
||
| 423 | * @return array |
||
| 424 | */ |
||
| 425 | protected function removeIgnoredFields($input) |
||
| 431 | |||
| 432 | /** |
||
| 433 | * Get inputs for relations. |
||
| 434 | * |
||
| 435 | * @param array $inputs |
||
| 436 | * |
||
| 437 | * @return array |
||
| 438 | */ |
||
| 439 | protected function getRelationInputs($inputs = []) |
||
| 455 | |||
| 456 | /** |
||
| 457 | * Call submitted callback. |
||
| 458 | * |
||
| 459 | * @return mixed |
||
| 460 | */ |
||
| 461 | protected function callSubmitted() |
||
| 467 | |||
| 468 | /** |
||
| 469 | * Call saving callback. |
||
| 470 | * |
||
| 471 | * @return mixed |
||
| 472 | */ |
||
| 473 | protected function callSaving() |
||
| 479 | |||
| 480 | /** |
||
| 481 | * Callback after saving a Model. |
||
| 482 | * |
||
| 483 | * @param Closure|null $callback |
||
| 484 | * |
||
| 485 | * @return mixed|null |
||
| 486 | */ |
||
| 487 | protected function complete(Closure $callback = null) |
||
| 493 | |||
| 494 | /** |
||
| 495 | * Handle update. |
||
| 496 | * |
||
| 497 | * @param int $id |
||
| 498 | * |
||
| 499 | * @return \Symfony\Component\HttpFoundation\Response |
||
| 500 | */ |
||
| 501 | public function update($id) |
||
| 553 | |||
| 554 | /** |
||
| 555 | * Get RedirectResponse after update. |
||
| 556 | * |
||
| 557 | * @return \Illuminate\Http\RedirectResponse |
||
| 558 | */ |
||
| 559 | View Code Duplication | protected function redirectAfterUpdate() |
|
| 567 | |||
| 568 | /** |
||
| 569 | * Handle editable update. |
||
| 570 | * |
||
| 571 | * @param array $input |
||
| 572 | * |
||
| 573 | * @return array |
||
| 574 | */ |
||
| 575 | protected function handleEditable(array $input = []) |
||
| 587 | |||
| 588 | /** |
||
| 589 | * @param array $input |
||
| 590 | * |
||
| 591 | * @return array |
||
| 592 | */ |
||
| 593 | protected function handleFileDelete(array $input = []) |
||
| 604 | |||
| 605 | /** |
||
| 606 | * Handle orderable update. |
||
| 607 | * |
||
| 608 | * @param int $id |
||
| 609 | * @param array $input |
||
| 610 | * |
||
| 611 | * @return bool |
||
| 612 | */ |
||
| 613 | protected function handleOrderable($id, array $input = []) |
||
| 627 | |||
| 628 | /** |
||
| 629 | * Update relation data. |
||
| 630 | * |
||
| 631 | * @param array $relationsData |
||
| 632 | * |
||
| 633 | * @return void |
||
| 634 | */ |
||
| 635 | protected function updateRelation($relationsData) |
||
| 713 | |||
| 714 | /** |
||
| 715 | * Prepare input data for update. |
||
| 716 | * |
||
| 717 | * @param array $updates |
||
| 718 | * @param bool $oneToOneRelation If column is one-to-one relation. |
||
| 719 | * |
||
| 720 | * @return array |
||
| 721 | */ |
||
| 722 | protected function prepareUpdate(array $updates, $oneToOneRelation = false) |
||
| 753 | |||
| 754 | /** |
||
| 755 | * @param string|array $columns |
||
| 756 | * @param bool $oneToOneRelation |
||
| 757 | * |
||
| 758 | * @return bool |
||
| 759 | */ |
||
| 760 | protected function invalidColumn($columns, $oneToOneRelation = false) |
||
| 771 | |||
| 772 | /** |
||
| 773 | * Prepare input data for insert. |
||
| 774 | * |
||
| 775 | * @param $inserts |
||
| 776 | * |
||
| 777 | * @return array |
||
| 778 | */ |
||
| 779 | protected function prepareInsert($inserts) |
||
| 802 | |||
| 803 | /** |
||
| 804 | * Is input data is has-one relation. |
||
| 805 | * |
||
| 806 | * @param array $inserts |
||
| 807 | * |
||
| 808 | * @return bool |
||
| 809 | */ |
||
| 810 | protected function isHasOneRelation($inserts) |
||
| 824 | |||
| 825 | /** |
||
| 826 | * Set submitted callback. |
||
| 827 | * |
||
| 828 | * @param Closure $callback |
||
| 829 | * |
||
| 830 | * @return void |
||
| 831 | */ |
||
| 832 | public function submitted(Closure $callback) |
||
| 836 | |||
| 837 | /** |
||
| 838 | * Set saving callback. |
||
| 839 | * |
||
| 840 | * @param Closure $callback |
||
| 841 | * |
||
| 842 | * @return void |
||
| 843 | */ |
||
| 844 | public function saving(Closure $callback) |
||
| 848 | |||
| 849 | /** |
||
| 850 | * Set saved callback. |
||
| 851 | * |
||
| 852 | * @param callable $callback |
||
| 853 | * |
||
| 854 | * @return void |
||
| 855 | */ |
||
| 856 | public function saved(Closure $callback) |
||
| 860 | |||
| 861 | /** |
||
| 862 | * Ignore fields to save. |
||
| 863 | * |
||
| 864 | * @param string|array $fields |
||
| 865 | * |
||
| 866 | * @return $this |
||
| 867 | */ |
||
| 868 | public function ignore($fields) |
||
| 874 | |||
| 875 | /** |
||
| 876 | * @param array $data |
||
| 877 | * @param string|array $columns |
||
| 878 | * |
||
| 879 | * @return array|mixed |
||
| 880 | */ |
||
| 881 | View Code Duplication | protected function getDataByColumn($data, $columns) |
|
| 899 | |||
| 900 | /** |
||
| 901 | * Find field object by column. |
||
| 902 | * |
||
| 903 | * @param $column |
||
| 904 | * |
||
| 905 | * @return mixed |
||
| 906 | */ |
||
| 907 | protected function getFieldByColumn($column) |
||
| 919 | |||
| 920 | /** |
||
| 921 | * Set original data for each field. |
||
| 922 | * |
||
| 923 | * @return void |
||
| 924 | */ |
||
| 925 | protected function setFieldOriginalValue() |
||
| 926 | { |
||
| 927 | // static::doNotSnakeAttributes($this->model); |
||
| 928 | |||
| 929 | $values = $this->model->toArray(); |
||
| 930 | |||
| 931 | $this->builder->fields()->each(function (Field $field) use ($values) { |
||
| 932 | $field->setOriginal($values); |
||
| 933 | }); |
||
| 934 | } |
||
| 935 | |||
| 936 | /** |
||
| 937 | * Set all fields value in form. |
||
| 938 | * |
||
| 939 | * @param $id |
||
| 940 | * |
||
| 941 | * @return void |
||
| 942 | */ |
||
| 943 | protected function setFieldValue($id) |
||
| 944 | { |
||
| 945 | $relations = $this->getRelations(); |
||
| 946 | |||
| 947 | $this->model = $this->model->with($relations)->findOrFail($id); |
||
| 948 | |||
| 949 | // static::doNotSnakeAttributes($this->model); |
||
| 950 | |||
| 951 | $data = $this->model->toArray(); |
||
| 952 | |||
| 953 | $this->builder->fields()->each(function (Field $field) use ($data) { |
||
| 954 | $field->fill($data); |
||
| 955 | }); |
||
| 956 | } |
||
| 957 | |||
| 958 | /** |
||
| 959 | * Don't snake case attributes. |
||
| 960 | * |
||
| 961 | * @param Model $model |
||
| 962 | * |
||
| 963 | * @return void |
||
| 964 | */ |
||
| 965 | protected static function doNotSnakeAttributes(Model $model) |
||
| 971 | |||
| 972 | /** |
||
| 973 | * Get validation messages. |
||
| 974 | * |
||
| 975 | * @param array $input |
||
| 976 | * |
||
| 977 | * @return MessageBag|bool |
||
| 978 | */ |
||
| 979 | protected function validationMessages($input) |
||
| 997 | |||
| 998 | /** |
||
| 999 | * Merge validation messages from input validators. |
||
| 1000 | * |
||
| 1001 | * @param \Illuminate\Validation\Validator[] $validators |
||
| 1002 | * |
||
| 1003 | * @return MessageBag |
||
| 1004 | */ |
||
| 1005 | protected function mergeValidationMessages($validators) |
||
| 1015 | |||
| 1016 | /** |
||
| 1017 | * Get all relations of model from callable. |
||
| 1018 | * |
||
| 1019 | * @return array |
||
| 1020 | */ |
||
| 1021 | public function getRelations() |
||
| 1047 | |||
| 1048 | /** |
||
| 1049 | * Set action for form. |
||
| 1050 | * |
||
| 1051 | * @param string $action |
||
| 1052 | * |
||
| 1053 | * @return $this |
||
| 1054 | */ |
||
| 1055 | public function setAction($action) |
||
| 1061 | |||
| 1062 | /** |
||
| 1063 | * Set field and label width in current form. |
||
| 1064 | * |
||
| 1065 | * @param int $fieldWidth |
||
| 1066 | * @param int $labelWidth |
||
| 1067 | * |
||
| 1068 | * @return $this |
||
| 1069 | */ |
||
| 1070 | public function setWidth($fieldWidth = 8, $labelWidth = 2) |
||
| 1081 | |||
| 1082 | /** |
||
| 1083 | * Set view for form. |
||
| 1084 | * |
||
| 1085 | * @param string $view |
||
| 1086 | * |
||
| 1087 | * @return $this |
||
| 1088 | */ |
||
| 1089 | public function setView($view) |
||
| 1095 | |||
| 1096 | /** |
||
| 1097 | * Add a row in form. |
||
| 1098 | * |
||
| 1099 | * @param Closure $callback |
||
| 1100 | * |
||
| 1101 | * @return $this |
||
| 1102 | */ |
||
| 1103 | public function row(Closure $callback) |
||
| 1109 | |||
| 1110 | /** |
||
| 1111 | * Tools setting for form. |
||
| 1112 | * |
||
| 1113 | * @param Closure $callback |
||
| 1114 | */ |
||
| 1115 | public function tools(Closure $callback) |
||
| 1119 | |||
| 1120 | /** |
||
| 1121 | * Disable form submit. |
||
| 1122 | * |
||
| 1123 | * @return $this |
||
| 1124 | */ |
||
| 1125 | public function disableSubmit() |
||
| 1131 | |||
| 1132 | /** |
||
| 1133 | * Disable form reset. |
||
| 1134 | * |
||
| 1135 | * @return $this |
||
| 1136 | */ |
||
| 1137 | public function disableReset() |
||
| 1143 | |||
| 1144 | /** |
||
| 1145 | * Get current resource route url. |
||
| 1146 | * |
||
| 1147 | * @param int $slice |
||
| 1148 | * |
||
| 1149 | * @return string |
||
| 1150 | */ |
||
| 1151 | public function resource($slice = -2) |
||
| 1161 | |||
| 1162 | /** |
||
| 1163 | * Render the form contents. |
||
| 1164 | * |
||
| 1165 | * @return string |
||
| 1166 | */ |
||
| 1167 | public function render() |
||
| 1175 | |||
| 1176 | /** |
||
| 1177 | * Get or set input data. |
||
| 1178 | * |
||
| 1179 | * @param string $key |
||
| 1180 | * @param null $value |
||
| 1181 | * |
||
| 1182 | * @return array|mixed |
||
| 1183 | */ |
||
| 1184 | public function input($key, $value = null) |
||
| 1192 | |||
| 1193 | /** |
||
| 1194 | * Register builtin fields. |
||
| 1195 | * |
||
| 1196 | * @return void |
||
| 1197 | */ |
||
| 1198 | public static function registerBuiltinFields() |
||
| 1253 | |||
| 1254 | /** |
||
| 1255 | * Register custom field. |
||
| 1256 | * |
||
| 1257 | * @param string $abstract |
||
| 1258 | * @param string $class |
||
| 1259 | * |
||
| 1260 | * @return void |
||
| 1261 | */ |
||
| 1262 | public static function extend($abstract, $class) |
||
| 1266 | |||
| 1267 | /** |
||
| 1268 | * Remove registered field. |
||
| 1269 | * |
||
| 1270 | * @param array|string $abstract |
||
| 1271 | */ |
||
| 1272 | public static function forget($abstract) |
||
| 1276 | |||
| 1277 | /** |
||
| 1278 | * Find field class. |
||
| 1279 | * |
||
| 1280 | * @param string $method |
||
| 1281 | * |
||
| 1282 | * @return bool|mixed |
||
| 1283 | */ |
||
| 1284 | View Code Duplication | public static function findFieldClass($method) |
|
| 1294 | |||
| 1295 | /** |
||
| 1296 | * Collect assets required by registered field. |
||
| 1297 | * |
||
| 1298 | * @return array |
||
| 1299 | */ |
||
| 1300 | public static function collectFieldAssets() |
||
| 1325 | /** |
||
| 1326 | * Collect rules of all fields. |
||
| 1327 | * |
||
| 1328 | * @return array |
||
| 1329 | */ |
||
| 1330 | public function getRules() |
||
| 1334 | |||
| 1335 | /** |
||
| 1336 | * Collect validation Messages of all fields. |
||
| 1337 | * |
||
| 1338 | * @return array |
||
| 1339 | */ |
||
| 1340 | public function getRuleMessages() |
||
| 1344 | |||
| 1345 | /** |
||
| 1346 | * Getter. |
||
| 1347 | * |
||
| 1348 | * @param string $name |
||
| 1349 | * |
||
| 1350 | * @return array|mixed |
||
| 1351 | */ |
||
| 1352 | public function __get($name) |
||
| 1356 | |||
| 1357 | /** |
||
| 1358 | * Setter. |
||
| 1359 | * |
||
| 1360 | * @param string $name |
||
| 1361 | * @param $value |
||
| 1362 | */ |
||
| 1363 | public function __set($name, $value) |
||
| 1367 | |||
| 1368 | /** |
||
| 1369 | * Generate a Field object and add to form builder if Field exists. |
||
| 1370 | * |
||
| 1371 | * @param string $method |
||
| 1372 | * @param array $arguments |
||
| 1373 | * |
||
| 1374 | * @return Field|void |
||
| 1375 | */ |
||
| 1376 | View Code Duplication | public function __call($method, $arguments) |
|
| 1388 | |||
| 1389 | /** |
||
| 1390 | * Render the contents of the form when casting to string. |
||
| 1391 | * |
||
| 1392 | * @return string |
||
| 1393 | */ |
||
| 1394 | public function __toString() |
||
| 1398 | } |
||
| 1399 |
Loading history...
It seems like the method you are trying to call exists only in some of the possible types.
Let’s take a look at an example:
Available Fixes
Add an additional type-check:
Only allow a single type to be passed if the variable comes from a parameter: