summaryrefslogtreecommitdiffstats
path: root/core/lib/Drupal/Core/PageCache/ResponsePolicyInterface.php
diff options
context:
space:
mode:
Diffstat (limited to 'core/lib/Drupal/Core/PageCache/ResponsePolicyInterface.php')
-rw-r--r--core/lib/Drupal/Core/PageCache/ResponsePolicyInterface.php42
1 files changed, 42 insertions, 0 deletions
diff --git a/core/lib/Drupal/Core/PageCache/ResponsePolicyInterface.php b/core/lib/Drupal/Core/PageCache/ResponsePolicyInterface.php
new file mode 100644
index 0000000..596f43f
--- /dev/null
+++ b/core/lib/Drupal/Core/PageCache/ResponsePolicyInterface.php
@@ -0,0 +1,42 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\PageCache\ResponsePolicyInterface.
+ */
+
+namespace Drupal\Core\PageCache;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * Defines the interface for response policy implementations.
+ *
+ * The response policy is evaluated in order to determine whether a page should
+ * be stored a in the cache. Calling code should do so unless static::DENY is
+ * returned from the check() method.
+ */
+interface ResponsePolicyInterface {
+
+ /**
+ * Deny storage of a page in the cache.
+ */
+ const DENY = 'deny';
+
+ /**
+ * Determines whether it is save to store a page in the cache.
+ *
+ * @param \Symfony\Component\HttpFoundation\Response $response
+ * The response which is about to be sent to the client.
+ * @param \Symfony\Component\HttpFoundation\Request $request
+ * The request object.
+ *
+ * @return string|NULL
+ * Either static::DENY or NULL. Calling code may attempt to store a page in
+ * the cache unless static::DENY is returned. Returns NULL if the policy
+ * policy is not specified for the given response.
+ */
+ public function check(Response $response, Request $request);
+
+}