Skip to content

The CMS
Docs
- Guide
- Cookbook
- Reference
- Screencasts
- Glossary
Resources
- Plugins
- Themes
- Newsletter
- Buzz
Community

Try
Buy

View all results ›

Text
- KirbyText
- Markdown
Templates
- Field methods
- Helpers
Panel
- Blueprints
- Fields
- Sections
- Blocks
- Icons
- Styling
- Samples
Objects
- $kirby
- $site
- $page
- $pages
- $file
- $files
- $user
- $users
- $block
- $blocks
- $layout
- $layouts
- $language
- $languages
- $pagination
- $request
- $session
- All classes
- Aliases
Router
- Patterns
- Response types
System
- Options
- Urls
- Roots
- Validators
Plugins
API
- Authentication
- Languages
- Pages
- Roles
- Site
- System
- Translations
- Users
Tools
- A
- Cookie
- Data
- Dir
- Escape
- F
- Header
- Html
- I18n
- Mime
- Query
- Str
- Tpl
- Url
- V
- Xml

new Cache()

Sets all parameters which are needed to connect to the cache storage
$cache->created()

Checks when the cache has been created; returns the creation timestamp on success and false if the item does not exist
$cache->enabled()

Returns whether the cache is ready to store values
$cache->exists()

Determines if an item exists in the cache
$cache->expired()

Checks if an item in the cache is expired
$cache->expires()

Checks when an item in the cache expires; returns the expiry timestamp on success, null if the item never expires and false if the item does not exist
$cache->flush()

Flushes the entire cache and returns whether the operation was successful; this needs to be defined by the driver
$cache->get()

Gets an item from the cache
$cache->getOrSet()

Returns a value by either getting it from the cache or via the callback function which then is stored in the cache for future retrieval. This method cannot be used for null as value to be cached.
$cache->modified()

Alternate version for Cache::created($key)
$cache->options()

Returns all passed cache options
$cache->remove()

Removes an item from the cache and returns whether the operation was successful; this needs to be defined by the driver
$cache->retrieve()

Internal method to retrieve the raw cache value; needs to return a Value object or null if not found; this needs to be defined by the driver
$cache->set()

Writes an item to the cache for a given number of minutes and returns whether the operation was successful; this needs to be defined by the driver

$cache->enabled()

Returns whether the cache is ready to store values

kirby/src/Cache/Cache.php#L57

$cache->enabled(): bool

Return type

bool

Parent class

Kirby\Cache\Cache

Did you find an error? Help us improve our docs and edit this page on Github. Make sure to check out our styleguide →