class PaymentMethod in Payment 8.2

Defines a payment method plugin annotation.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\payment\Annotations\PaymentMethod

1 file declares its use of PaymentMethod

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

4 classes are annotated with PaymentMethod

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

A basic payment method that does not transfer money.

PaymentTestNoResponse in modules/payment_test/src/Plugin/Payment/Method/PaymentTestNoResponse.php

A testing payment method.

PaymentTestResponse in modules/payment_test/src/Plugin/Payment/Method/PaymentTestResponse.php

A testing payment method.

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

A payment method controller that essentially disables payment methods.

File

src/Annotations/PaymentMethod.php, line 12

Namespace

Drupal\payment\Annotations

class PaymentMethod extends Plugin {

  /**
   * Whether the plugin is active.
   *
   * Inactive plugins should not be used to initiate new payments with, but
   * appear in the administration user interface and can be used to continue
   * processing existing payments.
   *
   * @var bool
   */
  public $active = TRUE;

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The translated human-readable plugin name.
   *
   * @var string
   */
  public $label;

  /**
   * The name of the class that provides plugin operations.
   *
   * The class must implement \Drupal\plugin\PluginOperationsProviderInterface.
   *
   * @var string
   */
  public $operations_provider;

}

Members

Name	Modifiers	Type	Description	Overrides
PaymentMethod::$active	public	property	Whether the plugin is active.
PaymentMethod::$id	public	property	The plugin ID.
PaymentMethod::$label	public	property	The translated human-readable plugin name.
PaymentMethod::$operations_provider	public	property	The name of the class that provides plugin operations.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2