class PurgeTagsHeader in Purge 8.3

Defines a PurgeTagsHeader annotation object.

Hierarchy

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

3 classes are annotated with PurgeTagsHeader

ATagsHeader in tests/modules/purge_tagsheader_test/src/Plugin/Purge/TagsHeader/ATagsHeader.php

Test header A.

BTagsHeader in tests/modules/purge_tagsheader_test/src/Plugin/Purge/TagsHeader/BTagsHeader.php

Test header B.

CTagsHeader in tests/modules/purge_tagsheader_test/src/Plugin/Purge/TagsHeader/CTagsHeader.php

Test header C.

File

src/Annotation/PurgeTagsHeader.php, line 12

Namespace

Drupal\purge\Annotation

class PurgeTagsHeader extends Plugin {

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

  /**
   * The HTTP response header that the plugin sets.
   *
   * @var string
   *
   * @warning
   *   In RFC #6648 the use of 'X-' as header prefixes has been deprecated
   *   for "application protocols", this naturally includes Drupal. Therefore
   *   if this is possible, consider header names without this prefix.
   */
  public $header_name;

  // phpcs:ignore -- annotation property!

  /**
   * Required purger plugins.
   *
   * When your tags header is specific for a certain purger plugin(s) you
   * can bind it to these plugins. This tags header 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
PurgeTagsHeader::$dependent_purger_plugins	public	property	Required purger plugins.
PurgeTagsHeader::$header_name	public	property	The HTTP response header that the plugin sets.
PurgeTagsHeader::$id	public	property	The plugin ID of the tagsheader.