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) |
||
| 172 | |||
| 173 | /** |
||
| 174 | * @inheritDoc |
||
| 175 | * @param Xhgui_Storage_Filter $filter |
||
| 176 | * @return int |
||
| 177 | */ |
||
| 178 | public function count(Xhgui_Storage_Filter $filter) |
||
| 186 | |||
| 187 | /** |
||
| 188 | * @inheritDoc |
||
| 189 | * @param $id |
||
| 190 | * @return mixed |
||
| 191 | */ |
||
| 192 | public function findOne($id) |
||
| 199 | |||
| 200 | /** |
||
| 201 | * @inheritDoc |
||
| 202 | * @param $id |
||
| 203 | * @return bool |
||
| 204 | */ |
||
| 205 | public function remove($id) |
||
| 217 | |||
| 218 | /** |
||
| 219 | * @inheritDoc |
||
| 220 | */ |
||
| 221 | public function drop() |
||
| 226 | |||
| 227 | /** |
||
| 228 | * @inheritDoc |
||
| 229 | * @param $match |
||
| 230 | * @param $col |
||
| 231 | * @param int $percentile |
||
| 232 | * @return array |
||
| 233 | */ |
||
| 234 | public function aggregate(Xhgui_Storage_Filter $filter, $col, $percentile = 1) |
||
| 274 | |||
| 275 | |||
| 276 | /** |
||
| 277 | * Column sorter |
||
| 278 | * |
||
| 279 | * @param $a |
||
| 280 | * @param $b |
||
| 281 | * @return int |
||
| 282 | */ |
||
| 283 | public function sortByColumn($a, $b) |
||
| 338 | |||
| 339 | /** |
||
| 340 | * Generate meta profile name from profile file name. |
||
| 341 | * |
||
| 342 | * In most cases just add .meta extension |
||
| 343 | * |
||
| 344 | * @param $file |
||
| 345 | * @return mixed |
||
| 346 | */ |
||
| 347 | protected function getMetafileNameFromProfileName($file) |
||
| 352 | |||
| 353 | /** |
||
| 354 | * Load profile file from disk, prepare it and return parsed array |
||
| 355 | * |
||
| 356 | * @param $path |
||
| 357 | * @param bool $meta |
||
| 358 | * @return mixed |
||
| 359 | */ |
||
| 360 | protected function importFile($path, $meta = false) |
||
| 397 | |||
| 398 | /** |
||
| 399 | * @inheritDoc |
||
| 400 | * @return array |
||
| 401 | */ |
||
| 402 | public function getWatchedFunctions() |
||
| 411 | |||
| 412 | /** |
||
| 413 | * @inheritDoc |
||
| 414 | * @param $name |
||
| 415 | * @return bool |
||
| 416 | */ |
||
| 417 | View Code Duplication | public function addWatchedFunction($name) |
|
| 430 | |||
| 431 | /** |
||
| 432 | * @inheritDoc |
||
| 433 | * @param $id |
||
| 434 | * @param $name |
||
| 435 | * @return bool |
||
| 436 | */ |
||
| 437 | View Code Duplication | public function updateWatchedFunction($id, $name) |
|
| 450 | |||
| 451 | /** |
||
| 452 | * @inheritDoc |
||
| 453 | * @param $id |
||
| 454 | */ |
||
| 455 | public function removeWatchedFunction($id) |
||
| 461 | |||
| 462 | /** |
||
| 463 | * Parse filename and try to get request time from filename |
||
| 464 | * |
||
| 465 | * @param $fileName |
||
| 466 | * @return bool|DateTime |
||
| 467 | */ |
||
| 468 | public function getRequestTimeFromFilename($fileName) |
||
| 480 | } |
||
| 481 |
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: