diff options
Diffstat (limited to 'library/Smarty/libs/sysplugins/smarty_cacheresource_custom.php')
| -rw-r--r-- | library/Smarty/libs/sysplugins/smarty_cacheresource_custom.php | 159 |
1 files changed, 103 insertions, 56 deletions
diff --git a/library/Smarty/libs/sysplugins/smarty_cacheresource_custom.php b/library/Smarty/libs/sysplugins/smarty_cacheresource_custom.php index ee9de157b..a258b2de7 100644 --- a/library/Smarty/libs/sysplugins/smarty_cacheresource_custom.php +++ b/library/Smarty/libs/sysplugins/smarty_cacheresource_custom.php @@ -2,42 +2,43 @@ /** * Smarty Internal Plugin * - * @package Smarty + * @package Smarty * @subpackage Cacher */ /** * Cache Handler API * - * @package Smarty + * @package Smarty * @subpackage Cacher - * @author Rodney Rehm + * @author Rodney Rehm */ -abstract class Smarty_CacheResource_Custom extends Smarty_CacheResource { - +abstract class Smarty_CacheResource_Custom extends Smarty_CacheResource +{ /** * fetch cached content and its modification time from data source * - * @param string $id unique cache content identifier - * @param string $name template name - * @param string $cache_id cache id - * @param string $compile_id compile id - * @param string $content cached content - * @param integer $mtime cache modification timestamp (epoch) + * @param string $id unique cache content identifier + * @param string $name template name + * @param string $cache_id cache id + * @param string $compile_id compile id + * @param string $content cached content + * @param integer $mtime cache modification timestamp (epoch) + * * @return void */ - protected abstract function fetch($id, $name, $cache_id, $compile_id, &$content, &$mtime); + abstract protected function fetch($id, $name, $cache_id, $compile_id, &$content, &$mtime); /** * Fetch cached content's modification timestamp from data source - * * {@internal implementing this method is optional. * Only implement it if modification times can be accessed faster than loading the complete cached content.}} * - * @param string $id unique cache content identifier - * @param string $name template name - * @param string $cache_id cache id - * @param string $compile_id compile id + * @param string $id unique cache content identifier + * @param string $name template name + * @param string $cache_id cache id + * @param string $compile_id compile id + * * @return integer|boolean timestamp (epoch) the template was modified, or false if not found */ protected function fetchTimestamp($id, $name, $cache_id, $compile_id) @@ -48,32 +49,35 @@ abstract class Smarty_CacheResource_Custom extends Smarty_CacheResource { /** * Save content to cache * - * @param string $id unique cache content identifier - * @param string $name template name - * @param string $cache_id cache id - * @param string $compile_id compile id - * @param integer|null $exp_time seconds till expiration or null - * @param string $content content to cache - * @return boolean success + * @param string $id unique cache content identifier + * @param string $name template name + * @param string $cache_id cache id + * @param string $compile_id compile id + * @param integer|null $exp_time seconds till expiration or null + * @param string $content content to cache + * + * @return boolean success */ - protected abstract function save($id, $name, $cache_id, $compile_id, $exp_time, $content); + abstract protected function save($id, $name, $cache_id, $compile_id, $exp_time, $content); /** * Delete content from cache * - * @param string $name template name - * @param string $cache_id cache id - * @param string $compile_id compile id - * @param integer|null $exp_time seconds till expiration time in seconds or null - * @return integer number of deleted caches + * @param string $name template name + * @param string $cache_id cache id + * @param string $compile_id compile id + * @param integer|null $exp_time seconds till expiration time in seconds or null + * + * @return integer number of deleted caches */ - protected abstract function delete($name, $cache_id, $compile_id, $exp_time); + abstract protected function delete($name, $cache_id, $compile_id, $exp_time); /** * populate Cached Object with meta data from Resource * - * @param Smarty_Template_Cached $cached cached object - * @param Smarty_Internal_Template $_template template object + * @param Smarty_Template_Cached $cached cached object + * @param Smarty_Internal_Template $_template template object + * * @return void */ public function populate(Smarty_Template_Cached $cached, Smarty_Internal_Template $_template) @@ -88,7 +92,8 @@ abstract class Smarty_CacheResource_Custom extends Smarty_CacheResource { /** * populate Cached Object with timestamp and exists from Resource * - * @param Smarty_Template_Cached $source cached object + * @param Smarty_Template_Cached $cached + * * @return void */ public function populateTimestamp(Smarty_Template_Cached $cached) @@ -97,6 +102,7 @@ abstract class Smarty_CacheResource_Custom extends Smarty_CacheResource { if ($mtime !== null) { $cached->timestamp = $mtime; $cached->exists = !!$cached->timestamp; + return; } $timestamp = null; @@ -108,11 +114,12 @@ abstract class Smarty_CacheResource_Custom extends Smarty_CacheResource { /** * 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 + * @param Smarty_Internal_Template $_template template object + * @param Smarty_Template_Cached $cached cached object + * + * @return boolean true or false if the cached content does not exist */ - public function process(Smarty_Internal_Template $_template, Smarty_Template_Cached $cached=null) + public function process(Smarty_Internal_Template $_template, Smarty_Template_Cached $cached = null) { if (!$cached) { $cached = $_template->cached; @@ -130,19 +137,25 @@ abstract class Smarty_CacheResource_Custom extends Smarty_CacheResource { ); } if (isset($content)) { + /** @var Smarty_Internal_Template $_smarty_tpl + * used in evaluated code + */ $_smarty_tpl = $_template; eval("?>" . $content); + return true; } + return false; } /** * Write the rendered template output to cache * - * @param Smarty_Internal_Template $_template template object - * @param string $content content to cache - * @return boolean success + * @param Smarty_Internal_Template $_template template object + * @param string $content content to cache + * + * @return boolean success */ public function writeCachedContent(Smarty_Internal_Template $_template, $content) { @@ -159,38 +172,69 @@ abstract class Smarty_CacheResource_Custom extends Smarty_CacheResource { /** * Empty cache * - * @param Smarty $smarty Smarty object - * @param integer $exp_time expiration time (number of seconds, not timestamp) + * @param Smarty $smarty Smarty object + * @param integer $exp_time expiration time (number of seconds, not timestamp) + * * @return integer number of cache files deleted */ - public function clearAll(Smarty $smarty, $exp_time=null) + public function clearAll(Smarty $smarty, $exp_time = null) { $this->cache = array(); + return $this->delete(null, null, null, $exp_time); } /** * Empty cache for a specific template * - * @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 (number of seconds, not timestamp) + * @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 (number of seconds, not timestamp) + * * @return integer number of cache files deleted */ public function clear(Smarty $smarty, $resource_name, $cache_id, $compile_id, $exp_time) { $this->cache = array(); - return $this->delete($resource_name, $cache_id, $compile_id, $exp_time); + $cache_name = null; + + if (isset($resource_name)) { + $_save_stat = $smarty->caching; + $smarty->caching = true; + $tpl = new $smarty->template_class($resource_name, $smarty); + $smarty->caching = $_save_stat; + + if ($tpl->source->exists) { + $cache_name = $tpl->source->name; + } else { + return 0; + } + // remove from template cache + if ($smarty->allow_ambiguous_resources) { + $_templateId = $tpl->source->unique_resource . $tpl->cache_id . $tpl->compile_id; + } else { + $_templateId = $smarty->joined_template_dir . '#' . $resource_name . $tpl->cache_id . $tpl->compile_id; + } + if (isset($_templateId[150])) { + $_templateId = sha1($_templateId); + } + unset($smarty->template_objects[$_templateId]); + // template object no longer needed + unset($tpl); + } + + return $this->delete($cache_name, $cache_id, $compile_id, $exp_time); } /** * 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 + * @param Smarty $smarty Smarty object + * @param Smarty_Template_Cached $cached cached object + * + * @return boolean true or false if cache is locked */ public function hasLock(Smarty $smarty, Smarty_Template_Cached $cached) { @@ -208,8 +252,10 @@ abstract class Smarty_CacheResource_Custom extends Smarty_CacheResource { /** * Lock cache for this template * - * @param Smarty $smarty Smarty object + * @param Smarty $smarty Smarty object * @param Smarty_Template_Cached $cached cached object + * + * @return bool|void */ public function acquireLock(Smarty $smarty, Smarty_Template_Cached $cached) { @@ -223,8 +269,10 @@ abstract class Smarty_CacheResource_Custom extends Smarty_CacheResource { /** * Unlock cache for this template * - * @param Smarty $smarty Smarty object + * @param Smarty $smarty Smarty object * @param Smarty_Template_Cached $cached cached object + * + * @return bool|void */ public function releaseLock(Smarty $smarty, Smarty_Template_Cached $cached) { @@ -234,4 +282,3 @@ abstract class Smarty_CacheResource_Custom extends Smarty_CacheResource { $this->delete($name, null, null, null); } } -?>
\ No newline at end of file |