class PurgeDiagnosticCheck in Purge 8.3

Defines a PurgeDiagnosticCheck annotation object.

Hierarchy

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

14 classes are annotated with PurgeDiagnosticCheck

AlwaysErrorDiagnosticCheck in tests/modules/purge_check_error_test/src/Plugin/Purge/DiagnosticCheck/AlwaysErrorDiagnosticCheck.php

Checks if there is a purger plugin that invalidates an external cache.

AlwaysInfoDiagnosticCheck in tests/modules/purge_check_test/src/Plugin/Purge/DiagnosticCheck/AlwaysInfoDiagnosticCheck.php

Checks if there is a purger plugin that invalidates an external cache.

AlwaysOkDiagnosticCheck in tests/modules/purge_check_test/src/Plugin/Purge/DiagnosticCheck/AlwaysOkDiagnosticCheck.php

Checks if there is a purger plugin that invalidates an external cache.

AlwaysWarningDiagnosticCheck in tests/modules/purge_check_warning_test/src/Plugin/Purge/DiagnosticCheck/AlwaysWarningDiagnosticCheck.php

Checks if there is a purger plugin that invalidates an external cache.

CapacityDiagnosticCheck in src/Plugin/Purge/DiagnosticCheck/CapacityDiagnosticCheck.php

Checks if there is purging capacity available.

... See full list

File

src/Annotation/PurgeDiagnosticCheck.php, line 12

Namespace

Drupal\purge\Annotation

class PurgeDiagnosticCheck extends Plugin {

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

  /**
   * The title of the check.
   *
   * @var \Drupal\Core\Annotation\Translation
   * @ingroup plugin_translatable
   */
  public $title;

  /**
   * The description of what the check does.
   *
   * @var \Drupal\Core\Annotation\Translation
   * @ingroup plugin_translatable
   */
  public $description;

  /**
   * Required queue plugins.
   *
   * When your diagnostic check is specific for a certain queue plugin(s) you
   * can bind it to these plugins. This check will then only get loaded when
   * any of these specified queues are in active use.
   *
   * @var array
   *
   * @code
   * dependent_queue_plugins = {"memory", "file"}
   * @endcode
   */
  public $dependent_queue_plugins = [];

  // phpcs:ignore -- annotation property!

  /**
   * Required purger plugins.
   *
   * When your diagnostic check is specific for a certain purger plugin(s) you
   * can bind it to these plugins. This check will then only get loaded when
   * any of these specified purgers are in active use.
   *
   * @var array
   *
   * @code
   * dependent_purger_plugins = {"mypurger"}
   * @endcode
   */
  public $dependent_purger_plugins = [];

}

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
PurgeDiagnosticCheck::$dependent_purger_plugins	public	property	Required purger plugins.
PurgeDiagnosticCheck::$dependent_queue_plugins	public	property	Required queue plugins.
PurgeDiagnosticCheck::$description	public	property	The description of what the check does.
PurgeDiagnosticCheck::$id	public	property	The plugin ID of the diagnostic check.
PurgeDiagnosticCheck::$title	public	property	The title of the check.