Smarty_CacheResource_Custom Class Reference

Inheritance diagram for Smarty_CacheResource_Custom:

Public Member Functions
	populate (Smarty_Template_Cached $cached, Smarty_Internal_Template $_template)
	populate Cached Object with meta data from Resource More...
	populateTimestamp (Smarty_Template_Cached $cached)
	populate Cached Object with timestamp and exists from Resource More...
	process (Smarty_Internal_Template $_template, Smarty_Template_Cached $cached=null)
	Read the cached template and process the header. More...
	writeCachedContent (Smarty_Internal_Template $_template, $content)
	Write the rendered template output to cache. More...
	clearAll (Smarty $smarty, $exp_time=null)
	Empty cache. More...
	clear (Smarty $smarty, $resource_name, $cache_id, $compile_id, $exp_time)
	Empty cache for a specific template. More...
	hasLock (Smarty $smarty, Smarty_Template_Cached $cached)
	Check is cache is locked for this template. More...
	acquireLock (Smarty $smarty, Smarty_Template_Cached $cached)
	Lock cache for this template. More...
	releaseLock (Smarty $smarty, Smarty_Template_Cached $cached)
	Unlock cache for this template. More...
Public Member Functions inherited from Smarty_CacheResource
	populate (Smarty_Template_Cached $cached, Smarty_Internal_Template $_template)
	populate Cached Object with meta data from Resource More...
	populateTimestamp (Smarty_Template_Cached $cached)
	populate Cached Object with timestamp and exists from Resource More...
	process (Smarty_Internal_Template $_template, Smarty_Template_Cached $cached=null)
	Read the cached template and process header. More...
	writeCachedContent (Smarty_Internal_Template $_template, $content)
	Write the rendered template output to cache. More...
	getCachedContent (Smarty_Internal_Template $_template)
	Return cached content. More...
	clearAll (Smarty $smarty, $exp_time=null)
	Empty cache. More...
	clear (Smarty $smarty, $resource_name, $cache_id, $compile_id, $exp_time)
	Empty cache for a specific template. More...
	locked (Smarty $smarty, Smarty_Template_Cached $cached)
	hasLock (Smarty $smarty, Smarty_Template_Cached $cached)
	acquireLock (Smarty $smarty, Smarty_Template_Cached $cached)
	releaseLock (Smarty $smarty, Smarty_Template_Cached $cached)

Protected Member Functions
	fetch ($id, $name, $cache_id, $compile_id, &$content, &$mtime)
	fetch cached content and its modification time from data source More...
	fetchTimestamp ($id, $name, $cache_id, $compile_id)
	Fetch cached content's modification timestamp from data source. More...
	save ($id, $name, $cache_id, $compile_id, $exp_time, $content)
	Save content to cache. More...
	delete ($name, $cache_id, $compile_id, $exp_time)
	Delete content from cache. More...

Additional Inherited Members
Static Public Member Functions inherited from Smarty_CacheResource
static	load (Smarty $smarty, $type=null)
	Load Cache Resource Handler. More...
static	invalidLoadedCache (Smarty $smarty)
	Invalid Loaded Cache Files. More...
Static Public Attributes inherited from Smarty_CacheResource
static	$resources = array()
Static Protected Attributes inherited from Smarty_CacheResource
static	$sysplugins

Detailed Description

Definition at line 16 of file smarty_cacheresource_custom.php.

Member Function Documentation

acquireLock	(	Smarty	$smarty,
		Smarty_Template_Cached	$cached
	)

Lock cache for this template.

Parameters

Smarty	$smarty	Smarty object
Smarty_Template_Cached	$cached	cached object

Definition at line 214 of file smarty_cacheresource_custom.php.

clear	(	Smarty	$smarty,
			$resource_name,
			$cache_id,
			$compile_id,
			$exp_time
	)

Empty cache for a specific template.

Parameters

Smarty	$smarty	Smarty object
string	$resource_name	template name
string	$cache_id	cache id
string	$compile_id	compile id
integer	$exp_time	expiration time (number of seconds, not timestamp)

Returns

integer number of cache files deleted

Definition at line 182 of file smarty_cacheresource_custom.php.

clearAll	(	Smarty	$smarty,
			$exp_time = null
	)

Empty cache.

Parameters

Smarty	$smarty	Smarty object
integer	$exp_time	expiration time (number of seconds, not timestamp)

Returns

integer number of cache files deleted

Definition at line 166 of file smarty_cacheresource_custom.php.

delete (   $name,   $cache_id,   $compile_id,   $exp_time  )

abstractprotected

Delete content from cache.

Parameters

string	$name	template name
string	$cache_id	cache id
string	$compile_id	compile id
integer | null	$exp_time	seconds till expiration time in seconds or null

Returns

integer number of deleted caches

fetch (   $id,   $name,   $cache_id,   $compile_id, &  $content, &  $mtime  )

abstractprotected

fetch cached content and its modification time from data source

Parameters

string	$id	unique cache content identifier
string	$name	template name
string	$cache_id	cache id
string	$compile_id	compile id
string	$content	cached content
integer	$mtime	cache modification timestamp (epoch)

Returns

void

fetchTimestamp (   $id,   $name,   $cache_id,   $compile_id  )

protected

Fetch cached content's modification timestamp from data source.

{

Definition at line 43 of file smarty_cacheresource_custom.php.

hasLock	(	Smarty	$smarty,
		Smarty_Template_Cached	$cached
	)

Check is cache is locked for this template.

Parameters

Smarty	$smarty	Smarty object
Smarty_Template_Cached	$cached	cached object

Returns

booelan true or false if cache is locked

Definition at line 195 of file smarty_cacheresource_custom.php.

populate	(	Smarty_Template_Cached	$cached,
		Smarty_Internal_Template	$_template
	)

populate Cached Object with meta data from Resource

Parameters

Smarty_Template_Cached	$cached	cached object
Smarty_Internal_Template	$_template	template object

Returns

void

Definition at line 79 of file smarty_cacheresource_custom.php.

populateTimestamp

(

Smarty_Template_Cached

$cached

)

populate Cached Object with timestamp and exists from Resource

Parameters

Smarty_Template_Cached

$source

cached object

Returns

void

Definition at line 94 of file smarty_cacheresource_custom.php.

process	(	Smarty_Internal_Template	$_template,
		Smarty_Template_Cached	$cached = null
	)

Read the cached template and process the header.

Parameters

Smarty_Internal_Template	$_template	template object
Smarty_Template_Cached	$cached	cached object

Returns

booelan true or false if the cached content does not exist

Definition at line 115 of file smarty_cacheresource_custom.php.

releaseLock	(	Smarty	$smarty,
		Smarty_Template_Cached	$cached
	)

Unlock cache for this template.

Parameters

Smarty	$smarty	Smarty object
Smarty_Template_Cached	$cached	cached object

Definition at line 229 of file smarty_cacheresource_custom.php.

save (   $id,   $name,   $cache_id,   $compile_id,   $exp_time,   $content  )

abstractprotected

Save content to cache.

Parameters

string	$id	unique cache content identifier
string	$name	template name
string	$cache_id	cache id
string	$compile_id	compile id
integer | null	$exp_time	seconds till expiration or null
string	$content	content to cache

Returns

boolean success

writeCachedContent	(	Smarty_Internal_Template	$_template,
			$content
	)

Write the rendered template output to cache.

Parameters

Smarty_Internal_Template	$_template	template object
string	$content	content to cache

Returns

boolean success

Definition at line 147 of file smarty_cacheresource_custom.php.

---

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

• lib/templateEngines/smarty/sysplugins/smarty_cacheresource_custom.php