3 * Smarty Resource Plugin
6 * @subpackage TemplateResources
11 * Smarty Resource Plugin
12 * Wrapper Implementation for custom resource plugins
15 * @subpackage TemplateResources
17 abstract class Smarty_Resource_Custom extends Smarty_Resource
20 * fetch template and its modification time from data source
22 * @param string $name template name
23 * @param string &$source template source
24 * @param integer &$mtime template modification timestamp (epoch)
26 abstract protected function fetch($name, &$source, &$mtime);
29 * Fetch template's modification timestamp from data source
30 * {@internal implementing this method is optional.
31 * Only implement it if modification times can be accessed faster than loading the complete template source.}}
33 * @param string $name template name
35 * @return integer|boolean timestamp (epoch) the template was modified, or false if not found
37 protected function fetchTimestamp($name)
43 * populate Source Object with meta data from Resource
45 * @param Smarty_Template_Source $source source object
46 * @param Smarty_Internal_Template $_template template object
48 public function populate(Smarty_Template_Source $source, Smarty_Internal_Template $_template = null)
50 $source->filepath = $source->type . ':' . $source->name;
51 $source->uid = sha1($source->type . ':' . $source->name);
53 $mtime = $this->fetchTimestamp($source->name);
54 if ($mtime !== null) {
55 $source->timestamp = $mtime;
57 $this->fetch($source->name, $content, $timestamp);
58 $source->timestamp = isset($timestamp) ? $timestamp : false;
59 if (isset($content)) {
60 $source->content = $content;
63 $source->exists = !!$source->timestamp;
67 * Load template's source into current template object
69 * @param Smarty_Template_Source $source source object
71 * @return string template source
72 * @throws SmartyException if source cannot be loaded
74 public function getContent(Smarty_Template_Source $source)
76 $this->fetch($source->name, $content, $timestamp);
77 if (isset($content)) {
81 throw new SmartyException("Unable to read template {$source->type} '{$source->name}'");
85 * Determine basename for compiled filename
87 * @param Smarty_Template_Source $source source object
89 * @return string resource's basename
91 public function getBasename(Smarty_Template_Source $source)
93 return basename($source->name);