Class Smarty_Internal_CacheResource_File

Description

This class does contain all necessary methods for the HTML cache on file system

Implements the file system as resource for the HTML cache Version ussing nocache inserts.

  • author: Rodney Rehm

Located in /libs/sysplugins/smarty_internal_cacheresource_file.php (line 19)

Smarty_CacheResource
   |
   --Smarty_Internal_CacheResource_File
Method Summary
void acquireLock (Smarty $smarty, Smarty_Template_Cached $cached)
integer clear (Smarty $smarty, string $resource_name, string $cache_id, string $compile_id, integer $exp_time, Smarty $_template)
integer clearAll (Smarty $smarty, [integer $exp_time = null], Smarty_Internal_Template $_template)
booelan hasLock (Smarty $smarty, Smarty_Template_Cached $cached)
booelan process (Smarty_Internal_Template $_template, [Smarty_Template_Cached $cached = null])
void releaseLock (Smarty $smarty, Smarty_Template_Cached $cached)
boolean writeCachedContent (Smarty_Internal_Template $_template, string $content)
Variables
Methods
acquireLock (line 236)

Lock cache for this template

  • access: public
void acquireLock (Smarty $smarty, Smarty_Template_Cached $cached)

Redefinition of:
Smarty_CacheResource::acquireLock()
clear (line 132)

Empty cache for a specific template

  • return: number of cache files deleted
  • access: public
integer clear (Smarty $smarty, string $resource_name, string $cache_id, string $compile_id, integer $exp_time, Smarty $_template)
  • Smarty $_template: template 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)
  • Smarty $smarty

Redefinition of:
Smarty_CacheResource::clear()
Empty cache for a specific template
clearAll (line 117)

Empty cache

  • return: number of cache files deleted
  • access: public
integer clearAll (Smarty $smarty, [integer $exp_time = null], Smarty_Internal_Template $_template)

Redefinition of:
Smarty_CacheResource::clearAll()
Empty cache
hasLock (line 219)

Check is cache is locked for this template

  • return: true or false if cache is locked
  • access: public
booelan hasLock (Smarty $smarty, Smarty_Template_Cached $cached)

Redefinition of:
Smarty_CacheResource::hasLock()
populate (line 28)

populate Cached Object with meta data from Resource

  • access: public
void populate (Smarty_Template_Cached $cached, Smarty_Internal_Template $_template)

Redefinition of:
Smarty_CacheResource::populate()
populate Cached Object with meta data from Resource
populateTimestamp (line 74)

populate Cached Object with timestamp and exists from Resource

  • access: public
void populateTimestamp (Smarty_Template_Cached $cached)

Redefinition of:
Smarty_CacheResource::populateTimestamp()
populate Cached Object with timestamp and exists from Resource
process (line 87)

Read the cached template and process its header

  • return: true or false if the cached content does not exist
  • access: public
booelan process (Smarty_Internal_Template $_template, [Smarty_Template_Cached $cached = null])

Redefinition of:
Smarty_CacheResource::process()
Read the cached template and process header
releaseLock (line 248)

Unlock cache for this template

  • access: public
void releaseLock (Smarty $smarty, Smarty_Template_Cached $cached)

Redefinition of:
Smarty_CacheResource::releaseLock()
writeCachedContent (line 100)

Write the rendered template output to cache

  • return: success
  • access: public
boolean writeCachedContent (Smarty_Internal_Template $_template, string $content)

Redefinition of:
Smarty_CacheResource::writeCachedContent()
Write the rendered template output to cache

Inherited Methods

Inherited From Smarty_CacheResource

Smarty_CacheResource::acquireLock()
Smarty_CacheResource::clear()
Smarty_CacheResource::clearAll()
Smarty_CacheResource::getCachedContent()
Smarty_CacheResource::hasLock()
Smarty_CacheResource::invalidLoadedCache()
Smarty_CacheResource::load()
Smarty_CacheResource::locked()
Smarty_CacheResource::populate()
Smarty_CacheResource::populateTimestamp()
Smarty_CacheResource::process()
Smarty_CacheResource::releaseLock()
Smarty_CacheResource::writeCachedContent()

Documentation generated on Sat, 24 Sep 2011 20:23:36 +0200 by phpDocumentor 1.4.1