bytic /
orm
Complex classes like Relation 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 Relation, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 26 | abstract class Relation |
||
| 27 | { |
||
| 28 | use HasManagerTrait; |
||
| 29 | |||
| 30 | /** |
||
| 31 | * @var |
||
| 32 | */ |
||
| 33 | protected $name = null; |
||
| 34 | |||
| 35 | /** |
||
| 36 | * @var string |
||
| 37 | */ |
||
| 38 | protected $type = 'relation'; |
||
| 39 | |||
| 40 | /** |
||
| 41 | * @var Record |
||
| 42 | */ |
||
| 43 | protected $item; |
||
| 44 | |||
| 45 | /** |
||
| 46 | * @var RecordManager |
||
| 47 | */ |
||
| 48 | protected $with = null; |
||
| 49 | |||
| 50 | /** |
||
| 51 | * @var null|string |
||
| 52 | */ |
||
| 53 | protected $table = null; |
||
| 54 | |||
| 55 | /** |
||
| 56 | * @var null|string |
||
| 57 | */ |
||
| 58 | protected $fk = null; |
||
| 59 | |||
| 60 | /** |
||
| 61 | * @var Query |
||
| 62 | */ |
||
| 63 | protected $query; |
||
| 64 | |||
| 65 | /** |
||
| 66 | * @var bool |
||
| 67 | */ |
||
| 68 | protected $populated = false; |
||
| 69 | |||
| 70 | /** |
||
| 71 | * @var array |
||
| 72 | */ |
||
| 73 | protected $params = []; |
||
| 74 | |||
| 75 | /** |
||
| 76 | * @var null|Collection|Record |
||
| 77 | */ |
||
| 78 | protected $results = null; |
||
| 79 | |||
| 80 | /** |
||
| 81 | * @return Query |
||
| 82 | * @throws Exception |
||
| 83 | */ |
||
| 84 | 1 | public function getQuery() |
|
| 85 | { |
||
| 86 | 1 | if ($this->query == null) { |
|
| 87 | 1 | $this->initQuery(); |
|
| 88 | } |
||
| 89 | |||
| 90 | 1 | return $this->query; |
|
| 91 | } |
||
| 92 | |||
| 93 | /** |
||
| 94 | * @param $query |
||
| 95 | * @return static |
||
| 96 | */ |
||
| 97 | public function setQuery($query) |
||
| 98 | { |
||
| 99 | $this->query = $query; |
||
| 100 | |||
| 101 | return $this; |
||
| 102 | } |
||
| 103 | |||
| 104 | /** |
||
| 105 | * @throws Exception |
||
| 106 | */ |
||
| 107 | 1 | public function initQuery() |
|
| 108 | { |
||
| 109 | 1 | $query = $this->newQuery(); |
|
| 110 | 1 | $this->populateQuerySpecific($query); |
|
| 111 | |||
| 112 | 1 | $this->query = $query; |
|
| 113 | 1 | } |
|
| 114 | |||
| 115 | /** |
||
| 116 | * @return Query |
||
| 117 | * @throws Exception |
||
| 118 | */ |
||
| 119 | 3 | public function newQuery() |
|
| 120 | { |
||
| 121 | 3 | return $this->getWith()->paramsToQuery(); |
|
| 122 | } |
||
| 123 | |||
| 124 | /** |
||
| 125 | * @return RecordManager |
||
| 126 | * @throws Exception |
||
| 127 | */ |
||
| 128 | 9 | public function getWith() |
|
| 129 | { |
||
| 130 | 9 | if ($this->with == null) { |
|
| 131 | 4 | $this->initWith(); |
|
| 132 | } |
||
| 133 | |||
| 134 | 9 | return $this->with; |
|
| 135 | } |
||
| 136 | |||
| 137 | /** |
||
| 138 | * @param RecordManager|HasRelationsRecordsTrait $object |
||
| 139 | * @return $this |
||
| 140 | */ |
||
| 141 | 9 | public function setWith($object) |
|
| 142 | { |
||
| 143 | 9 | $this->with = $object; |
|
|
|
|||
| 144 | |||
| 145 | 9 | return $this; |
|
| 146 | } |
||
| 147 | |||
| 148 | /** |
||
| 149 | * @throws Exception |
||
| 150 | */ |
||
| 151 | 4 | public function initWith() |
|
| 152 | { |
||
| 153 | 4 | $className = $this->getWithClass(); |
|
| 154 | 4 | $this->setWithClass($className); |
|
| 155 | 4 | } |
|
| 156 | |||
| 157 | /** |
||
| 158 | * @return string |
||
| 159 | */ |
||
| 160 | 3 | public function getWithClass() |
|
| 161 | { |
||
| 162 | 3 | return inflector()->pluralize($this->getName()); |
|
| 163 | } |
||
| 164 | |||
| 165 | /** |
||
| 166 | * @return mixed |
||
| 167 | * @throws RelationsNeedsAName |
||
| 168 | */ |
||
| 169 | 4 | public function getName() |
|
| 170 | { |
||
| 171 | 4 | if ($this->name === null) { |
|
| 172 | throw new RelationsNeedsAName(); |
||
| 173 | } |
||
| 174 | 4 | return $this->name; |
|
| 175 | } |
||
| 176 | |||
| 177 | /** |
||
| 178 | * @param string $name |
||
| 179 | */ |
||
| 180 | 9 | public function setName($name) |
|
| 181 | { |
||
| 182 | 9 | $this->name = $name; |
|
| 183 | 9 | } |
|
| 184 | |||
| 185 | /** |
||
| 186 | * @param string $name |
||
| 187 | * @throws Exception |
||
| 188 | */ |
||
| 189 | 4 | public function setWithClass($name) |
|
| 190 | { |
||
| 191 | try { |
||
| 192 | 4 | $manager = $this->getModelManagerInstance($name); |
|
| 193 | 4 | $this->setWith($manager); |
|
| 194 | } catch (InvalidModelException $exception) { |
||
| 195 | throw new Exception( |
||
| 196 | 'Cannot instance records [' . $name . '] in ' . $this->debugString() |
||
| 197 | . '|| with message ' . $exception->getMessage() |
||
| 198 | ); |
||
| 199 | } |
||
| 200 | 4 | } |
|
| 201 | |||
| 202 | /** |
||
| 203 | * @param $name |
||
| 204 | * @return RecordManager |
||
| 205 | * @throws InvalidModelException |
||
| 206 | */ |
||
| 207 | 4 | public function getModelManagerInstance($name) |
|
| 208 | { |
||
| 209 | 4 | return ModelLocator::get($name); |
|
| 210 | } |
||
| 211 | |||
| 212 | /** |
||
| 213 | * @return Record |
||
| 214 | */ |
||
| 215 | 8 | public function getItem() |
|
| 216 | { |
||
| 217 | 8 | return $this->item; |
|
| 218 | } |
||
| 219 | |||
| 220 | /** |
||
| 221 | * @param Record|HasRelationsRecordTrait $item |
||
| 222 | * @return $this |
||
| 223 | */ |
||
| 224 | 9 | public function setItem(Record $item) |
|
| 225 | { |
||
| 226 | 9 | $this->item = $item; |
|
| 227 | |||
| 228 | 9 | return $this; |
|
| 229 | } |
||
| 230 | |||
| 231 | /** |
||
| 232 | * @param AbstractQuery $query |
||
| 233 | */ |
||
| 234 | abstract public function populateQuerySpecific(AbstractQuery $query); |
||
| 235 | |||
| 236 | /** |
||
| 237 | * @return \Nip\Database\Query\Delete |
||
| 238 | * @throws Exception |
||
| 239 | */ |
||
| 240 | public function getDeleteQuery() |
||
| 241 | { |
||
| 242 | $query = $this->getWith()->newDeleteQuery(); |
||
| 243 | $this->populateQuerySpecific($query); |
||
| 244 | |||
| 245 | return $query; |
||
| 246 | } |
||
| 247 | |||
| 248 | /** |
||
| 249 | * @return Connection |
||
| 250 | */ |
||
| 251 | 1 | public function getDB() |
|
| 255 | |||
| 256 | /** |
||
| 257 | * @param $key |
||
| 258 | * @return mixed |
||
| 259 | */ |
||
| 260 | 2 | public function getParam($key) |
|
| 264 | |||
| 265 | /** |
||
| 266 | * @param $key |
||
| 267 | * @return boolean |
||
| 268 | */ |
||
| 269 | 2 | public function hasParam($key) |
|
| 273 | |||
| 274 | /** |
||
| 275 | * @param $params |
||
| 276 | * @throws Exception |
||
| 277 | */ |
||
| 278 | 3 | public function addParams($params) |
|
| 286 | |||
| 287 | /** |
||
| 288 | * @param $params |
||
| 289 | * @throws Exception |
||
| 290 | */ |
||
| 291 | 3 | public function checkParamClass($params) |
|
| 298 | |||
| 299 | /** |
||
| 300 | * @param $params |
||
| 301 | */ |
||
| 302 | 3 | public function checkParamWith($params) |
|
| 309 | |||
| 310 | /** |
||
| 311 | * @param $params |
||
| 312 | */ |
||
| 313 | 3 | public function checkParamTable($params) |
|
| 320 | |||
| 321 | /** |
||
| 322 | * @param $params |
||
| 323 | */ |
||
| 324 | 3 | public function checkParamFk($params) |
|
| 331 | |||
| 332 | /** |
||
| 333 | * @return array |
||
| 334 | */ |
||
| 335 | 1 | public function getParams(): array |
|
| 339 | |||
| 340 | /** |
||
| 341 | * @param $params |
||
| 342 | */ |
||
| 343 | 3 | public function setParams($params) |
|
| 347 | |||
| 348 | /** |
||
| 349 | * @return string |
||
| 350 | */ |
||
| 351 | 2 | public function getTable() |
|
| 359 | |||
| 360 | /** |
||
| 361 | * @param $name |
||
| 362 | */ |
||
| 363 | 2 | public function setTable($name) |
|
| 367 | |||
| 368 | 2 | protected function initTable() |
|
| 372 | |||
| 373 | /** |
||
| 374 | * @return string |
||
| 375 | * @throws Exception |
||
| 376 | */ |
||
| 377 | protected function generateTable() |
||
| 381 | |||
| 382 | /** |
||
| 383 | * Get the results of the relationship. |
||
| 384 | * @return Record|RecordCollection |
||
| 385 | */ |
||
| 386 | 3 | public function getResults() |
|
| 394 | |||
| 395 | /** |
||
| 396 | * @param $results |
||
| 397 | * @return null |
||
| 398 | */ |
||
| 399 | 3 | public function setResults($results) |
|
| 406 | |||
| 407 | /** |
||
| 408 | * @return bool |
||
| 409 | */ |
||
| 410 | 1 | public function isPopulatable() |
|
| 415 | |||
| 416 | /** |
||
| 417 | * @return bool |
||
| 418 | */ |
||
| 419 | 3 | public function isPopulated() |
|
| 423 | |||
| 424 | abstract public function initResults(); |
||
| 425 | |||
| 426 | /** |
||
| 427 | * @param RecordCollection $collection |
||
| 428 | * @return RecordCollection |
||
| 429 | * @throws Exception |
||
| 430 | */ |
||
| 431 | public function getEagerResults($collection) |
||
| 440 | |||
| 441 | /** |
||
| 442 | * @param RecordCollection $collection |
||
| 443 | * @return Query |
||
| 444 | * @throws Exception |
||
| 445 | */ |
||
| 446 | 2 | public function getEagerQuery(RecordCollection $collection) |
|
| 452 | |||
| 453 | /** |
||
| 454 | * @param Query $query |
||
| 455 | * @param array $fkList |
||
| 456 | * @return Query |
||
| 457 | * @throws Exception |
||
| 458 | */ |
||
| 459 | 1 | protected function populateEagerQueryFromFkList($query, $fkList) |
|
| 465 | |||
| 466 | /** |
||
| 467 | * @param RecordCollection $collection |
||
| 468 | * @return array |
||
| 469 | */ |
||
| 470 | 2 | public function getEagerFkList(RecordCollection $collection) |
|
| 478 | |||
| 479 | /** |
||
| 480 | * @return string |
||
| 481 | */ |
||
| 482 | 12 | public function getFK() |
|
| 490 | |||
| 491 | /** |
||
| 492 | * @param $name |
||
| 493 | */ |
||
| 494 | 12 | public function setFK($name) |
|
| 498 | |||
| 499 | 12 | protected function initFK() |
|
| 503 | |||
| 504 | /** |
||
| 505 | * @return string |
||
| 506 | */ |
||
| 507 | protected function generateFK() |
||
| 511 | |||
| 512 | /** |
||
| 513 | * @return string |
||
| 514 | * @throws Exception |
||
| 515 | */ |
||
| 516 | 1 | public function getWithPK() |
|
| 520 | |||
| 521 | /** |
||
| 522 | * @param RecordCollection $collection |
||
| 523 | * @param RecordCollection $recordsLoaded |
||
| 524 | * |
||
| 525 | * @return RecordCollection |
||
| 526 | */ |
||
| 527 | public function match(RecordCollection $collection, RecordCollection $recordsLoaded) |
||
| 539 | |||
| 540 | /** |
||
| 541 | * Build model dictionary keyed by the relation's foreign key. |
||
| 542 | * |
||
| 543 | * @param RecordCollection $collection |
||
| 544 | * @return array |
||
| 545 | */ |
||
| 546 | abstract protected function buildDictionary(RecordCollection $collection); |
||
| 547 | |||
| 548 | /** |
||
| 549 | * @param $dictionary |
||
| 550 | * @param Collection $collection |
||
| 551 | * @param Record $record |
||
| 552 | * @return mixed |
||
| 553 | */ |
||
| 554 | abstract public function getResultsFromCollectionDictionary($dictionary, $collection, $record); |
||
| 555 | |||
| 556 | public function save() |
||
| 559 | |||
| 560 | /** |
||
| 561 | * @return string |
||
| 562 | */ |
||
| 563 | public function getType() |
||
| 567 | |||
| 568 | /** |
||
| 569 | * @return string |
||
| 570 | */ |
||
| 571 | 1 | protected function debugString() |
|
| 578 | } |
||
| 579 |
Loading history...
Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.
For example, imagine you have a variable
$accountIdthat can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to theidproperty of an instance of theAccountclass. This class holds a proper account, so the id value must no longer be false.Either this assignment is in error or a type check should be added for that assignment.