interface EmailEventInterface in Commerce Email 8

Defines the interface for email events.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\commerce_email\Plugin\Commerce\EmailEvent\EmailEventInterface

1 file declares its use of EmailEventInterface

EmailEventManager.php in src/EmailEventManager.php

File

src/Plugin/Commerce/EmailEvent/EmailEventInterface.php, line 11

Namespace

Drupal\commerce_email\Plugin\Commerce\EmailEvent

interface EmailEventInterface extends PluginInspectionInterface {

  /**
   * Gets the email event label.
   *
   * @return string
   *   The email event label.
   */
  public function getLabel();

  /**
   * Gets the Symfony event name.
   *
   * @return string
   *   The Symfony event name.
   */
  public function getEventName();

  /**
   * Gets the email event entity type ID.
   *
   * This is the entity type ID of the entity the event is fired for.
   *
   * @return string
   *   The email event entity type ID.
   */
  public function getEntityTypeId();

  /**
   * Extracts the entity from the given event.
   *
   * @param \Symfony\Component\EventDispatcher\Event $event
   *   The event.
   *
   * @return \Drupal\Core\Entity\ContentEntityInterface
   *   The extracted entity.
   */
  public function extractEntityFromEvent(Event $event);

}

Members

Name	Modifiers	Type	Description	Overrides
EmailEventInterface::extractEntityFromEvent	public	function	Extracts the entity from the given event.	3
EmailEventInterface::getEntityTypeId	public	function	Gets the email event entity type ID.	1
EmailEventInterface::getEventName	public	function	Gets the Symfony event name.	1
EmailEventInterface::getLabel	public	function	Gets the email event label.	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