Complex classes like Style 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 Style, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
11 | class Style |
||
12 | { |
||
13 | /** Default font values */ |
||
14 | const DEFAULT_FONT_SIZE = 11; |
||
15 | const DEFAULT_FONT_COLOR = Color::BLACK; |
||
16 | const DEFAULT_FONT_NAME = 'Arial'; |
||
17 | |||
18 | /** @var int|null Style ID */ |
||
19 | protected $id = null; |
||
20 | |||
21 | /** @var bool Whether the font should be bold */ |
||
22 | protected $fontBold = false; |
||
23 | /** @var bool Whether the bold property was set */ |
||
24 | protected $hasSetFontBold = false; |
||
25 | |||
26 | /** @var bool Whether the font should be italic */ |
||
27 | protected $fontItalic = false; |
||
28 | /** @var bool Whether the italic property was set */ |
||
29 | protected $hasSetFontItalic = false; |
||
30 | |||
31 | /** @var bool Whether the font should be underlined */ |
||
32 | protected $fontUnderline = false; |
||
33 | /** @var bool Whether the underline property was set */ |
||
34 | protected $hasSetFontUnderline = false; |
||
35 | |||
36 | /** @var bool Whether the font should be struck through */ |
||
37 | protected $fontStrikethrough = false; |
||
38 | /** @var bool Whether the strikethrough property was set */ |
||
39 | protected $hasSetFontStrikethrough = false; |
||
40 | |||
41 | /** @var int Font size */ |
||
42 | protected $fontSize = self::DEFAULT_FONT_SIZE; |
||
43 | /** @var bool Whether the font size property was set */ |
||
44 | protected $hasSetFontSize = false; |
||
45 | |||
46 | /** @var string Font color */ |
||
47 | protected $fontColor = self::DEFAULT_FONT_COLOR; |
||
48 | /** @var bool Whether the font color property was set */ |
||
49 | protected $hasSetFontColor = false; |
||
50 | |||
51 | /** @var string Font name */ |
||
52 | protected $fontName = self::DEFAULT_FONT_NAME; |
||
53 | /** @var bool Whether the font name property was set */ |
||
54 | protected $hasSetFontName = false; |
||
55 | |||
56 | /** @var bool Whether specific font properties should be applied */ |
||
57 | protected $shouldApplyFont = false; |
||
58 | |||
59 | /** @var bool Whether the text should wrap in the cell (useful for long or multi-lines text) */ |
||
60 | protected $shouldWrapText = false; |
||
61 | /** @var bool Whether the wrap text property was set */ |
||
62 | protected $hasSetWrapText = false; |
||
63 | |||
64 | /** |
||
65 | * @var Border |
||
66 | */ |
||
67 | protected $border = null; |
||
68 | |||
69 | /** |
||
70 | * @var bool Whether border properties should be applied |
||
71 | */ |
||
72 | protected $shouldApplyBorder = false; |
||
73 | |||
74 | /** @var string Background color */ |
||
75 | protected $backgroundColor = null; |
||
76 | |||
77 | /** @var bool */ |
||
78 | protected $hasSetBackgroundColor = false; |
||
79 | |||
80 | |||
81 | /** |
||
82 | * @return int|null |
||
83 | */ |
||
84 | 237 | public function getId() |
|
88 | |||
89 | /** |
||
90 | * @param int $id |
||
91 | * @return Style |
||
92 | */ |
||
93 | 279 | public function setId($id) |
|
98 | |||
99 | /** |
||
100 | * @return Border |
||
101 | */ |
||
102 | 96 | public function getBorder() |
|
106 | |||
107 | /** |
||
108 | * @param Border $border |
||
109 | * @return Style |
||
110 | */ |
||
111 | 24 | public function setBorder(Border $border) |
|
117 | |||
118 | /** |
||
119 | * @return bool |
||
120 | */ |
||
121 | 270 | public function shouldApplyBorder() |
|
125 | |||
126 | /** |
||
127 | * @return bool |
||
128 | */ |
||
129 | 159 | public function isFontBold() |
|
133 | |||
134 | /** |
||
135 | * @return Style |
||
136 | */ |
||
137 | 48 | public function setFontBold() |
|
144 | |||
145 | /** |
||
146 | * @return bool |
||
147 | */ |
||
148 | 159 | public function isFontItalic() |
|
152 | |||
153 | /** |
||
154 | * @return Style |
||
155 | */ |
||
156 | 12 | public function setFontItalic() |
|
163 | |||
164 | /** |
||
165 | * @return bool |
||
166 | */ |
||
167 | 159 | public function isFontUnderline() |
|
171 | |||
172 | /** |
||
173 | * @return Style |
||
174 | */ |
||
175 | 18 | public function setFontUnderline() |
|
182 | |||
183 | /** |
||
184 | * @return bool |
||
185 | */ |
||
186 | 159 | public function isFontStrikethrough() |
|
190 | |||
191 | /** |
||
192 | * @return Style |
||
193 | */ |
||
194 | 12 | public function setFontStrikethrough() |
|
201 | |||
202 | /** |
||
203 | * @return int |
||
204 | */ |
||
205 | 222 | public function getFontSize() |
|
209 | |||
210 | /** |
||
211 | * @param int $fontSize Font size, in pixels |
||
212 | * @return Style |
||
213 | */ |
||
214 | 159 | public function setFontSize($fontSize) |
|
221 | |||
222 | /** |
||
223 | * @return string |
||
224 | */ |
||
225 | 222 | public function getFontColor() |
|
229 | |||
230 | /** |
||
231 | * Sets the font color. |
||
232 | * |
||
233 | * @param string $fontColor ARGB color (@see Color) |
||
234 | * @return Style |
||
235 | */ |
||
236 | 6 | public function setFontColor($fontColor) |
|
243 | |||
244 | /** |
||
245 | * @return string |
||
246 | */ |
||
247 | 261 | public function getFontName() |
|
251 | |||
252 | /** |
||
253 | * @param string $fontName Name of the font to use |
||
254 | * @return Style |
||
255 | */ |
||
256 | 150 | public function setFontName($fontName) |
|
263 | |||
264 | /** |
||
265 | * @return bool |
||
266 | */ |
||
267 | 234 | public function shouldWrapText() |
|
271 | |||
272 | /** |
||
273 | * @param bool|void $shouldWrap Should the text be wrapped |
||
274 | * @return Style |
||
275 | */ |
||
276 | 30 | public function setShouldWrapText($shouldWrap = true) |
|
282 | |||
283 | /** |
||
284 | * @return bool |
||
285 | */ |
||
286 | 186 | public function hasSetWrapText() |
|
290 | |||
291 | /** |
||
292 | * @return bool Whether specific font properties should be applied |
||
293 | */ |
||
294 | 186 | public function shouldApplyFont() |
|
298 | |||
299 | /** |
||
300 | * Sets the background color |
||
301 | * @param string $color ARGB color (@see Color) |
||
302 | * @return Style |
||
303 | */ |
||
304 | 18 | public function setBackgroundColor($color) |
|
310 | |||
311 | /** |
||
312 | * @return string |
||
313 | */ |
||
314 | 147 | public function getBackgroundColor() |
|
318 | |||
319 | /** |
||
320 | * |
||
321 | * @return bool Whether the background color should be applied |
||
322 | */ |
||
323 | 153 | public function shouldApplyBackgroundColor() |
|
327 | |||
328 | /** |
||
329 | * Serializes the style for future comparison with other styles. |
||
330 | * The ID is excluded from the comparison, as we only care about |
||
331 | * actual style properties. |
||
332 | * |
||
333 | * @return string The serialized style |
||
334 | */ |
||
335 | 279 | public function serialize() |
|
347 | |||
348 | /** |
||
349 | * Merges the current style with the given style, using the given style as a base. This means that: |
||
350 | * - if current style and base style both have property A set, use current style property's value |
||
351 | * - if current style has property A set but base style does not, use current style property's value |
||
352 | * - if base style has property A set but current style does not, use base style property's value |
||
353 | * |
||
354 | * @NOTE: This function returns a new style. |
||
355 | * |
||
356 | * @param Style $baseStyle |
||
357 | * @return Style New style corresponding to the merge of the 2 styles |
||
358 | */ |
||
359 | 93 | public function mergeWith($baseStyle) |
|
360 | { |
||
361 | 93 | $mergedStyle = clone $this; |
|
362 | |||
363 | 93 | $this->mergeFontStyles($mergedStyle, $baseStyle); |
|
364 | 93 | $this->mergeOtherFontProperties($mergedStyle, $baseStyle); |
|
365 | 93 | $this->mergeCellProperties($mergedStyle, $baseStyle); |
|
366 | |||
367 | 93 | return $mergedStyle; |
|
368 | } |
||
369 | |||
370 | /** |
||
371 | * @param Style $styleToUpdate (passed as reference) |
||
372 | * @param Style $baseStyle |
||
373 | * @return void |
||
374 | */ |
||
375 | 93 | private function mergeFontStyles($styleToUpdate, $baseStyle) |
|
376 | { |
||
377 | 93 | if (!$this->hasSetFontBold && $baseStyle->isFontBold()) { |
|
378 | 6 | $styleToUpdate->setFontBold(); |
|
379 | 6 | } |
|
380 | 93 | if (!$this->hasSetFontItalic && $baseStyle->isFontItalic()) { |
|
381 | 3 | $styleToUpdate->setFontItalic(); |
|
382 | 3 | } |
|
383 | 93 | if (!$this->hasSetFontUnderline && $baseStyle->isFontUnderline()) { |
|
384 | 3 | $styleToUpdate->setFontUnderline(); |
|
385 | 3 | } |
|
386 | 93 | if (!$this->hasSetFontStrikethrough && $baseStyle->isFontStrikethrough()) { |
|
387 | 3 | $styleToUpdate->setFontStrikethrough(); |
|
388 | 3 | } |
|
389 | 93 | } |
|
390 | |||
391 | /** |
||
392 | * @param Style $styleToUpdate Style to update (passed as reference) |
||
393 | * @param Style $baseStyle |
||
394 | * @return void |
||
395 | */ |
||
396 | 93 | private function mergeOtherFontProperties($styleToUpdate, $baseStyle) |
|
408 | |||
409 | /** |
||
410 | * @param Style $styleToUpdate Style to update (passed as reference) |
||
411 | * @param Style $baseStyle |
||
412 | * @return void |
||
413 | */ |
||
414 | 93 | private function mergeCellProperties($styleToUpdate, $baseStyle) |
|
426 | } |
||
427 |