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