Event dispatched after a payment method is updated.
Typical use case is to perform some action after payment method is updated (e.g. logging, cache purge, reindexing, etc.)
The following example log the update of the payment method:
final class PaymentMethodEventSubscriber implements EventSubscriberInterface
{
private function __construct(private LoggerInterface $logger)
{
}
public static function getSubscribedEvents(): array
{
return [
UpdatePaymentMethodEvent::class => 'onUpdatePaymentMethod',
];
}
public function onUpdatePaymentMethod(UpdatePaymentMethodEvent $event): void
{
$paymentMethod = $event->getPaymentMethodResult();
$this->logger->info(
'Payment method {name} has been updated',
[
'name' => $paymentMethod->getName()
]
);
}
}
Methods¶
__construct() ¶
UpdatePaymentMethodEvent.php
:
57
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$paymentMethod | PaymentMethodInterface | - | - |
$updateStruct | PaymentMethodUpdateStruct | - | - |
$paymentMethodResult | PaymentMethodInterface | - | - |
getPaymentMethod() ¶
UpdatePaymentMethodEvent.php
:
70
Returns the payment method that has been updated (before update).
|
|
Return values
getPaymentMethodResult() ¶
UpdatePaymentMethodEvent.php
:
86
Returns updated payment method (after update).
|
|
Return values
getUpdateStruct() ¶
UpdatePaymentMethodEvent.php
:
78
Returns update struct used to update payment method.
|
|
Return values
isPropagationStopped() ¶
Event.php
:
38
|
|
Return values
bool
stopPropagation() ¶
Event.php
:
50
Stops the propagation of the event to further event listeners.
|
|
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().