interface EdgeEntityEventDeriverInterface in Apigee Edge 8

Provides an interface for Apigee Edge entity event deriver.

Hierarchy

• interface \Drupal\Component\Plugin\Derivative\DeriverInterface
  • interface \Drupal\Core\Plugin\Discovery\ContainerDeriverInterface
    • interface \Drupal\apigee_edge_actions\Plugin\RulesEvent\EdgeEntityEventDeriverInterface

File

modules/apigee_edge_actions/src/Plugin/RulesEvent/EdgeEntityEventDeriverInterface.php, line 29

Namespace

Drupal\apigee_edge_actions\Plugin\RulesEvent

interface EdgeEntityEventDeriverInterface extends ContainerDeriverInterface {

  /**
   * Returns the event's label. Example: 'After saving a new App'.
   *
   * @param \Drupal\apigee_edge\Entity\EdgeEntityTypeInterface $entity_type
   *   The Apigee Edge entity type.
   *
   * @return string
   *   The event's label.
   */
  public function getLabel(EdgeEntityTypeInterface $entity_type) : string;

  /**
   * Returns an array of event context.
   *
   * @param \Drupal\apigee_edge\Entity\EdgeEntityTypeInterface $entity_type
   *   The Apigee Edge entity type.
   *
   * @return array
   *   An array of event context.
   */
  public function getContext(EdgeEntityTypeInterface $entity_type) : array;

  /**
   * Returns an array of entity types that are compatible to this event.
   *
   * @return array
   *   An array of Edge entity types.
   */
  public function getEntityTypes() : array;

}

Members

Name	Modifiers	Type	Description	Overrides
ContainerDeriverInterface::create	public static	function	Creates a new class instance.	38
DeriverInterface::getDerivativeDefinition	public	function	Gets the definition of a derivative plugin.	14
DeriverInterface::getDerivativeDefinitions	public	function	Gets the definition of all derivatives of a base plugin.	14
EdgeEntityEventDeriverInterface::getContext	public	function	Returns an array of event context.	1
EdgeEntityEventDeriverInterface::getEntityTypes	public	function	Returns an array of entity types that are compatible to this event.	1
EdgeEntityEventDeriverInterface::getLabel	public	function	Returns the event's label. Example: 'After saving a new App'.	7