eZTemplateCacheFunction Class Reference

Advanced cache handling. More...

Public Member Functions
	eZTemplateCacheFunction ($blockName= 'cache-block')
	functionList ()
	functionTemplateHints ()
	generateProcessedContent ($fname, $args)
	hasChildren ()
	process ($tpl, &$textElements, $functionName, $functionChildren, $functionParameters, $functionPlacement, $rootNamespace, $currentNamespace)
	processCached ($tpl, $functionChildren, $rootNamespace, $currentNamespace, $placementString, $keys, $subtreeExpiry, $expiry, $ignoreContentExpiry)
	processCachedPreprocess ($tpl, $functionChildren, $functionParameters, $functionPlacement, $rootNamespace, $currentNamespace)
	templateNodeTransformation ($functionName, &$node, $tpl, $parameters, $privateData)

Static Public Member Functions
static	expiryTemplateBlockCacheDir ()
static	subtreeCacheBaseSubDir ()
static	subtreeCacheSubDir ($subtreeExpiryParameter, $cacheFilename)
static	subtreeCacheSubDirForNode ($nodeID)
static	templateBlockCacheDir ()

Public Attributes
	$BlockName
	Name of the function. More...
const	DEFAULT_TTL = 7200

Static Private Member Functions
	processUncached ($tpl, $functionChildren, $rootNamespace, $currentNamespace)

Detailed Description

Advanced cache handling.

Member Function Documentation

static eZTemplateCacheFunction::expiryTemplateBlockCacheDir ( )

static

Deprecated:

Does not seem to be used Returns base directory where expired 'subtree_expiry' caches are stored.

Referenced by eZSubtreeCache\removeAllExpiryCacheFromDisk(), and eZSubtreeCache\renameDir().

eZTemplateCacheFunction::eZTemplateCacheFunction

(

$blockName = 'cache-block'

)

Initializes the object with names.

eZTemplateCacheFunction::functionList

(

)

Returns an array containing the name of the block function, default is "block". The name is specified in the constructor.

eZTemplateCacheFunction::functionTemplateHints

(

)

eZTemplateCacheFunction::generateProcessedContent	(		$fname,
			$args
	)

eZTemplateCacheFunction::hasChildren

(

)

Returns true.

eZTemplateCacheFunction::process	(		$tpl,
		&	$textElements,
			$functionName,
			$functionChildren,
			$functionParameters,
			$functionPlacement,
			$rootNamespace,
			$currentNamespace
	)

Processes the function with all it's children.

eZTemplateCacheFunction::processCached	(		$tpl,
			$functionChildren,
			$rootNamespace,
			$currentNamespace,
			$placementString,
			$keys,
			$subtreeExpiry,
			$expiry,
			$ignoreContentExpiry
	)

Referenced by processCachedPreprocess().

eZTemplateCacheFunction::processCachedPreprocess	(		$tpl,
			$functionChildren,
			$functionParameters,
			$functionPlacement,
			$rootNamespace,
			$currentNamespace
	)

Referenced by process().

eZTemplateCacheFunction::processUncached (   $tpl,   $functionChildren,   $rootNamespace,   $currentNamespace  )

staticprivate

Performs processing of the cache-block using the non-compiled way and with caching off.

Referenced by generateProcessedContent(), and process().

static eZTemplateCacheFunction::subtreeCacheBaseSubDir ( )

static

Deprecated:

Returns base directory where 'subtree_expiry' caches are stored.

Referenced by eZSubtreeCache\cleanupAll().

static eZTemplateCacheFunction::subtreeCacheSubDir (   $subtreeExpiryParameter,   $cacheFilename  )

static

Deprecated:

Returns path of the directory where 'subtree_expiry' caches are stored.

static eZTemplateCacheFunction::subtreeCacheSubDirForNode (   $nodeID )

static

Deprecated:

Builds and returns path from $nodeID, e.g. if $nodeID = 23 then path = subtree/2/3

Referenced by eZSubtreeCache\cleanup().

static eZTemplateCacheFunction::templateBlockCacheDir ( )

static

Deprecated:

Returns base directory where template block caches are stored.

Referenced by eZSubtreeCache\cleanup(), and eZSubtreeCache\cleanupAll().

eZTemplateCacheFunction::templateNodeTransformation	(		$functionName,
		&	$node,
			$tpl,
			$parameters,
			$privateData
	)

Member Data Documentation

eZTemplateCacheFunction::$BlockName

Name of the function.

const eZTemplateCacheFunction::DEFAULT_TTL = 7200

---

The documentation for this class was generated from the following file:

• eztemplatecachefunction.php