interface PaymentStatusInterface in Payment 8.2

A payment status plugin.

Plugins can additionally implement the following interfaces:

• \Drupal\Core\Plugin\PluginFormInterface
• \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\Status\PaymentStatusInterface

20 files declare their use of PaymentStatusInterface

BasicTest.php in tests/src/Unit/Plugin/Payment/MethodConfiguration/BasicTest.php

BasicTest.php in tests/src/Unit/Plugin/Payment/Method/BasicTest.php

EventDispatcherCollection.php in src/EventDispatcherCollection.php

EventDispatcherCollectionTest.php in tests/src/Unit/EventDispatcherCollectionTest.php

EventDispatcherInterface.php in src/EventDispatcherInterface.php

... See full list

File

src/Plugin/Payment/Status/PaymentStatusInterface.php, line 21

Namespace

Drupal\payment\Plugin\Payment\Status

interface PaymentStatusInterface extends PluginInspectionInterface, PaymentAwareInterface {

  /**
   * Sets the created date and time.
   *
   * @param string $created
   *   A Unix timestamp.
   * *
   * @return static
   */
  public function setCreated($created);

  /**
   * Gets the created date and time.
   *
   * @return string
   *   A Unix timestamp.
   */
  public function getCreated();

  /**
   * Gets this payment status's ancestors.
   *
   * @return array
   *   The plugin IDs of this status's ancestors.
   */
  function getAncestors();

  /**
   * Gets this payment status's children.
   *
   * @return array
   *   The plugin IDs of this status's children.
   */
  public function getChildren();

  /**
   * Get this payment status's descendants.
   *
   * @return array
   *   The machine names of this status's descendants.
   */
  function getDescendants();

  /**
   * Checks if the status has a given other status as one of its ancestors.
   *.
   * @param string $plugin_id
   *   The payment status plugin ID to check against.
   *
   * @return boolean
   */
  function hasAncestor($plugin_id);

  /**
   * Checks if the status is equal to a given other status or has it one of
   * its ancestors.
   *
   * @param string $plugin_id
   *   The payment status plugin ID to check against.
   *
   * @return boolean
   */
  function isOrHasAncestor($plugin_id);

}

Members

Name	Modifiers	Type	Description	Overrides
PaymentAwareInterface::getPayment	public	function	Gets the payment.	1
PaymentAwareInterface::setPayment	public	function	Sets the payment.	1
PaymentStatusInterface::getAncestors		function	Gets this payment status's ancestors.	1
PaymentStatusInterface::getChildren	public	function	Gets this payment status's children.	1
PaymentStatusInterface::getCreated	public	function	Gets the created date and time.	1
PaymentStatusInterface::getDescendants		function	Get this payment status's descendants.	1
PaymentStatusInterface::hasAncestor		function	Checks if the status has a given other status as one of its ancestors. .	1
PaymentStatusInterface::isOrHasAncestor		function	Checks if the status is equal to a given other status or has it one of its ancestors.	1
PaymentStatusInterface::setCreated	public	function	Sets the created date and time.	1
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