interface PaymentTypeInterface in Payment 8.2

A payment type plugin.

Plugins can additionally implement the following interfaces:

• \Drupal\Component\Plugin\ConfigurableInterface Required if the plugin has any internal configuration, so it can be exported for recreation of the plugin at a later time.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\payment\PaymentAwareInterface
  • interface \Drupal\payment\Plugin\Payment\Type\PaymentTypeInterface

4 files declare their use of PaymentTypeInterface

PaymentFormTest.php in modules/payment_form/tests/src/Unit/Entity/Payment/PaymentFormTest.php

PaymentStorageWebTest.php in tests/src/Functional/Entity/Payment/PaymentStorageWebTest.php

PaymentUnitTest.php in tests/src/Kernel/PaymentUnitTest.php

ResumeContextTest.php in modules/payment_reference/tests/src/Unit/Controller/ResumeContextTest.php

File

src/Plugin/Payment/Type/PaymentTypeInterface.php, line 17

Namespace

Drupal\payment\Plugin\Payment\Type

interface PaymentTypeInterface extends PluginInspectionInterface, PaymentAwareInterface {

  /**
   * Returns the description of the payment this plugin is of.
   *
   * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup
   */
  public function getPaymentDescription();

  /**
   * Checks if the payment type context can be resumed.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *
   * @see self::getResumeContextResponse
   */
  public function resumeContextAccess(AccountInterface $account);

  /**
   * Resumes the payer's original workflow.
   *
   * @return \Drupal\payment\Response\ResponseInterface
   *
   * @see self::resumeContextAccess
   */
  public function getResumeContextResponse();

}

Members

Name	Modifiers	Type	Description	Overrides
PaymentAwareInterface::getPayment	public	function	Gets the payment.	1
PaymentAwareInterface::setPayment	public	function	Sets the payment.	1
PaymentTypeInterface::getPaymentDescription	public	function	Returns the description of the payment this plugin is of.	4
PaymentTypeInterface::getResumeContextResponse	public	function	Resumes the payer's original workflow.	1
PaymentTypeInterface::resumeContextAccess	public	function	Checks if the payment type context can be resumed.	4
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2