Complex classes like Configuration 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 Configuration, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 21 | class Configuration extends AbstractModel implements ConfigurationInterface |
||
| 22 | { |
||
| 23 | /** |
||
| 24 | * Type. |
||
| 25 | * |
||
| 26 | * @var string |
||
| 27 | * @DatabaseField("string") |
||
| 28 | */ |
||
| 29 | protected $type = self::TYPE_TIME; |
||
| 30 | |||
| 31 | /** |
||
| 32 | * Handling. |
||
| 33 | * |
||
| 34 | * @var string |
||
| 35 | * @DatabaseField("string") |
||
| 36 | */ |
||
| 37 | protected $handling = self::HANDLING_INCLUDE; |
||
| 38 | |||
| 39 | /** |
||
| 40 | * State. |
||
| 41 | * |
||
| 42 | * @var string |
||
| 43 | * @DatabaseField("string") |
||
| 44 | */ |
||
| 45 | protected $state = self::STATE_DEFAULT; |
||
| 46 | |||
| 47 | /** |
||
| 48 | * Start date. |
||
| 49 | * |
||
| 50 | * @var \DateTime |
||
| 51 | * @DatabaseField(type="\DateTime", sql="date default NULL") |
||
| 52 | */ |
||
| 53 | protected $startDate; |
||
| 54 | |||
| 55 | /** |
||
| 56 | * End date. |
||
| 57 | * |
||
| 58 | * @var \DateTime |
||
| 59 | * @DatabaseField(type="\DateTime", sql="date default NULL") |
||
| 60 | */ |
||
| 61 | protected $endDate; |
||
| 62 | |||
| 63 | /** |
||
| 64 | * End date dynamic. |
||
| 65 | * |
||
| 66 | * @var string |
||
| 67 | * @DatabaseField("string") |
||
| 68 | */ |
||
| 69 | protected $endDateDynamic; |
||
| 70 | |||
| 71 | /** |
||
| 72 | * Start time. |
||
| 73 | * |
||
| 74 | * @var int |
||
| 75 | * @DatabaseField("int") |
||
| 76 | */ |
||
| 77 | protected $startTime; |
||
| 78 | |||
| 79 | /** |
||
| 80 | * End time. |
||
| 81 | * |
||
| 82 | * @var int |
||
| 83 | * @DatabaseField("int") |
||
| 84 | */ |
||
| 85 | protected $endTime; |
||
| 86 | |||
| 87 | /** |
||
| 88 | * AllDay. |
||
| 89 | * |
||
| 90 | * @var bool |
||
| 91 | * @DatabaseField("bool") |
||
| 92 | */ |
||
| 93 | protected $allDay; |
||
| 94 | |||
| 95 | /** |
||
| 96 | * OpenEndTime. |
||
| 97 | * |
||
| 98 | * @var bool |
||
| 99 | * @DatabaseField("bool") |
||
| 100 | */ |
||
| 101 | protected $openEndTime; |
||
| 102 | |||
| 103 | /** |
||
| 104 | * External ICS url. |
||
| 105 | * |
||
| 106 | * @var string |
||
| 107 | * @DatabaseField("string") |
||
| 108 | */ |
||
| 109 | protected $externalIcsUrl; |
||
| 110 | |||
| 111 | /** |
||
| 112 | * Groups. |
||
| 113 | * |
||
| 114 | * @var \TYPO3\CMS\Extbase\Persistence\ObjectStorage<\HDNET\Calendarize\Domain\Model\ConfigurationGroup> |
||
| 115 | * @DatabaseField("\TYPO3\CMS\Extbase\Persistence\ObjectStorage") |
||
| 116 | * @TYPO3\CMS\Extbase\Annotation\ORM\Lazy |
||
| 117 | */ |
||
| 118 | protected $groups; |
||
| 119 | |||
| 120 | /** |
||
| 121 | * Frequency. |
||
| 122 | * |
||
| 123 | * @var string |
||
| 124 | * @DatabaseField("string") |
||
| 125 | */ |
||
| 126 | protected $frequency = self::FREQUENCY_NONE; |
||
| 127 | |||
| 128 | /** |
||
| 129 | * Till date. |
||
| 130 | * |
||
| 131 | * @var \DateTime|null |
||
| 132 | * @DatabaseField(type="\DateTime", sql="date default NULL") |
||
| 133 | */ |
||
| 134 | protected $tillDate; |
||
| 135 | |||
| 136 | /** |
||
| 137 | * Till days. |
||
| 138 | * |
||
| 139 | * @var int |
||
| 140 | * @DatabaseField(sql="int(11)") |
||
| 141 | */ |
||
| 142 | protected $tillDays; |
||
| 143 | |||
| 144 | /** |
||
| 145 | * Till days relative. |
||
| 146 | * |
||
| 147 | * @var bool |
||
| 148 | * @DatabaseField("Boolean") |
||
| 149 | */ |
||
| 150 | protected $tillDaysRelative; |
||
| 151 | |||
| 152 | /** |
||
| 153 | * Till days past. |
||
| 154 | * |
||
| 155 | * @var int |
||
| 156 | * @DatabaseField(sql="int(11)") |
||
| 157 | */ |
||
| 158 | protected $tillDaysPast; |
||
| 159 | |||
| 160 | /** |
||
| 161 | * Counter amount. |
||
| 162 | * |
||
| 163 | * @var int |
||
| 164 | * @DatabaseField("int") |
||
| 165 | */ |
||
| 166 | protected $counterAmount; |
||
| 167 | |||
| 168 | /** |
||
| 169 | * Counter interval. |
||
| 170 | * |
||
| 171 | * @var int |
||
| 172 | * @DatabaseField("int") |
||
| 173 | */ |
||
| 174 | protected $counterInterval; |
||
| 175 | |||
| 176 | /** |
||
| 177 | * Recurrence. |
||
| 178 | * |
||
| 179 | * @var string |
||
| 180 | * @DatabaseField("string") |
||
| 181 | */ |
||
| 182 | protected $recurrence = self::RECURRENCE_NONE; |
||
| 183 | |||
| 184 | /** |
||
| 185 | * Day property. |
||
| 186 | * |
||
| 187 | * @var string |
||
| 188 | * @DatabaseField("string") |
||
| 189 | */ |
||
| 190 | protected $day = self::DAY_NONE; |
||
| 191 | |||
| 192 | /** |
||
| 193 | * Import ID if the item is based on an ICS structure. |
||
| 194 | * |
||
| 195 | * @var string|null |
||
| 196 | * @DatabaseField("string") |
||
| 197 | */ |
||
| 198 | protected $importId; |
||
| 199 | |||
| 200 | /** |
||
| 201 | * Configuration constructor. |
||
| 202 | */ |
||
| 203 | public function __construct() |
||
| 207 | |||
| 208 | /** |
||
| 209 | * Get type. |
||
| 210 | * |
||
| 211 | * @return string |
||
| 212 | */ |
||
| 213 | public function getType() |
||
| 217 | |||
| 218 | /** |
||
| 219 | * Set type. |
||
| 220 | * |
||
| 221 | * @param string $type |
||
| 222 | */ |
||
| 223 | public function setType($type) |
||
| 227 | |||
| 228 | /** |
||
| 229 | * Is all day. |
||
| 230 | * |
||
| 231 | * @return bool |
||
| 232 | */ |
||
| 233 | public function isAllDay() |
||
| 237 | |||
| 238 | /** |
||
| 239 | * Set all day. |
||
| 240 | * |
||
| 241 | * @param bool $allDay |
||
| 242 | */ |
||
| 243 | public function setAllDay($allDay) |
||
| 247 | |||
| 248 | /** |
||
| 249 | * Get end date. |
||
| 250 | * |
||
| 251 | * @return \DateTime |
||
| 252 | */ |
||
| 253 | public function getEndDate() |
||
| 261 | |||
| 262 | /** |
||
| 263 | * Set end date. |
||
| 264 | * |
||
| 265 | * @param \DateTime $endDate |
||
| 266 | */ |
||
| 267 | public function setEndDate($endDate) |
||
| 271 | |||
| 272 | /** |
||
| 273 | * Get end date dynamic. |
||
| 274 | * |
||
| 275 | * @return string |
||
| 276 | */ |
||
| 277 | public function getEndDateDynamic() |
||
| 281 | |||
| 282 | /** |
||
| 283 | * Set end date dynamic. |
||
| 284 | * |
||
| 285 | * @param string $endDateDynamic |
||
| 286 | */ |
||
| 287 | public function setEndDateDynamic($endDateDynamic) |
||
| 291 | |||
| 292 | /** |
||
| 293 | * Get end time. |
||
| 294 | * |
||
| 295 | * @return int |
||
| 296 | */ |
||
| 297 | public function getEndTime() |
||
| 301 | |||
| 302 | /** |
||
| 303 | * Set end time. |
||
| 304 | * |
||
| 305 | * @param int $endTime |
||
| 306 | */ |
||
| 307 | public function setEndTime($endTime) |
||
| 311 | |||
| 312 | /** |
||
| 313 | * Get start date. |
||
| 314 | * |
||
| 315 | * @return \DateTime |
||
| 316 | */ |
||
| 317 | public function getStartDate() |
||
| 325 | |||
| 326 | /** |
||
| 327 | * Set start date. |
||
| 328 | * |
||
| 329 | * @param \DateTime $startDate |
||
| 330 | */ |
||
| 331 | public function setStartDate($startDate) |
||
| 335 | |||
| 336 | /** |
||
| 337 | * Get start time. |
||
| 338 | * |
||
| 339 | * @return int |
||
| 340 | */ |
||
| 341 | public function getStartTime() |
||
| 345 | |||
| 346 | /** |
||
| 347 | * Set start time. |
||
| 348 | * |
||
| 349 | * @param int $startTime |
||
| 350 | */ |
||
| 351 | public function setStartTime($startTime) |
||
| 355 | |||
| 356 | /** |
||
| 357 | * Get groups. |
||
| 358 | * |
||
| 359 | * @return \TYPO3\CMS\Extbase\Persistence\ObjectStorage |
||
| 360 | */ |
||
| 361 | public function getGroups() |
||
| 369 | |||
| 370 | /** |
||
| 371 | * Set groups. |
||
| 372 | * |
||
| 373 | * @param \TYPO3\CMS\Extbase\Persistence\ObjectStorage $groups |
||
| 374 | */ |
||
| 375 | public function setGroups($groups) |
||
| 379 | |||
| 380 | /** |
||
| 381 | * Get frequency. |
||
| 382 | * |
||
| 383 | * @return string |
||
| 384 | */ |
||
| 385 | public function getFrequency() |
||
| 389 | |||
| 390 | /** |
||
| 391 | * Set frequency. |
||
| 392 | * |
||
| 393 | * @param string $frequency |
||
| 394 | */ |
||
| 395 | public function setFrequency($frequency) |
||
| 399 | |||
| 400 | /** |
||
| 401 | * Get till date. |
||
| 402 | * |
||
| 403 | * @return \DateTime|null |
||
| 404 | */ |
||
| 405 | public function getTillDate() |
||
| 409 | |||
| 410 | /** |
||
| 411 | * Set till date. |
||
| 412 | * |
||
| 413 | * @param \DateTime|null $tillDate |
||
| 414 | */ |
||
| 415 | public function setTillDate($tillDate) |
||
| 419 | |||
| 420 | /** |
||
| 421 | * Get till days. |
||
| 422 | * |
||
| 423 | * @return int |
||
| 424 | */ |
||
| 425 | public function getTillDays() |
||
| 429 | |||
| 430 | /** |
||
| 431 | * Set till days. |
||
| 432 | * |
||
| 433 | * @param int $tillDays |
||
| 434 | */ |
||
| 435 | public function setTillDays(int $tillDays) |
||
| 439 | |||
| 440 | /** |
||
| 441 | * Is till days relative. |
||
| 442 | * |
||
| 443 | * @return bool |
||
| 444 | */ |
||
| 445 | public function isTillDaysRelative() |
||
| 449 | |||
| 450 | /** |
||
| 451 | * Set till days relative. |
||
| 452 | * |
||
| 453 | * @param bool $tillDaysRelative |
||
| 454 | */ |
||
| 455 | public function setTillDaysRelative(bool $tillDaysRelative) |
||
| 459 | |||
| 460 | /** |
||
| 461 | * Get till days past. |
||
| 462 | * |
||
| 463 | * @return int |
||
| 464 | */ |
||
| 465 | public function getTillDaysPast() |
||
| 469 | |||
| 470 | /** |
||
| 471 | * Set till days past. |
||
| 472 | * |
||
| 473 | * @param int $tillDaysPast |
||
| 474 | */ |
||
| 475 | public function setTillDaysPast(int $tillDaysPast) |
||
| 479 | |||
| 480 | /** |
||
| 481 | * Get counter amount. |
||
| 482 | * |
||
| 483 | * @return int |
||
| 484 | */ |
||
| 485 | public function getCounterAmount() |
||
| 489 | |||
| 490 | /** |
||
| 491 | * Set counter amount. |
||
| 492 | * |
||
| 493 | * @param int $counterAmount |
||
| 494 | */ |
||
| 495 | public function setCounterAmount($counterAmount) |
||
| 499 | |||
| 500 | /** |
||
| 501 | * Get counter interval. |
||
| 502 | * |
||
| 503 | * @return int |
||
| 504 | */ |
||
| 505 | public function getCounterInterval() |
||
| 509 | |||
| 510 | /** |
||
| 511 | * Set counter interval. |
||
| 512 | * |
||
| 513 | * @param int $counterInterval |
||
| 514 | */ |
||
| 515 | public function setCounterInterval($counterInterval) |
||
| 519 | |||
| 520 | /** |
||
| 521 | * Get external ICS URL. |
||
| 522 | * |
||
| 523 | * @return string |
||
| 524 | */ |
||
| 525 | public function getExternalIcsUrl() |
||
| 529 | |||
| 530 | /** |
||
| 531 | * Set external ICS URL. |
||
| 532 | * |
||
| 533 | * @param string $externalIcsUrl |
||
| 534 | */ |
||
| 535 | public function setExternalIcsUrl($externalIcsUrl) |
||
| 539 | |||
| 540 | /** |
||
| 541 | * Get day. |
||
| 542 | * |
||
| 543 | * @return string |
||
| 544 | */ |
||
| 545 | public function getDay() |
||
| 549 | |||
| 550 | /** |
||
| 551 | * Set day. |
||
| 552 | * |
||
| 553 | * @param string $day |
||
| 554 | */ |
||
| 555 | public function setDay($day) |
||
| 559 | |||
| 560 | /** |
||
| 561 | * Get recurrence. |
||
| 562 | * |
||
| 563 | * @return string |
||
| 564 | */ |
||
| 565 | public function getRecurrence() |
||
| 569 | |||
| 570 | /** |
||
| 571 | * Set recurrence. |
||
| 572 | * |
||
| 573 | * @param string $recurrence |
||
| 574 | */ |
||
| 575 | public function setRecurrence($recurrence) |
||
| 579 | |||
| 580 | /** |
||
| 581 | * Get handling. |
||
| 582 | * |
||
| 583 | * @return string |
||
| 584 | */ |
||
| 585 | public function getHandling() |
||
| 589 | |||
| 590 | /** |
||
| 591 | * Set handling. |
||
| 592 | * |
||
| 593 | * @param string $handling |
||
| 594 | */ |
||
| 595 | public function setHandling($handling) |
||
| 599 | |||
| 600 | /** |
||
| 601 | * Get state. |
||
| 602 | * |
||
| 603 | * @return string |
||
| 604 | */ |
||
| 605 | public function getState() |
||
| 609 | |||
| 610 | /** |
||
| 611 | * Set state. |
||
| 612 | * |
||
| 613 | * @param string $state |
||
| 614 | */ |
||
| 615 | public function setState($state) |
||
| 619 | |||
| 620 | /** |
||
| 621 | * @return bool |
||
| 622 | */ |
||
| 623 | public function isOpenEndTime() |
||
| 627 | |||
| 628 | /** |
||
| 629 | * @param bool $openEndTime |
||
| 630 | */ |
||
| 631 | public function setOpenEndTime(bool $openEndTime) |
||
| 635 | |||
| 636 | /** |
||
| 637 | * @return string|null |
||
| 638 | */ |
||
| 639 | public function getImportId(): ?string |
||
| 643 | |||
| 644 | /** |
||
| 645 | * @param string|null $importId |
||
| 646 | */ |
||
| 647 | public function setImportId(?string $importId): void |
||
| 651 | } |
||
| 652 |