[ Index ]

PHP Cross Reference of phpBB-3.2.8-deutsch

title

Body

[close]

/vendor/symfony/http-kernel/HttpCache/ -> Esi.php (summary)

(no description)

File Size: 282 lines (10 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Esi:: (13 methods):
  __construct()
  getName()
  createCacheStrategy()
  hasSurrogateCapability()
  hasSurrogateEsiCapability()
  addSurrogateCapability()
  addSurrogateEsiCapability()
  addSurrogateControl()
  needsParsing()
  needsEsiParsing()
  renderIncludeTag()
  process()
  handle()


Class: Esi  - X-Ref

Esi implements the ESI capabilities to Request and Response instances.

For more information, read the following W3C notes:

* ESI Language Specification 1.0 (http://www.w3.org/TR/esi-lang)

* Edge Architecture Specification (http://www.w3.org/TR/edge-arch)

__construct(array $contentTypes = array('text/html', 'text/xml', 'application/xhtml+xml', 'application/xml')   X-Ref

param: array $contentTypes An array of content-type that should be parsed for ESI information

getName()   X-Ref
No description

createCacheStrategy()   X-Ref
Returns a new cache strategy instance.

return: ResponseCacheStrategyInterface A ResponseCacheStrategyInterface instance

hasSurrogateCapability(Request $request)   X-Ref
Checks that at least one surrogate has ESI/1.0 capability.

return: bool true if one surrogate has ESI/1.0 capability, false otherwise

hasSurrogateEsiCapability(Request $request)   X-Ref
Checks that at least one surrogate has ESI/1.0 capability.

param: Request $request A Request instance
return: bool true if one surrogate has ESI/1.0 capability, false otherwise

addSurrogateCapability(Request $request)   X-Ref
Adds ESI/1.0 capability to the given Request.


addSurrogateEsiCapability(Request $request)   X-Ref
Adds ESI/1.0 capability to the given Request.

param: Request $request A Request instance

addSurrogateControl(Response $response)   X-Ref
Adds HTTP headers to specify that the Response needs to be parsed for ESI.

This method only adds an ESI HTTP header if the Response has some ESI tags.

needsParsing(Response $response)   X-Ref
Checks that the Response needs to be parsed for ESI tags.

return: bool true if the Response needs to be parsed, false otherwise

needsEsiParsing(Response $response)   X-Ref
Checks that the Response needs to be parsed for ESI tags.

param: Response $response A Response instance
return: bool true if the Response needs to be parsed, false otherwise

renderIncludeTag($uri, $alt = null, $ignoreErrors = true, $comment = '')   X-Ref
Renders an ESI 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

process(Request $request, Response $response)   X-Ref
Replaces a Response ESI tags with the included resource content.

return: Response

handle(HttpCache $cache, $uri, $alt, $ignoreErrors)   X-Ref
Handles an ESI 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



Generated: Tue Apr 7 19:42:26 2020 Cross-referenced by PHPXref 0.7.1