bool hasSurrogateCapability(Request $request) Checks that at least one surrogate has ESI/1.0 capability. Parameters Request $request A Request instance Return Value bool true if one surrogate has Surrogate capability, false otherwise

string handle(HttpCache $cache, string $uri, string $alt, bool $ignoreErrors) Handles an ESI from the cache. Parameters HttpCache $cache An HttpCache instance string $uri The main URI string $alt An alternative URI bool $ignoreErrors Whether to ignore errors or not Return Value string Exceptions RuntimeException Exception

string getName() Returns surrogate name. Return Value string

bool needsParsing(Response $response) Checks that the Response needs to be parsed for ESI tags. Parameters Response $response A Response instance Return Value bool true if the Response needs to be parsed, false otherwise

ResponseCacheStrategyInterface createCacheStrategy() Returns a new cache strategy instance. Return Value ResponseCacheStrategyInterface A ResponseCacheStrategyInterface instance

class Esi implements SurrogateInterface 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) Methods __construct(array $contentTypes = array('text/html', 'text/xml', 'application/xhtml+xml', 'application/xml')) Constructor. string getName() Returns surrogate name. ResponseCacheStrategy

addSurrogateCapability(Request $request) Adds ESI/1.0 capability to the given Request. Parameters Request $request A Request instance

addSurrogateControl(Response $response) 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. Parameters Response $response A Response instance

static bool requiresDoubleQuoting(string $value) Determines if a PHP value would require double quoting in YAML. Parameters string $value A PHP value Return Value bool True if the value would require double quotes

static string escapeWithSingleQuotes(string $value) Escapes and surrounds a PHP value with single quotes. Parameters string $value A PHP value Return Value string The quoted, escaped string