perftools /
xhgui
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) |
||
| 69 | { |
||
| 70 | |||
| 71 | if ($filter->getId()) { |
||
| 72 | $result = glob($this->path . DIRECTORY_SEPARATOR . $filter->getId()); |
||
| 73 | } else { |
||
| 74 | $result = glob($this->path . $this->prefix . '*'); |
||
| 75 | sort($result); |
||
| 76 | } |
||
| 77 | |||
| 78 | $ret = array(); |
||
| 79 | foreach ($result as $i => $file) { |
||
| 80 | // skip meta files. |
||
| 81 | if (strpos($file, '.meta') !== false) { |
||
| 82 | continue; |
||
| 83 | } |
||
| 84 | |||
| 85 | // try to detect timestamp in filename, to optimize searching. |
||
| 86 | // If that fails we need to get it after file import from meta. |
||
| 87 | $reqTimeFromFilename = $this->getRequestTimeFromFilename($file); |
||
| 88 | if (!empty($reqTimeFromFilename)) { |
||
| 89 | if (null !== $filter->getStartDate() && |
||
| 90 | $this->getDateTimeFromString($filter->getStartDate(), 'start') >= $reqTimeFromFilename) { |
||
|
|
|||
| 91 | continue; |
||
| 92 | } |
||
| 93 | |||
| 94 | if (null !== $filter->getEndDate() && |
||
| 95 | $this->getDateTimeFromString($filter->getEndDate(), 'end') <= $reqTimeFromFilename) { |
||
| 96 | continue; |
||
| 97 | } |
||
| 98 | } |
||
| 99 | |||
| 100 | $metaFile = $this->getMetafileNameFromProfileName($file); |
||
| 101 | |||
| 102 | $meta = $this->importFile($metaFile, true); |
||
| 103 | if ($meta === false) { |
||
| 104 | continue; |
||
| 105 | } |
||
| 106 | |||
| 107 | $profile = $this->importFile($file, false); |
||
| 108 | if ($profile === false) { |
||
| 109 | continue; |
||
| 110 | } |
||
| 111 | |||
| 112 | if (!empty($profile['meta'])) { |
||
| 113 | $meta = array_merge($meta, $profile['meta']); |
||
| 114 | } |
||
| 115 | |||
| 116 | if (empty($reqTimeFromFilename) && (null !== $filter->getStartDate() || null !== $filter->getEndDate())) { |
||
| 117 | if (null !== $filter->getStartDate() && |
||
| 118 | $this->getDateTimeFromString($filter->getStartDate(), 'start') >= $filter->getStartDate()) { |
||
| 119 | continue; |
||
| 120 | } |
||
| 121 | if (null !== $filter->getEndDate() && |
||
| 122 | $this->getDateTimeFromString($filter->getEndDate(), 'end') <= $filter->getEndDate()) { |
||
| 123 | continue; |
||
| 124 | } |
||
| 125 | } |
||
| 126 | |||
| 127 | if ($filter->getUrl() && |
||
| 128 | strpos($meta['simple_url'], $filter->getUrl()) === false && |
||
| 129 | strpos($meta['SERVER']['SERVER_NAME'] . $meta['simple_url'], $filter->getUrl()) === false |
||
| 130 | ) { |
||
| 131 | continue; |
||
| 132 | } |
||
| 133 | |||
| 134 | View Code Duplication | if (null !== $filter->getCookie() && |
|
| 135 | strpos($meta['SERVER']['HTTP_COOKIE'], $filter->getCookie()) === false |
||
| 136 | ) { |
||
| 137 | continue; |
||
| 138 | } |
||
| 139 | |||
| 140 | if (null !== $filter->getIp() && $meta['SERVER']['REMOTE_ADDR'] !== $filter->getIp()) { |
||
| 141 | continue; |
||
| 142 | } |
||
| 143 | |||
| 144 | if (!empty($profile['profile'])) { |
||
| 145 | $profile = $profile['profile']; |
||
| 146 | } |
||
| 147 | |||
| 148 | if (!empty($profile['_id'])) { |
||
| 149 | $id = $profile['_id']; |
||
| 150 | } else { |
||
| 151 | $id = basename($file); |
||
| 152 | } |
||
| 153 | if (!empty($profile)) { |
||
| 154 | $ret[$id] = array( |
||
| 155 | 'profile' => $profile, |
||
| 156 | '_id' => $id, |
||
| 157 | 'meta' => $meta, |
||
| 158 | ); |
||
| 159 | } else { |
||
| 160 | $ret[$id] = $profile; |
||
| 161 | } |
||
| 162 | } |
||
| 163 | |||
| 164 | try { |
||
| 165 | if (!empty($ret) && $filter->hasSort()) { |
||
| 166 | $this->filter = $filter; |
||
| 167 | usort($ret, array($this, 'sortByColumn')); |
||
| 168 | unset($this->filter); |
||
| 169 | } |
||
| 170 | } catch (InvalidArgumentException $e) { |
||
| 171 | // ignore for now. |
||
| 172 | } |
||
| 173 | |||
| 174 | $cacheId = md5(serialize($filter->toArray())); |
||
| 175 | |||
| 176 | $this->countCache[$cacheId] = count($ret); |
||
| 177 | $ret = array_slice($ret, $filter->getPerPage() * ($filter->getPage() - 1), $filter->getPerPage()); |
||
| 178 | $ret = array_column($ret, null, '_id'); |
||
| 179 | |||
| 180 | return new Xhgui_Storage_ResultSet($ret, $this->countCache[$cacheId]); |
||
| 181 | } |
||
| 182 | |||
| 183 | /** |
||
| 184 | * @inheritDoc |
||
| 185 | * @param Xhgui_Storage_Filter $filter |
||
| 186 | * @return int |
||
| 187 | */ |
||
| 188 | public function count(Xhgui_Storage_Filter $filter) |
||
| 196 | |||
| 197 | /** |
||
| 198 | * @inheritDoc |
||
| 199 | * @param $id |
||
| 200 | * @return mixed |
||
| 201 | */ |
||
| 202 | public function findOne($id) |
||
| 209 | |||
| 210 | /** |
||
| 211 | * @inheritDoc |
||
| 212 | * @param $id |
||
| 213 | * @return bool |
||
| 214 | */ |
||
| 215 | public function remove($id) |
||
| 227 | |||
| 228 | /** |
||
| 229 | * @inheritDoc |
||
| 230 | */ |
||
| 231 | public function drop() |
||
| 236 | |||
| 237 | /** |
||
| 238 | * @inheritDoc |
||
| 239 | * @param $match |
||
| 240 | * @param $col |
||
| 241 | * @param int $percentile |
||
| 242 | * @return array |
||
| 243 | */ |
||
| 244 | public function aggregate(Xhgui_Storage_Filter $filter, $col, $percentile = 1) |
||
| 284 | |||
| 285 | |||
| 286 | /** |
||
| 287 | * Column sorter |
||
| 288 | * |
||
| 289 | * @param $a |
||
| 290 | * @param $b |
||
| 291 | * @return int |
||
| 292 | */ |
||
| 293 | public function sortByColumn($a, $b) |
||
| 348 | |||
| 349 | /** |
||
| 350 | * Generate meta profile name from profile file name. |
||
| 351 | * |
||
| 352 | * In most cases just add .meta extension |
||
| 353 | * |
||
| 354 | * @param $file |
||
| 355 | * @return mixed |
||
| 356 | */ |
||
| 357 | protected function getMetafileNameFromProfileName($file) |
||
| 362 | |||
| 363 | /** |
||
| 364 | * Load profile file from disk, prepare it and return parsed array |
||
| 365 | * |
||
| 366 | * @param $path |
||
| 367 | * @param bool $meta |
||
| 368 | * @return mixed |
||
| 369 | */ |
||
| 370 | protected function importFile($path, $meta = false) |
||
| 407 | |||
| 408 | /** |
||
| 409 | * @inheritDoc |
||
| 410 | * @return array |
||
| 411 | */ |
||
| 412 | public function getWatchedFunctions() |
||
| 421 | |||
| 422 | /** |
||
| 423 | * @inheritDoc |
||
| 424 | * @param $name |
||
| 425 | * @return bool |
||
| 426 | */ |
||
| 427 | View Code Duplication | public function addWatchedFunction($name) |
|
| 440 | |||
| 441 | /** |
||
| 442 | * @inheritDoc |
||
| 443 | * @param $id |
||
| 444 | * @param $name |
||
| 445 | * @return bool |
||
| 446 | */ |
||
| 447 | View Code Duplication | public function updateWatchedFunction($id, $name) |
|
| 460 | |||
| 461 | /** |
||
| 462 | * @inheritDoc |
||
| 463 | * @param $id |
||
| 464 | */ |
||
| 465 | public function removeWatchedFunction($id) |
||
| 471 | |||
| 472 | /** |
||
| 473 | * Parse filename and try to get request time from filename |
||
| 474 | * |
||
| 475 | * @param $fileName |
||
| 476 | * @return bool|DateTime |
||
| 477 | */ |
||
| 478 | public function getRequestTimeFromFilename($fileName) |
||
| 490 | } |
||
| 491 |
Loading history...
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: