WebhookRegister.php
108 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\PaymentGateways\PayPalCommerce\Webhooks; |
| 4 | |
| 5 | use Give\Framework\Exceptions\Primitives\InvalidArgumentException; |
| 6 | use Give\PaymentGateways\PayPalCommerce\Webhooks\Listeners\EventListener; |
| 7 | use Give\PaymentGateways\PayPalCommerce\Webhooks\Listeners\PayPalCommerce\PaymentCaptureCompleted; |
| 8 | use Give\PaymentGateways\PayPalCommerce\Webhooks\Listeners\PayPalCommerce\PaymentCaptureDenied; |
| 9 | use Give\PaymentGateways\PayPalCommerce\Webhooks\Listeners\PayPalCommerce\PaymentCaptureRefunded; |
| 10 | |
| 11 | class WebhookRegister |
| 12 | { |
| 13 | /** |
| 14 | * Array of the PayPal webhook event handlers. Add-ons can use the registerEventHandler method |
| 15 | * to add additional events/handlers. |
| 16 | * |
| 17 | * Structure: PayPalEventName => EventHandlerClass |
| 18 | * |
| 19 | * @since 2.9.0 |
| 20 | * |
| 21 | * @var string[] |
| 22 | */ |
| 23 | private $eventHandlers = [ |
| 24 | 'PAYMENT.CAPTURE.REFUNDED' => PaymentCaptureRefunded::class, |
| 25 | 'PAYMENT.CAPTURE.COMPLETED' => PaymentCaptureCompleted::class, |
| 26 | 'PAYMENT.CAPTURE.DENIED' => PaymentCaptureDenied::class, |
| 27 | ]; |
| 28 | |
| 29 | /** |
| 30 | * Use this to register additional events and handlers |
| 31 | * |
| 32 | * @since 2.9.0 |
| 33 | * |
| 34 | * @param string $payPalEvent PayPal event to listen for, i.e. CHECKOUT.ORDER.APPROVED |
| 35 | * @param string $eventHandler The FQCN of the event handler |
| 36 | * |
| 37 | * @return $this |
| 38 | */ |
| 39 | public function registerEventHandler($payPalEvent, $eventHandler) |
| 40 | { |
| 41 | if (isset($this->eventHandlers[$payPalEvent])) { |
| 42 | throw new InvalidArgumentException('Cannot register an already registered event'); |
| 43 | } |
| 44 | |
| 45 | if ( ! is_subclass_of($eventHandler, EventListener::class)) { |
| 46 | throw new InvalidArgumentException('Listener must be a subclass of ' . EventListener::class); |
| 47 | } |
| 48 | |
| 49 | $this->eventHandlers[$payPalEvent] = $eventHandler; |
| 50 | |
| 51 | return $this; |
| 52 | } |
| 53 | |
| 54 | /** |
| 55 | * Registers multiple event handlers using an array where the key is the |
| 56 | * |
| 57 | * @since 2.9.0 |
| 58 | * |
| 59 | * @param array $handlers = [ 'PAYPAL.EVENT' => EventHandler::class ] |
| 60 | */ |
| 61 | public function registerEventHandlers(array $handlers) |
| 62 | { |
| 63 | foreach ($handlers as $event => $handler) { |
| 64 | $this->registerEventHandler($event, $handler); |
| 65 | } |
| 66 | } |
| 67 | |
| 68 | /** |
| 69 | * Returns Event Listener instance for given event |
| 70 | * |
| 71 | * @since 2.9.0 |
| 72 | * |
| 73 | * @param string $event |
| 74 | * |
| 75 | * @return EventListener |
| 76 | */ |
| 77 | public function getEventHandler($event) |
| 78 | { |
| 79 | return give($this->eventHandlers[$event]); |
| 80 | } |
| 81 | |
| 82 | /** |
| 83 | * Checks whether the given event is registered |
| 84 | * |
| 85 | * @since 2.9.0 |
| 86 | * |
| 87 | * @param string $event |
| 88 | * |
| 89 | * @return bool |
| 90 | */ |
| 91 | public function hasEventRegistered($event) |
| 92 | { |
| 93 | return isset($this->eventHandlers[$event]); |
| 94 | } |
| 95 | |
| 96 | /** |
| 97 | * Returns an array of the registered events |
| 98 | * |
| 99 | * @since 2.9.0 |
| 100 | * |
| 101 | * @return string[] |
| 102 | */ |
| 103 | public function getRegisteredEvents() |
| 104 | { |
| 105 | return array_keys($this->eventHandlers); |
| 106 | } |
| 107 | } |
| 108 |