Smarty_CacheResource Class Reference

Inheritance diagram for Smarty_CacheResource:

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 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)

Static Public Member Functions
static	load (Smarty $smarty, $type=null)
	Load Cache Resource Handler. More...
static	invalidLoadedCache (Smarty $smarty)
	Invalid Loaded Cache Files. More...

Static Public Attributes
static	$resources = array()

Static Protected Attributes
static	$sysplugins

Detailed Description

Definition at line 16 of file smarty_cacheresource.php.

Member Function Documentation

acquireLock	(	Smarty	$smarty,
		Smarty_Template_Cached	$cached
	)

Definition at line 126 of file smarty_cacheresource.php.

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

abstract

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

clearAll ( Smarty  $smarty,   $exp_time = null  )

abstract

Empty cache.

Parameters

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

Returns

integer number of cache files deleted

getCachedContent

(

Smarty_Internal_Template

$_template

)

Return cached content.

Parameters

Smarty_Internal_Template	$_template	template object
string	$content	content of cache

Definition at line 72 of file smarty_cacheresource.php.

hasLock	(	Smarty	$smarty,
		Smarty_Template_Cached	$cached
	)

Definition at line 120 of file smarty_cacheresource.php.

static invalidLoadedCache ( Smarty  $smarty )

static

Invalid Loaded Cache Files.

Parameters

Smarty

$smarty

Smarty object

Definition at line 187 of file smarty_cacheresource.php.

static load ( Smarty  $smarty,   $type = null  )

static

Load Cache Resource Handler.

Parameters

Smarty	$smarty	Smarty object
string	$type	name of the cache resource

Returns

Smarty_CacheResource Cache Resource Handler

Definition at line 146 of file smarty_cacheresource.php.

locked	(	Smarty	$smarty,
		Smarty_Template_Cached	$cached
	)

Definition at line 104 of file smarty_cacheresource.php.

populate ( Smarty_Template_Cached  $cached, Smarty_Internal_Template  $_template  )

abstract

populate Cached Object with meta data from Resource

Parameters

Smarty_Template_Cached	$cached	cached object
Smarty_Internal_Template	$_template	template object

Returns

void

populateTimestamp ( Smarty_Template_Cached  $cached )

abstract

populate Cached Object with timestamp and exists from Resource

Parameters

Smarty_Template_Cached

$source

cached object

Returns

void

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

abstract

Read the cached template and process 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

releaseLock	(	Smarty	$smarty,
		Smarty_Template_Cached	$cached
	)

Definition at line 132 of file smarty_cacheresource.php.

writeCachedContent ( Smarty_Internal_Template  $_template,   $content  )

abstract

Write the rendered template output to cache.

Parameters

Smarty_Internal_Template	$_template	template object
string	$content	content to cache

Returns

boolean success

Field Documentation

$resources = array()

static

Definition at line 21 of file smarty_cacheresource.php.

$sysplugins

staticprotected

Initial value:

= array(
        'file' => true,
    )

Definition at line 27 of file smarty_cacheresource.php.

---

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

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