abstract class TagsHeaderBase in Purge 8.3

Base implementation for plugins that add and format a cache tags header.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\purge\Plugin\Purge\TagsHeader\TagsHeaderBase implements TagsHeaderInterface

3 files declare their use of TagsHeaderBase

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

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

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

File

src/Plugin/Purge/TagsHeader/TagsHeaderBase.php, line 11

Namespace

Drupal\purge\Plugin\Purge\TagsHeader

abstract class TagsHeaderBase extends PluginBase implements TagsHeaderInterface {

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public function getHeaderName() {
    return $this
      ->getPluginDefinition()['header_name'];
  }

  /**
   * {@inheritdoc}
   */
  public function getValue(array $tags) {
    return implode(' ', $tags);
  }

  /**
   * {@inheritdoc}
   */
  public function isEnabled() {
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TagsHeaderBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
TagsHeaderBase::getHeaderName	public	function	Fetch the HTTP response header name. Overrides TagsHeaderInterface::getHeaderName
TagsHeaderBase::getValue	public	function	Format the given cache tags for the header value representation. Overrides TagsHeaderInterface::getValue
TagsHeaderBase::isEnabled	public	function	Determine if this header should be added to the response. Overrides TagsHeaderInterface::isEnabled