public function CalculatedCacheContextInterface::getContext

public CalculatedCacheContextInterface::getContext($parameter = NULL)

Returns the string representation of the cache context.

A cache context service's name is used as a token (placeholder) cache key, and is then replaced with the string returned by this method.

Parameters

string|null $parameter: The parameter, or NULL to indicate all possible parameter values.

Return value

string The string representation of the cache context. When $parameter is NULL, a value representing all possible parameters must be generated.

Throws

\LogicException Thrown if the passed in parameter is invalid.

File

core/lib/Drupal/Core/Cache/Context/CalculatedCacheContextInterface.php, line 36

Class

CalculatedCacheContextInterface
Provides an interface for defining a calculated cache context service.

Namespace

Drupal\Core\Cache\Context

Code

public function getContext($parameter = NULL);

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Cache!Context!CalculatedCacheContextInterface.php/function/CalculatedCacheContextInterface::getContext/8.1.x