Miscellaneous
caches()
Signature
Section titled “Signature”caches() — returns any
Description
Section titled “Description”Tells CFWheels to cache one or more actions.
Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
action | string | yes | — | Action(s) to cache. This argument is also aliased as actions. |
time | numeric | yes | 60 | Minutes to cache the action(s) for. |
static | boolean | yes | false | Set to true to tell CFWheels that this is a static page and that it can skip running the controller filters (before and after filters set on actions). Please note that the onSessionStart and onRequestStart events still execute though. |
appendToKey | string | yes | — | List of variables to be evaluated at runtime and included in the cache key so that content can be cached separately. |
Examples
Section titled “Examples”// Cache the `termsOfUse` action
caches("termsOfUse");
// Cache the `termsOfUse` action for 30 minutes
caches(actions="browseByUser,browseByTitle", time=30);
// Cache the `termsOfUse` and `codeOfConduct` actions, including their filters
caches(actions="termsOfUse,codeOfConduct", static=true);
// Cache content separately based on region
caches(action="home", key="request.region");