Complex classes like Hydrator 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 Hydrator, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 8 | class Hydrator |
||
| 9 | { |
||
| 10 | /** |
||
| 11 | * All hydrators. |
||
| 12 | * |
||
| 13 | * @var |
||
| 14 | */ |
||
| 15 | const HYDRATORS = [ |
||
| 16 | 'borders', |
||
| 17 | 'cities', |
||
| 18 | 'collection', |
||
| 19 | 'countries', |
||
| 20 | 'country', |
||
| 21 | 'currencies', |
||
| 22 | 'flag', |
||
| 23 | 'geometry', |
||
| 24 | 'natural_earth_data', |
||
| 25 | 'states', |
||
| 26 | 'taxes', |
||
| 27 | 'timezones', |
||
| 28 | 'timezones_times', |
||
| 29 | 'topology', |
||
| 30 | ]; |
||
| 31 | |||
| 32 | /** |
||
| 33 | * Countries repository. |
||
| 34 | * |
||
| 35 | * @var Repository |
||
| 36 | */ |
||
| 37 | protected $repository; |
||
| 38 | |||
| 39 | /** |
||
| 40 | * Config. |
||
| 41 | * |
||
| 42 | * @var Config |
||
| 43 | */ |
||
| 44 | protected $config; |
||
| 45 | |||
| 46 | /** |
||
| 47 | * Hydrator constructor. |
||
| 48 | * |
||
| 49 | * @param object $config |
||
| 50 | */ |
||
| 51 | 31 | public function __construct($config) |
|
| 52 | { |
||
| 53 | 31 | $this->config = $config; |
|
| 54 | 31 | } |
|
| 55 | |||
| 56 | /** |
||
| 57 | * Can hydrate? |
||
| 58 | * |
||
| 59 | * @param $element |
||
| 60 | * @param $enabled |
||
| 61 | * @param $countryCode |
||
| 62 | * @return bool |
||
| 63 | */ |
||
| 64 | 20 | protected function canHydrate($element, $enabled, $countryCode) |
|
| 69 | |||
| 70 | /** |
||
| 71 | * @param $countryCode |
||
| 72 | */ |
||
| 73 | 20 | protected function createHydrated($countryCode) |
|
| 81 | |||
| 82 | 7 | protected function fixCurrencies($country) |
|
| 90 | |||
| 91 | /** |
||
| 92 | * Hydrate elements of a collection of countries. |
||
| 93 | * |
||
| 94 | * @param $countries |
||
| 95 | * @param $elements |
||
| 96 | * @return mixed |
||
| 97 | */ |
||
| 98 | 3 | private function hydrateCountries($countries, $elements = null) |
|
| 106 | |||
| 107 | /** |
||
| 108 | * Hydrate elements of a country. |
||
| 109 | * |
||
| 110 | * @param $country |
||
| 111 | * @param $elements |
||
| 112 | * @return mixed |
||
| 113 | */ |
||
| 114 | 20 | private function hydrateCountry($country, $elements) |
|
| 126 | |||
| 127 | /** |
||
| 128 | * Check if an element is a country. |
||
| 129 | * |
||
| 130 | * @param $element |
||
| 131 | * @return bool |
||
| 132 | */ |
||
| 133 | 20 | private function isCountry($element) |
|
| 137 | |||
| 138 | /** |
||
| 139 | * Check it's a currencies array or code. |
||
| 140 | * |
||
| 141 | * @param $data |
||
| 142 | * @return bool |
||
| 143 | */ |
||
| 144 | 7 | private function isCurrenciesArray($data) |
|
| 148 | |||
| 149 | /** |
||
| 150 | * Load the cities file and merge overloads. |
||
| 151 | * |
||
| 152 | * @param $country |
||
| 153 | * @return mixed |
||
| 154 | */ |
||
| 155 | 3 | private function loadCities($country) |
|
| 160 | |||
| 161 | /** |
||
| 162 | * Load the states file and merge overloads. |
||
| 163 | * |
||
| 164 | * @param $country |
||
| 165 | * @return mixed |
||
| 166 | */ |
||
| 167 | 8 | private function loadStates($country) |
|
| 172 | |||
| 173 | /** |
||
| 174 | * Load the taxes file and merge overloads. |
||
| 175 | * |
||
| 176 | * @param $country |
||
| 177 | * @return mixed |
||
| 178 | */ |
||
| 179 | 3 | private function loadTaxes($country) |
|
| 184 | |||
| 185 | /** |
||
| 186 | * Check if an element needs hydrated. |
||
| 187 | * |
||
| 188 | * @param $countryCode |
||
| 189 | * @param $element |
||
| 190 | * @param bool $enabled |
||
| 191 | * @return bool |
||
| 192 | */ |
||
| 193 | 20 | protected function needsHydration($countryCode, $element, $enabled = false) |
|
| 194 | { |
||
| 195 | 20 | if (! $this->canHydrate($element, $enabled, $countryCode)) { |
|
| 196 | return false; |
||
| 197 | } |
||
| 198 | |||
| 199 | 20 | return $this->updateHydrated($countryCode, $element); |
|
| 200 | } |
||
| 201 | |||
| 202 | /** |
||
| 203 | * Hydrate cities. |
||
| 204 | * |
||
| 205 | * @param $country |
||
| 206 | * @return mixed |
||
| 207 | */ |
||
| 208 | 3 | public function hydrateCities($country) |
|
| 214 | |||
| 215 | /** |
||
| 216 | * Hydrate states. |
||
| 217 | * |
||
| 218 | * @param $country |
||
| 219 | * @return mixed |
||
| 220 | */ |
||
| 221 | 8 | public function hydrateStates($country) |
|
| 227 | |||
| 228 | /** |
||
| 229 | * Hydrate taxes. |
||
| 230 | * |
||
| 231 | * @param $country |
||
| 232 | * @return Coollection |
||
| 233 | */ |
||
| 234 | 3 | public function hydrateTaxes($country) |
|
| 240 | |||
| 241 | /** |
||
| 242 | * Hydrate topoloy. |
||
| 243 | * |
||
| 244 | * @param $country |
||
| 245 | * @return mixed |
||
| 246 | */ |
||
| 247 | 2 | public function hydrateTopology($country) |
|
| 253 | |||
| 254 | /** |
||
| 255 | * Hydrate geometry. |
||
| 256 | * |
||
| 257 | * @param $country |
||
| 258 | * @return mixed |
||
| 259 | */ |
||
| 260 | 2 | public function hydrateGeometry($country) |
|
| 266 | |||
| 267 | /** |
||
| 268 | * Get hydration elements. |
||
| 269 | * |
||
| 270 | * @param $elements |
||
| 271 | * @return array|string|mixed |
||
| 272 | */ |
||
| 273 | 31 | protected function getHydrationElements($elements) |
|
| 283 | |||
| 284 | /** |
||
| 285 | * Hydrate flag. |
||
| 286 | * |
||
| 287 | * @param $country |
||
| 288 | * @return mixed |
||
| 289 | */ |
||
| 290 | 2 | public function hydrateFlag($country) |
|
| 298 | |||
| 299 | /** |
||
| 300 | * Hydrate borders. |
||
| 301 | * |
||
| 302 | * @param $country |
||
| 303 | * @return mixed |
||
| 304 | */ |
||
| 305 | 5 | public function hydrateBorders($country) |
|
| 315 | |||
| 316 | /** |
||
| 317 | * Hydrate timezones. |
||
| 318 | * |
||
| 319 | * @param $country |
||
| 320 | * @return mixed |
||
| 321 | */ |
||
| 322 | 5 | public function hydrateTimezones($country) |
|
| 326 | |||
| 327 | /** |
||
| 328 | * Hydrate all times for a country timezones. |
||
| 329 | * |
||
| 330 | * @param $country |
||
| 331 | * @return mixed |
||
| 332 | */ |
||
| 333 | 1 | public function hydrateTimezonesTimes($country) |
|
| 343 | |||
| 344 | /** |
||
| 345 | * Hydrate currencies. |
||
| 346 | * |
||
| 347 | * @param $country |
||
| 348 | * @return mixed |
||
| 349 | */ |
||
| 350 | 7 | public function hydrateCurrencies($country) |
|
| 374 | |||
| 375 | /** |
||
| 376 | * Hydrate a countries collection with languages. |
||
| 377 | * |
||
| 378 | * @param \PragmaRX\Coollection\Package\Coollection|array|\stdClass $target |
||
| 379 | * @param null $elements |
||
| 380 | * @return \PragmaRX\Coollection\Package\Coollection |
||
| 381 | */ |
||
| 382 | 31 | public function hydrate($target, $elements = null) |
|
| 394 | |||
| 395 | /** |
||
| 396 | * Get country by country code. |
||
| 397 | * |
||
| 398 | * @param $countryCode |
||
| 399 | * @return mixed |
||
| 400 | */ |
||
| 401 | 20 | public function getCountry($countryCode) |
|
| 405 | |||
| 406 | /** |
||
| 407 | * Check and create a country in the repository. |
||
| 408 | * |
||
| 409 | * @param $country |
||
| 410 | * @param $countryCode |
||
| 411 | */ |
||
| 412 | 20 | public function addCountry($countryCode, $country) |
|
| 418 | |||
| 419 | /** |
||
| 420 | * Hydrate a country element. |
||
| 421 | * |
||
| 422 | * @param $countryCode |
||
| 423 | * @param $element |
||
| 424 | * @param $enabled |
||
| 425 | */ |
||
| 426 | 20 | public function hydrateCountryElement($countryCode, $element, $enabled) |
|
| 432 | |||
| 433 | /** |
||
| 434 | * Check hydration elements. |
||
| 435 | * |
||
| 436 | * @param $elements |
||
| 437 | * @return static |
||
| 438 | */ |
||
| 439 | protected function checkHydrationElements($elements) |
||
| 454 | |||
| 455 | /** |
||
| 456 | * Repository setter. |
||
| 457 | * |
||
| 458 | * @param $repository |
||
| 459 | */ |
||
| 460 | 31 | public function setRepository($repository) |
|
| 464 | |||
| 465 | /** |
||
| 466 | * Update hydrated. |
||
| 467 | * |
||
| 468 | * @param $countryCode |
||
| 469 | * @param $element |
||
| 470 | * @return bool |
||
| 471 | */ |
||
| 472 | 20 | protected function updateHydrated($countryCode, $element) |
|
| 482 | } |
||
| 483 |
It seems like the method you are trying to call exists only in some of the possible types.
Let’s take a look at an example:
Available Fixes
Add an additional type-check:
Only allow a single type to be passed if the variable comes from a parameter: