$sources
$sources : array
cache for Smarty_Template_Source instances
Smarty Resource Plugin
Wrapper Implementation for custom resource plugins
getContent(\Smarty_Template_Source $source) : string
Load template's source into current template object
| \Smarty_Template_Source | $source | source object |
if source cannot be loaded
template source
populate(\Smarty_Template_Source $source, \Smarty_Internal_Template $_template = null)
populate Source Object with meta data from Resource
| \Smarty_Template_Source | $source | source object |
| \Smarty_Internal_Template | $_template | template object |
populateTimestamp(\Smarty_Template_Source $source)
populate Source Object with timestamp and exists from Resource
| \Smarty_Template_Source | $source | source object |
populateCompiledFilepath(\Smarty_Template_Compiled $compiled, \Smarty_Internal_Template $_template)
populate Compiled Object with compiled filepath
| \Smarty_Template_Compiled | $compiled | compiled object |
| \Smarty_Internal_Template | $_template | template object |
load(\Smarty $smarty, string $type) : \Smarty_Resource
Load Resource Handler
| \Smarty | $smarty | smarty object |
| string | $type | name of the resource |
Resource Handler
getUniqueTemplateName(string $smarty, string $template_resource) : string
modify template_resource according to resource handlers specifications
| string | $smarty | Smarty instance |
| string | $template_resource | template_resource to extracate resource handler and name of |
unique resource name
source(\Smarty_Internal_Template $_template = null, \Smarty $smarty = null, string $template_resource = null) : \Smarty_Template_Source
initialize Source Object for given resource
Either [$_template] or [$smarty, $template_resource] must be specified
| \Smarty_Internal_Template | $_template | template object |
| \Smarty | $smarty | smarty object |
| string | $template_resource | resource identifier |
Source Object
config(\Smarty_Internal_Config $_config) : \Smarty_Config_Source
initialize Config Source Object for given resource
| \Smarty_Internal_Config | $_config | config object |
Source Object
buildUniqueResourceName(\Smarty $smarty, string $resource_name) : string
modify resource_name according to resource handlers specifications
| \Smarty | $smarty | Smarty instance |
| string | $resource_name | resource_name to make unique |
unique resource name
buildFilepath(\Smarty_Template_Source $source, \Smarty_Internal_Template $_template = null) : string
build template filepath by traversing the template_dir array
| \Smarty_Template_Source | $source | source object |
| \Smarty_Internal_Template | $_template | template object |
if default template handler is registered but not callable
fully qualified filepath
fileExists(\Smarty_Template_Source $source, string $file) : boolean
test is file exists and save timestamp
| \Smarty_Template_Source | $source | source object |
| string | $file | file name |
true if file exists
getBasename(\Smarty_Template_Source $source) : string
Determine basename for compiled filename
| \Smarty_Template_Source | $source | source object |
resource's basename
parseResourceName(string $resource_name, string $default_resource, $name, $type) : void
extract resource_type and resource_name from template_resource and config_resource
| string | $resource_name | template_resource or config_resource to parse |
| string | $default_resource | the default resource_type defined in $smarty |
| $name | ||
| $type |
fetchTimestamp(string $name) : integer|boolean
Fetch template'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 template source.}}
| string | $name | template name |
timestamp (epoch) the template was modified, or false if not found
<?php
/**
* Smarty Resource Plugin
*
* @package Smarty
* @subpackage TemplateResources
* @author Rodney Rehm
*/
/**
* Smarty Resource Plugin
*
* Wrapper Implementation for custom resource plugins
*
* @package Smarty
* @subpackage TemplateResources
*/
abstract class Smarty_Resource_Custom extends Smarty_Resource {
/**
* fetch template and its modification time from data source
*
* @param string $name template name
* @param string &$source template source
* @param integer &$mtime template modification timestamp (epoch)
*/
protected abstract function fetch($name, &$source, &$mtime);
/**
* Fetch template'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 template source.}}
*
* @param string $name template name
* @return integer|boolean timestamp (epoch) the template was modified, or false if not found
*/
protected function fetchTimestamp($name)
{
return null;
}
/**
* populate Source Object with meta data from Resource
*
* @param Smarty_Template_Source $source source object
* @param Smarty_Internal_Template $_template template object
*/
public function populate(Smarty_Template_Source $source, Smarty_Internal_Template $_template=null)
{
$source->filepath = strtolower($source->type . ':' . $source->name);
$source->uid = sha1($source->type . ':' . $source->name);
$mtime = $this->fetchTimestamp($source->name);
if ($mtime !== null) {
$source->timestamp = $mtime;
} else {
$this->fetch($source->name, $content, $timestamp);
$source->timestamp = isset($timestamp) ? $timestamp : false;
if( isset($content) )
$source->content = $content;
}
$source->exists = !!$source->timestamp;
}
/**
* Load template's source into current template object
*
* @param Smarty_Template_Source $source source object
* @return string template source
* @throws SmartyException if source cannot be loaded
*/
public function getContent(Smarty_Template_Source $source)
{
$this->fetch($source->name, $content, $timestamp);
if (isset($content)) {
return $content;
}
throw new SmartyException("Unable to read template {$source->type} '{$source->name}'");
}
/**
* Determine basename for compiled filename
*
* @param Smarty_Template_Source $source source object
* @return string resource's basename
*/
protected function getBasename(Smarty_Template_Source $source)
{
return basename($source->name);
}
}
?>