Total Complexity | 44 |
Total Lines | 257 |
Duplicated Lines | 0 % |
Changes | 3 | ||
Bugs | 0 | Features | 0 |
Complex classes like HtmlBuilder 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 HtmlBuilder, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
4 | class HtmlBuilder |
||
5 | { |
||
6 | const TYPE_RAW = 'raw'; |
||
7 | const TYPE_IFRAME = 'iframe'; |
||
8 | const TYPE_VIDEO = 'video'; |
||
9 | |||
10 | public function __construct( |
||
15 | } |
||
16 | |||
17 | /** |
||
18 | * Returns current type. |
||
19 | */ |
||
20 | public function type(): string |
||
23 | } |
||
24 | |||
25 | /** |
||
26 | * Returns HTML code for media provider. |
||
27 | */ |
||
28 | public function html(array $options = [], array $globalOptions = [], bool $amp = false): string |
||
29 | { |
||
30 | if (is_array($this->html)) { |
||
31 | $attrs = $this->applyOptions($this->html, $options, $globalOptions); |
||
32 | |||
33 | if ($this->type === self::TYPE_IFRAME) { |
||
34 | return $this->iframe($attrs, $amp); |
||
35 | } |
||
36 | |||
37 | if ($this->type === self::TYPE_VIDEO) { |
||
38 | return $this->video($attrs, $amp); |
||
39 | } |
||
40 | |||
41 | return ''; |
||
42 | } else { |
||
43 | return $this->html; |
||
44 | } |
||
45 | } |
||
46 | |||
47 | /** |
||
48 | * Return AMP-friendly HTML for media provider. |
||
49 | */ |
||
50 | public function ampHtml(array $options = [], array $globalOptions = []): string |
||
51 | { |
||
52 | return $this->html($options, $globalOptions, true); |
||
53 | } |
||
54 | |||
55 | /** |
||
56 | * Returns URL for a given media provider embed. Returned url type depends on embed type: |
||
57 | * iframe - string |
||
58 | * video - string[] |
||
59 | * raw - null |
||
60 | */ |
||
61 | public function src(array $options = [], array $globalOptions = []): mixed |
||
62 | { |
||
63 | if (is_array($this->html)) { |
||
64 | $attrs = $this->applyOptions($this->html, $options, $globalOptions); |
||
65 | |||
66 | if ($this->type === self::TYPE_IFRAME) { |
||
67 | return $attrs['src'] ?? null; |
||
68 | } |
||
69 | |||
70 | if ($this->type === self::TYPE_VIDEO) { |
||
71 | return array_map(function ($source) { |
||
72 | return $source['src']; |
||
73 | }, $attrs['source']); |
||
74 | } |
||
75 | } |
||
76 | |||
77 | return null; |
||
78 | } |
||
79 | |||
80 | /** |
||
81 | * Constructs <iframe> HTML-element based on array of provider attributes. |
||
82 | */ |
||
83 | protected function iframe(array $attrs, bool $amp = false): string |
||
84 | { |
||
85 | $tag = $amp ? 'amp-iframe' : 'iframe'; |
||
86 | |||
87 | $html = "<$tag"; |
||
88 | foreach ($attrs as $attr => $val) { |
||
89 | $html .= sprintf(' %s="%s"', $attr, $val); |
||
90 | } |
||
91 | $html .= "></$tag>"; |
||
92 | |||
93 | return $html; |
||
94 | } |
||
95 | |||
96 | /** |
||
97 | * Constructs <video> HTML-element based on an array of provider attributes. |
||
98 | */ |
||
99 | protected function video(array $attrs, bool $amp = false): string |
||
100 | { |
||
101 | $tag = $amp ? 'amp-video' : 'video'; |
||
102 | |||
103 | $inner = ''; |
||
104 | |||
105 | $html = "<$tag"; |
||
106 | foreach ($attrs as $attr => $val) { |
||
107 | if (is_array($val)) { |
||
108 | foreach ($val as $child) { |
||
109 | $inner .= "<$attr"; |
||
110 | foreach ($child as $iattr => $ival) { |
||
111 | $inner .= sprintf(' %s="%s"', $iattr, $ival); |
||
112 | } |
||
113 | $inner .= ">"; |
||
114 | } |
||
115 | } else { |
||
116 | $html .= sprintf(' %s="%s"', $attr, $val); |
||
117 | } |
||
118 | } |
||
119 | $html .= ">"; |
||
120 | |||
121 | $html .= $inner; |
||
122 | |||
123 | $html .= "</$tag>"; |
||
124 | |||
125 | return $html; |
||
126 | } |
||
127 | |||
128 | /** |
||
129 | * Returns script source if available. |
||
130 | */ |
||
131 | public function script(): ?string |
||
132 | { |
||
133 | return $this->script; |
||
134 | } |
||
135 | |||
136 | /** |
||
137 | * Converts class to an array. |
||
138 | */ |
||
139 | public function toArray(): array |
||
144 | ]; |
||
145 | } |
||
146 | |||
147 | /** |
||
148 | * Extracts and returns an array of options for a current HTML element type. |
||
149 | */ |
||
150 | protected function getTypeOptions(array $options): array |
||
157 | } |
||
158 | |||
159 | /** |
||
160 | * Merge and apply local and global options to the provider attributes. |
||
161 | */ |
||
162 | protected function applyOptions(array $attrs, array $options, array $globalOptions): array |
||
163 | { |
||
164 | $mergedOptions = array_merge($globalOptions['attributes'] ?? [], $options); |
||
165 | $attrs = $this->applyDimensions($attrs, $mergedOptions); |
||
166 | $attrs = $this->applyAutoplay($attrs, $mergedOptions); |
||
167 | |||
168 | $typeOptions = $this->getTypeOptions($globalOptions); |
||
169 | |||
170 | return array_filter( |
||
171 | array_merge($typeOptions, $mergedOptions, $attrs), |
||
172 | fn($value) => $value !== null |
||
173 | ); |
||
174 | } |
||
175 | |||
176 | /** |
||
177 | * Apply width and height dimensions with aspect ratio calculations. |
||
178 | */ |
||
179 | protected function applyDimensions(array $attrs, array $options): array |
||
180 | { |
||
181 | $width = $options['width'] ?? null; |
||
182 | $height = $options['height'] ?? null; |
||
183 | |||
184 | if ($this->hasNumericDimensions($attrs)) { |
||
185 | $attrs = $this->applyAspectRatioDimensions($attrs, $width, $height); |
||
186 | } elseif ($width || $height) { |
||
187 | $attrs = $this->applyManualDimensions($attrs, $width, $height); |
||
188 | } |
||
189 | |||
190 | return $attrs; |
||
191 | } |
||
192 | |||
193 | /** |
||
194 | * Check if attributes have numeric width and height values. |
||
195 | */ |
||
196 | protected function hasNumericDimensions(array $attrs): bool |
||
197 | { |
||
198 | return isset($attrs['width'], $attrs['height']) |
||
199 | && is_numeric($attrs['width']) |
||
200 | && is_numeric($attrs['height']); |
||
201 | } |
||
202 | |||
203 | /** |
||
204 | * Apply dimensions while maintaining aspect ratio. |
||
205 | */ |
||
206 | protected function applyAspectRatioDimensions(array $attrs, mixed $width, mixed $height): array |
||
207 | { |
||
208 | $ratio = $attrs['width'] / $attrs['height']; |
||
209 | |||
210 | $attrs['width'] = $width ?: round(($height ?: $attrs['height']) * $ratio); |
||
211 | $attrs['height'] = $height ?: round($attrs['width'] / $ratio); |
||
212 | |||
213 | return $attrs; |
||
214 | } |
||
215 | |||
216 | /** |
||
217 | * Apply dimensions without aspect ratio calculations. |
||
218 | */ |
||
219 | protected function applyManualDimensions(array $attrs, mixed $width, mixed $height): array |
||
220 | { |
||
221 | if ($width) { |
||
222 | $attrs['width'] = $width; |
||
223 | } |
||
224 | |||
225 | if ($height) { |
||
226 | $attrs['height'] = $height; |
||
227 | } |
||
228 | |||
229 | return $attrs; |
||
230 | } |
||
231 | |||
232 | /** |
||
233 | * Handle autoplay functionality, especially for iframe embeds. |
||
234 | */ |
||
235 | protected function applyAutoplay(array $attrs, array &$options): array |
||
252 | } |
||
253 | |||
254 | /** |
||
255 | * Append custom parameter to the end of the url. |
||
256 | */ |
||
257 | protected function addUrlParam(string $url, string $param): string |
||
261 | } |
||
262 | } |
||
263 |