aleph1.co.uk Git - yaffs-website/blob - vendor/symfony/http-kernel/HttpCache/StoreInterface.php

   1 <?php
   2
   3 /*
   4  * This file is part of the Symfony package.
   5  *
   6  * (c) Fabien Potencier <fabien@symfony.com>
   7  *
   8  * This code is partially based on the Rack-Cache library by Ryan Tomayko,
   9  * which is released under the MIT license.
  10  *
  11  * For the full copyright and license information, please view the LICENSE
  12  * file that was distributed with this source code.
  13  */
  14
  15 namespace Symfony\Component\HttpKernel\HttpCache;
  16
  17 use Symfony\Component\HttpFoundation\Request;
  18 use Symfony\Component\HttpFoundation\Response;
  19
  20 /**
  21  * Interface implemented by HTTP cache stores.
  22  *
  23  * @author Fabien Potencier <fabien@symfony.com>
  24  */
  25 interface StoreInterface
  26 {
  27     /**
  28      * Locates a cached Response for the Request provided.
  29      *
  30      * @param Request $request A Request instance
  31      *
  32      * @return Response|null A Response instance, or null if no cache entry was found
  33      */
  34     public function lookup(Request $request);
  35
  36     /**
  37      * Writes a cache entry to the store for the given Request and Response.
  38      *
  39      * Existing entries are read and any that match the response are removed. This
  40      * method calls write with the new list of cache entries.
  41      *
  42      * @param Request  $request  A Request instance
  43      * @param Response $response A Response instance
  44      *
  45      * @return string The key under which the response is stored
  46      */
  47     public function write(Request $request, Response $response);
  48
  49     /**
  50      * Invalidates all cache entries that match the request.
  51      *
  52      * @param Request $request A Request instance
  53      */
  54     public function invalidate(Request $request);
  55
  56     /**
  57      * Locks the cache for a given Request.
  58      *
  59      * @param Request $request A Request instance
  60      *
  61      * @return bool|string true if the lock is acquired, the path to the current lock otherwise
  62      */
  63     public function lock(Request $request);
  64
  65     /**
  66      * Releases the lock for the given Request.
  67      *
  68      * @param Request $request A Request instance
  69      *
  70      * @return bool False if the lock file does not exist or cannot be unlocked, true otherwise
  71      */
  72     public function unlock(Request $request);
  73
  74     /**
  75      * Returns whether or not a lock exists.
  76      *
  77      * @param Request $request A Request instance
  78      *
  79      * @return bool true if lock exists, false otherwise
  80      */
  81     public function isLocked(Request $request);
  82
  83     /**
  84      * Purges data for the given URL.
  85      *
  86      * @param string $url A URL
  87      *
  88      * @return bool true if the URL exists and has been purged, false otherwise
  89      */
  90     public function purge($url);
  91
  92     /**
  93      * Cleanups storage.
  94      */
  95     public function cleanup();
  96 }