You are here

Home » API reference » Purge 8.3 » PathInvalidation.php

class PathInvalidation in Purge 8.3

Describes path based invalidation, e.g. "news/article-1".

Plugin annotation


@PurgeInvalidation(
  id = "path",
  label = @Translation("Path"),
  description = @Translation("Invalidates by path."),
  examples = {"news/article-1"},
  expression_required = TRUE,
  expression_can_be_empty = TRUE,
  expression_must_be_string = TRUE
)

Hierarchy

Expanded class hierarchy of PathInvalidation

File

src/Plugin/Purge/Invalidation/PathInvalidation.php, line 20

Namespace

Drupal\purge\Plugin\Purge\Invalidation
View source 
class PathInvalidation extends InvalidationBase implements InvalidationInterface {

  /**
   * {@inheritdoc}
   */
  public function validateExpression($wildcard_check = TRUE) {
    parent::validateExpression();
    if ($wildcard_check && strpos($this->expression, '*') !== FALSE) {
      throw new InvalidExpressionException('Path invalidations should not contain asterisks.');
    }
    if ($wildcard_check && $this->expression === '*') {
      throw new InvalidExpressionException('Path invalidations cannot be "*".');
    }
    if (strpos($this->expression, ' ') !== FALSE) {
      throw new InvalidExpressionException('Path invalidations cannot contain spaces, use %20 instead.');
    }
    if (strpos($this->expression, '/') === 0) {
      throw new InvalidExpressionException('Path invalidations cannot start with slashes.');
    }
  }

}

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
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::getExpression public function Get the invalidation expression. Overrides ImmutableInvalidationInterface::getExpression 1
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::getState public function Get the current or general state of the invalidation. Overrides ImmutableInvalidationInterface::getState 1
ImmutableInvalidationBase::getStateContexts public function Get all stored state contexts. Overrides ImmutableInvalidationInterface::getStateContexts
ImmutableInvalidationBase::getStates public function Get all invalidation states. Overrides ImmutableInvalidationInterface::getStates
ImmutableInvalidationBase::getStateString public function Get the current state as string. Overrides ImmutableInvalidationInterface::getStateString 1
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
ImmutableInvalidationBase::__toString public function Return the string expression of the invalidation. Overrides ImmutableInvalidationInterface::__toString 1
InvalidationBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
InvalidationBase::deleteProperty public function Delete a purger specific property. Overrides InvalidationInterface::deleteProperty
InvalidationBase::getId public function Get the instance ID. Overrides InvalidationInterface::getId
InvalidationBase::removeStateContext public function Remove a state context from the object because the purger no longer exists. Overrides InvalidationInterface::removeStateContext
InvalidationBase::setProperty public function Set a purger specific property. Overrides InvalidationInterface::setProperty
InvalidationBase::setState public function Set the state of the invalidation. Overrides InvalidationInterface::setState
InvalidationBase::setStateContext public function Set (or reset) state context to the purger instance next in line. Overrides InvalidationInterface::setStateContext
InvalidationBase::__construct public function Constructs \Drupal\purge\Plugin\Purge\Invalidation\InvalidationBase. Overrides PluginBase::__construct
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.
PathInvalidation::validateExpression public function Validate the expression given to the invalidation during instantiation. Overrides InvalidationBase::validateExpression 1
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.
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.