derhansen /
sf_event_mgt
Complex classes like RegistrationService 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 RegistrationService, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 31 | class RegistrationService |
||
| 32 | { |
||
| 33 | /** |
||
| 34 | * The object manager |
||
| 35 | * |
||
| 36 | * @var \TYPO3\CMS\Extbase\Object\ObjectManager |
||
| 37 | * */ |
||
| 38 | protected $objectManager; |
||
| 39 | |||
| 40 | /** |
||
| 41 | * @var EventDispatcherInterface |
||
| 42 | */ |
||
| 43 | protected $eventDispatcher; |
||
| 44 | |||
| 45 | /** |
||
| 46 | * RegistrationRepository |
||
| 47 | * |
||
| 48 | * @var \DERHANSEN\SfEventMgt\Domain\Repository\RegistrationRepository |
||
| 49 | * */ |
||
| 50 | protected $registrationRepository; |
||
| 51 | |||
| 52 | /** |
||
| 53 | * FrontendUserRepository |
||
| 54 | * |
||
| 55 | * @var \TYPO3\CMS\Extbase\Domain\Repository\FrontendUserRepository |
||
| 56 | * */ |
||
| 57 | protected $frontendUserRepository; |
||
| 58 | |||
| 59 | /** |
||
| 60 | * Hash Service |
||
| 61 | * |
||
| 62 | * @var \TYPO3\CMS\Extbase\Security\Cryptography\HashService |
||
| 63 | * */ |
||
| 64 | protected $hashService; |
||
| 65 | |||
| 66 | /** |
||
| 67 | * Payment Service |
||
| 68 | * |
||
| 69 | * @var \DERHANSEN\SfEventMgt\Service\PaymentService |
||
| 70 | * */ |
||
| 71 | protected $paymentService; |
||
| 72 | |||
| 73 | /** |
||
| 74 | * Notification Service |
||
| 75 | * |
||
| 76 | * @var \DERHANSEN\SfEventMgt\Service\NotificationService |
||
| 77 | */ |
||
| 78 | protected $notificationService; |
||
| 79 | |||
| 80 | /** |
||
| 81 | * DI for $frontendUserRepository |
||
| 82 | * |
||
| 83 | * @param \TYPO3\CMS\Extbase\Domain\Repository\FrontendUserRepository $frontendUserRepository |
||
| 84 | */ |
||
| 85 | public function injectFrontendUserRepository( |
||
| 90 | |||
| 91 | /** |
||
| 92 | * DI for $hashService |
||
| 93 | * |
||
| 94 | * @param \TYPO3\CMS\Extbase\Security\Cryptography\HashService $hashService |
||
| 95 | */ |
||
| 96 | public function injectHashService(\TYPO3\CMS\Extbase\Security\Cryptography\HashService $hashService) |
||
| 100 | |||
| 101 | /** |
||
| 102 | * @param \DERHANSEN\SfEventMgt\Service\NotificationService $notificationService |
||
| 103 | */ |
||
| 104 | public function injectNotificationService(\DERHANSEN\SfEventMgt\Service\NotificationService $notificationService) |
||
| 108 | |||
| 109 | /** |
||
| 110 | * DI for $objectManager |
||
| 111 | * |
||
| 112 | * @param \TYPO3\CMS\Extbase\Object\ObjectManager $objectManager |
||
| 113 | */ |
||
| 114 | public function injectObjectManager(\TYPO3\CMS\Extbase\Object\ObjectManager $objectManager) |
||
| 118 | |||
| 119 | /** |
||
| 120 | * @param EventDispatcherInterface $eventDispatcher |
||
| 121 | */ |
||
| 122 | public function injectEventDispatcher(EventDispatcherInterface $eventDispatcher) |
||
| 126 | |||
| 127 | /** |
||
| 128 | * DI for $paymentService |
||
| 129 | * |
||
| 130 | * @param \DERHANSEN\SfEventMgt\Service\PaymentService $paymentService |
||
| 131 | */ |
||
| 132 | public function injectPaymentService(\DERHANSEN\SfEventMgt\Service\PaymentService $paymentService) |
||
| 136 | |||
| 137 | /** |
||
| 138 | * DI for $registrationRepository |
||
| 139 | * |
||
| 140 | * @param \DERHANSEN\SfEventMgt\Domain\Repository\RegistrationRepository $registrationRepository |
||
| 141 | */ |
||
| 142 | public function injectRegistrationRepository( |
||
| 147 | |||
| 148 | /** |
||
| 149 | * Duplicates (all public accessable properties) the given registration the |
||
| 150 | * amount of times configured in amountOfRegistrations |
||
| 151 | * |
||
| 152 | * @param \DERHANSEN\SfEventMgt\Domain\Model\Registration $registration Registration |
||
| 153 | */ |
||
| 154 | public function createDependingRegistrations($registration) |
||
| 171 | |||
| 172 | /** |
||
| 173 | * Confirms all depending registrations based on the given main registration |
||
| 174 | * |
||
| 175 | * @param \DERHANSEN\SfEventMgt\Domain\Model\Registration $registration Registration |
||
| 176 | */ |
||
| 177 | public function confirmDependingRegistrations($registration) |
||
| 186 | |||
| 187 | /** |
||
| 188 | * Checks if the registration can be confirmed and returns an array of variables |
||
| 189 | * |
||
| 190 | * @param int $reguid UID of registration |
||
| 191 | * @param string $hmac HMAC for parameters |
||
| 192 | * |
||
| 193 | * @return array |
||
| 194 | */ |
||
| 195 | public function checkConfirmRegistration($reguid, $hmac) |
||
| 241 | |||
| 242 | /** |
||
| 243 | * Cancels all depending registrations based on the given main registration |
||
| 244 | * |
||
| 245 | * @param \DERHANSEN\SfEventMgt\Domain\Model\Registration $registration Registration |
||
| 246 | */ |
||
| 247 | public function cancelDependingRegistrations($registration) |
||
| 254 | |||
| 255 | /** |
||
| 256 | * Checks if the registration can be cancelled and returns an array of variables |
||
| 257 | * |
||
| 258 | * @param int $reguid UID of registration |
||
| 259 | * @param string $hmac HMAC for parameters |
||
| 260 | * |
||
| 261 | * @return array |
||
| 262 | */ |
||
| 263 | public function checkCancelRegistration($reguid, $hmac) |
||
| 312 | |||
| 313 | /** |
||
| 314 | * Returns the current frontend user object if available |
||
| 315 | * |
||
| 316 | * @return mixed \TYPO3\CMS\Extbase\Domain\Model\FrontendUser|null |
||
| 317 | */ |
||
| 318 | public function getCurrentFeUserObject() |
||
| 326 | |||
| 327 | /** |
||
| 328 | * Checks, if the registration can successfully be created. Note, that |
||
| 329 | * $result is passed by reference! |
||
| 330 | * |
||
| 331 | * @param \DERHANSEN\SfEventMgt\Domain\Model\Event $event Event |
||
| 332 | * @param \DERHANSEN\SfEventMgt\Domain\Model\Registration $registration Registration |
||
| 333 | * @param int $result Result |
||
| 334 | * |
||
| 335 | * @return array |
||
| 336 | */ |
||
| 337 | public function checkRegistrationSuccess($event, $registration, $result) |
||
| 375 | |||
| 376 | /** |
||
| 377 | * Returns if the given email is registered to the given event |
||
| 378 | * |
||
| 379 | * @param \DERHANSEN\SfEventMgt\Domain\Model\Event $event |
||
| 380 | * @param string $email |
||
| 381 | * @return bool |
||
| 382 | */ |
||
| 383 | protected function emailNotUnique($event, $email) |
||
| 405 | |||
| 406 | /** |
||
| 407 | * Returns, if payment redirect for the payment method is enabled |
||
| 408 | * |
||
| 409 | * @param Registration $registration |
||
| 410 | * @return bool |
||
| 411 | */ |
||
| 412 | public function redirectPaymentEnabled($registration) |
||
| 426 | |||
| 427 | /** |
||
| 428 | * Returns if the given amount of registrations for the event will be registrations for the waitlist |
||
| 429 | * (depending on the total amount of registrations and free places) |
||
| 430 | * |
||
| 431 | * @param \DERHANSEN\SfEventMgt\Domain\Model\Event $event |
||
| 432 | * @param int $amountOfRegistrations |
||
| 433 | * @return bool |
||
| 434 | */ |
||
| 435 | public function isWaitlistRegistration($event, $amountOfRegistrations) |
||
| 449 | |||
| 450 | /** |
||
| 451 | * Fixes the event uid of a registration if the event has been saved as a child of a translated event. |
||
| 452 | * |
||
| 453 | * Since TYPO3 9.5 (#82363), registrations for events are saved to the translated event record |
||
| 454 | * |
||
| 455 | * Example: |
||
| 456 | * |
||
| 457 | * When a registration is saved for a translated event, the registration $registration->setEvent($event) will |
||
| 458 | * now save the UID of the translated event instead of the uid of the event in default language. |
||
| 459 | * |
||
| 460 | * This behavior breaks limitations on events (e.g. max participants). Therefore, the registration must always |
||
| 461 | * be related to the default event language (Extbase behavior before TYPO3 9.5) |
||
| 462 | * |
||
| 463 | * @param Registration $registration |
||
| 464 | * @param Event $event |
||
| 465 | */ |
||
| 466 | public function fixRegistrationEvent(Registration $registration, Event $event) |
||
| 475 | |||
| 476 | /** |
||
| 477 | * Ensures, that the field "sys_language_uid" for registration fields values has the same value as the |
||
| 478 | * language of the registration and event. This is required, so emails include registration field values |
||
| 479 | * and correct registration field labels in their translated state. |
||
| 480 | * |
||
| 481 | * @param Registration $registration |
||
| 482 | * @param Event $event |
||
| 483 | */ |
||
| 484 | public function fixRegistationFieldValueLanguage(Registration $registration, Event $event) |
||
| 493 | |||
| 494 | /** |
||
| 495 | * Updates the field "sys_language_uid" for all registration field values of the given registration |
||
| 496 | * |
||
| 497 | * @param Registration $registration |
||
| 498 | * @param int $sysLanguageUid |
||
| 499 | */ |
||
| 500 | protected function updateRegistrationFieldValueLanguage(Registration $registration, int $sysLanguageUid) |
||
| 514 | |||
| 515 | /** |
||
| 516 | * Sets the "event" field of the given registration to the uid of the given event |
||
| 517 | * |
||
| 518 | * @param Registration $registration |
||
| 519 | * @param Event $event |
||
| 520 | */ |
||
| 521 | protected function updateRegistrationEventUid(Registration $registration, Event $event) |
||
| 535 | |||
| 536 | /** |
||
| 537 | * Updates registration/waitlist registration counters for the given event |
||
| 538 | * |
||
| 539 | * @param Event $event |
||
| 540 | */ |
||
| 541 | protected function updateEventRegistrationCounters(Event $event) |
||
| 566 | |||
| 567 | /** |
||
| 568 | * Returns the total amount of registrations/waitlist registrations for an event |
||
| 569 | * |
||
| 570 | * @param Event $event |
||
| 571 | * @param int $waitlist |
||
| 572 | * @return mixed |
||
| 573 | */ |
||
| 574 | protected function getEventRegistrationCount(Event $event, int $waitlist = 0) |
||
| 595 | |||
| 596 | /** |
||
| 597 | * Handles the process of moving registration up from the waitlist. |
||
| 598 | * |
||
| 599 | * @param Event $event |
||
| 600 | * @param array $settings |
||
| 601 | */ |
||
| 602 | public function moveUpWaitlistRegistrations(Event $event, array $settings) |
||
| 641 | } |
||
| 642 |
Loading history...
This method has been deprecated. The supplier of the class has supplied an explanatory message.
The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.