HTTPCacheControlMiddleware

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Get inherited config value

Gets the uninherited value for the given config option

Update the config value for a given property

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Generate response for the given request

Refactor HTTP::add_cache_headers() (e.g. etag handling) into this middleware

Get current vary keys

Add a vary

Set vary

Combine vary strings/arrays into a single array, or normalise a single vary

Register a modification date. Used to calculate the "Last-Modified" HTTP header.

Can be called multiple times, and will automatically retain the most recent date.

Set current state. Should only be invoked internally after processing precedence rules.

Get current state

Instruct the cache to apply a change with a given level, optionally modifying it with a force flag to increase priority of this action.

If the apply level was successful, the change is made and the internal level threshold is incremented.

Low level method for setting directives include any experimental or custom ones added via config.

You need to specify the state (or states) to apply this directive to. Can also remove directives with false

Low level method to set directives from an associative array

Low level method for removing directives

Low level method to check if a directive is currently set

Check if the current state has the given directive.

Low level method to get the value of a directive for a state.

Returns false if there is no directive. True means the flag is set, otherwise the value of the directive.

Get the value of the given directive for the current state

Get directives for the given state

Get all directives for the currently active state

The cache should not store anything about the client request or server response.

Affects all non-disabled states. Use setStateDirective() instead to set for a single state. Set the no-store directive (also removes max-age and s-maxage for consistency purposes)

Forces caches to submit the request to the origin server for validation before releasing a cached copy.

Affects all non-disabled states. Use setStateDirective() instead to set for a single state.

Specifies the maximum amount of time (seconds) a resource will be considered fresh.

This directive is relative to the time of the request. Affects all non-disabled states. Use enableCache(), publicCache() or setStateDirective() instead to set the max age for a single state.

Overrides max-age or the Expires header, but it only applies to shared caches (e.g., proxies) and is ignored by a private cache.

Affects all non-disabled states. Use setStateDirective() instead to set for a single state.

The cache must verify the status of the stale resources before using it and expired ones should not be used.

Affects all non-disabled states. Use setStateDirective() instead to set for a single state.

Simple way to set cache control header to a cacheable state.

Needs either setMaxAge() or the $maxAge method argument in order to activate caching.

The resulting cache-control headers will be chosen from the 'enabled' set of directives.

Does not set public directive. Usually, setMaxAge() is sufficient. Use publicCache() if this is explicitly required. See https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/http-caching#public_vs_private

Simple way to set cache control header to a non-cacheable state.

Use this method over privateCache() if you are unsure about caching details. Takes precedence over unforced enableCache(), privateCache() or publicCache() calls.

The resulting cache-control headers will be chosen from the 'disabled' set of directives.

Removes all state and replaces it with no-cache, no-store, must-revalidate. Although no-store is sufficient the others are added under recommendation from Mozilla (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#Examples)

Does not set private directive, use privateCache() if this is explicitly required. See https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/http-caching#public_vs_private

Advanced way to set cache control header to a non-cacheable state.

Indicates that the response is intended for a single user and must not be stored by a shared cache. A private cache (e.g. Web Browser) may store the response.

The resulting cache-control headers will be chosen from the 'private' set of directives.

Advanced way to set cache control header to a cacheable state.

Indicates that the response may be cached by any cache. (eg: CDNs, Proxies, Web browsers). Needs either setMaxAge() or the $maxAge method argument in order to activate caching.

The resulting cache-control headers will be chosen from the 'private' set of directives.

Generate all headers to add to this object

Generate the cache header

Generate all headers to output

Reset registered http cache control and force a fresh instance to be built

No description

Generate vary http header

Generate Last-Modified header

Generate Expires http header

Update state based on current request and response objects