You are here

interface ChannelInterface in Courier 8

Same name and namespace in other branches
  1. 2.x src/ChannelInterface.php \Drupal\courier\ChannelInterface

Defines an interface for channels (templates).

Hierarchy

Expanded class hierarchy of ChannelInterface

All classes that implement ChannelInterface

9 files declare their use of ChannelInterface
Broken.php in src/Plugin/IdentityChannel/Broken.php
Contains \Drupal\courier\Plugin\IdentityChannel\Broken.
courier.module in ./courier.module
GlobalTemplateCollectionManager.php in src/Service/GlobalTemplateCollectionManager.php
GlobalTemplateCollectionManagerInterface.php in src/Service/GlobalTemplateCollectionManagerInterface.php
IdentityChannelPluginInterface.php in src/Plugin/IdentityChannel/IdentityChannelPluginInterface.php
Contains \Drupal\courier\Plugin\IdentityChannel\IdentityChannelPluginInterface.

... See full list

File

src/ChannelInterface.php, line 15
Contains \Drupal\courier\ChannelInterface.

Namespace

Drupal\courier
View source
interface ChannelInterface extends FieldableEntityInterface, TokenInterface {

  /**
   * Applies tokens to relevant fields.
   *
   * @return static
   *   Return this instance for chaining.
   */
  public function applyTokens();

  /**
   * Sends messages in bulk.
   *
   * @param \Drupal\courier\ChannelInterface[] $messages
   *   An array of messages.
   * @param array $options
   *   Miscellaneous options.
   *
   * @throws \Drupal\courier\Exception\ChannelFailure
   *   Throw if the message cannot be sent.
   */
  public static function sendMessages(array $messages, $options = []);

  /**
   * Sends this message.
   *
   * @param array $options
   *   Miscellaneous options to pass to the sender.
   */
  public function sendMessage(array $options = []);

  /**
   * Determine if there is enough data to transmit a message.
   *
   * Ideally some validation should also be done on the entity form.
   *
   * @return bool
   */
  public function isEmpty();

  /**
   * Import the message values from configuration values into this entity, as
   * found in the 'courier.template.TYPE' config type. Where TYPE is the entity
   * type ID of this entity.
   *
   * This method is the reverse of {@link exportTemplate()}
   *
   * @param mixed $content
   *   Values from a 'courier.template.TYPE' configuration.
   */
  public function importTemplate($content);

  /**
   * Export the message values from this template to configuration values, as
   * found in the 'courier.template.TYPE' config type. Where TYPE is the entity
   * type ID of this entity.
   *
   * This method is the reverse of {@link importTemplate()}
   *
   * @return mixed
   *   Values from this entity converted to 'courier.template.TYPE'
   *   configuration.
   */
  public function exportTemplate();

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 9
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
ChannelInterface::applyTokens public function Applies tokens to relevant fields. 2
ChannelInterface::exportTemplate public function Export the message values from this template to configuration values, as found in the 'courier.template.TYPE' config type. Where TYPE is the entity type ID of this entity. 2
ChannelInterface::importTemplate public function Import the message values from configuration values into this entity, as found in the 'courier.template.TYPE' config type. Where TYPE is the entity type ID of this entity. 2
ChannelInterface::isEmpty public function Determine if there is enough data to transmit a message. 2
ChannelInterface::sendMessage public function Sends this message. 1
ChannelInterface::sendMessages public static function Sends messages in bulk. 2
EntityInterface::bundle public function Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::link Deprecated public function Deprecated way of generating a link to the entity. See toLink(). 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 3
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::url Deprecated public function Gets the public URL for this entity. 2
EntityInterface::urlInfo Deprecated public function Gets the URL object for the entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
FieldableEntityInterface::baseFieldDefinitions public static function Provides base field definitions for an entity type. 2
FieldableEntityInterface::bundleFieldDefinitions public static function Provides field definitions for a specific bundle. 2
FieldableEntityInterface::get public function Gets a field item list. 1
FieldableEntityInterface::getFieldDefinition public function Gets the definition of a contained field. 1
FieldableEntityInterface::getFieldDefinitions public function Gets an array of field definitions of all contained fields. 1
FieldableEntityInterface::getFields public function Gets an array of all field item lists. 1
FieldableEntityInterface::getTranslatableFields public function Gets an array of field item lists for translatable fields. 1
FieldableEntityInterface::hasField public function Determines whether the entity has a field with the given name. 1
FieldableEntityInterface::isValidationRequired public function Checks whether entity validation is required before saving the entity. 1
FieldableEntityInterface::onChange public function Reacts to changes to a field. 1
FieldableEntityInterface::set public function Sets a field value. 1
FieldableEntityInterface::setValidationRequired public function Sets whether entity validation is required before saving the entity. 1
FieldableEntityInterface::toArray public function Gets an array of all field values. Overrides EntityInterface::toArray
FieldableEntityInterface::validate public function Validates the currently set values. 1
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. 1
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. 1
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. 1
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. 1
TokenInterface::getTokenOptions function Gets token options as required by \Drupal::token()->replace().
TokenInterface::getTokenValues function Gets token values.
TokenInterface::setTokenOption function Sets a token option.
TokenInterface::setTokenValue function Sets a value to a token type.