class RecipientType in Workbench Email 8

Defines a Recipient type annotation object.

Plugin Namespace: Plugin\workbench_email\RecipientType.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\workbench_email\Annotation\RecipientType

See also

\Drupal\workbench_email\RecipientTypePluginManager

\Drupal\workbench_email\Plugin\RecipientTypeInterface

\Drupal\workbench_email\Plugin\RecipientTypeBase

Plugin API

7 classes are annotated with RecipientType

Author in src/Plugin/RecipientType/Author.php

Provides a recipient type of the content author.

EmailField in src/Plugin/RecipientType/EmailField.php

Provides a recipient type of an email field.

EntityReferenceUser in src/Plugin/RecipientType/EntityReferenceUser.php

Provides a recipient type based on entity reference fields.

FixedEmail in src/Plugin/RecipientType/FixedEmail.php

Provides a recipient type of fixed email field

LastRevisionAuthor in src/Plugin/RecipientType/LastRevisionAuthor.php

Defines a plugin for mailing to last revision author.

... See full list

File

src/Annotation/RecipientType.php, line 19

Namespace

Drupal\workbench_email\Annotation

class RecipientType extends Plugin {

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

  /**
   * The name of the provider that owns the recipient type.
   *
   * @var string
   */
  public $provider;

  /**
   * The human-readable name of the recipient type.
   *
   * This is used as an administrative summary of what the recipient type does.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $title;

  /**
   * Additional administrative information about the recipient type's behavior.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description = '';

  /**
   * Whether this recipient type is enabled or disabled by default.
   *
   * @var bool
   */
  public $status = FALSE;

  /**
   * The default settings for the recipient type.
   *
   * @var array
   */
  public $settings = [];

}

Members

Name	Modifiers	Type	Description	Overrides
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
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
RecipientType::$description	public	property	Additional administrative information about the recipient type's behavior.
RecipientType::$id	public	property	The plugin ID.
RecipientType::$provider	public	property	The name of the provider that owns the recipient type.
RecipientType::$settings	public	property	The default settings for the recipient type.
RecipientType::$status	public	property	Whether this recipient type is enabled or disabled by default.
RecipientType::$title	public	property	The human-readable name of the recipient type.