eZTemplateCacheFunction Class Reference

Advanced cache handling. More...

List of all members.

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.
const	DEFAULT_TTL = 7200
Static Private Member Functions
	processUncached ($tpl, $functionChildren, $rootNamespace, $currentNamespace)

---

Detailed Description

Advanced cache handling.

Definition at line 18 of file eztemplatecachefunction.php.

---

Member Function Documentation

static eZTemplateCacheFunction::expiryTemplateBlockCacheDir

(

)

[static]

Deprecated:

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

Definition at line 342 of file eztemplatecachefunction.php.

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

eZTemplateCacheFunction::eZTemplateCacheFunction

(

$

blockName = 'cache-block'

)

Initializes the object with names.

Definition at line 25 of file eztemplatecachefunction.php.

eZTemplateCacheFunction::functionList

(

)

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

Definition at line 34 of file eztemplatecachefunction.php.

eZTemplateCacheFunction::functionTemplateHints

(

)

Definition at line 39 of file eztemplatecachefunction.php.

eZTemplateCacheFunction::generateProcessedContent	(	$	fname,
		$	args
	)

Definition at line 286 of file eztemplatecachefunction.php.

eZTemplateCacheFunction::hasChildren

(

)

Returns true.

Definition at line 320 of file eztemplatecachefunction.php.

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

Processes the function with all it's children.

Definition at line 173 of file eztemplatecachefunction.php.

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

Definition at line 234 of file eztemplatecachefunction.php.

Referenced by processCachedPreprocess().

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

Definition at line 199 of file eztemplatecachefunction.php.

Referenced by process().

eZTemplateCacheFunction::processUncached	(	$	tpl,
		$	functionChildren,
		$	rootNamespace,
		$	currentNamespace
	)		[static, private]

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

Definition at line 300 of file eztemplatecachefunction.php.

Referenced by generateProcessedContent(), and process().

static eZTemplateCacheFunction::subtreeCacheBaseSubDir

(

)

[static]

Deprecated:

Returns base directory where 'subtree_expiry' caches are stored.

Definition at line 332 of file eztemplatecachefunction.php.

Referenced by eZSubtreeCache\cleanupAll().

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

Deprecated:

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

Definition at line 363 of file eztemplatecachefunction.php.

static eZTemplateCacheFunction::subtreeCacheSubDirForNode

(

$

nodeID

)

[static]

Deprecated:

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

Definition at line 373 of file eztemplatecachefunction.php.

Referenced by eZSubtreeCache\cleanup().

static eZTemplateCacheFunction::templateBlockCacheDir

(

)

[static]

Deprecated:

Returns base directory where template block caches are stored.

Definition at line 353 of file eztemplatecachefunction.php.

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

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

Definition at line 48 of file eztemplatecachefunction.php.

---

Member Data Documentation

eZTemplateCacheFunction::$BlockName

Name of the function.

Definition at line 380 of file eztemplatecachefunction.php.

const eZTemplateCacheFunction::DEFAULT_TTL = 7200

Definition at line 20 of file eztemplatecachefunction.php.

Referenced by processCachedPreprocess().

---

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

• eztemplatecachefunction.php