class CommerceEmailEvent in Commerce Email 8

Defines the email event plugin annotation object.

Plugin namespace: Plugin\Commerce\EmailEvent.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\commerce_email\Annotation\CommerceEmailEvent

1 file declares its use of CommerceEmailEvent

EmailEventManager.php in src/EmailEventManager.php

3 classes are annotated with CommerceEmailEvent

CheckoutCompletionRegister in src/Plugin/Commerce/EmailEvent/CheckoutCompletionRegister.php

Provides the CheckoutCompletionRegister email event.

OrderPaid in src/Plugin/Commerce/EmailEvent/OrderPaid.php

Provides the OrderPaid email event.

OrderPlaced in src/Plugin/Commerce/EmailEvent/OrderPlaced.php

Provides the OrderPlaced email event.

File

src/Annotation/CommerceEmailEvent.php, line 14

Namespace

Drupal\commerce_email\Annotation

class CommerceEmailEvent extends Plugin {

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

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

  /**
   * The Symfony event name.
   *
   * For example: 'commerce_order.place.post_transition'.
   *
   * @var string
   */
  protected $event_name;

  /**
   * The email event entity type ID.
   *
   * This is the entity type ID of the entity the event is fired for.
   * For example: 'commerce_order'.
   *
   * @var string
   */
  public $entity_type;

}

Members

Name	Modifiers	Type	Description	Overrides
CommerceEmailEvent::$entity_type	public	property	The email event entity type ID.
CommerceEmailEvent::$event_name	protected	property	The Symfony event name.
CommerceEmailEvent::$id	public	property	The plugin ID.
CommerceEmailEvent::$label	public	property	The email event label.
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