site.ini [Cache] #

The block [Cache] of settings/site.ini, with 1 setting(s).

Never edit settings/site.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/site.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/site.ini.append.php for one siteaccess,
• extension/<extension>/settings/site.ini.append.php in an extension (read when the extension is active).

CacheItems #

Array with cache items to extend ezcache
Example of use:
CacheItems[]=custom

[Cache_custom]

[optional] Name of the cache item, key (custom) is used camel-cased if not set
name=Custom cache
[optional] Id of cache item, to be used from command line, key (custom) is used if not set
id=custom
[optional] If cache item should be cleared using cluster instead of plain file handler, def: false
isClustered=true
[optional] tags that will trigger clearing of this item, default: empty array
tags[]=content
tags[]=custom
[optional] If cache uses eZExpiryHandler, then this is the key to get expiry time
expiryKey=global-custom-cache
[optional] (bool) If this cache is enabled or not, default: true
enabled=false
[optional] Path where cache is stored, either directory or file if class/purgeClass
variables are unset, relative to current cache directory is assumed
path=custom_cache.php
[optional] custom cache clear function "<class>::clearCache()" to be called
class=eZSomeClassName
[optional] custom cache purge function "<class>::purgeCache()" to be called
purgeClass=eZSomeClassName

Default: a list of 6: rest, restRoutes, exphelpcontent, smarty, twig, searchsuggest.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[Cache]
# an empty "CacheItems[]" first replaces the shipped list; without it the items are added
CacheItems[]
CacheItems[]=rest
CacheItems[]=restRoutes
CacheItems[]=exphelpcontent
CacheItems[]=smarty
CacheItems[]=twig
CacheItems[]=searchsuggest
*/ ?>

Related #

• All blocks of site.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/site.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.