You are here

Home » API reference » Payment 8.2 » Basic.php

class Basic in Payment 8.2

Same name in this branch
  1. 8.2 src/Plugin/Payment/MethodConfiguration/Basic.php \Drupal\payment\Plugin\Payment\MethodConfiguration\Basic
  2. 8.2 src/Plugin/Payment/Method/Basic.php \Drupal\payment\Plugin\Payment\Method\Basic
  3. 8.2 src/Plugin/Payment/LineItem/Basic.php \Drupal\payment\Plugin\Payment\LineItem\Basic

A basic payment method that does not transfer money.

Plugins that extend this class must have the following keys in their plugin definitions:

  • entity_id: (string) The ID of the payment method entity the plugin is for.
  • execute_status_id: (string) The ID of the payment status plugin to set at payment execution.
  • capture: (boolean) Whether or not payment capture is supported.
  • capture_status_id: (string) The ID of the payment status plugin to set at payment capture.
  • refund: (boolean) Whether or not payment refunds are supported.
  • refund_status_id: (string) The ID of the payment status plugin to set at payment refund.

Plugin annotation


@PaymentMethod(
  deriver = "Drupal\payment\Plugin\Payment\Method\BasicDeriver",
  id = "payment_basic",
  operations_provider = "\Drupal\payment\Plugin\Payment\Method\BasicOperationsProvider",
)

Hierarchy

Expanded class hierarchy of Basic

1 file declares its use of Basic
BasicTest.php in tests/src/Unit/Plugin/Payment/Method/BasicTest.php

File

src/Plugin/Payment/Method/Basic.php, line 40

Namespace

Drupal\payment\Plugin\Payment\Method
View source 
class Basic extends PaymentMethodBase implements ContainerFactoryPluginInterface, PaymentMethodCapturePaymentInterface, PaymentMethodRefundPaymentInterface, PaymentMethodUpdatePaymentStatusInterface {

  /**
   * The payment status manager.
   *
   * @var \Drupal\payment\Plugin\Payment\Status\PaymentStatusManagerInterface
   */
  protected $paymentStatusManager;

  /**
   * Constructs a new instance.
   *
   * @param mixed[] $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\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\payment\EventDispatcherInterface $event_dispatcher
   *   The event dispatcher.
   * @param \Drupal\Core\Utility\Token $token
   *   The token API.
   * @param \Drupal\payment\Plugin\Payment\Status\PaymentStatusManagerInterface
   *   The payment status manager.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, ModuleHandlerInterface $module_handler, EventDispatcherInterface $event_dispatcher, Token $token, PaymentStatusManagerInterface $payment_status_manager) {
    $configuration += $this
      ->defaultConfiguration();
    parent::__construct($configuration, $plugin_id, $plugin_definition, $module_handler, $event_dispatcher, $token, $payment_status_manager);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('module_handler'), $container
      ->get('payment.event_dispatcher'), $container
      ->get('token'), $container
      ->get('plugin.manager.payment.status'));
  }

  /**
   * {@inheritdoc}
   */
  public function getSupportedCurrencies() {
    return TRUE;
  }

  /**
   * Gets the ID of the payment method this plugin is for.
   *
   * @return string
   */
  public function getEntityId() {
    return $this->pluginDefinition['entity_id'];
  }

  /**
   * Gets the status to set on payment execution.
   *
   * @return string
   *   The plugin ID of the payment status to set.
   */
  public function getExecuteStatusId() {
    return $this->pluginDefinition['execute_status_id'];
  }

  /**
   * Gets the status to set on payment capture.
   *
   * @return string
   *   The plugin ID of the payment status to set.
   */
  public function getCaptureStatusId() {
    return $this->pluginDefinition['capture_status_id'];
  }

  /**
   * Gets whether or not capture is supported.
   *
   * @param bool
   *   Whether or not to support capture.
   */
  public function getCapture() {
    return $this->pluginDefinition['capture'];
  }

  /**
   * Gets the status to set on payment refund.
   *
   * @return string
   *   The plugin ID of the payment status to set.
   */
  public function getRefundStatusId() {
    return $this->pluginDefinition['refund_status_id'];
  }

  /**
   * Gets whether or not capture is supported.
   *
   * @param bool
   *   Whether or not to support capture.
   */
  public function getRefund() {
    return $this->pluginDefinition['refund'];
  }

  /**
   * {@inheritdoc}
   */
  protected function doExecutePayment() {
    $this
      ->getPayment()
      ->setPaymentStatus($this->paymentStatusManager
      ->createInstance($this
      ->getExecuteStatusId()));
    $this
      ->getPayment()
      ->save();
  }

  /**
   * {@inheritdoc}
   */
  public function doCapturePayment() {
    $this
      ->getPayment()
      ->setPaymentStatus($this->paymentStatusManager
      ->createInstance($this
      ->getCaptureStatusId()));
    $this
      ->getPayment()
      ->save();
  }

  /**
   * {@inheritdoc}
   */
  public function doCapturePaymentAccess(AccountInterface $account) {
    return $this
      ->getCapture() && $this
      ->getPayment()
      ->getPaymentStatus()
      ->getPluginId() != $this
      ->getCaptureStatusId();
  }

  /**
   * {@inheritdoc}
   */
  public function doRefundPayment() {
    $this
      ->getPayment()
      ->setPaymentStatus($this->paymentStatusManager
      ->createInstance($this
      ->getRefundStatusId()));
    $this
      ->getPayment()
      ->save();
  }

  /**
   * {@inheritdoc}
   */
  public function doRefundPaymentAccess(AccountInterface $account) {
    return $this
      ->getRefund() && $this
      ->getPayment()
      ->getPaymentStatus()
      ->getPluginId() != $this
      ->getRefundStatusId();
  }

  /**
   * {@inheritdoc}
   */
  public function updatePaymentStatusAccess(AccountInterface $account) {
    return AccessResult::forbidden();
  }

  /**
   * {@inheritdoc}
   */
  public function getSettablePaymentStatuses(AccountInterface $account, PaymentInterface $payment) {
    return [];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Basic::$paymentStatusManager protected property The payment status manager.
Basic::create public static function Creates an instance of the plugin. Overrides PaymentMethodBase::create
Basic::doCapturePayment public function Performs the actual payment capture. Overrides PaymentMethodBase::doCapturePayment
Basic::doCapturePaymentAccess public function Performs a payment method-specific access check for payment capture. Overrides PaymentMethodBase::doCapturePaymentAccess
Basic::doExecutePayment protected function Performs the actual payment execution. Overrides PaymentMethodBase::doExecutePayment
Basic::doRefundPayment public function Performs the actual payment refund. Overrides PaymentMethodBase::doRefundPayment
Basic::doRefundPaymentAccess public function Performs a payment method-specific access check for payment refunds. Overrides PaymentMethodBase::doRefundPaymentAccess
Basic::getCapture public function Gets whether or not capture is supported.
Basic::getCaptureStatusId public function Gets the status to set on payment capture.
Basic::getEntityId public function Gets the ID of the payment method this plugin is for.
Basic::getExecuteStatusId public function Gets the status to set on payment execution.
Basic::getRefund public function Gets whether or not capture is supported.
Basic::getRefundStatusId public function Gets the status to set on payment refund.
Basic::getSettablePaymentStatuses public function Returns the statuses that can be set on a payment. Overrides PaymentMethodUpdatePaymentStatusInterface::getSettablePaymentStatuses
Basic::getSupportedCurrencies public function Returns the supported currencies. Overrides PaymentMethodBase::getSupportedCurrencies
Basic::updatePaymentStatusAccess public function Checks if the payment status can be updated. Overrides PaymentMethodUpdatePaymentStatusInterface::updatePaymentStatusAccess
Basic::__construct public function Constructs a new instance. Overrides PaymentMethodBase::__construct
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.
PaymentAwareTrait::$payment protected property The payment.
PaymentAwareTrait::getPayment public function
PaymentAwareTrait::setPayment public function
PaymentMethodBase::$eventDispatcher protected property The event dispatcher.
PaymentMethodBase::$moduleHandler protected property The module handler.
PaymentMethodBase::$token protected property The token API.
PaymentMethodBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
PaymentMethodBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
PaymentMethodBase::capturePayment public function Captures the payment. Overrides PaymentMethodCapturePaymentInterface::capturePayment
PaymentMethodBase::capturePaymentAccess public function Checks if the payment can be captured. Overrides PaymentMethodCapturePaymentInterface::capturePaymentAccess
PaymentMethodBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
PaymentMethodBase::doExecutePaymentAccess protected function Performs a payment method-specific access check for payment execution.
PaymentMethodBase::executePayment public function Executes the payment. Overrides PaymentMethodInterface::executePayment
PaymentMethodBase::executePaymentAccess public function Checks if the payment can be executed. Overrides PaymentMethodInterface::executePaymentAccess
PaymentMethodBase::executePaymentAccessCurrency protected function Checks a payment's currency against this plugin.
PaymentMethodBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
PaymentMethodBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
PaymentMethodBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
PaymentMethodBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
PaymentMethodBase::getMessageText public function Gets the payer message text.
PaymentMethodBase::getMessageTextFormat public function Gets the payer message text format.
PaymentMethodBase::getPaymentCaptureResult public function Gets the payment capture status. Overrides PaymentMethodCapturePaymentInterface::getPaymentCaptureResult
PaymentMethodBase::getPaymentExecutionResult public function Gets the payment execution status. Overrides PaymentMethodInterface::getPaymentExecutionResult 1
PaymentMethodBase::getPaymentRefundResult public function Gets the payment refund status. Overrides PaymentMethodRefundPaymentInterface::getPaymentRefundResult
PaymentMethodBase::refundPayment public function Refunds the payment. Overrides PaymentMethodRefundPaymentInterface::refundPayment
PaymentMethodBase::refundPaymentAccess public function Checks if the payment can be refunded. Overrides PaymentMethodRefundPaymentInterface::refundPaymentAccess
PaymentMethodBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
PaymentMethodBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
PaymentMethodBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
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.