You are here

Home » API reference » Commerce Core 8.2 » PaymentProcess.php

class PaymentProcess in Commerce Core 8.2

Provides the payment process pane.

Plugin annotation


@CommerceCheckoutPane(
  id = "payment_process",
  label = @Translation("Payment process"),
  default_step = "payment",
  wrapper_element = "container",
)

Hierarchy

Expanded class hierarchy of PaymentProcess

File

modules/payment/src/Plugin/Commerce/CheckoutPane/PaymentProcess.php, line 31

Namespace

Drupal\commerce_payment\Plugin\Commerce\CheckoutPane
View source 
class PaymentProcess extends CheckoutPaneBase {

  /**
   * The inline form manager.
   *
   * @var \Drupal\commerce\InlineFormManager
   */
  protected $inlineFormManager;

  /**
   * The logger.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * Constructs a new PaymentProcess object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\commerce_checkout\Plugin\Commerce\CheckoutFlow\CheckoutFlowInterface $checkout_flow
   *   The parent checkout flow.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\commerce\InlineFormManager $inline_form_manager
   *   The inline form manager.
   * @param \Psr\Log\LoggerInterface $logger
   *   The logger.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, CheckoutFlowInterface $checkout_flow, EntityTypeManagerInterface $entity_type_manager, InlineFormManager $inline_form_manager, LoggerInterface $logger) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $checkout_flow, $entity_type_manager);
    $this->inlineFormManager = $inline_form_manager;
    $this->logger = $logger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, CheckoutFlowInterface $checkout_flow = NULL) {
    return new static($configuration, $plugin_id, $plugin_definition, $checkout_flow, $container
      ->get('entity_type.manager'), $container
      ->get('plugin.manager.commerce_inline_form'), $container
      ->get('logger.channel.commerce_payment'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'capture' => TRUE,
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationSummary() {
    if (!empty($this->configuration['capture'])) {
      $summary = $this
        ->t('Transaction mode: Authorize and capture');
    }
    else {
      $summary = $this
        ->t('Transaction mode: Authorize only');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['capture'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Transaction mode'),
      '#description' => $this
        ->t('This setting is only respected if the chosen payment gateway supports authorizations.'),
      '#options' => [
        TRUE => $this
          ->t('Authorize and capture'),
        FALSE => $this
          ->t('Authorize only (requires manual capture after checkout)'),
      ],
      '#default_value' => (int) $this->configuration['capture'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    if (!$form_state
      ->getErrors()) {
      $values = $form_state
        ->getValue($form['#parents']);
      $this->configuration['capture'] = !empty($values['capture']);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function isVisible() {
    if ($this->order
      ->isPaid() || $this->order
      ->getTotalPrice()
      ->isZero()) {

      // No payment is needed if the order is free or has already been paid.
      return FALSE;
    }
    $payment_info_pane = $this->checkoutFlow
      ->getPane('payment_information');
    if (!$payment_info_pane
      ->isVisible() || $payment_info_pane
      ->getStepId() == '_disabled') {

      // Hide the pane if the PaymentInformation pane has been disabled.
      return FALSE;
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function buildPaneForm(array $pane_form, FormStateInterface $form_state, array &$complete_form) {
    $error_step_id = $this
      ->getErrorStepId();

    // The payment gateway is currently always required to be set.
    if ($this->order
      ->get('payment_gateway')
      ->isEmpty()) {
      $this
        ->messenger()
        ->addError($this
        ->t('No payment gateway selected.'));
      $this->checkoutFlow
        ->redirectToStep($error_step_id);
    }

    /** @var \Drupal\commerce_payment\Entity\PaymentGatewayInterface $payment_gateway */
    $payment_gateway = $this->order->payment_gateway->entity;
    $payment_gateway_plugin = $payment_gateway
      ->getPlugin();
    $payment = $this
      ->createPayment($payment_gateway);
    $next_step_id = $this->checkoutFlow
      ->getNextStepId($this
      ->getStepId());
    if ($payment_gateway_plugin instanceof SupportsStoredPaymentMethodsInterface && !$this->order
      ->get('payment_method')
      ->isEmpty()) {
      try {
        $payment->payment_method = $this->order
          ->get('payment_method')->entity;
        $payment_gateway_plugin
          ->createPayment($payment, $this->configuration['capture']);
        $this->checkoutFlow
          ->redirectToStep($next_step_id);
      } catch (DeclineException $e) {
        $message = $this
          ->t('We encountered an error processing your payment method. Please verify your details and try again.');
        $this
          ->messenger()
          ->addError($message);
        $this->checkoutFlow
          ->redirectToStep($error_step_id);
      } catch (PaymentGatewayException $e) {
        $this->logger
          ->error($e
          ->getMessage());
        $message = $this
          ->t('We encountered an unexpected error processing your payment method. Please try again later.');
        $this
          ->messenger()
          ->addError($message);
        $this->checkoutFlow
          ->redirectToStep($error_step_id);
      }
    }
    elseif ($payment_gateway_plugin instanceof OffsitePaymentGatewayInterface) {
      $complete_form['actions']['next']['#value'] = $this
        ->t('Proceed to @gateway', [
        '@gateway' => $payment_gateway_plugin
          ->getDisplayLabel(),
      ]);

      // Make sure that the payment gateway's onCancel() method is invoked,
      // by pointing the "Go back" link to the cancel URL.
      $complete_form['actions']['next']['#suffix'] = Link::fromTextAndUrl($this
        ->t('Go back'), $this
        ->buildCancelUrl())
        ->toString();

      // Actions are not needed by gateways that embed iframes or redirect
      // via GET. The inline form can show them when needed (redirect via POST).
      $complete_form['actions']['#access'] = FALSE;
      $inline_form = $this->inlineFormManager
        ->createInstance('payment_gateway_form', [
        'operation' => 'offsite-payment',
        'catch_build_exceptions' => FALSE,
      ], $payment);
      $pane_form['offsite_payment'] = [
        '#parents' => array_merge($pane_form['#parents'], [
          'offsite_payment',
        ]),
        '#inline_form' => $inline_form,
        '#return_url' => $this
          ->buildReturnUrl()
          ->toString(),
        '#cancel_url' => $this
          ->buildCancelUrl()
          ->toString(),
        '#capture' => $this->configuration['capture'],
      ];
      try {
        $pane_form['offsite_payment'] = $inline_form
          ->buildInlineForm($pane_form['offsite_payment'], $form_state);
      } catch (PaymentGatewayException $e) {
        $this->logger
          ->error($e
          ->getMessage());
        $message = $this
          ->t('We encountered an unexpected error processing your payment. Please try again later.');
        $this
          ->messenger()
          ->addError($message);
        $this->checkoutFlow
          ->redirectToStep($error_step_id);
      }
      return $pane_form;
    }
    elseif ($payment_gateway_plugin instanceof ManualPaymentGatewayInterface) {
      try {
        $payment_gateway_plugin
          ->createPayment($payment);
        $this->checkoutFlow
          ->redirectToStep($next_step_id);
      } catch (PaymentGatewayException $e) {
        $this->logger
          ->error($e
          ->getMessage());
        $message = $this
          ->t('We encountered an unexpected error processing your payment. Please try again later.');
        $this
          ->messenger()
          ->addError($message);
        $this->checkoutFlow
          ->redirectToStep($error_step_id);
      }
    }
    else {
      $this->logger
        ->error('Unable process payment with :plugin_id', [
        ':plugin_id' => $payment_gateway_plugin
          ->getPluginId(),
      ]);
      $message = $this
        ->t('We encountered an unexpected error processing your payment. Please try again later.');
      $this
        ->messenger()
        ->addError($message);
      $this->checkoutFlow
        ->redirectToStep($error_step_id);
    }
  }

  /**
   * Builds the URL to the "return" page.
   *
   * @return \Drupal\Core\Url
   *   The "return" page URL.
   */
  protected function buildReturnUrl() {
    return Url::fromRoute('commerce_payment.checkout.return', [
      'commerce_order' => $this->order
        ->id(),
      'step' => 'payment',
    ], [
      'absolute' => TRUE,
    ]);
  }

  /**
   * Builds the URL to the "cancel" page.
   *
   * @return \Drupal\Core\Url
   *   The "cancel" page URL.
   */
  protected function buildCancelUrl() {
    return Url::fromRoute('commerce_payment.checkout.cancel', [
      'commerce_order' => $this->order
        ->id(),
      'step' => 'payment',
    ], [
      'absolute' => TRUE,
    ]);
  }

  /**
   * Gets the step ID that the customer should be sent to on error.
   *
   * @return string
   *   The error step ID.
   */
  protected function getErrorStepId() {

    // Default to the step that contains the PaymentInformation pane.
    $step_id = $this->checkoutFlow
      ->getPane('payment_information')
      ->getStepId();
    if ($step_id == '_disabled') {

      // Can't redirect to the _disabled step. This could mean that isVisible()
      // was overridden to allow PaymentProcess to be used without a
      // payment_information pane, but this method was not modified.
      throw new \RuntimeException('Cannot get the step ID for the payment_information pane. The pane is disabled.');
    }
    return $step_id;
  }

  /**
   * Creates the payment to be processed.
   *
   * @param \Drupal\commerce_payment\Entity\PaymentGatewayInterface $payment_gateway
   *   The payment gateway in use.
   *
   * @return \Drupal\commerce_payment\Entity\PaymentInterface
   *   The created payment.
   */
  protected function createPayment(PaymentGatewayInterface $payment_gateway) {
    $payment_storage = $this->entityTypeManager
      ->getStorage('commerce_payment');

    /** @var \Drupal\commerce_payment\Entity\PaymentInterface $payment */
    $payment = $payment_storage
      ->create([
      'state' => 'new',
      'amount' => $this->order
        ->getBalance(),
      'payment_gateway' => $payment_gateway
        ->id(),
      'order_id' => $this->order
        ->id(),
    ]);
    return $payment;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CheckoutPaneBase::$checkoutFlow protected property The parent checkout flow.
CheckoutPaneBase::$entityTypeManager protected property The entity type manager.
CheckoutPaneBase::$order protected property The current order.
CheckoutPaneBase::buildPaneSummary public function Builds a summary of the pane values. Overrides CheckoutPaneInterface::buildPaneSummary 3
CheckoutPaneBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
CheckoutPaneBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
CheckoutPaneBase::getDisplayLabel public function Gets the pane display label. Overrides CheckoutPaneInterface::getDisplayLabel
CheckoutPaneBase::getId public function Gets the pane ID. Overrides CheckoutPaneInterface::getId
CheckoutPaneBase::getLabel public function Gets the pane label. Overrides CheckoutPaneInterface::getLabel
CheckoutPaneBase::getStepId public function Gets the pane step ID. Overrides CheckoutPaneInterface::getStepId
CheckoutPaneBase::getWeight public function Gets the pane weight. Overrides CheckoutPaneInterface::getWeight
CheckoutPaneBase::getWrapperElement public function Gets the pane wrapper element. Overrides CheckoutPaneInterface::getWrapperElement
CheckoutPaneBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
CheckoutPaneBase::setOrder public function Sets the current order. Overrides CheckoutPaneInterface::setOrder
CheckoutPaneBase::setStepId public function Sets the pane step ID. Overrides CheckoutPaneInterface::setStepId
CheckoutPaneBase::setWeight public function Sets the pane weight. Overrides CheckoutPaneInterface::setWeight
CheckoutPaneBase::submitPaneForm public function Handles the submission of an pane form. Overrides CheckoutPaneInterface::submitPaneForm 7
CheckoutPaneBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
CheckoutPaneBase::validatePaneForm public function Validates the pane form. Overrides CheckoutPaneInterface::validatePaneForm 4
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PaymentProcess::$inlineFormManager protected property The inline form manager.
PaymentProcess::$logger protected property The logger.
PaymentProcess::buildCancelUrl protected function Builds the URL to the "cancel" page.
PaymentProcess::buildConfigurationForm public function Form constructor. Overrides CheckoutPaneBase::buildConfigurationForm
PaymentProcess::buildConfigurationSummary public function Builds a summary of the pane configuration. Overrides CheckoutPaneBase::buildConfigurationSummary
PaymentProcess::buildPaneForm public function Builds the pane form. Overrides CheckoutPaneInterface::buildPaneForm
PaymentProcess::buildReturnUrl protected function Builds the URL to the "return" page.
PaymentProcess::create public static function Creates an instance of the plugin. Overrides CheckoutPaneBase::create
PaymentProcess::createPayment protected function Creates the payment to be processed.
PaymentProcess::defaultConfiguration public function Gets default configuration for this plugin. Overrides CheckoutPaneBase::defaultConfiguration
PaymentProcess::getErrorStepId protected function Gets the step ID that the customer should be sent to on error.
PaymentProcess::isVisible public function Determines whether the pane is visible. Overrides CheckoutPaneBase::isVisible
PaymentProcess::submitConfigurationForm public function Form submission handler. Overrides CheckoutPaneBase::submitConfigurationForm
PaymentProcess::__construct public function Constructs a new PaymentProcess object. Overrides CheckoutPaneBase::__construct
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.