class PurgePurger in Purge 8.3

Defines a PurgePurger annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\purge\Annotation\PurgePurger

5 classes are annotated with PurgePurger

APurger in tests/modules/purge_purger_test/src/Plugin/Purge/Purger/APurger.php

Test purger A.

BPurger in tests/modules/purge_purger_test/src/Plugin/Purge/Purger/BPurger.php

Test purger B.

CPurger in tests/modules/purge_purger_test/src/Plugin/Purge/Purger/CPurger.php

Test purger C.

GoodPurger in tests/modules/purge_purger_test/src/Plugin/Purge/Purger/GoodPurger.php

A purger that always succeeds.

WithFormPurger in tests/modules/purge_purger_test/src/Plugin/Purge/Purger/WithFormPurger.php

Test PurgerWithForm.

File

src/Annotation/PurgePurger.php, line 12

Namespace

Drupal\purge\Annotation

class PurgePurger extends Plugin {

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

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

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

  /**
   * Time in seconds to wait after invalidation.
   *
   * The value is expressed as float between 0.0 and 3.0. After ::invalidate()
   * finished, the system will automatically wait this time to allow the caching
   * platform in front of Drupal, to catch up (before other purgers kick in).
   *
   * This value adds up to the total time hint of this purger and therefore the
   * higher this value is, the less processing can happen per request. Platforms
   * that clear instantly (e.g.: via a socket) are best off leaving this at 0.0.
   *
   * @var float
   */
  public $cooldown_time = 0.0;

  // phpcs:ignore -- annotation property!

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

  /**
   * Whether end users can create more then one instance of the purger plugin.
   *
   * When you set 'multi_instance = TRUE' in your plugin annotation, it
   * becomes possible for end-users to create multiple instances of your
   * purger. With \Drupal\purge\Plugin\Purge\Purger\PurgerInterface::getId(),
   * you can read the unique identifier of your instance to keep multiple
   * instances apart.
   *
   * @var bool
   */
  public $multi_instance = FALSE;

  // phpcs:ignore -- annotation property!

  /**
   * Types supported by the purger.
   *
   * A list of invalidation types that are supported by the purger plugin, for
   * instance 'tag', 'path' or 'url'. The plugin will only receive invalidation
   * requests for the given types, others fail with state NOT_SUPPORTED. It
   * is possible to dynamically provide this list by overloading the base
   * implementation.
   *
   * @var string[]
   * @see \Drupal\purge\Plugin\Purge\Purger\PurgerInterface::getTypes()
   */
  public $types = [];

}

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
PurgePurger::$configform	public	property	Class name of the configuration form of your purger.
PurgePurger::$cooldown_time	public	property	Time in seconds to wait after invalidation.
PurgePurger::$description	public	property	The description of the purger plugin.
PurgePurger::$id	public	property	The plugin ID of the purger plugin.
PurgePurger::$label	public	property	The human-readable name of the purger plugin.
PurgePurger::$multi_instance	public	property	Whether end users can create more then one instance of the purger plugin.
PurgePurger::$types	public	property	Types supported by the purger.