123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376 |
- <?php
- /**
- * Smarty Internal Plugin Template
- * This file contains the Smarty template engine
- *
- * @package Smarty
- * @subpackage Template
- * @author Uwe Tews
- */
-
- /**
- * Main class with template data structures and methods
- *
- * @package Smarty
- * @subpackage Template
- *
- * @property Smarty_Template_Source|Smarty_Template_Config $source
- * @property Smarty_Template_Compiled $compiled
- * @property Smarty_Template_Cached $cached
- * @method bool mustCompile()
- */
- class Smarty_Internal_Template extends Smarty_Internal_TemplateBase
- {
- /**
- * This object type (Smarty = 1, template = 2, data = 4)
- *
- * @var int
- */
- public $_objType = 2;
-
- /**
- * Global smarty instance
- *
- * @var Smarty
- */
- public $smarty = null;
-
- /**
- * Source instance
- *
- * @var Smarty_Template_Source|Smarty_Template_Config
- */
- public $source = null;
-
- /**
- * Template resource
- *
- * @var string
- */
- public $template_resource = null;
-
- /**
- * flag if compiled template is invalid and must be (re)compiled
- *
- * @var bool
- */
- public $mustCompile = null;
-
- /**
- * Template Id
- *
- * @var null|string
- */
- public $templateId = null;
-
- /**
- * Known template functions
- *
- * @var array
- */
- public $tpl_function = array();
-
- /**
- * Scope in which template is rendered
- *
- * @var int
- */
- public $scope = 0;
-
- /**
- * Create template data object
- * Some of the global Smarty settings copied to template scope
- * It load the required template resources and caching plugins
- *
- * @param string $template_resource template resource string
- * @param Smarty $smarty Smarty instance
- * @param \Smarty_Internal_Template|\Smarty|\Smarty_Internal_Data $_parent back pointer to parent object
- * with variables or null
- * @param mixed $_cache_id cache id or null
- * @param mixed $_compile_id compile id or null
- * @param bool $_caching use caching?
- * @param int $_cache_lifetime cache life-time in seconds
- *
- * @throws \SmartyException
- */
- public function __construct($template_resource, Smarty $smarty, Smarty_Internal_Data $_parent = null,
- $_cache_id = null, $_compile_id = null, $_caching = null, $_cache_lifetime = null)
- {
- $this->smarty = &$smarty;
- // Smarty parameter
- $this->cache_id = $_cache_id === null ? $this->smarty->cache_id : $_cache_id;
- $this->compile_id = $_compile_id === null ? $this->smarty->compile_id : $_compile_id;
- $this->caching = $_caching === null ? $this->smarty->caching : $_caching;
- if ($this->caching === true) {
- $this->caching = Smarty::CACHING_LIFETIME_CURRENT;
- }
- $this->cache_lifetime = $_cache_lifetime === null ? $this->smarty->cache_lifetime : $_cache_lifetime;
- $this->parent = $_parent;
- // Template resource
- $this->template_resource = $template_resource;
- $this->source = Smarty_Template_Source::load($this);
- parent::__construct();
- }
-
- /**
- * render template
- *
- * @param bool $merge_tpl_vars if true parent template variables merged in to local scope
- * @param bool $no_output_filter if true do not run output filter
- * @param bool $display true: display, false: fetch null: subtemplate
- *
- * @throws Exception
- * @throws SmartyException
- * @return string rendered template output
- */
- public function render($no_output_filter = true, $display = null)
- {
- $parentIsTpl = isset($this->parent) && $this->parent->_objType == 2;
- if ($this->smarty->debugging) {
- $this->smarty->_debug->start_template($this, $display);
- }
- // checks if template exists
- if (!$this->source->exists) {
- if ($parentIsTpl) {
- $parent_resource = " in '{$this->parent->template_resource}'";
- } else {
- $parent_resource = '';
- }
- throw new SmartyException("Unable to load template {$this->source->type} '{$this->source->name}'{$parent_resource}");
- }
- // disable caching for evaluated code
- if ($this->source->handler->recompiled) {
- $this->caching = false;
- }
- // read from cache or render
- $isCacheTpl =
- $this->caching == Smarty::CACHING_LIFETIME_CURRENT || $this->caching == Smarty::CACHING_LIFETIME_SAVED;
- if ($isCacheTpl) {
- if (!isset($this->cached)) {
- $this->loadCached();
- }
- $this->cached->render($this, $no_output_filter);
- } elseif ($this->source->handler->uncompiled) {
- $this->source->render($this);
- } else {
- if (!isset($this->compiled)) {
- $this->loadCompiled();
- }
- $this->compiled->render($this);
- }
-
- // display or fetch
- if ($display) {
- if ($this->caching && $this->smarty->cache_modified_check) {
- $this->smarty->ext->_cachemodify->cacheModifiedCheck($this->cached, $this,
- isset($content) ? $content : ob_get_clean());
- } else {
- if ((!$this->caching || $this->cached->has_nocache_code || $this->source->handler->recompiled) &&
- !$no_output_filter && (isset($this->smarty->autoload_filters['output']) ||
- isset($this->smarty->registered_filters['output']))
- ) {
- echo $this->smarty->ext->_filterHandler->runFilter('output', ob_get_clean(), $this);
- } else {
- ob_end_flush();
- flush();
- }
- }
- if ($this->smarty->debugging) {
- $this->smarty->_debug->end_template($this);
- // debug output
- $this->smarty->_debug->display_debug($this, true);
- }
- return '';
- } else {
- if ($this->smarty->debugging) {
- $this->smarty->_debug->end_template($this);
- if ($this->smarty->debugging === 2 && $display === false) {
- $this->smarty->_debug->display_debug($this, true);
- }
- }
- if ($parentIsTpl) {
- if (!empty($this->tpl_function)) {
- $this->parent->tpl_function = array_merge($this->parent->tpl_function, $this->tpl_function);
- }
- foreach ($this->compiled->required_plugins as $code => $tmp1) {
- foreach ($tmp1 as $name => $tmp) {
- foreach ($tmp as $type => $data) {
- $this->parent->compiled->required_plugins[$code][$name][$type] = $data;
- }
- }
- }
- }
- if (!$no_output_filter &&
- (!$this->caching || $this->cached->has_nocache_code || $this->source->handler->recompiled) &&
- (isset($this->smarty->autoload_filters['output']) || isset($this->smarty->registered_filters['output']))
- ) {
- return $this->smarty->ext->_filterHandler->runFilter('output', ob_get_clean(), $this);
- }
- // return cache content
- return null;
- }
- }
-
- /**
- * Compiles the template
- * If the template is not evaluated the compiled template is saved on disk
- */
- public function compileTemplateSource()
- {
- return $this->compiled->compileTemplateSource($this);
- }
-
- /**
- * Writes the content to cache resource
- *
- * @param string $content
- *
- * @return bool
- */
- public function writeCachedContent($content)
- {
- return $this->smarty->ext->_updateCache->writeCachedContent($this->cached, $this, $content);
- }
-
- /**
- * Get unique template id
- *
- * @return string
- */
- public function _getTemplateId()
- {
- return isset($this->templateId) ? $this->templateId : $this->templateId =
- $this->smarty->_getTemplateId($this->template_resource, $this->cache_id, $this->compile_id);
- }
-
- /**
- * runtime error not matching capture tags
- */
- public function capture_error()
- {
- throw new SmartyException("Not matching {capture} open/close in \"{$this->template_resource}\"");
- }
-
- /**
- * Load compiled object
- *
- */
- public function loadCompiled()
- {
- if (!isset($this->compiled)) {
- $this->compiled = Smarty_Template_Compiled::load($this);
- }
- }
-
- /**
- * Load cached object
- *
- */
- public function loadCached()
- {
- if (!isset($this->cached)) {
- $this->cached = Smarty_Template_Cached::load($this);
- }
- }
-
- /**
- * Load compiler object
- *
- * @throws \SmartyException
- */
- public function loadCompiler()
- {
- if (!class_exists($this->source->handler->compiler_class)) {
- $this->smarty->loadPlugin($this->source->handler->compiler_class);
- }
- $this->compiler = new $this->source->handler->compiler_class($this->source->handler->template_lexer_class,
- $this->source->handler->template_parser_class,
- $this->smarty);
- }
-
- /**
- * Handle unknown class methods
- *
- * @param string $name unknown method-name
- * @param array $args argument array
- *
- * @return mixed
- * @throws SmartyException
- */
- public function __call($name, $args)
- {
- // method of Smarty object?
- if (method_exists($this->smarty, $name)) {
- return call_user_func_array(array($this->smarty, $name), $args);
- }
- // parent
- return parent::__call($name, $args);
- }
-
- /**
- * set Smarty property in template context
- *
- * @param string $property_name property name
- * @param mixed $value value
- *
- * @throws SmartyException
- */
- public function __set($property_name, $value)
- {
- switch ($property_name) {
- case 'compiled':
- case 'cached':
- case 'compiler':
- $this->$property_name = $value;
- return;
- default:
- // Smarty property ?
- if (property_exists($this->smarty, $property_name)) {
- $this->smarty->$property_name = $value;
- return;
- }
- }
- throw new SmartyException("invalid template property '$property_name'.");
- }
-
- /**
- * get Smarty property in template context
- *
- * @param string $property_name property name
- *
- * @return mixed|Smarty_Template_Cached
- * @throws SmartyException
- */
- public function __get($property_name)
- {
- switch ($property_name) {
- case 'compiled':
- $this->loadCompiled();
- return $this->compiled;
-
- case 'cached':
- $this->loadCached();
- return $this->cached;
-
- case 'compiler':
- $this->loadCompiler();
- return $this->compiler;
- default:
- // Smarty property ?
- if (property_exists($this->smarty, $property_name)) {
- return $this->smarty->$property_name;
- }
- }
- throw new SmartyException("template property '$property_name' does not exist.");
- }
-
- /**
- * Template data object destructor
- */
- public function __destruct()
- {
- if ($this->smarty->cache_locking && isset($this->cached) && $this->cached->is_locked) {
- $this->cached->handler->releaseLock($this->smarty, $this->cached);
- }
- }
- }
|