Ssi::renderIncludeTag()

string renderIncludeTag(string $uri, string $alt = null, bool $ignoreErrors = true, string $comment = '') Renders a Surrogate tag. Parameters string $uri A URI string $alt An alternate URI bool $ignoreErrors Whether to ignore errors or not string $comment A comment to add as an esi:include tag Return Value string

SsiFragmentRenderer

class SsiFragmentRenderer extends AbstractSurrogateFragmentRenderer Implements the SSI rendering strategy. Methods setFragmentPath(string $path) Sets the fragment path that triggers the fragment listener. from RoutableFragmentRenderer __construct(SurrogateInterface $surrogate = null, FragmentRendererInterface $inlineStrategy, UriSigner $signer = null) Constructor. from AbstractSurrogateFragmentRenderer Response render(string|ControllerReference $uri, Request $request, array $opti

Ssi::hasSurrogateCapability()

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

Ssi::handle()

string handle(HttpCache $cache, string $uri, string $alt, bool $ignoreErrors) Handles a Surrogate 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

Ssi::needsParsing()

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

Ssi::getName()

string getName() Returns surrogate name. Return Value string

Ssi::process()

Response process(Request $request, Response $response) Replaces a Response Surrogate tags with the included resource content. Parameters Request $request A Request instance Response $response A Response instance Return Value Response

Ssi::createCacheStrategy()

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

Ssi::addSurrogateCapability()

addSurrogateCapability(Request $request) Adds Surrogate-capability to the given Request. Parameters Request $request A Request instance

Ssi::addSurrogateControl()

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