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 StatsJsonView 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 StatsJsonView, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
14 | class StatsJsonView extends BaseJsonView |
||
15 | { |
||
16 | /** |
||
17 | * Flag if the response should return the raw data. |
||
18 | * |
||
19 | * @var boolean |
||
20 | * @since 1.0 |
||
21 | */ |
||
22 | private $authorizedRaw = false; |
||
23 | |||
24 | /** |
||
25 | * Array holding the valid data sources. |
||
26 | * |
||
27 | * @var array |
||
28 | * @since 1.0 |
||
29 | */ |
||
30 | private $dataSources = ['php_version', 'db_type', 'db_version', 'cms_version', 'server_os']; |
||
31 | |||
32 | /** |
||
33 | * The data source to return. |
||
34 | * |
||
35 | * @var string |
||
36 | * @since 1.0 |
||
37 | */ |
||
38 | private $source = ''; |
||
39 | |||
40 | /** |
||
41 | * Count of the number of items. |
||
42 | * |
||
43 | * @var integer |
||
44 | * @since 1.0 |
||
45 | */ |
||
46 | private $totalItems = 0; |
||
47 | |||
48 | /** |
||
49 | * Set whether the raw data should be returned. |
||
50 | * |
||
51 | * @param bool $authorizedRaw Flag if the response should return the raw data. |
||
52 | * |
||
53 | * @return void |
||
54 | * |
||
55 | * @since 1.0 |
||
56 | */ |
||
57 | 1 | public function isAuthorizedRaw(bool $authorizedRaw) |
|
61 | |||
62 | /** |
||
63 | * Method to render the view. |
||
64 | * |
||
65 | * @return string The rendered view. |
||
66 | * |
||
67 | * @since 1.0 |
||
68 | * @throws \InvalidArgumentException |
||
69 | */ |
||
70 | public function render() |
||
71 | { |
||
72 | $items = $this->model->getItems($this->source); |
||
73 | |||
74 | // Null out the model now to free some memory |
||
75 | $this->model = null; |
||
76 | |||
77 | if ($this->source) |
||
78 | { |
||
79 | return $this->processSingleSource($items); |
||
80 | } |
||
81 | |||
82 | $php_version = []; |
||
83 | $db_type = []; |
||
84 | $db_version = []; |
||
85 | $cms_version = []; |
||
86 | $server_os = []; |
||
87 | |||
88 | // If we have the entire database, we have to loop within each group to put it all together |
||
89 | foreach ($items as $group) |
||
90 | { |
||
91 | $this->totalItems += count($group); |
||
92 | |||
93 | foreach ($group as $item) |
||
94 | { |
||
95 | foreach ($this->dataSources as $source) |
||
96 | { |
||
97 | if (isset($item[$source]) && !is_null($item[$source])) |
||
98 | { |
||
99 | // Special case, if the server is empty then change the key to "unknown" |
||
100 | if ($source === 'server_os' && empty($item[$source])) |
||
101 | { |
||
102 | if (!isset(${$source}['unknown'])) |
||
103 | { |
||
104 | ${$source}['unknown'] = 0; |
||
105 | } |
||
106 | |||
107 | ${$source}['unknown']++; |
||
108 | } |
||
109 | else |
||
110 | { |
||
111 | View Code Duplication | if (!isset(${$source}[$item[$source]])) |
|
|
|||
112 | { |
||
113 | ${$source}[$item[$source]] = 0; |
||
114 | } |
||
115 | |||
116 | ${$source}[$item[$source]]++; |
||
117 | } |
||
118 | } |
||
119 | } |
||
120 | } |
||
121 | } |
||
122 | |||
123 | unset($items); |
||
124 | |||
125 | $data = [ |
||
126 | 'php_version' => $php_version, |
||
127 | 'db_type' => $db_type, |
||
128 | 'db_version' => $db_version, |
||
129 | 'cms_version' => $cms_version, |
||
130 | 'server_os' => $server_os, |
||
131 | ]; |
||
132 | |||
133 | $responseData = $this->buildResponseData($data); |
||
134 | |||
135 | $responseData['total'] = $this->totalItems; |
||
136 | |||
137 | $this->addData('data', $responseData); |
||
138 | |||
139 | return parent::render(); |
||
140 | } |
||
141 | |||
142 | /** |
||
143 | * Set the data source. |
||
144 | * |
||
145 | * @param string $source Data source to return. |
||
146 | * |
||
147 | * @return void |
||
148 | * |
||
149 | * @since 1.0 |
||
150 | */ |
||
151 | 1 | public function setSource(string $source) |
|
155 | |||
156 | /** |
||
157 | * Process the raw data into the response data format. |
||
158 | * |
||
159 | * @param array $data The raw data array. |
||
160 | * |
||
161 | * @return array |
||
162 | * |
||
163 | * @since 1.0 |
||
164 | */ |
||
165 | private function buildResponseData(array $data) : array |
||
192 | |||
193 | /** |
||
194 | * Process the response for a single data source. |
||
195 | * |
||
196 | * @param \Generator $generator The source items to process. |
||
197 | * |
||
198 | * @return string The rendered view. |
||
199 | * |
||
200 | * @since 1.0 |
||
201 | */ |
||
202 | private function processSingleSource(\Generator $generator) : string |
||
252 | |||
253 | /** |
||
254 | * Sanitize the response data into summarized groups. |
||
255 | * |
||
256 | * @param array $responseData The response data to sanitize. |
||
257 | * |
||
258 | * @return array |
||
259 | * |
||
260 | * @since 1.0 |
||
261 | */ |
||
262 | private function sanitizeData(array $responseData) : array |
||
346 | } |
||
347 |
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.