BeforeUpdatePaymentMethodEvent

Typical use case are to modify the payment method update struct before executing operation or completely override payment method update logic. See the two examples below.

The following first example capitalizes the first character of each word in each names of the payment method to update:

final class PaymentMethodEventSubscriber implements EventSubscriberInterface
{
    public static function getSubscribedEvents(): array
    {
       return [
           BeforeUpdatePaymentMethodEvent::class => 'onBeforeUpdatePaymentMethod',
       ];
    }

   public function onBeforeUpdatePaymentMethod(BeforeUpdatePaymentMethodEvent $event): void
   {
        $updateStruct = $event->getUpdateStruct();

        foreach ($updateStruct->getNames() ?? [] as $languageCode => $name) {
            if ($name !== null) {
                // Capitalize payment method name
                $updateStruct->setName($languageCode, ucwords($name));
            }
        }
   }
}

The following second example sets its own payment method, and cancel the default payment method update process:

final class PaymentMethodEventSubscriber implements EventSubscriberInterface
{
    public static function getSubscribedEvents(): array
    {
        return [
             BeforeUpdatePaymentMethodEvent::class => 'onBeforeUpdatePaymentMethod',
        ];
    }

  public function onBeforeUpdatePaymentMethod(BeforeUpdatePaymentMethodEvent $event): void
  {
     // ...
     $event->setPaymentMethodResult($paymentMethod);
     $event->stopPropagation();
  }
}

Returns overridden PaymentMethodServiceInterface::updatePaymentMethod() result.

Returns whether the PaymentMethodServiceInterface::updatePaymentMethod() result is overridden.

Overrides PaymentMethodServiceInterface::updatePaymentMethod() execution result.

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