interface InvalidationInterface in Purge 8.3

Desribes the invalidation object.

Invalidations are small value objects that describe and track invalidations on one or more external caching systems within the Purge pipeline. These objects can be directly instantiated from InvalidationsService and float freely between the QueueService and the PurgersService.

Hierarchy

interface \Drupal\purge\Plugin\Purge\Invalidation\ImmutableInvalidationInterface; interface \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- interface \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface

Expanded class hierarchy of InvalidationInterface

All classes that implement InvalidationInterface

15 files declare their use of InvalidationInterface

CacheTagsQueuerTest.php in modules/purge_queuer_coretags/tests/src/Unit/CacheTagsQueuerTest.php
GoodPurger.php in tests/modules/purge_purger_test/src/Plugin/Purge/Purger/GoodPurger.php
NullPurgerBase.php in tests/modules/purge_purger_test/src/Plugin/Purge/Purger/NullPurgerBase.php
PluginTestBase.php in tests/src/Kernel/Invalidation/PluginTestBase.php
ProxyItem.php in src/Plugin/Purge/Queue/ProxyItem.php

... See full list

File

src/Plugin/Purge/Invalidation/InvalidationInterface.php, line 15

Namespace

Drupal\purge\Plugin\Purge\Invalidation

View source

interface InvalidationInterface extends ImmutableInvalidationInterface, ContainerFactoryPluginInterface {

  /**
   * Delete a purger specific property.
   *
   * Once ::setStateContext() has been called, purgers can call ::setProperty()
   * and ::getProperty() to store specific metadata on the invalidation. The
   * most common usecase for setting properties is for multi-step cache
   * invalidation, for instance CDNs returning IDs to check against later.
   *
   * @param string $key
   *   The key of the stored property, unique to the current purger context.
   *
   * @throws \LogicException
   *   Thrown when operating in general context, call ::setStateContext() first.
   */
  public function deleteProperty($key);

  /**
   * Get the instance ID.
   *
   * @return int
   *   Unique integer ID for this object instance (during runtime).
   */
  public function getId();

  /**
   * Remove a state context from the object because the purger no longer exists.
   *
   * @param string $purger_instance_id
   *   The instance ID of the purger to wipe from the invalidation.
   *
   * @throws \LogicException
   *   Thrown when the value is incorrect or when NOT operating in NULL context.
   */
  public function removeStateContext($purger_instance_id);

  /**
   * Set a purger specific property.
   *
   * Once ::setStateContext() has been called, purgers can call ::setProperty()
   * and ::getProperty() to store specific metadata on the invalidation. The
   * most common usecase for setting properties is for multi-step cache
   * invalidation, for instance CDNs returning IDs to check against later.
   *
   * @param string $key
   *   The key of the property to set, unique to the current purger context.
   * @param mixed $value
   *   The value of the property.
   *
   * @throws \LogicException
   *   Thrown when operating in general context, call ::setStateContext() first.
   */
  public function setProperty($key, $value);

  /**
   * Set the state of the invalidation.
   *
   * Setting state on invalidation objects is the responsibility of purgers, as
   * only purgers decide what succeeded and what failed. For this reason a call
   * to ::setStateContext() before the state is set, is obligatory.
   *
   * @param int $state
   *   One of the following states:
   *   - InvStatesInterface::SUCCEEDED
   *   - InvStatesInterface::FAILED
   *   - InvStatesInterface::PROCESSING
   *   - InvStatesInterface::NOT_SUPPORTED.
   *
   * @throws \Drupal\purge\Plugin\Purge\Invalidation\Exception\InvalidStateException
   *   Thrown when the $state parameter doesn't match any of the constants
   *   defined in \Drupal\purge\Plugin\Purge\Invalidation\InvStatesInterface.
   * @throws \LogicException
   *   Thrown when the state is being set in general context.
   */
  public function setState($state);

  /**
   * Set (or reset) state context to the purger instance next in line.
   *
   * New, freshly claimed invalidations and those exiting the PurgersService
   * always have NULL as their state context. This means that when called,
   * ::getState() resolves the general state by triaging all stored states. So
   * for example: when no states are known, it will evaluate to FRESH but when
   * one state is set to SUCCEEDED and a few others to FAILED, the general state
   * becomes FAILED. When only SUCCEEDED's is stored, it will evaluate as such.
   *
   * However, the behaviors of ::getState() and ::setState() change after a call
   * to ::setStateContext(). From this point on, both will respectively retrieve
   * and store the state *specific* to that purger context. Context switching is
   * handled by PurgersServiceInterface::invalidate() and therefore no
   * understanding of this concept is required outside the purgers service code.
   *
   * @param string|null $purger_instance_id
   *   The instance ID of the purger that is about to process the object, or
   *   NULL when no longer any purgers are processing it. NULL is the default.
   *
   * @throws \LogicException
   *   Thrown when the given parameter is empty, not a string or NULL.
   * @throws \Drupal\purge\Plugin\Purge\Purger\Exception\BadPluginBehaviorException
   *   Thrown when the last set state was not any of:
   *   - InvStatesInterface::SUCCEEDED
   *   - InvStatesInterface::FAILED
   *   - InvStatesInterface::PROCESSING
   *   - InvStatesInterface::NOT_SUPPORTED.
   *
   * @see \Drupal\purge\Plugin\Purge\Purger\PurgersServiceInterface::invalidate()
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::setState()
   * @see \Drupal\purge\Plugin\Purge\Invalidation\ImmutableInvalidationInterface::getState()
   */
  public function setStateContext($purger_instance_id);

  /**
   * Validate the expression given to the invalidation during instantiation.
   *
   * @throws \Drupal\purge\Plugin\Purge\Invalidation\Exception\MissingExpressionException
   *   Thrown when plugin defined expression_required = TRUE and when it is
   *   instantiated without expression (NULL).
   * @throws \Drupal\purge\Plugin\Purge\Invalidation\Exception\InvalidExpressionException
   *   Exception thrown when plugin got instantiated with an expression that is
   *   not deemed valid for the type of invalidation.
   *
   * @see \Drupal\purge\Annotation\PurgeInvalidation::$expression_required
   * @see \Drupal\purge\Annotation\PurgeInvalidation::$expression_can_be_empty
   */
  public function validateExpression();

}

Members

Name	Modifiers	Type	Description	Overrides
ContainerFactoryPluginInterface::create	public static	function	Creates an instance of the plugin.	112
ImmutableInvalidationInterface::getExpression	public	function	Get the invalidation expression.	1
ImmutableInvalidationInterface::getProperties	public	function	Get all stored properties.	1
ImmutableInvalidationInterface::getProperty	public	function	Retrieve a purger specific property value.	1
ImmutableInvalidationInterface::getState	public	function	Get the current or general state of the invalidation.	1
ImmutableInvalidationInterface::getStateContexts	public	function	Get all stored state contexts.	1
ImmutableInvalidationInterface::getStates	public	function	Get all invalidation states.	1
ImmutableInvalidationInterface::getStateString	public	function	Get the current state as string.	1
ImmutableInvalidationInterface::getStateStringTranslated	public	function	Get the current state as user translated string.	1
ImmutableInvalidationInterface::getType	public	function	Get the type of invalidation.	1
ImmutableInvalidationInterface::__toString	public	function	Return the string expression of the invalidation.	1
InvalidationInterface::deleteProperty	public	function	Delete a purger specific property.	1
InvalidationInterface::getId	public	function	Get the instance ID.	1
InvalidationInterface::removeStateContext	public	function	Remove a state context from the object because the purger no longer exists.	1
InvalidationInterface::setProperty	public	function	Set a purger specific property.	1
InvalidationInterface::setState	public	function	Set the state of the invalidation.	1
InvalidationInterface::setStateContext	public	function	Set (or reset) state context to the purger instance next in line.	1
InvalidationInterface::validateExpression	public	function	Validate the expression given to the invalidation during instantiation.	1
InvStatesInterface::FAILED		constant	The invalidation failed and will be offered again later.
InvStatesInterface::FRESH		constant	Invalidation is new and no processing has been attempted on it yet.
InvStatesInterface::NOT_SUPPORTED		constant	The type of invalidation isn't supported and will be offered again later.
InvStatesInterface::PROCESSING		constant	The invalidation is processing.
InvStatesInterface::SUCCEEDED		constant	The invalidation succeeded.
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2

You are here

interface InvalidationInterface in Purge 8.3

Hierarchy

File

Namespace

Members

API Navigation