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 Html 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 Html, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
26 | class Html |
||
27 | { |
||
28 | use Macroable; |
||
29 | |||
30 | /** @var \Illuminate\Http\Request */ |
||
31 | protected $request; |
||
32 | |||
33 | /** @var \ArrayAccess|array */ |
||
34 | protected $model; |
||
35 | |||
36 | public function __construct(Request $request) |
||
46 | |||
47 | /** |
||
48 | * @param string|null $href |
||
49 | * @param string|null $text |
||
50 | * |
||
51 | * @return \Spatie\Html\Elements\A |
||
52 | */ |
||
53 | public function a($href = null, $contents = null) |
||
59 | |||
60 | /** |
||
61 | * @param string|null $href |
||
62 | * @param string|null $text |
||
63 | * |
||
64 | * @return \Spatie\Html\Elements\I |
||
65 | * @throws \Spatie\Html\Exceptions\InvalidHtml |
||
66 | */ |
||
67 | public function i($contents = null) |
||
72 | |||
73 | /** |
||
74 | * @param string|null $type |
||
75 | * @param string|null $text |
||
76 | * |
||
77 | * @return \Spatie\Html\Elements\Button |
||
78 | */ |
||
79 | public function button($contents = null, $type = null) |
||
85 | |||
86 | /** |
||
87 | * @param \Illuminate\Support\Collection|iterable|string $classes |
||
88 | * |
||
89 | * @return \Illuminate\Contracts\Support\Htmlable |
||
90 | */ |
||
91 | public static function class_($classes) |
||
104 | |||
105 | /** |
||
106 | * @param string|null $name |
||
107 | * @param bool $checked |
||
108 | * @param string|null $value |
||
109 | * |
||
110 | * @return \Spatie\Html\Elements\Input |
||
111 | */ |
||
112 | public function checkbox($name = null, $checked = false, $value = '1') |
||
121 | |||
122 | /** |
||
123 | * @param \Spatie\Html\HtmlElement|string|null $contents |
||
124 | * |
||
125 | * @return \Spatie\Html\Elements\Div |
||
126 | */ |
||
127 | public function div($contents = null) |
||
131 | |||
132 | /** |
||
133 | * @param string|null $name |
||
134 | * @param string|null $value |
||
135 | * |
||
136 | * @return \Spatie\Html\Elements\Input |
||
137 | */ |
||
138 | public function email($name = '', $value = '') |
||
142 | |||
143 | /** |
||
144 | * @param string|null $name |
||
145 | * @param string|null $value |
||
146 | * |
||
147 | * @return \Spatie\Html\Elements\Input |
||
148 | */ |
||
149 | public function date($name = '', $value = '') |
||
153 | |||
154 | /** |
||
155 | * @param string|null $name |
||
156 | * @param string|null $value |
||
157 | * |
||
158 | * @return \Spatie\Html\Elements\Input |
||
159 | */ |
||
160 | public function time($name = '', $value = '') |
||
164 | |||
165 | /** |
||
166 | * @param string $tag |
||
167 | * |
||
168 | * @return \Spatie\Html\Elements\Element |
||
169 | */ |
||
170 | public function element($tag) |
||
174 | |||
175 | /** |
||
176 | * @param string|null $type |
||
177 | * @param string|null $name |
||
178 | * @param string|null $value |
||
179 | * |
||
180 | * @return \Spatie\Html\Elements\Input |
||
181 | */ |
||
182 | public function input($type = null, $name = null, $value = null) |
||
192 | |||
193 | /** |
||
194 | * @param \Spatie\Html\HtmlElement|string|null $legend |
||
195 | * |
||
196 | * @return \Spatie\Html\Elements\Fieldset |
||
197 | */ |
||
198 | public function fieldset($legend = null) |
||
204 | |||
205 | /** |
||
206 | * @param string $method |
||
207 | * @param string|null $action |
||
208 | * |
||
209 | * @return \Spatie\Html\Elements\Form |
||
210 | */ |
||
211 | public function form($method = 'POST', $action = null) |
||
231 | |||
232 | /** |
||
233 | * @param string|null $name |
||
234 | * @param string|null $value |
||
235 | * |
||
236 | * @return \Spatie\Html\Elements\Input |
||
237 | */ |
||
238 | public function hidden($name = null, $value = null) |
||
242 | |||
243 | /** |
||
244 | * @param string|null $src |
||
245 | * @param string|null $alt |
||
246 | * |
||
247 | * @return \Spatie\Html\Elements\Img |
||
248 | */ |
||
249 | public function img($src = null, $alt = null) |
||
255 | |||
256 | /** |
||
257 | * @param \Spatie\Html\HtmlElement|iterable|string|null $contents |
||
258 | * @param string|null $for |
||
259 | * |
||
260 | * @return \Spatie\Html\Elements\Label |
||
261 | */ |
||
262 | public function label($contents = null, $for = null) |
||
268 | |||
269 | /** |
||
270 | * @param \Spatie\Html\HtmlElement|string|null $contents |
||
271 | * |
||
272 | * @return \Spatie\Html\Elements\Legend |
||
273 | * @throws \Spatie\Html\Exceptions\InvalidHtml |
||
274 | */ |
||
275 | public function legend($contents = null) |
||
279 | |||
280 | /** |
||
281 | * @param string $email |
||
282 | * @param string|null $text |
||
283 | * |
||
284 | * @return \Spatie\Html\Elements\A |
||
285 | */ |
||
286 | public function mailto($email, $text = null) |
||
290 | |||
291 | /** |
||
292 | * @param string|null $name |
||
293 | * @param iterable $options |
||
294 | * @param string|iterable|null $value |
||
295 | * |
||
296 | * @return \Spatie\Html\Elements\Select |
||
297 | */ |
||
298 | View Code Duplication | public function multiselect($name = null, $options = [], $value = null) |
|
307 | |||
308 | /** |
||
309 | * @param string|null $text |
||
310 | * @param string|null $value |
||
311 | * @param bool $selected |
||
312 | * |
||
313 | * @return \Spatie\Html\Elements\Option |
||
314 | */ |
||
315 | public function option($text = null, $value = null, $selected = false) |
||
322 | |||
323 | /** |
||
324 | * @param string|null $value |
||
325 | * |
||
326 | * @return \Spatie\Html\Elements\Input |
||
327 | */ |
||
328 | public function password($name = null) |
||
332 | |||
333 | /** |
||
334 | * @param string|null $name |
||
335 | * @param bool $checked |
||
336 | * @param string|null $value |
||
337 | * |
||
338 | * @return \Spatie\Html\Elements\Input |
||
339 | */ |
||
340 | public function radio($name = null, $checked = false, $value = null) |
||
346 | |||
347 | /** |
||
348 | * @param string|null $name |
||
349 | * @param iterable $options |
||
350 | * @param string|iterable|null $value |
||
351 | * @param bool $strict |
||
352 | * |
||
353 | * @return \Spatie\Html\Elements\Select |
||
354 | */ |
||
355 | View Code Duplication | public function select($name = null, $options = [], $value = null, $strict = false) |
|
363 | |||
364 | /** |
||
365 | * @param \Spatie\Html\HtmlElement|string|null $contents |
||
366 | * |
||
367 | * @return \Spatie\Html\Elements\Span |
||
368 | */ |
||
369 | public function span($contents = null) |
||
373 | |||
374 | /** |
||
375 | * @param string|null $text |
||
376 | * |
||
377 | * @return \Spatie\Html\Elements\Button |
||
378 | */ |
||
379 | public function submit($text = null) |
||
383 | |||
384 | /** |
||
385 | * @param string|null $text |
||
386 | * |
||
387 | * @return \Spatie\Html\Elements\Button |
||
388 | */ |
||
389 | public function reset($text = null) |
||
393 | |||
394 | /** |
||
395 | * @param string $number |
||
396 | * @param string|null $text |
||
397 | * |
||
398 | * @return \Spatie\Html\Elements\A |
||
399 | */ |
||
400 | public function tel($number, $text = null) |
||
404 | |||
405 | /** |
||
406 | * @param string|null $name |
||
407 | * @param string|null $value |
||
408 | * |
||
409 | * @return \Spatie\Html\Elements\Input |
||
410 | */ |
||
411 | public function text($name = null, $value = null) |
||
415 | |||
416 | /** |
||
417 | * @param string|null $name |
||
418 | * |
||
419 | * @return \Spatie\Html\Elements\File |
||
420 | */ |
||
421 | public function file($name = null) |
||
427 | |||
428 | /** |
||
429 | * @param string|null $name |
||
430 | * @param string|null $value |
||
431 | * |
||
432 | * @return \Spatie\Html\Elements\Textarea |
||
433 | */ |
||
434 | public function textarea($name = null, $value = null) |
||
441 | |||
442 | /** |
||
443 | * @return \Spatie\Html\Elements\Input |
||
444 | */ |
||
445 | public function token() |
||
452 | |||
453 | /** |
||
454 | * @param \ArrayAccess|array $model |
||
455 | * |
||
456 | * @return $this |
||
457 | */ |
||
458 | public function model($model) |
||
464 | |||
465 | /** |
||
466 | * @param \ArrayAccess|array $model |
||
467 | * @param string|null $method |
||
468 | * @param string|null $action |
||
469 | * |
||
470 | * @return \Spatie\Html\Elements\Form |
||
471 | */ |
||
472 | public function modelForm($model, $method = 'POST', $action = null) |
||
478 | |||
479 | /** |
||
480 | * @return $this |
||
481 | */ |
||
482 | public function endModel() |
||
488 | |||
489 | /** |
||
490 | * @return \Illuminate\Contracts\Support\Htmlable |
||
491 | */ |
||
492 | public function closeModelForm() |
||
498 | |||
499 | /** |
||
500 | * @param string $name |
||
501 | * @param mixed $value |
||
502 | * |
||
503 | * @return mixed |
||
504 | */ |
||
505 | protected function old($name, $value = null) |
||
525 | |||
526 | /** |
||
527 | * Retrieve the value from the current session or assigned model. This is |
||
528 | * a public alias for `old`. |
||
529 | * |
||
530 | * @param string $name |
||
531 | * @param mixed $value |
||
532 | * |
||
533 | * @return mixed |
||
534 | */ |
||
535 | public function value($name, $default = null) |
||
539 | |||
540 | /** |
||
541 | * @param string $name |
||
542 | * |
||
543 | * @return string |
||
544 | */ |
||
545 | protected function fieldName($name) |
||
549 | |||
550 | protected function ensureModelIsAvailable() |
||
556 | } |
||
557 |