[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

/libraries/Smarty/libs/sysplugins/ -> smarty_cacheresource_keyvaluestore.php (summary)

Smarty Internal Plugin

File Size: 463 lines (16 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 18 functions

  populate()
  populateTimestamp()
  process()
  writeCachedContent()
  clearAll()
  clear()
  getTemplateUid()
  sanitize()
  fetch()
  addMetaTimestamp()
  getMetaTimestamp()
  invalidate()
  getLatestInvalidationTimestamp()
  listInvalidationKeys()
  hasLock()
  acquireLock()
  releaseLock()
  purge()

Functions
Functions that are not part of a class:

populate(Smarty_Template_Cached $cached, Smarty_Internal_Template $_template)   X-Ref
populate Cached Object with meta data from Resource

param: Smarty_Template_Cached   $cached    cached object
param: Smarty_Internal_Template $_template template object
return: void

populateTimestamp(Smarty_Template_Cached $cached)   X-Ref
populate Cached Object with timestamp and exists from Resource

param: Smarty_Template_Cached $cached cached object
return: void

process(Smarty_Internal_Template $_template, Smarty_Template_Cached $cached=null)   X-Ref
Read the cached template and process the header

param: Smarty_Internal_Template $_template template object
param: Smarty_Template_Cached $cached cached object
return: booelan true or false if the cached content does not exist

writeCachedContent(Smarty_Internal_Template $_template, $content)   X-Ref
Write the rendered template output to cache

param: Smarty_Internal_Template $_template template object
param: string $content content to cache
return: boolean success

clearAll(Smarty $smarty, $exp_time=null)   X-Ref
Empty cache

{@internal the $exp_time argument is ignored altogether }}

param: Smarty  $smarty   Smarty object
param: integer $exp_time expiration time [being ignored]
return: integer number of cache files deleted [always -1]

clear(Smarty $smarty, $resource_name, $cache_id, $compile_id, $exp_time)   X-Ref
Empty cache for a specific template

{@internal the $exp_time argument is ignored altogether}}

param: Smarty  $smarty        Smarty object
param: string  $resource_name template name
param: string  $cache_id      cache id
param: string  $compile_id    compile id
param: integer $exp_time      expiration time [being ignored]
return: integer number of cache files deleted [always -1]

getTemplateUid(Smarty $smarty, $resource_name, $cache_id, $compile_id)   X-Ref
Get template's unique ID

param: Smarty $smarty        Smarty object
param: string $resource_name template name
param: string $cache_id      cache id
param: string $compile_id    compile id
return: string filepath of cache file

sanitize($string)   X-Ref
Sanitize CacheID components

param: string $string CacheID component to sanitize
return: string sanitized CacheID component

fetch($cid, $resource_name = null, $cache_id = null, $compile_id = null, &$content = null, &$timestamp = null, $resource_uid = null)   X-Ref
Fetch and prepare a cache object.

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

addMetaTimestamp(&$content)   X-Ref
Add current microtime to the beginning of $cache_content

{@internal the header uses 8 Bytes, the first 4 Bytes are the seconds, the second 4 Bytes are the microseconds}}

param: string &$content the content to be cached

getMetaTimestamp(&$content)   X-Ref
Extract the timestamp the $content was cached

param: string &$content the cached content
return: float the microtime the content was cached

invalidate($cid = null, $resource_name = null, $cache_id = null, $compile_id = null, $resource_uid = null)   X-Ref
Invalidate CacheID

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

getLatestInvalidationTimestamp($cid, $resource_name = null, $cache_id = null, $compile_id = null, $resource_uid = null)   X-Ref
Determine the latest timestamp known to the invalidation chain

param: string $cid           CacheID to determine latest invalidation timestamp of
param: string $resource_name template name
param: string $cache_id      cache id
param: string $compile_id    compile id
param: string $resource_uid  source's filepath
return: float the microtime the CacheID was invalidated

listInvalidationKeys($cid, $resource_name = null, $cache_id = null, $compile_id = null, $resource_uid = null)   X-Ref
Translate a CacheID into the list of applicable InvalidationKeys.

Splits "some|chain|into|an|array" into array( '#clearAll#', 'some', 'some|chain', 'some|chain|into', ... )

param: string $cid           CacheID to translate
param: string $resource_name template name
param: string $cache_id      cache id
param: string $compile_id    compile id
param: string $resource_uid  source's filepath
return: array list of InvalidationKeys

hasLock(Smarty $smarty, Smarty_Template_Cached $cached)   X-Ref
Check is cache is locked for this template

param: Smarty $smarty Smarty object
param: Smarty_Template_Cached $cached cached object
return: booelan true or false if cache is locked

acquireLock(Smarty $smarty, Smarty_Template_Cached $cached)   X-Ref
Lock cache for this template

param: Smarty $smarty Smarty object
param: Smarty_Template_Cached $cached cached object

releaseLock(Smarty $smarty, Smarty_Template_Cached $cached)   X-Ref
Unlock cache for this template

param: Smarty $smarty Smarty object
param: Smarty_Template_Cached $cached cached object

purge()   X-Ref
Remove *all* values from cache

return: boolean true on success, false on failure



Generated: Fri Nov 28 20:08:37 2014 Cross-referenced by PHPXref 0.7.1