You are here

public function ImmutableInvalidationInterface::getProperty in Purge 8.3

Retrieve a purger specific property value.

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.

Parameters

string $key: The key of the stored property, unique to the current purger context.

Return value

null|mixed The property value or NULL when no such property exists.

Throws

\LogicException Thrown when operating in general context, call ::setStateContext() first.

1 method overrides ImmutableInvalidationInterface::getProperty()
ImmutableInvalidationBase::getProperty in src/Plugin/Purge/Invalidation/ImmutableInvalidationBase.php
Retrieve a purger specific property value.

File

src/Plugin/Purge/Invalidation/ImmutableInvalidationInterface.php, line 62

Class

ImmutableInvalidationInterface
Describes the immutable invalidation.

Namespace

Drupal\purge\Plugin\Purge\Invalidation

Code

public function getProperty($key);