You are here

Home » API reference » Acquia Purge 8 » AcquiaPlatformCdnTagsHeader.php

class AcquiaPlatformCdnTagsHeader in Acquia Purge 8

Exports a tags header for the current Platform CDN backend.

Plugin annotation


@PurgeTagsHeader(
  id = "acquiapurgecdntagsheader",
  header_name = "X-Acquia-Purge-Cdn-Unconfigured",
  dependent_purger_plugins = {"acquia_platform_cdn"},
)

Hierarchy

Expanded class hierarchy of AcquiaPlatformCdnTagsHeader

File

src/Plugin/Purge/TagsHeader/AcquiaPlatformCdnTagsHeader.php, line 20

Namespace

Drupal\acquia_purge\Plugin\Purge\TagsHeader
View source 
class AcquiaPlatformCdnTagsHeader extends TagsHeaderBase implements TagsHeaderInterface {

  /**
   * The Acquia Platform CDN backend.
   *
   * @var null|string
   */
  protected $backendClass = NULL;

  /**
   * Information object interfacing with the Acquia platform.
   *
   * @var \Drupal\acquia_purge\AcquiaCloud\PlatformInfoInterface
   */
  protected $platformInfo;

  /**
   * Constructs a AcquiaPlatformCdnTagsHeader object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\acquia_purge\AcquiaCloud\PlatformInfoInterface $acquia_purge_platforminfo
   *   Information object interfacing with the Acquia platform.
   */
  public final function __construct(array $configuration, $plugin_id, $plugin_definition, PlatformInfoInterface $acquia_purge_platforminfo) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->platformInfo = $acquia_purge_platforminfo;
    $this->backendClass = BackendFactory::getClass($this->platformInfo);

    // When a backend is available, inject the platform info object.
    if ($this->backendClass) {
      $this->backendClass::platformInfo($this->platformInfo);
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('acquia_purge.platforminfo'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function getValue(array $tags) {
    if ($this->backendClass) {
      return $this->backendClass::tagsHeaderValue($tags);
    }
    return 'n/a';
  }

  /**
   * {@inheritdoc}
   */
  public function isEnabled() {
    if ($this->backendClass) {
      return TRUE;
    }
    return FALSE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AcquiaPlatformCdnTagsHeader::$backendClass protected property The Acquia Platform CDN backend.
AcquiaPlatformCdnTagsHeader::$platformInfo protected property Information object interfacing with the Acquia platform.
AcquiaPlatformCdnTagsHeader::create public static function Creates an instance of the plugin. Overrides TagsHeaderBase::create
AcquiaPlatformCdnTagsHeader::getHeaderName public function Fetch the HTTP response header name. Overrides TagsHeaderBase::getHeaderName
AcquiaPlatformCdnTagsHeader::getValue public function Format the given cache tags for the header value representation. Overrides TagsHeaderBase::getValue
AcquiaPlatformCdnTagsHeader::isEnabled public function Determine if this header should be added to the response. Overrides TagsHeaderBase::isEnabled
AcquiaPlatformCdnTagsHeader::__construct final public function Constructs a AcquiaPlatformCdnTagsHeader object. Overrides PluginBase::__construct
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.
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.