You are here

Home » API reference » Purge 8.3 » PurgeQueuer.php

class PurgeQueuer in Purge 8.3

Defines a PurgeQueuer annotation object.

Hierarchy

Expanded class hierarchy of PurgeQueuer

7 classes are annotated with PurgeQueuer
AQueuer in tests/modules/purge_queuer_test/src/Plugin/Purge/Queuer/AQueuer.php
Test queuer A.
BQueuer in tests/modules/purge_queuer_test/src/Plugin/Purge/Queuer/BQueuer.php
Test queuer B.
CoreTagsQueuer in modules/purge_queuer_coretags/src/Plugin/Purge/Queuer/CoreTagsQueuer.php
Queues every tag that Drupal invalidates internally.
CQueuer in tests/modules/purge_queuer_test/src/Plugin/Purge/Queuer/CQueuer.php
Test queuer C.
DrushQueueAddQueuer in modules/purge_drush/src/Plugin/Purge/Queuer/DrushQueueAddQueuer.php
Queuer for the 'drush p:queue-add' command.

... See full list

File

src/Annotation/PurgeQueuer.php, line 12

Namespace

Drupal\purge\Annotation
View source 
class PurgeQueuer extends Plugin {

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

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

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

  /**
   * Whether the plugin needs to auto enable when first discovered.
   *
   * @var bool
   */
  public $enable_by_default = FALSE;

  // phpcs:ignore -- annotation property!

  /**
   * Class name of the configuration form of your queuer.
   *
   * Full class name of the configuration form of your queuer, with leading
   * backslash. Class must extend \Drupal\purge_ui\Form\QueuerConfigFormBase.
   *
   * @var string
   */
  public $configform = '';

}

Members

Namesort descending 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
PurgeQueuer::$configform public property Class name of the configuration form of your queuer.
PurgeQueuer::$description public property The description of the queuer plugin.
PurgeQueuer::$enable_by_default public property Whether the plugin needs to auto enable when first discovered.
PurgeQueuer::$id public property The plugin ID of the queuer plugin.
PurgeQueuer::$label public property The human-readable name of the queuer plugin.