Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Cache/Context/CalculatedCacheContextInterface.php

	Code Coverage
	Classes and Traits		Functions and Methods				Lines
Total	100.00% covered (success)	0 / 0	100.00% covered (success)	100.00%	0 / 0	CRAP	100.00% covered (success)	100.00%	0 / 0

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Cache\Context\CalculatedCacheContextInterface.
6	*/
7
8	namespace Drupal\Core\Cache\Context;
9
10	/**
11	* Provides an interface for defining a calculated cache context service.
12	*/
13	interface CalculatedCacheContextInterface {
14
15	/**
16	* Returns the label of the cache context.
17	*
18	* @return string
19	* The label of the cache context.
20	*
21	* @see Cache
22	*/
23	public static function getLabel();
24
25	/**
26	* Returns the string representation of the cache context.
27	*
28	* A cache context service's name is used as a token (placeholder) cache key,
29	* and is then replaced with the string returned by this method.
30	*
31	* @param string\|null $parameter
32	* The parameter, or NULL to indicate all possible parameter values.
33	*
34	* @return string
35	* The string representation of the cache context. When $parameter is NULL,
36	* a value representing all possible parameters must be generated.
37	*
38	* @throws \LogicException
39	* Thrown if the passed in parameter is invalid.
40	*/
41	public function getContext($parameter = NULL);
42
43	/**
44	* Gets the cacheability metadata for the context based on the parameter value.
45	*
46	* There are three valid cases for the returned CacheableMetadata object:
47	* - An empty object means this can be optimized away safely.
48	* - A max-age of 0 means that this context can never be optimized away. It
49	* will never bubble up and cache tags will not be used.
50	* - Any non-zero max-age and cache tags will bubble up into the cache item
51	* if this is optimized away to allow for invalidation if the context
52	* value changes.
53	*
54	* @param string\|null $parameter
55	* The parameter, or NULL to indicate all possible parameter values.
56	*
57	* @return \Drupal\Core\Cache\CacheableMetadata
58	* A cacheable metadata object.
59	*
60	* @throws \LogicException
61	* Thrown if the passed in parameter is invalid.
62	*/
63	public function getCacheableMetadata($parameter = NULL);
64
65	}