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 Experiment 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 Experiment, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
18 | class Experiment |
||
19 | { |
||
20 | /** |
||
21 | * The project the Experiment is in |
||
22 | * @var integer |
||
23 | */ |
||
24 | private $projectId; |
||
25 | |||
26 | /** |
||
27 | * List of IDs of all audiences the Experiment is targeted at |
||
28 | * @var array[integer] |
||
29 | */ |
||
30 | private $audienceIds; |
||
31 | |||
32 | /** |
||
33 | * The ID for the Campaign that the Experiment is in |
||
34 | * @var integer |
||
35 | */ |
||
36 | private $campaignId; |
||
37 | |||
38 | /** |
||
39 | * Experiment-level changes that will run before all Variations. Typically |
||
40 | * this is custom CSS or custom JavaScript. |
||
41 | * @var array[Change] |
||
42 | */ |
||
43 | private $changes; |
||
44 | |||
45 | /** |
||
46 | * The time the experiment was initially created |
||
47 | * @var string |
||
48 | */ |
||
49 | private $created; |
||
50 | |||
51 | /** |
||
52 | * The description or hypothesis for an Experiment |
||
53 | * @var string |
||
54 | */ |
||
55 | private $description; |
||
56 | |||
57 | /** |
||
58 | * Percentage expressed as a number from 0-10000 to hold back from being |
||
59 | * included in the experiment |
||
60 | * @var integer |
||
61 | */ |
||
62 | private $holdback; |
||
63 | |||
64 | /** |
||
65 | * Unique string identifier for this experiment within the project. |
||
66 | * @var string |
||
67 | */ |
||
68 | private $key; |
||
69 | |||
70 | /** |
||
71 | * The last time the experiment was modified |
||
72 | * @var string |
||
73 | */ |
||
74 | private $lastModified; |
||
75 | |||
76 | /** |
||
77 | * An ordered list of metrics to track for the experiment |
||
78 | * @var array[Metric] |
||
79 | */ |
||
80 | private $metrics; |
||
81 | |||
82 | /** |
||
83 | * Name of the Experiment |
||
84 | * @var string |
||
85 | */ |
||
86 | private $name; |
||
87 | |||
88 | /** |
||
89 | * The last time the experiment was modified |
||
90 | * @var Schedule |
||
91 | */ |
||
92 | private $schedule; |
||
93 | |||
94 | /** |
||
95 | * Current state of the experiment. Can be 'active', 'paused' or 'archived'. |
||
96 | * @var string |
||
97 | */ |
||
98 | private $status; |
||
99 | |||
100 | /** |
||
101 | * A list of Variations that each define an experience to show in the context |
||
102 | * of the Experiment for the purpose of comparison against each other |
||
103 | * @var array[Variation] |
||
104 | */ |
||
105 | private $variations = array(); |
||
106 | |||
107 | /** |
||
108 | * The unique identifier for the Experiment |
||
109 | * @var integer |
||
110 | */ |
||
111 | private $id; |
||
112 | |||
113 | /** |
||
114 | * Whether or not the Experiment is a classic Experiment |
||
115 | * @var boolean |
||
116 | */ |
||
117 | private $isClassic; |
||
118 | |||
119 | /** |
||
120 | * Indicates whether this is a standalone a/b experiment or an experience within a personalization campaign |
||
121 | * Can be a/b or personalization |
||
122 | * @var string |
||
123 | */ |
||
124 | private $type; |
||
125 | |||
126 | /** |
||
127 | * The audiences that should see this experiment. If the field is null or |
||
128 | * omitted, the experiment will target everyone. Multiple audiences can be |
||
129 | * combined with "and" or "or" using the same structure as audience conditions |
||
130 | * @var string |
||
131 | */ |
||
132 | private $audienceConditions; |
||
133 | |||
134 | /** |
||
135 | * Traffic allocation policy across variations in this experiment |
||
136 | * @var string |
||
137 | */ |
||
138 | private $allocationPolicy; |
||
139 | |||
140 | /** |
||
141 | * The first time the Experiment was activated |
||
142 | * @var type |
||
143 | */ |
||
144 | private $earliest; |
||
145 | |||
146 | /** |
||
147 | * A list of Page IDs used in the Experiment. url_targeting or page_ids, but not both. |
||
148 | */ |
||
149 | private $pageIds; |
||
150 | |||
151 | /** |
||
152 | * Constructor. |
||
153 | */ |
||
154 | 7 | public function __construct($options = array()) |
|
205 | |||
206 | /** |
||
207 | * Returns this object as array. |
||
208 | */ |
||
209 | 3 | public function toArray() |
|
268 | |||
269 | 5 | public function getProjectId() |
|
273 | |||
274 | 7 | public function setProjectId($projectId) |
|
278 | |||
279 | 4 | public function getAudienceIds() |
|
283 | |||
284 | 7 | public function setAudienceIds($audienceIds) |
|
288 | |||
289 | 4 | public function getCampaignId() |
|
293 | |||
294 | 7 | public function setCampaignId($campaignId) |
|
298 | |||
299 | 4 | public function getChanges() |
|
303 | |||
304 | 7 | public function setChanges($changes) |
|
308 | |||
309 | 4 | public function getCreated() |
|
313 | |||
314 | 5 | public function setCreated($created) |
|
318 | |||
319 | 4 | public function getDescription() |
|
323 | |||
324 | 7 | public function setDescription($description) |
|
328 | |||
329 | 4 | public function getHoldback() |
|
333 | |||
334 | 7 | public function setHoldback($holdback) |
|
338 | |||
339 | 4 | public function getKey() |
|
343 | |||
344 | 7 | public function setKey($key) |
|
348 | |||
349 | 4 | public function getLastModified() |
|
353 | |||
354 | 5 | public function setLastModified($lastModified) |
|
358 | |||
359 | 4 | public function getMetrics() |
|
363 | |||
364 | 7 | public function setMetrics($metrics) |
|
368 | |||
369 | 7 | public function getName() |
|
373 | |||
374 | 7 | public function setName($name) |
|
378 | |||
379 | 4 | public function getSchedule() |
|
383 | |||
384 | 7 | public function setSchedule($schedule) |
|
388 | |||
389 | 4 | public function getStatus() |
|
393 | |||
394 | 7 | public function setStatus($status) |
|
398 | |||
399 | 4 | public function getVariations() |
|
403 | |||
404 | 7 | public function setVariations($variations) |
|
408 | |||
409 | 4 | public function getId() |
|
413 | |||
414 | 5 | public function setId($id) |
|
418 | |||
419 | 4 | public function getIsClassic() |
|
423 | |||
424 | 5 | public function setIsClassic($isClassic) |
|
428 | |||
429 | 3 | public function getType() |
|
433 | |||
434 | 2 | public function setType($type) |
|
438 | |||
439 | 3 | public function getAudienceConditions() |
|
443 | |||
444 | 2 | public function setAudienceConditions($audienceConditions) |
|
448 | |||
449 | public function getConfig() |
||
453 | |||
454 | public function setConfig($config) |
||
458 | |||
459 | 3 | public function getAllocationPolicy() |
|
463 | |||
464 | public function setAllocationPolicy($allocationPolicy) |
||
468 | |||
469 | 3 | public function getEarliest() |
|
473 | |||
474 | public function setEarliest($earliest) |
||
478 | |||
479 | 3 | public function getPageIds() |
|
483 | |||
484 | public function setPageIds($pageIds) |
||
488 | } |
||
489 | |||
490 |
According to the PSR-2, the body of a case statement must start on the line immediately following the case statement.
}
To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.