class CheckoutPaymentProcess in Commerce PayPal 8

Provides the PayPal Checkout payment process pane.

This extends the default "payment_process" pane which cannot work if the "payment_information" pane isn't visible. This is only required in the "shortcut" flow which is used in combination with the "paypal_checkout" Checkout flow this module provides.

Plugin annotation


@CommerceCheckoutPane(
  id = "paypal_checkout_payment_process",
  label = @Translation("PayPal Checkout payment process"),
  default_step = "payment"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\commerce_checkout\Plugin\Commerce\CheckoutPane\CheckoutPaneBase implements CheckoutPaneInterface, ContainerFactoryPluginInterface
    class \Drupal\commerce_payment\Plugin\Commerce\CheckoutPane\PaymentProcess
    class \Drupal\commerce_paypal\Plugin\Commerce\CheckoutPane\CheckoutPaymentProcess

Expanded class hierarchy of CheckoutPaymentProcess

File

src/Plugin/Commerce/CheckoutPane/CheckoutPaymentProcess.php, line 22

Namespace

Drupal\commerce_paypal\Plugin\Commerce\CheckoutPane

View source

class CheckoutPaymentProcess extends PaymentProcess {

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

      // No payment is needed if the order is free or has already been paid.
      return FALSE;
    }
    if ($this->checkoutFlow
      ->getPluginId() !== 'paypal_checkout' || empty($this->order
      ->getData('commerce_paypal_checkout')) || $this->order
      ->get('payment_gateway')
      ->isEmpty()) {
      return FALSE;
    }
    $checkout_data = $this->order
      ->getData('commerce_paypal_checkout');

    /** @var \Drupal\commerce_payment\Entity\PaymentGatewayInterface $payment_gateway */
    $payment_gateway = $this->order
      ->get('payment_gateway')->entity;
    return $checkout_data['flow'] === 'shortcut' && $payment_gateway
      ->getPlugin() instanceof CheckoutInterface;
  }

  /**
   * Gets the step ID that the customer should be sent to on error.
   *
   * @return string
   *   The error step ID.
   */
  protected function getErrorStepId() {
    $visible_steps = $this->checkoutFlow
      ->getVisibleSteps();
    return key($visible_steps);
  }

}

Members

Name	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
CheckoutPaymentProcess::getErrorStepId	protected	function	Gets the step ID that the customer should be sent to on error. Overrides PaymentProcess::getErrorStepId
CheckoutPaymentProcess::isVisible	public	function	Determines whether the pane is visible. Overrides PaymentProcess::isVisible
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::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.

You are here