interface PaymentStatusManagerInterface in Payment 8.2

Defines a payment status manager.

Hierarchy

• interface \Drupal\plugin\PluginOperationsProviderProviderInterface; interface \Drupal\Component\Plugin\PluginManagerInterface
  • interface \Drupal\payment\Plugin\Payment\Status\PaymentStatusManagerInterface

19 files declare their use of PaymentStatusManagerInterface

Basic.php in src/Plugin/Payment/Method/Basic.php

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

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

DatabaseQueue.php in src/DatabaseQueue.php

DatabaseQueueTest.php in tests/src/Unit/DatabaseQueueTest.php

... See full list

File

src/Plugin/Payment/Status/PaymentStatusManagerInterface.php, line 11

Namespace

Drupal\payment\Plugin\Payment\Status

interface PaymentStatusManagerInterface extends PluginOperationsProviderProviderInterface, PluginManagerInterface {

  /**
   * Creates a payment status.
   *
   * @param string $plugin_id
   *   The id of the plugin being instantiated.
   * @param mixed[] $configuration
   *   An array of configuration relevant to the plugin instance.
   *
   * @return \Drupal\payment\Plugin\Payment\Status\PaymentStatusInterface
   */
  public function createInstance($plugin_id, array $configuration = []);

  /**
   * Gets a payment status's ancestors.
   *
   * @param string $plugin_id
   *
   * @return array
   *   The plugin IDs of this status's ancestors.
   */
  public function getAncestors($plugin_id);

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

  /**
   * Get a payment status's descendants.
   *
   * @param string $plugin_id
   *
   * @return array
   *   The machine names of this status's descendants.
   */
  public function getDescendants($plugin_id);

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

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

}

Members

Name	Modifiers	Type	Description	Overrides
DiscoveryInterface::getDefinition	public	function	Gets a specific plugin definition.	4
DiscoveryInterface::getDefinitions	public	function	Gets the definition of all plugins for this type.	3
DiscoveryInterface::hasDefinition	public	function	Indicates if a specific plugin definition exists.	2
MapperInterface::getInstance	public	function	Gets a preconfigured instance of a plugin.	4
PaymentStatusManagerInterface::createInstance	public	function	Creates a payment status. Overrides FactoryInterface::createInstance
PaymentStatusManagerInterface::getAncestors	public	function	Gets a payment status's ancestors.	1
PaymentStatusManagerInterface::getChildren	public	function	Gets a payment status's children.	1
PaymentStatusManagerInterface::getDescendants	public	function	Get a payment status's descendants.	1
PaymentStatusManagerInterface::hasAncestor	public	function	Checks if a status has a given other status as one of its ancestors.	1
PaymentStatusManagerInterface::isOrHasAncestor	public	function	Checks if the status is equal to a given other status or has it one of its ancestors.	1
PluginOperationsProviderProviderInterface::getOperationsProvider	public	function	Gets the plugin's operations provider.