Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/PageCache/ResponsePolicyInterface.php

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\PageCache\ResponsePolicyInterface.
6	*/
7
8	namespace Drupal\Core\PageCache;
9
10	use Symfony\Component\HttpFoundation\Request;
11	use Symfony\Component\HttpFoundation\Response;
12
13	/**
14	* Defines the interface for response policy implementations.
15	*
16	* The response policy is evaluated in order to determine whether a page should
17	* be stored a in the cache. Calling code should do so unless static::DENY is
18	* returned from the check() method.
19	*/
20	interface ResponsePolicyInterface {
21
22	/**
23	* Deny storage of a page in the cache.
24	*/
25	const DENY = 'deny';
26
27	/**
28	* Determines whether it is save to store a page in the cache.
29	*
30	* @param \Symfony\Component\HttpFoundation\Response $response
31	* The response which is about to be sent to the client.
32	* @param \Symfony\Component\HttpFoundation\Request $request
33	* The request object.
34	*
35	* @return string\|NULL
36	* Either static::DENY or NULL. Calling code may attempt to store a page in
37	* the cache unless static::DENY is returned. Returns NULL if the policy
38	* policy is not specified for the given response.
39	*/
40	public function check(Response $response, Request $request);
41
42	}