Class

eZContentCacheManager

class eZContentCacheManager

Constants

CLEAR_NO_CACHE

CLEAR_NODE_CACHE

CLEAR_PARENT_CACHE

CLEAR_RELATING_CACHE

CLEAR_KEYWORD_CACHE

CLEAR_SIBLINGS_CACHE

CLEAR_CHILDREN_CACHE

CLEAR_ALL_CACHE

CLEAR_DEFAULT

Methods

static  addAdditionalNodeIDPerObject(int $contentObjectID, int $additionalNodeID)

Adds an additional NodeID to be appended to the node list for clearing view cache.

static  appendChildrenNodeIDs(array(eZContentObjectTreeNode) $nodeList, array(int) $nodeIDList)

For each node in $nodeList finds its children nodes and adds its ids to the $nodeIDList.

static  clearObjectViewCacheArray(array $objectIDList)

Clears view caches of nodes, parent nodes and relating nodes of content objects with ids contained in $objectIDList.

static boolean clearNodeViewCacheArray(array $nodeList, array $contentObjectList = null)

Clears view caches for an array of nodes.

static  clearObjectViewCacheIfNeeded(array $objectID, bool|int $versionNum = true, bool|array $additionalNodeList = false)

Clears view cache for specified object(s).

static  clearTemplateBlockCacheIfNeeded(int|array $objectID)

Clears template-block cache and template-block with subtree_expiry parameter caches for specified object(s).

static  clearTemplateBlockCache(int|array|bool $objectID, bool $checkViewCacheClassSettings = false)

Clears template-block cache and template-block with subtree_expiry parameter caches for specified object without checking 'TemplateCache' ini setting.

static  clearContentCacheIfNeeded(int|array $objectID, bool|int $versionNum = true, bool|array $additionalNodeList = false)

Clears content cache for specified (list of) object: view cache, template-block cache, template-block with subtree_expiry parameter cache.

Details

at line 51
static public addAdditionalNodeIDPerObject(int $contentObjectID, int $additionalNodeID)

Adds an additional NodeID to be appended to the node list for clearing view cache.

Parameters

int $contentObjectID
int $additionalNodeID

at line 307
static public appendChildrenNodeIDs(array(eZContentObjectTreeNode) $nodeList, array(int) $nodeIDList)

For each node in $nodeList finds its children nodes and adds its ids to the $nodeIDList.

Parameters

array(eZContentObjectTreeNode) $nodeList
array(int) $nodeIDList

at line 711
static public clearObjectViewCacheArray(array $objectIDList)

Clears view caches of nodes, parent nodes and relating nodes of content objects with ids contained in $objectIDList.

It will use 'viewcache.ini' to determine additional nodes.

Parameters

array $objectIDList List of object ID

See also

clearObjectViewCache

at line 741
static public boolean clearNodeViewCacheArray(array $nodeList, array $contentObjectList = null)

Clears view caches for an array of nodes.

Parameters

array $nodeList List of node IDs to clear
array $contentObjectList List of content object IDs to clear

Return Value

boolean returns true on success

at line 795
static public clearObjectViewCacheIfNeeded(array $objectID, bool|int $versionNum = true, bool|array $additionalNodeList = false)

Clears view cache for specified object(s).

Checks 'ViewCaching' ini setting to determine whether cache is enabled or not.

Parameters

array $objectID (list of) object ID
bool|int $versionNum
bool|array $additionalNodeList

at line 823
static public clearTemplateBlockCacheIfNeeded(int|array $objectID)

Clears template-block cache and template-block with subtree_expiry parameter caches for specified object(s).

Checks 'TemplateCache' ini setting to determine whether cache is enabled or not. If $objectID is \c false all template block caches will be cleared.

Parameters

int|array $objectID (list of) object ID.

at line 838
static public clearTemplateBlockCache(int|array|bool $objectID, bool $checkViewCacheClassSettings = false)

Clears template-block cache and template-block with subtree_expiry parameter caches for specified object without checking 'TemplateCache' ini setting.

Parameters

int|array|bool $objectID (list of) object ID, if false only ordinary template block caches will be cleared Support for array value available {@since 5.0}.
bool $checkViewCacheClassSettings Check whether ViewCache class settings should be verified

at line 1062
static public clearContentCacheIfNeeded(int|array $objectID, bool|int $versionNum = true, bool|array $additionalNodeList = false)

Clears content cache for specified (list of) object: view cache, template-block cache, template-block with subtree_expiry parameter cache.

Checks appropriate ini settings to determine whether caches are enabled or not.

Parameters

int|array $objectID (list of) object ID
bool|int $versionNum
bool|array $additionalNodeList