class StockEventType in Commerce Stock 8

Defines a stock event type item annotation object.

Plugin namespace: Plugin\Commerce\StockEventType.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\commerce_stock\Annotation\StockEventType

See also

\Drupal\commerce_stock\Plugin\StockEventTypeManager

Plugin API

6 classes are annotated with StockEventType

OrderCancel in src/Plugin/Commerce/StockEventType/OrderCancel.php

Provides the order place event type.

OrderDelete in src/Plugin/Commerce/StockEventType/OrderDelete.php

Provides the order delete event type.

OrderItemDelete in src/Plugin/Commerce/StockEventType/OrderItemDelete.php

Provides the order item delete event type.

OrderItemUpdate in src/Plugin/Commerce/StockEventType/OrderItemUpdate.php

Provides the order item update event type.

OrderPlace in src/Plugin/Commerce/StockEventType/OrderPlace.php

Provides the order place event type.

... See full list

File

src/Annotation/StockEventType.php, line 17

Namespace

Drupal\commerce_stock\Annotation

class StockEventType extends Plugin {

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

  /**
   * The stock event type label.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * The stock event type display label.
   *
   * For enventually use in UI.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $displayLabel;

  /**
   * The stock event type default transaction message.
   *
   * To use as default transaction message.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $transactionMessage;

}

Members

Name	Modifiers	Type	Description	Overrides
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
StockEventType::$displayLabel	public	property	The stock event type display label.
StockEventType::$id	public	property	The plugin ID.
StockEventType::$label	public	property	The stock event type label.
StockEventType::$transactionMessage	public	property	The stock event type default transaction message.