Smarty_CacheResource_KeyValueStore Klassenreferenz

Klassendiagramm für Smarty_CacheResource_KeyValueStore:

Zusammengehörigkeiten von Smarty_CacheResource_KeyValueStore:

Öffentliche Methoden
	populate (Smarty_Template_Cached $cached, Smarty_Internal_Template $_template)
	populateTimestamp (Smarty_Template_Cached $cached)
	writeCachedContent (Smarty_Internal_Template $_template, $content)
	readCachedContent (Smarty_Internal_Template $_template)
	clearAll (Smarty $smarty, $exp_time=null)
	clear (Smarty $smarty, $resource_name, $cache_id, $compile_id, $exp_time)
	hasLock (Smarty $smarty, Smarty_Template_Cached $cached)
	acquireLock (Smarty $smarty, Smarty_Template_Cached $cached)
	releaseLock (Smarty $smarty, Smarty_Template_Cached $cached)
Öffentliche Methoden geerbt von Smarty_CacheResource
	populate (Smarty_Template_Cached $cached, Smarty_Internal_Template $_template)
	populateTimestamp (Smarty_Template_Cached $cached)
	process (Smarty_Internal_Template $_template, Smarty_Template_Cached $cached=null)
	writeCachedContent (Smarty_Internal_Template $_template, $content)
	getCachedContent (Smarty_Internal_Template $_template)
	clearAll (Smarty $smarty, $exp_time=null)
	clear (Smarty $smarty, $resource_name, $cache_id, $compile_id, $exp_time)
	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)

Geschützte Methoden
	getTemplateUid (Smarty $smarty, $resource_name, $cache_id, $compile_id)
	sanitize ($string)
	fetch ($cid, $resource_name=null, $cache_id=null, $compile_id=null, &$content=null, &$timestamp=null, $resource_uid=null)
	addMetaTimestamp (&$content)
	getMetaTimestamp (&$content)
	invalidate ($cid=null, $resource_name=null, $cache_id=null, $compile_id=null, $resource_uid=null)
	getLatestInvalidationTimestamp ($cid, $resource_name=null, $cache_id=null, $compile_id=null, $resource_uid=null)
	listInvalidationKeys ($cid, $resource_name=null, $cache_id=null, $compile_id=null, $resource_uid=null)
	read (array $keys)
	write (array $keys, $expire=null)
	delete (array $keys)
	purge ()

Geschützte Attribute
	$contents = array()
	$timestamps = array()

Weitere Geerbte Elemente
Öffentliche, statische Methoden geerbt von Smarty_CacheResource
static	load (Smarty $smarty, $type=null)
static	invalidLoadedCache (Smarty $smarty)
Statische, geschützte Attribute geerbt von Smarty_CacheResource
static	$sysplugins

Ausführliche Beschreibung

Definiert in Zeile 31 der Datei smarty_cacheresource_keyvaluestore.php.

Dokumentation der Elementfunktionen

acquireLock	(	Smarty	$smarty,
		Smarty_Template_Cached	$cached
	)

Lock cache for this template

Parameter

Smarty	$smarty	Smarty object
Smarty_Template_Cached	$cached	cached object

Rückgabe

bool|void

Definiert in Zeile 451 der Datei smarty_cacheresource_keyvaluestore.php.

Benutzt write().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

addMetaTimestamp ( &  $content)

protected

Add current microtime to the beginning of $cache_content {

Definiert in Zeile 282 der Datei smarty_cacheresource_keyvaluestore.php.

Wird benutzt von writeCachedContent().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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

Empty cache for a specific template {

Definiert in Zeile 184 der Datei smarty_cacheresource_keyvaluestore.php.

Benutzt getTemplateUid(), invalidate() und sanitize().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

clearAll	(	Smarty	$smarty,
			$exp_time = null
	)

Empty cache {

Definiert in Zeile 160 der Datei smarty_cacheresource_keyvaluestore.php.

Benutzt invalidate() und purge().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

delete ( array  $keys)

abstractprotected

Remove values from cache

Parameter

array

$keys

list of keys to delete

Rückgabe

boolean true on success, false on failure

fetch (   $cid,   $resource_name = null,   $cache_id = null,   $compile_id = null, &  $content = null, &  $timestamp = null,   $resource_uid = null  )

protected

Fetch and prepare a cache object.

Parameter

string	$cid	CacheID to fetch
string	$resource_name	template name
string	$cache_id	cache id
string	$compile_id	compile id
string	$content	cached content
integer	&$timestamp	cached timestamp (epoch)
string	$resource_uid	resource's uid

Rückgabe

boolean success

Definiert in Zeile 259 der Datei smarty_cacheresource_keyvaluestore.php.

Benutzt getLatestInvalidationTimestamp(), getMetaTimestamp() und read().

Wird benutzt von populateTimestamp() und readCachedContent().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getLatestInvalidationTimestamp (   $cid,   $resource_name = null,   $cache_id = null,   $compile_id = null,   $resource_uid = null  )

protected

Determine the latest timestamp known to the invalidation chain

Parameter

string	$cid	CacheID to determine latest invalidation timestamp of
string	$resource_name	template name
string	$cache_id	cache id
string	$compile_id	compile id
string	$resource_uid	source's filepath

Rückgabe

float the microtime the CacheID was invalidated

Definiert in Zeile 353 der Datei smarty_cacheresource_keyvaluestore.php.

Benutzt listInvalidationKeys() und read().

Wird benutzt von fetch().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getMetaTimestamp ( &  $content)

protected

Extract the timestamp the $content was cached

Parameter

string

&$content

the cached content

Rückgabe

float the microtime the content was cached

Definiert in Zeile 296 der Datei smarty_cacheresource_keyvaluestore.php.

Wird benutzt von fetch().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getTemplateUid ( Smarty  $smarty,   $resource_name,   $cache_id,   $compile_id  )

protected

Get template's unique ID

Parameter

Smarty	$smarty	Smarty object
string	$resource_name	template name
string	$cache_id	cache id
string	$compile_id	compile id

Rückgabe

string filepath of cache file

Definiert in Zeile 204 der Datei smarty_cacheresource_keyvaluestore.php.

Wird benutzt von clear().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

hasLock	(	Smarty	$smarty,
		Smarty_Template_Cached	$cached
	)

Check is cache is locked for this template

Parameter

Smarty	$smarty	Smarty object
Smarty_Template_Cached	$cached	cached object

Rückgabe

boolean true or false if cache is locked

Definiert in Zeile 435 der Datei smarty_cacheresource_keyvaluestore.php.

Benutzt read().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

invalidate (   $cid = null,   $resource_name = null,   $cache_id = null,   $compile_id = null,   $resource_uid = null  )

protected

Invalidate CacheID

Parameter

string	$cid	CacheID
string	$resource_name	template name
string	$cache_id	cache id
string	$compile_id	compile id
string	$resource_uid	source's uid

Rückgabe

void

Definiert in Zeile 313 der Datei smarty_cacheresource_keyvaluestore.php.

Benutzt sanitize() und write().

Wird benutzt von clear() und clearAll().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

listInvalidationKeys (   $cid,   $resource_name = null,   $cache_id = null,   $compile_id = null,   $resource_uid = null  )

protected

Translate a CacheID into the list of applicable InvalidationKeys. Splits "some|chain|into|an|array" into array( 'clearAll#', 'some', 'some|chain', 'some|chain|into', ... )

Parameter

string	$cid	CacheID to translate
string	$resource_name	template name
string	$cache_id	cache id
string	$compile_id	compile id
string	$resource_uid	source's filepath

Rückgabe

array list of InvalidationKeys $invalidationKeyPrefix to prepend to each InvalidationKey

Definiert in Zeile 387 der Datei smarty_cacheresource_keyvaluestore.php.

Benutzt sanitize().

Wird benutzt von getLatestInvalidationTimestamp().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

populate	(	Smarty_Template_Cached	$cached,
		Smarty_Internal_Template	$_template
	)

populate Cached Object with meta data from Resource

Parameter

Smarty_Template_Cached	$cached	cached object
Smarty_Internal_Template	$_template	template object

Rückgabe

void

Definiert in Zeile 55 der Datei smarty_cacheresource_keyvaluestore.php.

Benutzt populateTimestamp() und sanitize().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

populateTimestamp

(

Smarty_Template_Cached

$cached)

populate Cached Object with timestamp and exists from Resource

Parameter

Smarty_Template_Cached

$cached

cached object

Rückgabe

void

Definiert in Zeile 69 der Datei smarty_cacheresource_keyvaluestore.php.

Benutzt fetch().

Wird benutzt von populate().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

purge ( )

protected

Remove all values from cache

Rückgabe

boolean true on success, false on failure

Definiert in Zeile 506 der Datei smarty_cacheresource_keyvaluestore.php.

Wird benutzt von clearAll().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

read ( array  $keys)

abstractprotected

Read values for a set of keys from cache

Parameter

array

$keys

list of keys to fetch

Rückgabe

array list of values with the given keys used as indexes

Wird benutzt von fetch(), getLatestInvalidationTimestamp() und hasLock().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

readCachedContent

(

Smarty_Internal_Template

$_template)

Read cached template from cache

Parameter

Smarty_Internal_Template

$_template

template object

Rückgabe

string content

Definiert in Zeile 134 der Datei smarty_cacheresource_keyvaluestore.php.

Benutzt fetch().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

releaseLock	(	Smarty	$smarty,
		Smarty_Template_Cached	$cached
	)

Unlock cache for this template

Parameter

Smarty	$smarty	Smarty object
Smarty_Template_Cached	$cached	cached object

Rückgabe

bool|void

Definiert in Zeile 466 der Datei smarty_cacheresource_keyvaluestore.php.

sanitize (   $string)

protected

Sanitize CacheID components

Parameter

string

$string

CacheID component to sanitize

Rückgabe

string sanitized CacheID component

Definiert in Zeile 235 der Datei smarty_cacheresource_keyvaluestore.php.

Wird benutzt von clear(), invalidate(), listInvalidationKeys() und populate().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

write ( array  $keys,   $expire = null  )

abstractprotected

Save values for a set of keys to cache

Parameter

array	$keys	list of values to save
int	$expire	expiration time

Rückgabe

boolean true on success, false on failure

Wird benutzt von acquireLock(), invalidate() und writeCachedContent().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

writeCachedContent	(	Smarty_Internal_Template	$_template,
			$content
	)

Write the rendered template output to cache

Parameter

Smarty_Internal_Template	$_template	template object
string	$content	content to cache

Rückgabe

boolean success

Definiert in Zeile 120 der Datei smarty_cacheresource_keyvaluestore.php.

Benutzt addMetaTimestamp() und write().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Dokumentation der Datenelemente

$contents = array()

protected

Definiert in Zeile 38 der Datei smarty_cacheresource_keyvaluestore.php.

$timestamps = array()

protected

Definiert in Zeile 45 der Datei smarty_cacheresource_keyvaluestore.php.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• libs/sysplugins/smarty_cacheresource_keyvaluestore.php