class MessagePurge in Message 8

Defines a MessagePurge annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\message\Annotation\MessagePurge

2 classes are annotated with MessagePurge

Days in src/Plugin/MessagePurge/Days.php

Delete messages older than certain days.

Quota in src/Plugin/MessagePurge/Quota.php

Maximal (approximate) amount of messages.

File

src/Annotation/MessagePurge.php, line 12

Namespace

Drupal\message\Annotation

class MessagePurge extends Plugin {

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

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

  /**
   * A short description of the plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

}

Members

Name	Modifiers	Type	Description	Overrides
MessagePurge::$description	public	property	A short description of the plugin.
MessagePurge::$id	public	property	The plugin ID.
MessagePurge::$label	public	property	The human-readable name 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
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