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

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Cache\Context\CacheContextInterface.
6	*/
7
8	namespace Drupal\Core\Cache\Context;
9
10	/**
11	* Provides an interface for defining a cache context service.
12	*/
13	interface CacheContextInterface {
14
15	/**
16	* Returns the label of the cache context.
17	*
18	* @return string
19	* The label of the cache context.
20	*/
21	public static function getLabel();
22
23	/**
24	* Returns the string representation of the cache context.
25	*
26	* A cache context service's name is used as a token (placeholder) cache key,
27	* and is then replaced with the string returned by this method.
28	*
29	* @return string
30	* The string representation of the cache context.
31	*/
32	public function getContext();
33
34	/**
35	* Gets the cacheability metadata for the context.
36	*
37	* There are three valid cases for the returned CacheableMetadata object:
38	* - An empty object means this can be optimized away safely.
39	* - A max-age of 0 means that this context can never be optimized away. It
40	* will never bubble up and cache tags will not be used.
41	* - Any non-zero max-age and cache tags will bubble up into the cache item
42	* if this is optimized away to allow for invalidation if the context
43	* value changes.
44	*
45	*
46	* @return \Drupal\Core\Cache\CacheableMetadata
47	* A cacheable metadata object.
48	*/
49	public function getCacheableMetadata();
50
51	}