diff options
Diffstat (limited to 'library/Smarty/libs/sysplugins/smarty_internal_templatebase.php')
| -rw-r--r-- | library/Smarty/libs/sysplugins/smarty_internal_templatebase.php | 603 |
1 files changed, 181 insertions, 422 deletions
diff --git a/library/Smarty/libs/sysplugins/smarty_internal_templatebase.php b/library/Smarty/libs/sysplugins/smarty_internal_templatebase.php index 68fd4be2e..9b4953dee 100644 --- a/library/Smarty/libs/sysplugins/smarty_internal_templatebase.php +++ b/library/Smarty/libs/sysplugins/smarty_internal_templatebase.php @@ -11,8 +11,32 @@ /** * Class with shared template methods * - * @package Smarty - * @subpackage Template + * @package Smarty + * @subpackage Template + * + * @property Smarty $smarty + * @method Smarty_Internal_TemplateBase setAutoloadFilters(mixed $filters, string $type = null) + * @method Smarty_Internal_TemplateBase addAutoloadFilters(mixed $filters, string $type = null) + * @method array getAutoloadFilters(string $type = null) + * @local_method Smarty_Internal_TemplateBase registerFilter(string $type, callback $callback, string $name = null) + * @method Smarty_Internal_TemplateBase unregisterFilter(string $type, mixed $callback) + * @method Smarty_Internal_TemplateBase unloadFilter(string $type, string $name) + * @method string getDebugTemplate() + * @method Smarty_Internal_TemplateBase setDebugTemplate(string $tpl_name) + * @method Smarty_Internal_TemplateBase setDefaultModifier(mixed $modifiers) + * @method Smarty_Internal_TemplateBase addDefaultModifier(mixed $modifiers) + * @method array getDefaultModifier() + * @method Smarty_Internal_TemplateBase registerDefaultPluginHandler(callback $callback) + * @method Smarty_Internal_TemplateBase registerResource(string $name, Smarty_Resource $resource_handler) + * @method Smarty_Internal_TemplateBase unregisterResource(string $name) + * @method Smarty_Internal_TemplateBase registerCacheResource(string $name, Smarty_CacheResource $resource_handler) + * @method Smarty_Internal_TemplateBase unregisterCacheResource(string $name) + * @method Smarty_Internal_TemplateBase unregisterPlugin(string $type, string $name) + * @method Smarty_Internal_TemplateBase unregisterObject(string $object_name) + * @method object getRegisteredObject(string $object_name) + * @method Smarty_Internal_TemplateBase registerClass(string $class_name, string $class_impl) + * @method Smarty_Internal_TemplateBase createData(Smarty_Internal_Data $parent = null, string $name = null) + * @method array getTags(mixed $template = null) */ abstract class Smarty_Internal_TemplateBase extends Smarty_Internal_Data { @@ -23,6 +47,7 @@ abstract class Smarty_Internal_TemplateBase extends Smarty_Internal_Data * @var string */ public $cache_id = null; + /** * Set this if you want different sets of compiled files for the same * templates. @@ -30,12 +55,14 @@ abstract class Smarty_Internal_TemplateBase extends Smarty_Internal_Data * @var string */ public $compile_id = null; + /** * caching enabled * * @var boolean */ public $caching = false; + /** * cache lifetime in seconds * @@ -44,514 +71,246 @@ abstract class Smarty_Internal_TemplateBase extends Smarty_Internal_Data public $cache_lifetime = 3600; /** - * test if cache is valid - * - * @param string|object $template the resource handle of the template file or template object - * @param mixed $cache_id cache id to be used with this template - * @param mixed $compile_id compile id to be used with this template - * @param object $parent next higher level of Smarty variables + * universal cache * - * @return boolean cache status + * @var array() */ - public function isCached($template = null, $cache_id = null, $compile_id = null, $parent = null) - { - if ($template === null && $this instanceof $this->template_class) { - $template = $this; - } else { - if (!($template instanceof $this->template_class)) { - if ($parent === null) { - $parent = $this; - } - $smarty = isset($this->smarty) ? $this->smarty : $this; - $template = $smarty->createTemplate($template, $cache_id, $compile_id, $parent, false); - } - } - // return cache status of template - if (!isset($template->cached)) { - $template->loadCached(); - } - return $template->cached->isCached($template); - } - - /** - * creates a data object - * - * @param object $parent next higher level of Smarty variables - * @param string $name optional data block name - * - * @returns Smarty_Data data object - */ - public function createData($parent = null, $name = null) - { - $dataObj = new Smarty_Data($parent, $this, $name); - if ($this->debugging) { - Smarty_Internal_Debug::register_data($dataObj); - } - return $dataObj; - } - - /** - * Get unique template id - * - * @param string $template_name - * @param null|mixed $cache_id - * @param null|mixed $compile_id - * - * @return string - */ - public function getTemplateId($template_name, $cache_id = null, $compile_id = null) - { - $cache_id = isset($cache_id) ? $cache_id : $this->cache_id; - $compile_id = isset($compile_id) ? $compile_id : $this->compile_id; - $smarty = isset($this->smarty) ? $this->smarty : $this; - if ($smarty->allow_ambiguous_resources) { - $_templateId = Smarty_Resource::getUniqueTemplateName($this, $template_name) . "#{$cache_id}#{$compile_id}"; - } else { - $_templateId = $smarty->joined_template_dir . "#{$template_name}#{$cache_id}#{$compile_id}"; - } - if (isset($_templateId[150])) { - $_templateId = sha1($_templateId); - } - return $_templateId; - } - - /** - * Registers plugin to be used in templates - * - * @param string $type plugin type - * @param string $tag name of template tag - * @param callback $callback PHP callback to register - * @param boolean $cacheable if true (default) this fuction is cachable - * @param array $cache_attr caching attributes if any - * - * @return Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or - * Smarty_Internal_Template) instance for chaining - * @throws SmartyException when the plugin tag is invalid - */ - public function registerPlugin($type, $tag, $callback, $cacheable = true, $cache_attr = null) - { - $smarty = isset($this->smarty) ? $this->smarty : $this; - if (isset($smarty->registered_plugins[$type][$tag])) { - throw new SmartyException("Plugin tag \"{$tag}\" already registered"); - } elseif (!is_callable($callback)) { - throw new SmartyException("Plugin \"{$tag}\" not callable"); - } else { - $smarty->registered_plugins[$type][$tag] = array($callback, (bool) $cacheable, (array) $cache_attr); - } - - return $this; - } + public $_cache = array(); /** - * Unregister Plugin + * fetches a rendered Smarty template * - * @param string $type of plugin - * @param string $tag name of plugin + * @param string $template the resource handle of the template file or template object + * @param mixed $cache_id cache id to be used with this template + * @param mixed $compile_id compile id to be used with this template + * @param object $parent next higher level of Smarty variables * - * @return Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or - * Smarty_Internal_Template) instance for chaining + * @throws Exception + * @throws SmartyException + * @return string rendered template output */ - public function unregisterPlugin($type, $tag) + public function fetch($template = null, $cache_id = null, $compile_id = null, $parent = null) { - $smarty = isset($this->smarty) ? $this->smarty : $this; - if (isset($smarty->registered_plugins[$type][$tag])) { - unset($smarty->registered_plugins[$type][$tag]); - } - - return $this; + $result = $this->_execute($template, $cache_id, $compile_id, $parent, 0); + return $result === null ? ob_get_clean() : $result; } /** - * Registers a resource to fetch a template - * - * @param string $type name of resource type - * @param Smarty_Resource|array $callback or instance of Smarty_Resource, or array of callbacks to handle resource - * (deprecated) + * displays a Smarty template * - * @return Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or - * Smarty_Internal_Template) instance for chaining + * @param string $template the resource handle of the template file or template object + * @param mixed $cache_id cache id to be used with this template + * @param mixed $compile_id compile id to be used with this template + * @param object $parent next higher level of Smarty variables */ - public function registerResource($type, $callback) + public function display($template = null, $cache_id = null, $compile_id = null, $parent = null) { - $smarty = isset($this->smarty) ? $this->smarty : $this; - $smarty->registered_resources[$type] = $callback instanceof Smarty_Resource ? $callback : array($callback, false); - - return $this; + // display template + $this->_execute($template, $cache_id, $compile_id, $parent, 1); } /** - * Unregisters a resource + * test if cache is valid * - * @param string $type name of resource type + * @api Smarty::isCached() + * @link http://www.smarty.net/docs/en/api.is.cached.tpl * - * @return Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or - * Smarty_Internal_Template) instance for chaining - */ - public function unregisterResource($type) - { - $smarty = isset($this->smarty) ? $this->smarty : $this; - if (isset($smarty->registered_resources[$type])) { - unset($smarty->registered_resources[$type]); - } - - return $this; - } - - /** - * Registers a cache resource to cache a template's output - * - * @param string $type name of cache resource type - * @param Smarty_CacheResource $callback instance of Smarty_CacheResource to handle output caching + * @param null|string|\Smarty_Internal_Template $template the resource handle of the template file or template object + * @param mixed $cache_id cache id to be used with this template + * @param mixed $compile_id compile id to be used with this template + * @param object $parent next higher level of Smarty variables * - * @return Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or - * Smarty_Internal_Template) instance for chaining + * @return boolean cache status */ - public function registerCacheResource($type, Smarty_CacheResource $callback) + public function isCached($template = null, $cache_id = null, $compile_id = null, $parent = null) { - $smarty = isset($this->smarty) ? $this->smarty : $this; - $smarty->registered_cache_resources[$type] = $callback; - - return $this; + return $this->_execute($template, $cache_id, $compile_id, $parent, 2); } /** - * Unregisters a cache resource + * fetches a rendered Smarty template * - * @param string $type name of cache resource type + * @param string $template the resource handle of the template file or template object + * @param mixed $cache_id cache id to be used with this template + * @param mixed $compile_id compile id to be used with this template + * @param object $parent next higher level of Smarty variables + * @param string $function function type 0 = fetch, 1 = display, 2 = isCache * - * @return Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or - * Smarty_Internal_Template) instance for chaining + * @return mixed + * @throws \Exception + * @throws \SmartyException */ - public function unregisterCacheResource($type) + private function _execute($template, $cache_id, $compile_id, $parent, $function) { - $smarty = isset($this->smarty) ? $this->smarty : $this; - if (isset($smarty->registered_cache_resources[$type])) { - unset($smarty->registered_cache_resources[$type]); + $smarty = $this->_objType == 1 ? $this : $this->smarty; + if ($template === null) { + if ($this->_objType != 2) { + throw new SmartyException($function . '():Missing \'$template\' parameter'); + } else { + $template = clone $this; + } + } elseif (is_object($template)) { + if (!isset($template->_objType) || $template->_objType != 2) { + throw new SmartyException($function . '():Template object expected'); + } else { + /* @var Smarty_Internal_Template $template */ + $template = clone $template; + } + } else { + // get template object + /* @var Smarty_Internal_Template $template */ + $template = $smarty->createTemplate($template, $cache_id, $compile_id, $parent, false); + if ($this->_objType == 1) { + // set caching in template object + $template->caching = $this->caching; + } } - - return $this; - } - - /** - * Registers object to be used in templates - * - * @param $object_name - * @param object $object_impl the referenced PHP object to register - * @param array $allowed list of allowed methods (empty = all) - * @param boolean $smarty_args smarty argument format, else traditional - * @param array $block_methods list of block-methods - * - * @throws SmartyException - * @return Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or - * Smarty_Internal_Template) instance for chaining - */ - public function registerObject($object_name, $object_impl, $allowed = array(), $smarty_args = true, $block_methods = array()) - { - // test if allowed methods callable - if (!empty($allowed)) { - foreach ((array) $allowed as $method) { - if (!is_callable(array($object_impl, $method)) && !property_exists($object_impl, $method)) { - throw new SmartyException("Undefined method or property '$method' in registered object"); + // fetch template content + $level = ob_get_level(); + try { + $_smarty_old_error_level = + ($this->_objType == 1 && isset($smarty->error_reporting)) ? error_reporting($smarty->error_reporting) : + null; + if ($function == 2) { + if ($template->caching) { + // return cache status of template + if (!isset($template->cached)) { + $template->loadCached(); + } + $result = $template->cached->isCached($template); + $template->smarty->_cache['isCached'][$template->_getTemplateId()] = $template; + } else { + return false; + } + } else { + ob_start(); + $template->_mergeVars(); + if (!empty(Smarty::$global_tpl_vars)) { + $template->tpl_vars = array_merge(Smarty::$global_tpl_vars, $template->tpl_vars); } + $result = $template->render(false, $function); } + if (isset($_smarty_old_error_level)) { + error_reporting($_smarty_old_error_level); + } + return $result; } - // test if block methods callable - if (!empty($block_methods)) { - foreach ((array) $block_methods as $method) { - if (!is_callable(array($object_impl, $method))) { - throw new SmartyException("Undefined method '$method' in registered object"); - } + catch (Exception $e) { + while (ob_get_level() > $level) { + ob_end_clean(); } + throw $e; } - // register the object - $smarty = isset($this->smarty) ? $this->smarty : $this; - $smarty->registered_objects[$object_name] = - array($object_impl, (array) $allowed, (boolean) $smarty_args, (array) $block_methods); - - return $this; } /** - * return a reference to a registered object - * - * @param string $name object name + * Registers plugin to be used in templates * - * @return object - * @throws SmartyException if no such object is found - */ - public function getRegisteredObject($name) - { - $smarty = isset($this->smarty) ? $this->smarty : $this; - if (!isset($smarty->registered_objects[$name])) { - throw new SmartyException("'$name' is not a registered object"); - } - if (!is_object($smarty->registered_objects[$name][0])) { - throw new SmartyException("registered '$name' is not an object"); - } - - return $smarty->registered_objects[$name][0]; - } - - /** - * unregister an object + * @api Smarty::registerPlugin() + * @link http://www.smarty.net/docs/en/api.register.plugin.tpl * - * @param string $name object name + * @param string $type plugin type + * @param string $name name of template tag + * @param callback $callback PHP callback to register + * @param bool $cacheable if true (default) this function is cache able + * @param mixed $cache_attr caching attributes if any * - * @return Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or - * Smarty_Internal_Template) instance for chaining + * @return \Smarty|\Smarty_Internal_Template + * @throws SmartyException when the plugin tag is invalid */ - public function unregisterObject($name) + public function registerPlugin($type, $name, $callback, $cacheable = true, $cache_attr = null) { - $smarty = isset($this->smarty) ? $this->smarty : $this; - if (isset($smarty->registered_objects[$name])) { - unset($smarty->registered_objects[$name]); - } - - return $this; + return $this->ext->registerPlugin->registerPlugin($this, $type, $name, $callback, $cacheable, $cache_attr); } /** - * Registers static classes to be used in templates - * - * @param $class_name - * @param string $class_impl the referenced PHP class to register + * load a filter of specified type and name * - * @throws SmartyException - * @return Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or - * Smarty_Internal_Template) instance for chaining - */ - public function registerClass($class_name, $class_impl) - { - // test if exists - if (!class_exists($class_impl)) { - throw new SmartyException("Undefined class '$class_impl' in register template class"); - } - // register the class - $smarty = isset($this->smarty) ? $this->smarty : $this; - $smarty->registered_classes[$class_name] = $class_impl; - - return $this; - } - - /** - * Registers a default plugin handler + * @api Smarty::loadFilter() + * @link http://www.smarty.net/docs/en/api.load.filter.tpl * - * @param callable $callback class/method name + * @param string $type filter type + * @param string $name filter name * - * @return Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or - * Smarty_Internal_Template) instance for chaining - * @throws SmartyException if $callback is not callable + * @return bool + * @throws SmartyException if filter could not be loaded */ - public function registerDefaultPluginHandler($callback) + public function loadFilter($type, $name) { - $smarty = isset($this->smarty) ? $this->smarty : $this; - if (is_callable($callback)) { - $smarty->default_plugin_handler_func = $callback; - } else { - throw new SmartyException("Default plugin handler '$callback' not callable"); - } - - return $this; + return $this->ext->loadFilter->loadFilter($this, $type, $name); } /** - * Registers a default template handler - * - * @param callable $callback class/method name + * Registers a filter function * - * @return Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or - * Smarty_Internal_Template) instance for chaining - * @throws SmartyException if $callback is not callable - */ - public function registerDefaultTemplateHandler($callback) - { - Smarty_Internal_Extension_DefaultTemplateHandler::registerDefaultTemplateHandler($this, $callback); - return $this; - } - - /** - * Registers a default template handler + * @api Smarty::registerFilter() + * @link http://www.smarty.net/docs/en/api.register.filter.tpl * - * @param callable $callback class/method name + * @param string $type filter type + * @param callback $callback + * @param string|null $name optional filter name * - * @return Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or - * Smarty_Internal_Template) instance for chaining - * @throws SmartyException if $callback is not callable + * @return \Smarty|\Smarty_Internal_Template + * @throws \SmartyException */ - public function registerDefaultConfigHandler($callback) + public function registerFilter($type, $callback, $name = null) { - Smarty_Internal_Extension_DefaultTemplateHandler::registerDefaultConfigHandler($this, $callback); - return $this; + return $this->ext->registerFilter->registerFilter($this, $type, $callback, $name); } /** - * Registers a filter function - * - * @param string $type filter type - * @param callback $callback + * Registers object to be used in templates * - * @return Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or - * Smarty_Internal_Template) instance for chaining - */ - public function registerFilter($type, $callback) - { - $smarty = isset($this->smarty) ? $this->smarty : $this; - $smarty->registered_filters[$type][$this->_get_filter_name($callback)] = $callback; - - return $this; - } - - /** - * Unregisters a filter function + * @api Smarty::registerObject() + * @link http://www.smarty.net/docs/en/api.register.object.tpl * - * @param string $type filter type - * @param callback $callback + * @param string $object_name + * @param object $object the referenced PHP object to register + * @param array $allowed_methods_properties list of allowed methods (empty = all) + * @param bool $format smarty argument format, else traditional + * @param array $block_methods list of block-methods * - * @return Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or - * Smarty_Internal_Template) instance for chaining + * @return \Smarty|\Smarty_Internal_Template + * @throws \SmartyException */ - public function unregisterFilter($type, $callback) + public function registerObject($object_name, $object, $allowed_methods_properties = array(), $format = true, + $block_methods = array()) { - $name = $this->_get_filter_name($callback); - $smarty = isset($this->smarty) ? $this->smarty : $this; - if (isset($smarty->registered_filters[$type][$name])) { - unset($smarty->registered_filters[$type][$name]); - } - - return $this; + return $this->ext->registerObject->registerObject($this, $object_name, $object, $allowed_methods_properties, + $format, $block_methods); } /** - * Return internal filter name - * - * @param callback $function_name - * - * @return string internal filter name + * @param boolean $caching */ - public function _get_filter_name($function_name) + public function setCaching($caching) { - if (is_array($function_name)) { - $_class_name = (is_object($function_name[0]) ? - get_class($function_name[0]) : $function_name[0]); - - return $_class_name . '_' . $function_name[1]; - } else { - return $function_name; - } + $this->caching = $caching; } /** - * load a filter of specified type and name - * - * @param string $type filter type - * @param string $name filter name - * - * @throws SmartyException if filter could not be loaded + * @param int $cache_lifetime */ - public function loadFilter($type, $name) + public function setCacheLifetime($cache_lifetime) { - $smarty = isset($this->smarty) ? $this->smarty : $this; - $_plugin = "smarty_{$type}filter_{$name}"; - $_filter_name = $_plugin; - if ($smarty->loadPlugin($_plugin)) { - if (class_exists($_plugin, false)) { - $_plugin = array($_plugin, 'execute'); - } - if (is_callable($_plugin)) { - $smarty->registered_filters[$type][$_filter_name] = $_plugin; - - return true; - } - } - throw new SmartyException("{$type}filter \"{$name}\" not callable"); + $this->cache_lifetime = $cache_lifetime; } /** - * unload a filter of specified type and name - * - * @param string $type filter type - * @param string $name filter name - * - * @return Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or - * Smarty_Internal_Template) instance for chaining + * @param string $compile_id */ - public function unloadFilter($type, $name) + public function setCompileId($compile_id) { - $smarty = isset($this->smarty) ? $this->smarty : $this; - $_filter_name = "smarty_{$type}filter_{$name}"; - if (isset($smarty->registered_filters[$type][$_filter_name])) { - unset ($smarty->registered_filters[$type][$_filter_name]); - } - - return $this; + $this->compile_id = $compile_id; } /** - * preg_replace callback to convert camelcase getter/setter to underscore property names - * - * @param string $match match string - * - * @return string replacemant + * @param string $cache_id */ - private function replaceCamelcase($match) + public function setCacheId($cache_id) { - return "_" . strtolower($match[1]); + $this->cache_id = $cache_id; } - /** - * Handle unknown class methods - * - * @param string $name unknown method-name - * @param array $args argument array - * - * @throws SmartyException - */ - public function __call($name, $args) - { - static $_prefixes = array('set' => true, 'get' => true); - static $_resolved_property_name = array(); - static $_resolved_property_source = array(); - - // see if this is a set/get for a property - $first3 = strtolower(substr($name, 0, 3)); - if (isset($_prefixes[$first3]) && isset($name[3]) && $name[3] !== '_') { - if (isset($_resolved_property_name[$name])) { - $property_name = $_resolved_property_name[$name]; - } else { - // try to keep case correct for future PHP 6.0 case-sensitive class methods - // lcfirst() not available < PHP 5.3.0, so improvise - $property_name = strtolower(substr($name, 3, 1)) . substr($name, 4); - // convert camel case to underscored name - $property_name = preg_replace_callback('/([A-Z])/', array($this, 'replaceCamelcase'), $property_name); - $_resolved_property_name[$name] = $property_name; - } - if (isset($_resolved_property_source[$property_name])) { - $status = $_resolved_property_source[$property_name]; - } else { - $status = null; - if (property_exists($this, $property_name)) { - $status = true; - } elseif (property_exists($this->smarty, $property_name)) { - $status = false; - } - $_resolved_property_source[$property_name] = $status; - } - $smarty = null; - if ($status === true) { - $smarty = $this; - } elseif ($status === false) { - $smarty = $this->smarty; - } - if ($smarty) { - if ($first3 == 'get') { - return $smarty->$property_name; - } else { - return $smarty->$property_name = $args[0]; - } - } - throw new SmartyException("property '$property_name' does not exist."); - } - throw new SmartyException("Call of unknown method '$name'."); - } } |