class IdentityChannel in Courier 2.x

A bridge applying identity information to a message.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\courier\Annotation\IdentityChannel

3 classes are annotated with IdentityChannel

Broken in src/Plugin/IdentityChannel/Broken.php

Fallback plugin for missing IdentityChannel plugins.

User in src/Plugin/IdentityChannel/CourierEmail/User.php

Supports core user entities.

User in tests/modules/courier_test_message/src/Plugin/IdentityChannel/TestMessage/User.php

Supports core user entities.

File

src/Annotation/IdentityChannel.php, line 12

Namespace

Drupal\courier\Annotation

class IdentityChannel extends Plugin {

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

  /**
   * The human-readable name of the plugin.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * The ID of an entity type implementing \Drupal\courier\ChannelInterface.
   *
   * @var string
   */
  public $channel;

  /**
   * The ID of an entity type representing an identity.
   *
   * @var string
   */
  public $identity;

  /**
   * The weight of the plugin.
   *
   * @var int
   */
  public $weight;

}

Members

Name	Modifiers	Type	Description	Overrides
IdentityChannel::$channel	public	property	The ID of an entity type implementing \Drupal\courier\ChannelInterface.
IdentityChannel::$id	public	property	The plugin ID.
IdentityChannel::$identity	public	property	The ID of an entity type representing an identity.
IdentityChannel::$label	public	property	The human-readable name of the plugin.
IdentityChannel::$weight	public	property	The weight of the plugin.
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	1
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