Complex classes like Product 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 Product, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
26 | class Product implements ProductInterface |
||
|
|||
27 | { |
||
28 | use TimestampableTrait, ToggleableTrait; |
||
29 | use TranslatableTrait { |
||
30 | __construct as private initializeTranslationsCollection; |
||
31 | } |
||
32 | |||
33 | /** |
||
34 | * @var mixed |
||
35 | */ |
||
36 | protected $id; |
||
37 | |||
38 | /** |
||
39 | * @var string |
||
40 | */ |
||
41 | protected $code; |
||
42 | |||
43 | /** |
||
44 | * @var \DateTime |
||
45 | */ |
||
46 | protected $availableOn; |
||
47 | |||
48 | /** |
||
49 | * @var \DateTime |
||
50 | */ |
||
51 | protected $availableUntil; |
||
52 | |||
53 | /** |
||
54 | * @var Collection|AttributeValueInterface[] |
||
55 | */ |
||
56 | protected $attributes; |
||
57 | |||
58 | /** |
||
59 | * @var Collection|ProductVariantInterface[] |
||
60 | */ |
||
61 | protected $variants; |
||
62 | |||
63 | /** |
||
64 | * @var Collection|ProductOptionInterface[] |
||
65 | */ |
||
66 | protected $options; |
||
67 | |||
68 | /** |
||
69 | * @var Collection|ProductAssociationInterface[] |
||
70 | */ |
||
71 | protected $associations; |
||
72 | |||
73 | public function __construct() |
||
74 | { |
||
75 | $this->initializeTranslationsCollection(); |
||
76 | |||
77 | $this->availableOn = new \DateTime(); |
||
78 | $this->attributes = new ArrayCollection(); |
||
79 | $this->associations = new ArrayCollection(); |
||
80 | $this->variants = new ArrayCollection(); |
||
81 | $this->options = new ArrayCollection(); |
||
82 | $this->createdAt = new \DateTime(); |
||
83 | } |
||
84 | |||
85 | /** |
||
86 | * @return string |
||
87 | */ |
||
88 | public function __toString() |
||
89 | { |
||
90 | return $this->getName(); |
||
91 | } |
||
92 | |||
93 | /** |
||
94 | * {@inheritdoc} |
||
95 | */ |
||
96 | public function getId() |
||
97 | { |
||
98 | return $this->id; |
||
99 | } |
||
100 | |||
101 | /** |
||
102 | * @return string |
||
103 | */ |
||
104 | public function getCode() |
||
105 | { |
||
106 | return $this->code; |
||
107 | } |
||
108 | |||
109 | /** |
||
110 | * @param string $code |
||
111 | */ |
||
112 | public function setCode($code) |
||
113 | { |
||
114 | $this->code = $code; |
||
115 | } |
||
116 | |||
117 | /** |
||
118 | * {@inheritdoc} |
||
119 | */ |
||
120 | public function getName() |
||
121 | { |
||
122 | return $this->getTranslation()->getName(); |
||
123 | } |
||
124 | |||
125 | /** |
||
126 | * {@inheritdoc} |
||
127 | */ |
||
128 | public function setName($name) |
||
129 | { |
||
130 | $this->getTranslation()->setName($name); |
||
131 | } |
||
132 | |||
133 | /** |
||
134 | * {@inheritdoc} |
||
135 | */ |
||
136 | public function getSlug() |
||
137 | { |
||
138 | return $this->getTranslation()->getSlug(); |
||
139 | } |
||
140 | |||
141 | /** |
||
142 | * {@inheritdoc} |
||
143 | */ |
||
144 | public function setSlug($slug = null) |
||
145 | { |
||
146 | $this->getTranslation()->setSlug($slug); |
||
147 | } |
||
148 | |||
149 | /** |
||
150 | * {@inheritdoc} |
||
151 | */ |
||
152 | public function getDescription() |
||
153 | { |
||
154 | return $this->getTranslation()->getDescription(); |
||
155 | } |
||
156 | |||
157 | /** |
||
158 | * {@inheritdoc} |
||
159 | */ |
||
160 | public function setDescription($description) |
||
161 | { |
||
162 | $this->getTranslation()->setDescription($description); |
||
163 | } |
||
164 | |||
165 | /** |
||
166 | * {@inheritdoc} |
||
167 | */ |
||
168 | public function getMetaKeywords() |
||
169 | { |
||
170 | return $this->getTranslation()->getMetaKeywords(); |
||
171 | } |
||
172 | |||
173 | /** |
||
174 | * {@inheritdoc} |
||
175 | */ |
||
176 | public function setMetaKeywords($metaKeywords) |
||
177 | { |
||
178 | $this->getTranslation()->setMetaKeywords($metaKeywords); |
||
179 | } |
||
180 | |||
181 | /** |
||
182 | * {@inheritdoc} |
||
183 | */ |
||
184 | public function getMetaDescription() |
||
185 | { |
||
186 | return $this->getTranslation()->getMetaDescription(); |
||
187 | } |
||
188 | |||
189 | /** |
||
190 | * {@inheritdoc} |
||
191 | */ |
||
192 | public function setMetaDescription($metaDescription) |
||
193 | { |
||
194 | $this->getTranslation()->setMetaDescription($metaDescription); |
||
195 | } |
||
196 | |||
197 | /** |
||
198 | * {@inheritdoc} |
||
199 | */ |
||
200 | public function isAvailable() |
||
201 | { |
||
202 | return (new DateRange($this->availableOn, $this->availableUntil))->isInRange(); |
||
203 | } |
||
204 | |||
205 | /** |
||
206 | * {@inheritdoc} |
||
207 | */ |
||
208 | public function getAvailableOn() |
||
212 | |||
213 | /** |
||
214 | * {@inheritdoc} |
||
215 | */ |
||
216 | public function setAvailableOn(\DateTime $availableOn = null) |
||
220 | |||
221 | /** |
||
222 | * {@inheritdoc} |
||
223 | */ |
||
224 | public function getAvailableUntil() |
||
228 | |||
229 | /** |
||
230 | * {@inheritdoc} |
||
231 | */ |
||
232 | public function setAvailableUntil(\DateTime $availableUntil = null) |
||
236 | |||
237 | /** |
||
238 | * {@inheritdoc} |
||
239 | */ |
||
240 | public function getAttributes() |
||
244 | |||
245 | /** |
||
246 | * {@inheritdoc} |
||
247 | */ |
||
248 | public function addAttribute(AttributeValueInterface $attribute) |
||
255 | |||
256 | /** |
||
257 | * {@inheritdoc} |
||
258 | */ |
||
259 | public function removeAttribute(AttributeValueInterface $attribute) |
||
266 | |||
267 | /** |
||
268 | * {@inheritdoc} |
||
269 | */ |
||
270 | public function hasAttribute(AttributeValueInterface $attribute) |
||
274 | |||
275 | /** |
||
276 | * {@inheritdoc} |
||
277 | */ |
||
278 | public function hasAttributeByCode($attributeCode) |
||
288 | |||
289 | /** |
||
290 | * {@inheritdoc} |
||
291 | */ |
||
292 | public function getAttributeByCode($attributeCode) |
||
302 | |||
303 | /** |
||
304 | * {@inheritdoc} |
||
305 | */ |
||
306 | public function hasVariants() |
||
310 | |||
311 | /** |
||
312 | * {@inheritdoc} |
||
313 | */ |
||
314 | public function getVariants() |
||
318 | |||
319 | /** |
||
320 | * {@inheritdoc} |
||
321 | */ |
||
322 | public function getAvailableVariants() |
||
328 | |||
329 | /** |
||
330 | * {@inheritdoc} |
||
331 | */ |
||
332 | public function addVariant(ProductVariantInterface $variant) |
||
339 | |||
340 | /** |
||
341 | * {@inheritdoc} |
||
342 | */ |
||
343 | public function removeVariant(ProductVariantInterface $variant) |
||
350 | |||
351 | /** |
||
352 | * {@inheritdoc} |
||
353 | */ |
||
354 | public function hasVariant(ProductVariantInterface $variant) |
||
358 | |||
359 | /** |
||
360 | * {@inheritdoc} |
||
361 | */ |
||
362 | public function hasOptions() |
||
366 | |||
367 | /** |
||
368 | * {@inheritdoc} |
||
369 | */ |
||
370 | public function getOptions() |
||
374 | |||
375 | /** |
||
376 | * {@inheritdoc} |
||
377 | */ |
||
378 | public function addOption(ProductOptionInterface $option) |
||
384 | |||
385 | /** |
||
386 | * {@inheritdoc} |
||
387 | */ |
||
388 | public function removeOption(ProductOptionInterface $option) |
||
394 | |||
395 | /** |
||
396 | * {@inheritdoc} |
||
397 | */ |
||
398 | public function hasOption(ProductOptionInterface $option) |
||
402 | |||
403 | /** |
||
404 | * {@inheritdoc} |
||
405 | */ |
||
406 | public function getAssociations() |
||
410 | |||
411 | /** |
||
412 | * {@inheritdoc} |
||
413 | */ |
||
414 | public function addAssociation(ProductAssociationInterface $association) |
||
421 | |||
422 | /** |
||
423 | * {@inheritdoc} |
||
424 | */ |
||
425 | public function removeAssociation(ProductAssociationInterface $association) |
||
432 | |||
433 | /** |
||
434 | * {@inheritdoc} |
||
435 | */ |
||
436 | public function hasAssociation(ProductAssociationInterface $association) |
||
440 | |||
441 | /** |
||
442 | * {@inheritdoc} |
||
443 | */ |
||
444 | public function isSimple() |
||
448 | |||
449 | /** |
||
450 | * {@inheritdoc} |
||
451 | */ |
||
452 | public function isConfigurable() |
||
456 | |||
457 | /** |
||
458 | * {@inheritdoc} |
||
459 | */ |
||
460 | protected function createTranslation() |
||
461 | { |
||
462 | return new ProductTranslation(); |
||
463 | } |
||
464 | } |
||
465 |