Complex classes like ThemeConfiguration 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 ThemeConfiguration, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
9 | class ThemeConfiguration extends AbstractConfigurableElement implements NavigableThemeInterface |
||
|
|||
10 | { |
||
11 | |||
12 | const THEME = 'Magium\Magento\Themes\Admin\ThemeConfiguration'; |
||
13 | |||
14 | public $baseUrl = 'http://localhost/admin'; |
||
15 | |||
16 | public $homeXpath = '//img[@class="logo"]'; |
||
17 | |||
18 | public $loginUsernameField = '//input[@type="text" and @id="username"]'; |
||
19 | public $loginPasswordField = '//input[@type="password" and @id="login"]'; |
||
20 | public $loginSubmitButton = '//input[@type="submit" and @value="{{Login}}"]'; |
||
21 | |||
22 | public $navigationBaseXPathSelector = '//ul[@id="nav"]'; |
||
23 | // public $navigationChildXPathSelector1 = 'li/descendant::span[.="{{%s}}"]'; |
||
24 | public $navigationChildXPathSelector = 'a[concat(" ",normalize-space(.)," ") = " {{%s}} "]/..'; |
||
25 | |||
26 | public $adminPopupMessageContainerXpath = '//*[@id="message-popup-window"]'; |
||
27 | public $adminPopupMessageCloseButtonXpath = '//*[@id="message-popup-window"]/descendant::*[@title="close"]'; |
||
28 | |||
29 | public $systemConfigTabsXpath = '//ul[@id="system_config_tabs"]/descendant::a[concat(" ",normalize-space(.)," ") = " {{%s}} "]'; |
||
30 | public $systemConfigSectionToggleXpath = '//form[@id="config_edit_form"]/descendant::div[contains(concat(" ",normalize-space(@class)," ")," section-config ")]/descendant::a[.="{{%s}}"]'; |
||
31 | public $systemConfigSectionDisplayCheckXpath = '//legend[.="{{%s}}"]/ancestor::fieldset'; |
||
32 | public $systemConfigToggleEnableXpath = '//legend[.="{{%s}}"]/../descendant::td[concat(" ",normalize-space(.)," ") = " {{Enabled}} "]/../td/descendant::select/option[@value="%d"]'; |
||
33 | |||
34 | public $xTreeRootXpath = '//ul[contains(concat(" ",normalize-space(@class)," ")," x-tree-root-ct ")]/div/li[contains(concat(" ",normalize-space(@class)," ")," x-tree-node ")]/div/a'; |
||
35 | public $xTreeNamedRootXpath = '//ul[contains(concat(" ",normalize-space(@class)," ")," x-tree-root-ct ")]/div/li[contains(concat(" ",normalize-space(@class)," ")," x-tree-node ")]/div/a[contains(concat("---",normalize-space(.)), "---{{%s}} (")]'; |
||
36 | public $xTreeChildXpath = 'ul/li[contains(concat(" ",normalize-space(@class)," ")," x-tree-node ")]/div/a/span[contains(concat("---",normalize-space(.)), "---{{%s}} (")]/..'; |
||
37 | public $xTreeChildNodePrefixXpath = '/../..'; |
||
38 | public $xTreeChildNodeExpandPrefixXpath = '/../img[contains(concat(" ",normalize-space(@class)," ")," x-tree-ec-icon ")]'; |
||
39 | |||
40 | public $systemConfigurationSaveButtonXpath = '//div[@class="main-col-inner"]/div[@class="content-header"]/descendant::button[@title="{{Save Config}}"]'; |
||
41 | |||
42 | public $systemConfigSaveSuccessfulXpath = '//li[@class="success-msg"]/descendant::span[.="{{The configuration has been saved}}."]'; |
||
43 | |||
44 | public $testLoggedInAtBaseUrl = '//a[@class="active"]/span[.="{{Dashboard}}"]'; |
||
45 | |||
46 | public $tableButtonXpath = '//table[@class="actions"]/descendant::span[.="{{%s}}"]'; |
||
47 | |||
48 | public $selectOrderXpath = '//table[@id="sales_order_grid_table"]/descendant::td[concat(" ",normalize-space(.)," ") = " %s "]/../td/a[.="{{View}}"]'; |
||
49 | public $selectCustomerXpath = '//table[@id="customerGrid_table"]/descendant::td[concat(" ",normalize-space(.)," ") = " %s "]/../td/a[.="{{Edit}}"]'; |
||
50 | |||
51 | public $systemConfigSettingLabelXpath = '//td[@class="label"]/label[.=" {{%s}}"]'; |
||
52 | |||
53 | public $widgetTabXpath = '//a[contains(@class, "tab-item-link")]/span[.="{{%s}}"]'; |
||
54 | public $widgetTabHeaderXpath = '//div[@class="entry-edit-head"]/h4[.="{{%s}}"]'; |
||
55 | public $widgetAttributeByLabelXpath = '//table[@class="form-list"]/descendant::td[@class="label"]/label[.="{{%s}} *" or .="{{%s}}*" or .="{{%s}} " or .="{{%s}}"]/ancestor::tr/td[@class="value"]/*[@name]'; |
||
56 | public $widgetActionButtonXpath = '//div[@class="content-header"]/descendant::button/descendant::span[.="{{%s}}"]'; |
||
57 | |||
58 | public $guaranteedPageLoadedElementDisplayedXpath = '//div[@class="footer"]'; |
||
59 | |||
60 | public $successfulActionXpath = '//li[@class="success-msg"]'; |
||
61 | public $errorActionXpath = '//li[@class="error-msg"]'; |
||
62 | |||
63 | public $shippingCarrierXpath = '//select[@name="tracking[%d][carrier_code]"]'; |
||
64 | public $shippingTitleXpath = '//input[@name="tracking[%d][title]"]'; |
||
65 | public $shippingTrackingNumberXpath = '//input[@name="tracking[%d][number]"]'; |
||
66 | |||
67 | public $formButtonXpath = '//div[@class="content-header"]/p[@class="form-buttons"]/descendant::span[.="{{%s}}"]'; |
||
68 | |||
69 | public $cacheNavigationPath = '{{System}}/{{Cache Management}}'; |
||
70 | |||
71 | public $cacheTargetXpath = '//input[@name="types" and @value="{{%s}}"]'; |
||
72 | |||
73 | public $cacheAllTargetsXpath = '//input[@name="types"]'; |
||
74 | |||
75 | public $cacheMassActionOptionXpath = '//select[@id="cache_grid_massaction-select"]/option[@value="{{%s}}"]'; |
||
76 | |||
77 | public $cacheSubmitXpath = '//button[@title="{{Submit}}"]'; |
||
78 | |||
79 | public $firstTermsRowXpath = '//table[@id="agreementGrid_table"]/tbody/tr/td[not(contains(concat(" ",normalize-space(@class)," ")," empty-text "))]'; |
||
80 | |||
81 | public $orderCancelledMessageXpath = '//div[@id="messages"]/descendant::span[contains(., "{{The order has been cancelled}}")]'; |
||
82 | |||
83 | /** |
||
84 | * @return string |
||
85 | */ |
||
86 | public function getOrderCancelledMessageXpath() |
||
90 | |||
91 | |||
92 | |||
93 | /** |
||
94 | * @return string |
||
95 | */ |
||
96 | public function getFirstTermsRowXpath() |
||
100 | |||
101 | /** |
||
102 | * @return string |
||
103 | */ |
||
104 | public function getCacheSubmitXpath() |
||
108 | |||
109 | |||
110 | |||
111 | /** |
||
112 | * @return string |
||
113 | */ |
||
114 | public function getCacheMassActionOptionXpath($option) |
||
119 | |||
120 | |||
121 | |||
122 | /** |
||
123 | * @return string |
||
124 | */ |
||
125 | public function getCacheAllTargetsXpath() |
||
129 | |||
130 | |||
131 | |||
132 | /** |
||
133 | * @return string |
||
134 | */ |
||
135 | public function getCacheTargetXpath($type) |
||
140 | |||
141 | |||
142 | |||
143 | /** |
||
144 | * @return string |
||
145 | */ |
||
146 | public function getCacheNavigationPath() |
||
150 | |||
151 | |||
152 | public function getFormButtonXpath($button) |
||
157 | |||
158 | /** |
||
159 | * @return string |
||
160 | */ |
||
161 | public function getShippingCarrierXpath($count) |
||
166 | |||
167 | /** |
||
168 | * @return string |
||
169 | */ |
||
170 | public function getShippingTitleXpath($count) |
||
175 | |||
176 | /** |
||
177 | * @return string |
||
178 | */ |
||
179 | public function getShippingTrackingNumberXpath($count) |
||
184 | |||
185 | |||
186 | |||
187 | /** |
||
188 | * @return string |
||
189 | */ |
||
190 | public function getXTreeChildNodeExpandPrefixXpath() |
||
194 | |||
195 | /** |
||
196 | * @return string |
||
197 | */ |
||
198 | public function getXTreeNamedRootXpath($category) |
||
203 | |||
204 | |||
205 | |||
206 | |||
207 | /** |
||
208 | * @return string |
||
209 | */ |
||
210 | public function getXTreeChildNodePrefixXpath() |
||
214 | |||
215 | /** |
||
216 | * @return string |
||
217 | */ |
||
218 | public function getXTreeChildXpath($name) |
||
223 | |||
224 | /** |
||
225 | * @return string |
||
226 | */ |
||
227 | public function getXTreeRootXpath() |
||
231 | |||
232 | |||
233 | |||
234 | public function set($name, $value) |
||
238 | |||
239 | /** |
||
240 | * @return string |
||
241 | */ |
||
242 | public function getSuccessfulActionXpath() |
||
246 | |||
247 | /** |
||
248 | * @return string |
||
249 | */ |
||
250 | public function getErrorActionXpath() |
||
254 | |||
255 | |||
256 | |||
257 | /** |
||
258 | * @return string |
||
259 | */ |
||
260 | public function getWidgetActionButtonXpath($label) |
||
264 | |||
265 | /** |
||
266 | * @return string |
||
267 | */ |
||
268 | public function getWidgetAttributeByLabelXpath($attribute) |
||
272 | |||
273 | |||
274 | |||
275 | /** |
||
276 | * @return string |
||
277 | */ |
||
278 | public function getWidgetTabHeaderXpath($name) |
||
282 | |||
283 | /** |
||
284 | * @return string |
||
285 | */ |
||
286 | public function getWidgetTabXpath($name) |
||
290 | |||
291 | |||
292 | |||
293 | public function getGuaranteedPageLoadedElementDisplayedXpath() |
||
297 | |||
298 | /** |
||
299 | * @param mixed $guaranteedPageLoadedElementDisplayedXpath |
||
300 | */ |
||
301 | public function setGuaranteedPageLoadedElementDisplayedXpath($guaranteedPageLoadedElementDisplayedXpath) |
||
305 | |||
306 | /** |
||
307 | * @return string |
||
308 | */ |
||
309 | public function getHomeXpath() |
||
313 | |||
314 | /** |
||
315 | * @return string |
||
316 | */ |
||
317 | public function getSystemConfigSettingLabelXpath($label) |
||
322 | |||
323 | /** |
||
324 | * Why is this an option? So you can have a different theme setup for different languages and still use the same code. |
||
325 | * |
||
326 | * @var string |
||
327 | */ |
||
328 | |||
329 | public $searchButtonText = '{{Search}}'; |
||
330 | |||
331 | /** |
||
332 | * @return Translator |
||
333 | */ |
||
334 | public function getTranslator() |
||
338 | |||
339 | /** |
||
340 | * @return string |
||
341 | */ |
||
342 | public function getLoginUsernameField() |
||
346 | |||
347 | /** |
||
348 | * @return string |
||
349 | */ |
||
350 | public function getLoginPasswordField() |
||
354 | |||
355 | /** |
||
356 | * @return string |
||
357 | */ |
||
358 | public function getLoginSubmitButton() |
||
362 | |||
363 | /** |
||
364 | * @return string |
||
365 | */ |
||
366 | public function getNavigationBaseXPathSelector() |
||
370 | |||
371 | /** |
||
372 | * @return string |
||
373 | */ |
||
374 | public function getNavigationChildXPathSelector($text) |
||
379 | |||
380 | /** |
||
381 | * @return mixed |
||
382 | */ |
||
383 | public function getBaseUrl() |
||
387 | |||
388 | /** |
||
389 | * @return string |
||
390 | */ |
||
391 | public function getSearchButtonText() |
||
395 | |||
396 | |||
397 | |||
398 | /** |
||
399 | * @return string |
||
400 | */ |
||
401 | public function getSelectOrderXpath($order) |
||
406 | /** |
||
407 | * @return string |
||
408 | */ |
||
409 | public function getSelectCustomerXpath($value) |
||
414 | |||
415 | /** |
||
416 | * @return string |
||
417 | */ |
||
418 | public function getTableButtonXpath($buttonValue) |
||
423 | |||
424 | |||
425 | |||
426 | /** |
||
427 | * @return string |
||
428 | */ |
||
429 | public function getTestLoggedInAtBaseUrl() |
||
433 | |||
434 | |||
435 | |||
436 | /** |
||
437 | * @return string |
||
438 | */ |
||
439 | public function getSystemConfigSaveSuccessfulXpath() |
||
443 | |||
444 | /** |
||
445 | * @return string |
||
446 | */ |
||
447 | public function getSystemConfigurationSaveButtonXpath() |
||
451 | |||
452 | /** |
||
453 | * @return string |
||
454 | */ |
||
455 | public function getSystemConfigSectionToggleXpath($section) |
||
460 | |||
461 | /** |
||
462 | * @return string |
||
463 | */ |
||
464 | public function getSystemConfigSectionDisplayCheckXpath($section) |
||
469 | |||
470 | /** |
||
471 | * @return string |
||
472 | */ |
||
473 | public function getSystemConfigToggleEnableXpath($section, $option) |
||
478 | |||
479 | /** |
||
480 | * @return string |
||
481 | */ |
||
482 | public function getSystemConfigTabsXpath($tabName) |
||
487 | |||
488 | |||
489 | public function getAdminPopupMessageContainerXpath() |
||
493 | |||
494 | public function getAdminPopupMessageCloseButtonXpath() |
||
498 | |||
499 | public function getUseClicksToNavigate() |
||
503 | |||
504 | public function configure(AbstractTestCase $testCase) |
||
508 | |||
509 | } |
||
510 |