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 Xhgui_Storage_File 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 Xhgui_Storage_File, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
3 | class Xhgui_Storage_File extends Xhgui_Storage_Abstract implements |
||
4 | Xhgui_StorageInterface, |
||
5 | Xhgui_WatchedFunctionsStorageInterface |
||
6 | { |
||
7 | |||
8 | /** |
||
9 | * @var string |
||
10 | */ |
||
11 | protected $path = '../data/'; |
||
12 | |||
13 | /** |
||
14 | * @var string |
||
15 | */ |
||
16 | protected $prefix = 'xhgui.data'; |
||
17 | |||
18 | /** |
||
19 | * @var bool|mixed |
||
20 | */ |
||
21 | protected $separateMeta = true; |
||
22 | |||
23 | /** |
||
24 | * @var mixed |
||
25 | */ |
||
26 | protected $dataSerializer; |
||
27 | |||
28 | /** |
||
29 | * @var mixed |
||
30 | */ |
||
31 | protected $metaSerializer; |
||
32 | |||
33 | /** |
||
34 | * @var string |
||
35 | */ |
||
36 | protected $watchedFunctionsPathPrefix = '../watched_functions/'; |
||
37 | |||
38 | /** |
||
39 | * @var int[] |
||
40 | */ |
||
41 | protected $countCache; |
||
42 | |||
43 | /** |
||
44 | * @var Xhgui_Storage_Filter |
||
45 | */ |
||
46 | private $filter; |
||
47 | |||
48 | /** |
||
49 | * Xhgui_Storage_File constructor. |
||
50 | * @param $config |
||
51 | */ |
||
52 | public function __construct($config) |
||
61 | |||
62 | /** |
||
63 | * @inheritDoc |
||
64 | * @param Xhgui_Storage_Filter $filter |
||
65 | * @param bool $projections |
||
66 | * @return Xhgui_Storage_ResultSet |
||
67 | */ |
||
68 | public function find(Xhgui_Storage_Filter $filter, $projections = false) |
||
180 | |||
181 | /** |
||
182 | * @inheritDoc |
||
183 | * @param Xhgui_Storage_Filter $filter |
||
184 | * @return int |
||
185 | */ |
||
186 | public function count(Xhgui_Storage_Filter $filter) |
||
194 | |||
195 | /** |
||
196 | * @inheritDoc |
||
197 | * @param $id |
||
198 | * @return mixed |
||
199 | */ |
||
200 | public function findOne($id) |
||
207 | |||
208 | /** |
||
209 | * @inheritDoc |
||
210 | * @param $id |
||
211 | * @return bool |
||
212 | */ |
||
213 | public function remove($id) |
||
225 | |||
226 | /** |
||
227 | * @inheritDoc |
||
228 | */ |
||
229 | public function drop() |
||
234 | |||
235 | /** |
||
236 | * @inheritDoc |
||
237 | * @param $match |
||
238 | * @param $col |
||
239 | * @param int $percentile |
||
240 | * @return array |
||
241 | */ |
||
242 | public function aggregate(Xhgui_Storage_Filter $filter, $col, $percentile = 1) |
||
282 | |||
283 | |||
284 | /** |
||
285 | * Column sorter |
||
286 | * |
||
287 | * @param $a |
||
288 | * @param $b |
||
289 | * @return int |
||
290 | */ |
||
291 | public function sortByColumn($a, $b) |
||
346 | |||
347 | /** |
||
348 | * Generate meta profile name from profile file name. |
||
349 | * |
||
350 | * In most cases just add .meta extension |
||
351 | * |
||
352 | * @param $file |
||
353 | * @return mixed |
||
354 | */ |
||
355 | protected function getMetafileNameFromProfileName($file) |
||
360 | |||
361 | /** |
||
362 | * Load profile file from disk, prepare it and return parsed array |
||
363 | * |
||
364 | * @param $path |
||
365 | * @param bool $meta |
||
366 | * @return mixed |
||
367 | */ |
||
368 | protected function importFile($path, $meta = false) |
||
405 | |||
406 | /** |
||
407 | * @inheritDoc |
||
408 | * @return array |
||
409 | */ |
||
410 | public function getWatchedFunctions() |
||
419 | |||
420 | /** |
||
421 | * @inheritDoc |
||
422 | * @param $name |
||
423 | * @return bool |
||
424 | */ |
||
425 | View Code Duplication | public function addWatchedFunction($name) |
|
438 | |||
439 | /** |
||
440 | * @inheritDoc |
||
441 | * @param $id |
||
442 | * @param $name |
||
443 | * @return bool |
||
444 | */ |
||
445 | View Code Duplication | public function updateWatchedFunction($id, $name) |
|
458 | |||
459 | /** |
||
460 | * @inheritDoc |
||
461 | * @param $id |
||
462 | */ |
||
463 | public function removeWatchedFunction($id) |
||
469 | |||
470 | /** |
||
471 | * Parse filename and try to get request time from filename |
||
472 | * |
||
473 | * @param $fileName |
||
474 | * @return bool|DateTime |
||
475 | */ |
||
476 | public function getRequestTimeFromFilename($fileName) |
||
488 | } |
||
489 |
It seems like the type of the argument is not accepted by the function/method which you are calling.
In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.
We suggest to add an explicit type cast like in the following example: