AbstractSurrogate.php
1 year ago
Esi.php
1 year ago
HttpCache.php
1 year ago
ResponseCacheStrategy.php
1 year ago
ResponseCacheStrategyInterface.php
2 years ago
Ssi.php
1 year ago
Store.php
1 year ago
StoreInterface.php
2 years ago
SubRequestHandler.php
2 years ago
SurrogateInterface.php
1 year ago
SurrogateInterface.php
78 lines
| 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | * This file is part of the Symfony package. |
| 5 | * |
| 6 | * (c) Fabien Potencier <fabien@symfony.com> |
| 7 | * |
| 8 | * For the full copyright and license information, please view the LICENSE |
| 9 | * file that was distributed with this source code. |
| 10 | */ |
| 11 | namespace Matomo\Dependencies\Symfony\Component\HttpKernel\HttpCache; |
| 12 | |
| 13 | use Matomo\Dependencies\Symfony\Component\HttpFoundation\Request; |
| 14 | use Matomo\Dependencies\Symfony\Component\HttpFoundation\Response; |
| 15 | interface SurrogateInterface |
| 16 | { |
| 17 | /** |
| 18 | * Returns surrogate name. |
| 19 | * |
| 20 | * @return string |
| 21 | */ |
| 22 | public function getName(); |
| 23 | /** |
| 24 | * Returns a new cache strategy instance. |
| 25 | * |
| 26 | * @return ResponseCacheStrategyInterface |
| 27 | */ |
| 28 | public function createCacheStrategy(); |
| 29 | /** |
| 30 | * Checks that at least one surrogate has Surrogate capability. |
| 31 | * |
| 32 | * @return bool |
| 33 | */ |
| 34 | public function hasSurrogateCapability(Request $request); |
| 35 | /** |
| 36 | * Adds Surrogate-capability to the given Request. |
| 37 | */ |
| 38 | public function addSurrogateCapability(Request $request); |
| 39 | /** |
| 40 | * Adds HTTP headers to specify that the Response needs to be parsed for Surrogate. |
| 41 | * |
| 42 | * This method only adds an Surrogate HTTP header if the Response has some Surrogate tags. |
| 43 | */ |
| 44 | public function addSurrogateControl(Response $response); |
| 45 | /** |
| 46 | * Checks that the Response needs to be parsed for Surrogate tags. |
| 47 | * |
| 48 | * @return bool |
| 49 | */ |
| 50 | public function needsParsing(Response $response); |
| 51 | /** |
| 52 | * Renders a Surrogate tag. |
| 53 | * |
| 54 | * @param string|null $alt An alternate URI |
| 55 | * @param string $comment A comment to add as an esi:include tag |
| 56 | * |
| 57 | * @return string |
| 58 | */ |
| 59 | public function renderIncludeTag(string $uri, ?string $alt = null, bool $ignoreErrors = \true, string $comment = ''); |
| 60 | /** |
| 61 | * Replaces a Response Surrogate tags with the included resource content. |
| 62 | * |
| 63 | * @return Response |
| 64 | */ |
| 65 | public function process(Request $request, Response $response); |
| 66 | /** |
| 67 | * Handles a Surrogate from the cache. |
| 68 | * |
| 69 | * @param string $alt An alternative URI |
| 70 | * |
| 71 | * @return string |
| 72 | * |
| 73 | * @throws \RuntimeException |
| 74 | * @throws \Exception |
| 75 | */ |
| 76 | public function handle(HttpCache $cache, string $uri, string $alt, bool $ignoreErrors); |
| 77 | } |
| 78 |