template.php

Go to the documentation of this file.

<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/

class XoopsTpl extends Smarty
{
    public $currentTheme = null;

    public function __construct()
    {
        parent::__construct(); // SMARTY_PLUGINS_DIR is initialized into parent
        $xoops = Xoops::getInstance();
        $xoops->preload()->triggerEvent('core.template.construct.start', array($this));
        $this->left_delimiter = '<{';
        $this->right_delimiter = '}>';
        $this->setTemplateDir(\XoopsBaseConfig::get('themes-path'));
        $this->setCacheDir(\XoopsBaseConfig::get('smarty-cache'));
        $this->setCompileDir(\XoopsBaseConfig::get('smarty-compile'));
        $this->compile_check = ($xoops->getConfig('theme_fromfile') == 1);
        $this->setPluginsDir(\XoopsBaseConfig::get('smarty-xoops-plugins'));
        $this->addPluginsDir(SMARTY_PLUGINS_DIR);
        $this->setCompileId();
        $this->assign(
            array('xoops_url' => \XoopsBaseConfig::get('url'),
                'xoops_rootpath' => \XoopsBaseConfig::get('root-path'),
                'xoops_langcode' => XoopsLocale::getLangCode(),
                'xoops_charset' => XoopsLocale::getCharset(),
                'xoops_version' => \Xoops::VERSION,
                'xoops_upload_url' => \XoopsBaseConfig::get('uploads-url'))
        );
    }

    public function fetchFromData($tplSource, $display = false, $vars = null)
    {
        $oldVars = $this->_tpl_vars;
        if (isset($vars)) {
            $this->assign($vars);
        }
        if ($display) {
            $out = $this->display('eval:'.$tplSource);
        } else {
            $out = $this->fetch('eval:'.$tplSource);
        }
        $this->_tpl_vars = $oldVars;
        return $out;
    }

    public function touch($resourceName)
    {
        $isForced = $this->force_compile;
        $this->force_compile = true;
        $this->clearCache($resourceName);
        $result = true; // $this->_compile_resource($resourceName, $this->_get_compile_path($resourceName));
        $this->force_compile = $isForced;
        return $result;
    }

    public function _get_auto_id($cache_id = null, $compile_id = null)
    {
        if (isset($cache_id)) {
            return (isset($compile_id)) ? $compile_id . '-' . $cache_id : $cache_id;
        } else {
            if (isset($compile_id)) {
                return $compile_id;
            } else {
                return null;
            }
        }
    }

    public function setCompileId($module_dirname = null, $theme_set = null, $template_set = null)
    {
        $xoops = Xoops::getInstance();

        $template_set = empty($template_set) ? $xoops->getConfig('template_set') : $template_set;
        $theme_set = empty($theme_set) ? $xoops->getConfig('theme_set') : $theme_set;
        $module_dirname = empty($module_dirname) ? $xoops->moduleDirname : $module_dirname;
        $this->compile_id = substr(md5(\XoopsBaseConfig::get('url')), 0, 8) . '-' . $module_dirname . '-' . $theme_set . '-' . $template_set;
        //$this->_compile_id = $this->compile_id;
    }

    public function clearModuleCompileCache($module_dirname = null, $theme_set = null, $template_set = null)
    {
        $hold_compile_id = $this->compile_id;
        // $this->setCompileId($module_dirname, $template_set, $theme_set);
        // TODO - should handle $use_sub_dirs
        $this->setCompileId($module_dirname, '*', '*');
        $compile_id = $this->compile_id;
        $this->compile_id = $hold_compile_id;
        $compile_id = preg_replace('![^\w\|]+!', '_', $compile_id);
        $glob = $compile_id . '*.php';
        $count=0;
        $files = glob($this->compile_dir . '/' . $glob);
        foreach ($files as $filename) {
            $count += unlink($filename) ? 1 : 0;
        }
        $files = glob($this->cache_dir . '/*' . $glob);
        foreach ($files as $filename) {
            $count += unlink($filename) ? 1 : 0;
        }
        return $count;
    }

    public function clearCache($template_name, $cache_id = null, $compile_id = null, $exp_time = null, $type = null)
    {
        \Xoops::getInstance()->deprecated('XoopsTpl::clearCache() is potentially ambiguous');
        return parent::clearCache($template_name, $cache_id, $compile_id, $exp_time, $type);
    }
}