Classes List

Symfony\Component\HttpKernel\HttpCache\SurrogateInterface

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\HttpKernel\HttpCache;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

interface SurrogateInterface
{
    /** * Returns surrogate name. * * @return string */
    public function getName();

    /** * Returns a new cache strategy instance. * * @return ResponseCacheStrategyInterface A ResponseCacheStrategyInterface instance */
    public function createCacheStrategy();

    /** * Checks that at least one surrogate has Surrogate capability. * * @return bool true if one surrogate has Surrogate capability, false otherwise */
    public function hasSurrogateCapability(Request $request);

    /** * Adds Surrogate-capability to the given Request. */
    public function addSurrogateCapability(Request $request);

    /** * Adds HTTP headers to specify that the Response needs to be parsed for Surrogate. * * This method only adds an Surrogate HTTP header if the Response has some Surrogate tags. */
    public function addSurrogateControl(Response $response);

    /** * Checks that the Response needs to be parsed for Surrogate tags. * * @return bool true if the Response needs to be parsed, false otherwise */
    public function needsParsing(Response $response);

    /** * Renders a Surrogate tag. * * @param string $uri A URI * @param string $alt An alternate URI * @param bool $ignoreErrors Whether to ignore errors or not * @param string $comment A comment to add as an esi:include tag * * @return string */
    public function renderIncludeTag($uri$alt = null$ignoreErrors = true$comment = '');

    /** * Replaces a Response Surrogate tags with the included resource content. * * @return Response */
    public function process(Request $requestResponse $response);

    /** * Handles a Surrogate from the cache. * * @param HttpCache $cache An HttpCache instance * @param string $uri The main URI * @param string $alt An alternative URI * @param bool $ignoreErrors Whether to ignore errors or not * * @return string * * @throws \RuntimeException * @throws \Exception */
    public function handle(HttpCache $cache$uri$alt$ignoreErrors);
}