PurgerBase.php in Purge 8.3

Namespace

Drupal\purge\Plugin\Purge\Purger

File

src/Plugin/Purge/Purger/PurgerBase.php

<?php

namespace Drupal\purge\Plugin\Purge\Purger;

use Drupal\Core\Plugin\PluginBase;
use Drupal\purge\Logger\PurgeLoggerAwareTrait;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides a base class for all purgers - the cache invalidation executors.
 */
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;
  }

}

Classes

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