class ImmutableInvalidation in Purge 8.3

Provides the immutable invalidation object.

Immutable invalidations are not used in real-life cache invalidation, as \Drupal\purge\Plugin\Purge\Purger\PurgersServiceInterface doesn't accept them. However, as they are read-only, they are used by user interfaces to see what is in the queue without actually claiming or changing it.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\purge\Plugin\Purge\Invalidation\ImmutableInvalidationBase implements ImmutableInvalidationInterface
      • class \Drupal\purge\Plugin\Purge\Invalidation\ImmutableInvalidation implements ImmutableInvalidationInterface

File

src/Plugin/Purge/Invalidation/ImmutableInvalidation.php, line 13

Namespace

Drupal\purge\Plugin\Purge\Invalidation

class ImmutableInvalidation extends ImmutableInvalidationBase implements ImmutableInvalidationInterface {

  /**
   * The wrapped invalidation object.
   *
   * @var \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface
   */
  protected $invalidation;

  /**
   * Constructs the immutable invalidation object.
   *
   * @param \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface $invalidation
   *   The invalidation object describes what needs to be invalidated from the
   *   external caching system, and gets instantiated by the service
   *   'purge.invalidation.factory', either directly or through a queue claim.
   */
  public function __construct(InvalidationInterface $invalidation) {
    $this->invalidation = $invalidation;
  }

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

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

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

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

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

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

}

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
ImmutableInvalidation::$invalidation	protected	property	The wrapped invalidation object.
ImmutableInvalidation::getExpression	public	function	Get the invalidation expression. Overrides ImmutableInvalidationBase::getExpression
ImmutableInvalidation::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginBase::getPluginDefinition
ImmutableInvalidation::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginBase::getPluginId
ImmutableInvalidation::getState	public	function	Get the current or general state of the invalidation. Overrides ImmutableInvalidationBase::getState
ImmutableInvalidation::getStateString	public	function	Get the current state as string. Overrides ImmutableInvalidationBase::getStateString
ImmutableInvalidation::__construct	public	function	Constructs the immutable invalidation object. Overrides PluginBase::__construct
ImmutableInvalidation::__toString	public	function	Return the string expression of the invalidation. Overrides ImmutableInvalidationBase::__toString
ImmutableInvalidationBase::$context	protected	property	The instance ID of the purger that is about to process this object.
ImmutableInvalidationBase::$expression	protected	property	Mixed expression (or NULL) that describes what needs to be invalidated.	1
ImmutableInvalidationBase::$id	protected	property	Unique runtime ID for this instance.
ImmutableInvalidationBase::$properties	protected	property	Purger metadata.
ImmutableInvalidationBase::$states	protected	property	Invalidation states per purger.
ImmutableInvalidationBase::$statesAfterProcessing	protected	property	Valid post-processing states.
ImmutableInvalidationBase::getProperties	public	function	Get all stored properties. Overrides ImmutableInvalidationInterface::getProperties
ImmutableInvalidationBase::getProperty	public	function	Retrieve a purger specific property value. Overrides ImmutableInvalidationInterface::getProperty
ImmutableInvalidationBase::getStateContexts	public	function	Get all stored state contexts. Overrides ImmutableInvalidationInterface::getStateContexts
ImmutableInvalidationBase::getStates	public	function	Get all invalidation states. Overrides ImmutableInvalidationInterface::getStates
ImmutableInvalidationBase::getStateStringTranslated	public	function	Get the current state as user translated string. Overrides ImmutableInvalidationInterface::getStateStringTranslated
ImmutableInvalidationBase::getType	public	function	Get the type of invalidation. Overrides ImmutableInvalidationInterface::getType
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.
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::isConfigurable	public	function	Determines if the plugin is configurable.
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.