Copied!

DeletePaymentMethodEvent

DeletePaymentMethodEvent.php : 48
Extends AfterEvent

Event dispatched after a payment method is deleted.

Typical use case is to perform additional operations after payment method deletion (e.g. logging, cache purge, reindexing, etc.)

The following example log the deletion of the payment method:

final class PaymentMethodEventSubscriber implements EventSubscriberInterface
{
   private function __construct(private LoggerInterface $logger)
   {
   }

   public static function getSubscribedEvents(): array
   {
       return [
           DeletePaymentMethodEvent::class => 'onDeletePaymentMethod',
       ];
    }

   public function onDeletePaymentMethod(DeletePaymentMethodEvent $event): void
   {
       $paymentMethod = $event->getPaymentMethod();

       $this->logger->info(
           'Payment method {name} has been deleted',
           [
               'name' => $paymentMethod->getName()
           ]
       );
   }
}

Methods

public__construct()

DeletePaymentMethodEvent.php : 52
public __construct(PaymentMethodInterface $paymentMethod)

Parameters

Name Type Default value Description
$paymentMethod PaymentMethodInterface - -

publicgetPaymentMethod()

DeletePaymentMethodEvent.php : 60

Returns the payment method that has been deleted.

public getPaymentMethod() : PaymentMethodInterface

Return values

PaymentMethodInterface

publicisPropagationStopped()

Event.php : 38
public isPropagationStopped() : bool

Return values

bool

publicstopPropagation()

Event.php : 50

Stops the propagation of the event to further event listeners.

public stopPropagation() : void

If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().