Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/PageCache/RequestPolicyInterface.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\PageCache\RequestPolicyInterface.
6	*/
7
8	namespace Drupal\Core\PageCache;
9
10	use Symfony\Component\HttpFoundation\Request;
11
12	/**
13	* Defines the interface for request policy implementations.
14	*
15	* The request policy is evaluated in order to determine whether delivery of a
16	* cached page should be attempted. The caller should do so if static::ALLOW is
17	* returned from the check() method.
18	*/
19	interface RequestPolicyInterface {
20
21	/**
22	* Allow delivery of cached pages.
23	*/
24	const ALLOW = 'allow';
25
26	/**
27	* Deny delivery of cached pages.
28	*/
29	const DENY = 'deny';
30
31	/**
32	* Determines whether delivery of a cached page should be attempted.
33	*
34	* Note that the request-policy check runs very early. In particular it is
35	* not possible to determine the logged in user. Also the current route match
36	* is not yet present when the check runs. Therefore, request-policy checks
37	* need to be designed in a way such that they do not depend on any other
38	* service and only take in account the information present on the incoming
39	* request.
40	*
41	* When matching against the request path, special attention is needed to
42	* support path prefixes which are often used on multilingual sites.
43	*
44	* @param \Symfony\Component\HttpFoundation\Request $request
45	* The incoming request object.
46	*
47	* @return string\|NULL
48	* One of static::ALLOW, static::DENY or NULL. Calling code may attempt to
49	* deliver a cached page if static::ALLOW is returned. Returns NULL if the
50	* policy is not specified for the given request.
51	*/
52	public function check(Request $request);
53
54	}