abstract class VarnishPurgerBase in Varnish purger 8

Same name and namespace in other branches

8.2 src/Plugin/Purge/Purger/VarnishPurgerBase.php \Drupal\varnish_purger\Plugin\Purge\Purger\VarnishPurgerBase

Abstract base class for HTTP based configurable purgers.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\purge\Plugin\Purge\Purger\PurgerBase implements PurgerInterface uses PurgeLoggerAwareTrait
    class \Drupal\varnish_purger\Plugin\Purge\Purger\VarnishPurgerBase implements PurgerInterface

Expanded class hierarchy of VarnishPurgerBase

File

src/Plugin/Purge/Purger/VarnishPurgerBase.php, line 15

Namespace

Drupal\varnish_purger\Plugin\Purge\Purger

View source

abstract class VarnishPurgerBase extends PurgerBase implements PurgerInterface {

  /**
   * @var \GuzzleHttp\Client
   */
  protected $client;

  /**
   * The settings entity holding all configuration.
   *
   * @var \Drupal\varnish_purger\Entity\VarnishPurgerSettings
   */
  protected $settings;

  /**
   * The token service.
   *
   * @var \Drupal\Core\Utility\Token
   */
  protected $token;

  /**
   * Constructs the Varnish purger.
   *
   * @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 \GuzzleHttp\ClientInterface $http_client
   *   An HTTP client that can perform remote requests.
   * @param \Drupal\Core\Utility\Token $token
   *   The token service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ClientInterface $http_client, Token $token) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->settings = VarnishPurgerSettings::load($this
      ->getId());
    $this->client = $http_client;
    $this->token = $token;
  }

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

  /**
   * {@inheritdoc}
   */
  public function delete() {
    VarnishPurgerSettings::load($this
      ->getId())
      ->delete();
  }

  /**
   * {@inheritdoc}
   */
  public function getCooldownTime() {
    return $this->settings->cooldown_time;
  }

  /**
   * {@inheritdoc}
   */
  public function getIdealConditionsLimit() {
    return $this->settings->max_requests;
  }

  /**
   * Retrieve all configured headers that need to be set.
   *
   * @param array $token_data
   *   An array of keyed objects, to pass on to the token service.
   *
   * @return string[]
   *   Associative array with header values and field names in the key.
   */
  protected function getHeaders($token_data) {
    $headers = [];
    $headers['user-agent'] = 'varnish_purger module for Drupal 8.';
    foreach ($this->settings->headers as $header) {

      // According to https://tools.ietf.org/html/rfc2616#section-4.2, header
      // names are case-insensitive. Therefore, to aid easy overrides by end
      // users, we lower all header names so that no doubles are sent.
      $headers[strtolower($header['field'])] = $this->token
        ->replace($header['value'], $token_data);
    }
    return $headers;
  }

  /**
   * {@inheritdoc}
   */
  public function getLabel() {
    if ($this->settings->name) {
      return $this->settings->name;
    }
    else {
      return parent::getLabel();
    }
  }

  /**
   * Retrieve the Guzzle connection options to set.
   *
   * @param array $token_data
   *   An array of keyed objects, to pass on to the token service.
   *
   * @return mixed[]
   *   Associative array with option/value pairs.
   */
  protected function getOptions($token_data) {
    $opt = [
      'http_errors' => $this->settings->http_errors,
      'connect_timeout' => $this->settings->connect_timeout,
      'timeout' => $this->settings->timeout,
      'headers' => $this
        ->getHeaders($token_data),
    ];
    if ($this->settings->scheme === 'https') {
      $opt['verify'] = (bool) $this->settings->verify;
    }
    return $opt;
  }

  /**
   * {@inheritdoc}
   */
  public function getTimeHint() {

    // When runtime measurement is enabled, we just use the base implementation.
    if ($this->settings->runtime_measurement) {
      return parent::getTimeHint();
    }

    // Theoretically connection timeouts and general timeouts can add up, so
    // we add up our assumption of the worst possible time it takes as well.
    return $this->settings->connect_timeout + $this->settings->timeout;
  }

  /**
   * {@inheritdoc}
   */
  public function getTypes() {
    return [
      $this->settings->invalidationtype,
    ];
  }

  /**
   * Retrieve the URI to connect to.
   *
   * @param array $token_data
   *   An array of keyed objects, to pass on to the token service.
   *
   * @return string
   *   URL string representation.
   */
  protected function getUri($token_data) {
    return sprintf('%s://%s:%s%s', $this->settings->scheme, $this->settings->hostname, $this->settings->port, $this->token
      ->replace($this->settings->path, $token_data));
  }

  /**
   * {@inheritdoc}
   */
  public function hasRuntimeMeasurement() {
    return (bool) $this->settings->runtime_measurement;
  }

}

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.
PurgeLoggerAwareTrait::$logger	protected	property	Channel logger.
PurgeLoggerAwareTrait::logger	public	function
PurgerBase::$id	protected	property	Unique instance ID for this purger.
PurgerBase::$runtimeMeasurement	protected	property	The runtime measurement counter.
PurgerBase::getId	public	function	Retrieve the unique instance ID for this purger instance. Overrides PurgerInterface::getId
PurgerBase::getRuntimeMeasurement	public	function	Get the runtime measurement counter. Overrides PurgerCapacityDataInterface::getRuntimeMeasurement
PurgerBase::routeTypeToMethod	public	function	Route certain type of invalidations to other methods. Overrides PurgerInterface::routeTypeToMethod
PurgerBase::setRuntimeMeasurement	public	function	Inject the runtime measurement counter. Overrides PurgerCapacityDataInterface::setRuntimeMeasurement
PurgerInterface::invalidate	public	function	Invalidate content from external caches.	1
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.
VarnishPurgerBase::$client	protected	property
VarnishPurgerBase::$settings	protected	property	The settings entity holding all configuration.
VarnishPurgerBase::$token	protected	property	The token service.
VarnishPurgerBase::create	public static	function	Creates an instance of the plugin. Overrides PurgerBase::create
VarnishPurgerBase::delete	public	function	The current instance of this purger plugin is about to be deleted. Overrides PurgerBase::delete
VarnishPurgerBase::getCooldownTime	public	function	Get the time in seconds to wait after invalidation. Overrides PurgerBase::getCooldownTime
VarnishPurgerBase::getHeaders	protected	function	Retrieve all configured headers that need to be set.
VarnishPurgerBase::getIdealConditionsLimit	public	function	Get the maximum number of invalidations that this purger can process. Overrides PurgerBase::getIdealConditionsLimit
VarnishPurgerBase::getLabel	public	function	Retrieve the user-readable label for this purger instance. Overrides PurgerBase::getLabel
VarnishPurgerBase::getOptions	protected	function	Retrieve the Guzzle connection options to set.
VarnishPurgerBase::getTimeHint	public	function	Get the maximum number of seconds, processing a single invalidation takes. Overrides PurgerBase::getTimeHint
VarnishPurgerBase::getTypes	public	function	Retrieve the list of supported invalidation types. Overrides PurgerBase::getTypes
VarnishPurgerBase::getUri	protected	function	Retrieve the URI to connect to.
VarnishPurgerBase::hasRuntimeMeasurement	public	function	Indicates whether your purger utilizes dynamic runtime measurement. Overrides PurgerCapacityDataInterface::hasRuntimeMeasurement
VarnishPurgerBase::__construct	public	function	Constructs the Varnish purger. Overrides PurgerBase::__construct

You are here

abstract class VarnishPurgerBase in Varnish purger 8

Hierarchy

File

Namespace

Members

API Navigation