class EntityQueueHandler in Entityqueue 8

Defines a EntityQueueHandler annotation object.

Plugin Namespace: Plugin\EntityQueueHandler.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\entityqueue\Annotation\EntityQueueHandler

See also

\Drupal\entityqueue\EntityQueueHandlerInterface

\Drupal\entityqueue\EntityQueueHandlerManager

\Drupal\entityqueue\EntityQueueHandlerBase

Plugin API

4 classes are annotated with EntityQueueHandler

Multiple in src/Plugin/EntityQueueHandler/Multiple.php

Defines an entity queue handler that manages multiple subqueues.

Simple in src/Plugin/EntityQueueHandler/Simple.php

Defines an entity queue handler that manages a single subqueue.

SmartQueue in modules/entityqueue_smartqueue/src/Plugin/EntityQueueHandler/SmartQueue.php

Plugin annotation @EntityQueueHandler( id = "smartqueue", title = @Translation("Smart queue"), description = @Translation("Provides automated subqueues for each entity of a given type."), )

Test in tests/modules/entityqueue_test/src/Plugin/EntityQueueHandler/Test.php

Defines an entity queue handler for testing.

File

src/Annotation/EntityQueueHandler.php, line 19

Namespace

Drupal\entityqueue\Annotation

class EntityQueueHandler extends Plugin {

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

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

  /**
   * The description of the queue handler plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

}

Members

Name	Modifiers	Type	Description	Overrides
EntityQueueHandler::$description	public	property	The description of the queue handler plugin.
EntityQueueHandler::$id	public	property	The plugin ID.
EntityQueueHandler::$title	public	property	The human-readable name of the queue handler 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