You are here

Home » API reference » Generic HTTP Purger 8 » HttpBundledPurger.php

class HttpBundledPurger in Generic HTTP Purger 8

HTTP Bundled Purger.

Plugin annotation


@PurgePurger(
  id = "httpbundled",
  label = @Translation("HTTP Bundled Purger"),
  configform = "\Drupal\purge_purger_http\Form\HttpBundledPurgerForm",
  cooldown_time = 0.0,
  description = @Translation("Configurable purger that sends a single HTTP request for a set of invalidation instructions."),
  multi_instance = TRUE,
  types = {},
)

Hierarchy

Expanded class hierarchy of HttpBundledPurger

File

src/Plugin/Purge/Purger/HttpBundledPurger.php, line 21

Namespace

Drupal\purge_purger_http\Plugin\Purge\Purger
View source 
class HttpBundledPurger extends HttpPurgerBase implements PurgerInterface {

  /**
   * {@inheritdoc}
   */
  public function invalidate(array $invalidations) {

    // Create a simple closure to mass-update states on the objects.
    $set_state = function ($state) use ($invalidations) {
      foreach ($invalidations as $invalidation) {
        $invalidation
          ->setState($state);
      }
    };

    // Build up a single HTTP request, execute it and log errors.
    $token_data = [
      'invalidations' => $invalidations,
    ];
    $uri = $this
      ->getUri($token_data);
    $opt = $this
      ->getOptions($token_data);
    try {
      $this->client
        ->request($this->settings->request_method, $uri, $opt);
      $set_state(InvalidationInterface::SUCCEEDED);
    } catch (\Exception $e) {
      $set_state(InvalidationInterface::FAILED);

      // Log as much useful information as we can.
      $headers = $opt['headers'];
      unset($opt['headers']);
      $debug = json_encode(str_replace("\n", ' ', [
        'msg' => $e
          ->getMessage(),
        'uri' => $uri,
        'method' => $this->settings->request_method,
        'guzzle_opt' => $opt,
        'headers' => $headers,
      ]));
      $this
        ->logger()
        ->emergency("item failed due @e, details (JSON): @debug", [
        '@e' => get_class($e),
        '@debug' => $debug,
      ]);
    }
  }

}

Members

Namesort descending 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
HttpBundledPurger::invalidate public function Invalidate content from external caches. Overrides PurgerInterface::invalidate
HttpPurgerBase::$client protected property The Guzzle HTTP client.
HttpPurgerBase::$settings protected property The settings entity holding all configuration.
HttpPurgerBase::$token protected property The token service.
HttpPurgerBase::create public static function Creates an instance of the plugin. Overrides PurgerBase::create
HttpPurgerBase::delete public function The current instance of this purger plugin is about to be deleted. Overrides PurgerBase::delete
HttpPurgerBase::getCooldownTime public function Get the time in seconds to wait after invalidation. Overrides PurgerBase::getCooldownTime
HttpPurgerBase::getHeaders protected function Retrieve all configured headers that need to be set.
HttpPurgerBase::getIdealConditionsLimit public function Get the maximum number of invalidations that this purger can process. Overrides PurgerBase::getIdealConditionsLimit
HttpPurgerBase::getLabel public function Retrieve the user-readable label for this purger instance. Overrides PurgerBase::getLabel
HttpPurgerBase::getOptions protected function Retrieve the Guzzle connection options to set.
HttpPurgerBase::getTimeHint public function Get the maximum number of seconds, processing a single invalidation takes. Overrides PurgerBase::getTimeHint
HttpPurgerBase::getTypes public function Retrieve the list of supported invalidation types. Overrides PurgerBase::getTypes
HttpPurgerBase::getUri protected function Retrieve the URI to connect to.
HttpPurgerBase::hasRuntimeMeasurement public function Indicates whether your purger utilizes dynamic runtime measurement. Overrides PurgerCapacityDataInterface::hasRuntimeMeasurement
HttpPurgerBase::__construct final public function Constructs the HTTP purger. Overrides PurgerBase::__construct
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
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.