interface IdentityChannelPluginInterface in Courier 8
Same name and namespace in other branches
- 2.x src/Plugin/IdentityChannel/IdentityChannelPluginInterface.php \Drupal\courier\Plugin\IdentityChannel\IdentityChannelPluginInterface
Interface for IdentityChannel plugins.
Hierarchy
- interface \Drupal\courier\Plugin\IdentityChannel\IdentityChannelPluginInterface
Expanded class hierarchy of IdentityChannelPluginInterface
All classes that implement IdentityChannelPluginInterface
2 files declare their use of IdentityChannelPluginInterface
- User.php in src/
Plugin/ IdentityChannel/ CourierEmail/ User.php - Contains \Drupal\courier\Plugin\IdentityChannel\CourierEmail\User.
- User.php in tests/
modules/ courier_test_message/ src/ Plugin/ IdentityChannel/ TestMessage/ User.php
File
- src/
Plugin/ IdentityChannel/ IdentityChannelPluginInterface.php, line 16 - Contains \Drupal\courier\Plugin\IdentityChannel\IdentityChannelPluginInterface.
Namespace
Drupal\courier\Plugin\IdentityChannelView source
interface IdentityChannelPluginInterface {
/**
* Inserts the identity into the message.
*
* @param \Drupal\courier\ChannelInterface $message
* The message. Passed by reference.
* @param EntityInterface $identity
* The identity.
*
* @throws \Drupal\courier\Exception\IdentityException
* Thrown when an identity cannot be applied. Message is discarded, it does
* not stop creation of remaining messages in collection.
*/
public function applyIdentity(ChannelInterface &$message, EntityInterface $identity);
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
IdentityChannelPluginInterface:: |
public | function | Inserts the identity into the message. | 3 |