interface RequestPolicyInterface (View source)

Defines the interface for request policy implementations.

The request policy is evaluated in order to determine whether delivery of a cached page should be attempted. The caller should do so if static::ALLOW is returned from the check() method.

Constants

ALLOW

Allow delivery of cached pages.

DENY

Deny delivery of cached pages.

Methods

string|null
check(Request $request)

Determines whether delivery of a cached page should be attempted.

Details

string|null check(Request $request)

Determines whether delivery of a cached page should be attempted.

Note that the request-policy check runs very early. In particular it is not possible to determine the logged in user. Also the current route match is not yet present when the check runs. Therefore, request-policy checks need to be designed in a way such that they do not depend on any other service and only take in account the information present on the incoming request.

When matching against the request path, special attention is needed to support path prefixes which are often used on multilingual sites.

Parameters

Request $request

The incoming request object.

Return Value

string|null

One of static::ALLOW, static::DENY or NULL. Calling code may attempt to deliver a cached page if static::ALLOW is returned. Returns NULL if the policy is not specified for the given request.