abstract class PurgerBase in Purge 8.3

Provides a base class for all purgers - the cache invalidation executors.

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

Expanded class hierarchy of PurgerBase

1 file declares its use of PurgerBase

NullPurgerBase.php in tests/modules/purge_purger_test/src/Plugin/Purge/Purger/NullPurgerBase.php

File

src/Plugin/Purge/Purger/PurgerBase.php, line 12

Namespace

Drupal\purge\Plugin\Purge\Purger

View source

abstract class PurgerBase extends PluginBase implements PurgerInterface {
  use PurgeLoggerAwareTrait;

  /**
   * Unique instance ID for this purger.
   *
   * @var string
   */
  protected $id;

  /**
   * The runtime measurement counter.
   *
   * @var null|\Drupal\purge\Plugin\Purge\Purger\RuntimeMeasurementInterface
   */
  protected $runtimeMeasurement = NULL;

  /**
   * Construct a PurgerBase derivative.
   *
   * @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.
   *
   * @throws \LogicException
   *   Thrown if $configuration['id'] is missing, see Purger\Service::createId.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    if (!is_string($configuration['id']) || empty($configuration['id'])) {
      throw new \LogicException('Purger cannot be constructed without ID.');
    }
    $this->id = $configuration['id'];
    unset($configuration['id']);
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }

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

  /**
   * {@inheritdoc}
   */
  public function delete() {
    if ($this->pluginDefinition['multi_instance']) {
      throw new \LogicException('Plugin is multi-instantiable, ::delete() not implemented!');
    }
  }

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

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

    // We don't know how much invalidations our derivatives can process under
    // ideal circumstances, it can range from low numbers on inefficient CDNs to
    // literally thousands when connecting to efficient systems over a local
    // socket. Purger implementations are definitely encouraged to overload this
    // method with a value that is as accurately approached as possible.
    return 100;
  }

  /**
   * {@inheritdoc}
   */
  public function getId() {
    return $this->id;
  }

  /**
   * {@inheritdoc}
   */
  public function getLabel() {
    $label = $this
      ->getPluginDefinition()['label'];
    if ($this
      ->getPluginDefinition()['multi_instance']) {
      return $this
        ->t('@label @id', [
        '@label' => $label,
        '@id' => $this->id,
      ]);
    }
    else {
      return $label;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getRuntimeMeasurement() {
    return $this->runtimeMeasurement;
  }

  /**
   * {@inheritdoc}
   */
  public function getTimeHint() {
    if (!$this
      ->hasRuntimeMeasurement()) {
      throw new \LogicException('Since ::hasRuntimeMeasurement() returns FALSE, ::getTimeHint() needs to be implemented! Please read the PurgerCapacityDataInterface::hasRuntimeMeasurement() documentation.');
    }

    // Return the measured number of seconds, if stored of course.
    if (!is_null($this->runtimeMeasurement)) {
      if (($measured_time = $this->runtimeMeasurement
        ->get()) > 0.0) {
        return $measured_time;
      }
    }

    // A single invalidation lasting 4.0 seconds is quite terrible, but a safe
    // default to use as hint when no measurement was stored yet.
    return 4.0;
  }

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

  /**
   * {@inheritdoc}
   */
  public function routeTypeToMethod($type) {
    return 'invalidate';
  }

  /**
   * {@inheritdoc}
   */
  public function setRuntimeMeasurement(RuntimeMeasurementInterface $measurement) {
    $this->runtimeMeasurement = $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::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PurgerBase::delete	public	function	The current instance of this purger plugin is about to be deleted. Overrides PurgerInterface::delete	1
PurgerBase::getCooldownTime	public	function	Get the time in seconds to wait after invalidation. Overrides PurgerCapacityDataInterface::getCooldownTime
PurgerBase::getId	public	function	Retrieve the unique instance ID for this purger instance. Overrides PurgerInterface::getId
PurgerBase::getIdealConditionsLimit	public	function	Get the maximum number of invalidations that this purger can process. Overrides PurgerCapacityDataInterface::getIdealConditionsLimit	1
PurgerBase::getLabel	public	function	Retrieve the user-readable label for this purger instance. Overrides PurgerInterface::getLabel
PurgerBase::getRuntimeMeasurement	public	function	Get the runtime measurement counter. Overrides PurgerCapacityDataInterface::getRuntimeMeasurement
PurgerBase::getTimeHint	public	function	Get the maximum number of seconds, processing a single invalidation takes. Overrides PurgerCapacityDataInterface::getTimeHint
PurgerBase::getTypes	public	function	Retrieve the list of supported invalidation types. Overrides PurgerInterface::getTypes
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
PurgerBase::__construct	public	function	Construct a PurgerBase derivative. Overrides PluginBase::__construct
PurgerCapacityDataInterface::hasRuntimeMeasurement	public	function	Indicates whether your purger utilizes dynamic runtime measurement.	1
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.

You are here

abstract class PurgerBase in Purge 8.3

Hierarchy

File

Namespace

Members

API Navigation