Class Smarty_CacheResource

Cache Handler API

Direct known subclasses

Smarty_CacheResource_Custom, Smarty_CacheResource_KeyValueStore, Smarty_Internal_CacheResource_File

Abstract
Package: Smarty\Cacher
Author: Rodney Rehm
Located at wa-system/vendors/smarty3/sysplugins/smarty_cacheresource.php

Methods summary
`abstract public`	# `populate( Smarty_Template_Cached $cached, Smarty_Internal_Template $_template )` populate Cached Object with meta data from Resource populate Cached Object with meta data from Resource Parameters `$cached` `Smarty_Template_Cached` $cached cached object `$_template` `Smarty_Internal_Template` $_template template object
`abstract public`	# `populateTimestamp( Smarty_Template_Cached $cached )` populate Cached Object with timestamp and exists from Resource populate Cached Object with timestamp and exists from Resource Parameters `$cached` `Smarty_Template_Cached` $source cached object
`abstract public booelan`	# `process( Smarty_Internal_Template $_template, Smarty_Template_Cached $cached = null )` Read the cached template and process header Read the cached template and process header Parameters `$_template` `Smarty_Internal_Template` $_template template object `$cached` `Smarty_Template_Cached` $cached cached object Returns `booelan` true or false if the cached content does not exist
`abstract public boolean`	# `writeCachedContent( Smarty_Internal_Template $_template, string $content )` Write the rendered template output to cache Write the rendered template output to cache Parameters `$_template` `Smarty_Internal_Template` $_template template object `$content` `string` $content content to cache Returns `boolean` success
`public`	# `getCachedContent( Smarty_Internal_Template $_template )` Return cached content Return cached content Parameters `$_template` `Smarty_Internal_Template` $_template template object
`abstract public integer`	# `clearAll( Smarty $smarty, integer $exp_time = null )` Empty cache Empty cache Parameters `$smarty` `Smarty` $smarty Smarty object `$exp_time` `integer` $exp_time expiration time (number of seconds, not timestamp) Returns `integer` number of cache files deleted
`abstract public integer`	# `clear( Smarty $smarty, string $resource_name, string $cache_id, string $compile_id, integer $exp_time )` Empty cache for a specific template Empty cache for a specific template Parameters `$smarty` `Smarty` $smarty Smarty object `$resource_name` `string` $resource_name template name `$cache_id` `string` $cache_id cache id `$compile_id` `string` $compile_id compile id `$exp_time` `integer` $exp_time expiration time (number of seconds, not timestamp) Returns `integer` number of cache files deleted
`public`	# `locked( Smarty $smarty, Smarty_Template_Cached $cached )`
`public`	# `hasLock( Smarty $smarty, Smarty_Template_Cached $cached )`
`public`	# `acquireLock( Smarty $smarty, Smarty_Template_Cached $cached )`
`public`	# `releaseLock( Smarty $smarty, Smarty_Template_Cached $cached )`
`public static Smarty_CacheResource`	# `load( Smarty $smarty, string $type = null )` Load Cache Resource Handler Load Cache Resource Handler Parameters `$smarty` `Smarty` $smarty Smarty object `$type` `string` $type name of the cache resource Returns `Smarty_CacheResource` Cache Resource Handler
`public static`	# `invalidLoadedCache( Smarty $smarty )` Invalid Loaded Cache Files Invalid Loaded Cache Files Parameters `$smarty` `Smarty` $smarty Smarty object

Properties summary
`public static array`	`$resources`	`array()`	# cache for Smarty_CacheResource instances cache for Smarty_CacheResource instances
`protected static array`	`$sysplugins`	`array( 'file' => true, )`	# resource types provided by the core resource types provided by the core