XoopsTpl

Complexity

Total Complexity

30

Size/Duplication

Total Lines	242
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	_get_auto_id()	0	8	4
A	__construct()	0	31	3
A	touch()	0	9	1
A	fetchFromData()	0	17	3
A	xoops_setTemplateDir()	0	5	1
A	xoops_setCacheTime()	0	8	2
A	clearCache()	0	13	1
A	xoops_canUpdateFromFile()	0	5	1
A	xoops_fetchFromData()	0	5	1
B	setCompileId()	0	13	7
A	xoops_setCompileDir()	0	5	1
A	xoops_setCaching()	0	5	1
A	xoops_setCacheDir()	0	5	1
A	xoops_getTemplateDir()	0	5	1
A	xoops_setDebugging()	0	5	2

<?php
/**
 * XOOPS template engine class
 *
 * 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.
 *
 * @copyright       (c) 2000-2021 XOOPS Project (https://xoops.org)
 * @license             GNU GPL 2 (https://www.gnu.org/licenses/gpl-2.0.html)
 * @author              Kazumi Ono <onokazu@xoops.org>
 * @author              Skalpa Keo <skalpa@xoops.org>
 * @author              Taiwen Jiang <phppp@users.sourceforge.net>
 * @package             kernel
 * @subpackage          core
 */

defined('XOOPS_ROOT_PATH') || exit('Restricted access');
/**
 * Base class: Smarty template engine
 */
define('SMARTY_DIR', XOOPS_ROOT_PATH . '/class/smarty/');
require_once SMARTY_DIR . 'Smarty.class.php';

xoops_loadLanguage('global');

/**
 * Template engine
 *
 * @package             kernel
 * @subpackage          core
 * @author              Kazumi Ono <onokazu@xoops.org>
 * @copyright       (c) 2000-2021 XOOPS Project (https://xoops.org)
 */
class XoopsTpl extends Smarty
{
    /**
     * XoopsTpl constructor.
     */
    public function __construct()
    {
        global $xoopsConfig;

        $this->left_delimiter  = '<{';
        $this->right_delimiter = '}>';
        $this->template_dir    = XOOPS_THEME_PATH;
        $this->cache_dir       = XOOPS_VAR_PATH . '/caches/smarty_cache';
        $this->compile_dir     = XOOPS_VAR_PATH . '/caches/smarty_compile';
        $this->compile_check   = ($xoopsConfig['theme_fromfile'] == 1);
        $this->plugins_dir     = array(
            XOOPS_ROOT_PATH . '/class/smarty/xoops_plugins',
            XOOPS_ROOT_PATH . '/class/smarty/plugins');
        if ($xoopsConfig['debug_mode']) {
            $this->debugging_ctrl = 'URL';
            $this->debug_tpl = XOOPS_ROOT_PATH . '/class/smarty/xoops_tpl/debug.tpl';
            if ($xoopsConfig['debug_mode'] == 3) {
                $this->debugging = true;
            }
        }
        parent::__construct();
        $this->setCompileId();
        $this->assign(array(
                          'xoops_url'        => XOOPS_URL,
                          'xoops_rootpath'   => XOOPS_ROOT_PATH,
                          'xoops_langcode'   => _LANGCODE,
                          'xoops_charset'    => _CHARSET,
                          'xoops_version'    => XOOPS_VERSION,
                          'xoops_upload_url' => XOOPS_UPLOAD_URL));
        $xoopsPreload = XoopsPreload::getInstance();
        $xoopsPreload->triggerEvent('core.class.template.new', array($this));
    }

    /**
     * Renders output from template data
     *
     * @param string $tplSource The template to render
     * @param bool   $display   If rendered text should be output or returned
     * @param null   $vars

Are you sure the doc-type for parameter $vars is correct as it would always require null to be passed?

     *
     * @return string Rendered output if $display was false
     */
    public function fetchFromData($tplSource, $display = false, $vars = null)

The parameter $display is not used and could be removed.

    {
        if (!function_exists('smarty_function_eval')) {
            require_once SMARTY_DIR . '/plugins/function.eval.php';
        }
        if (isset($vars)) {
            $oldVars = $this->_tpl_vars;
            $this->assign($vars);
            $out             = smarty_function_eval(array(
                                                        'var' => $tplSource), $this);
            $this->_tpl_vars = $oldVars;

            return $out;
        }

        return smarty_function_eval(array(
                                        'var' => $tplSource), $this);
    }

    /**
     * XoopsTpl::touch
     *
     * @param  mixed $resourceName
     * @return bool
     */
    public function touch($resourceName)
    {
        $isForced            = $this->force_compile;
        $this->force_compile = true;
        $this->clear_cache($resourceName);
        $result              = $this->_compile_resource($resourceName, $this->_get_compile_path($resourceName));
        $this->force_compile = $isForced;

        return $result;
    }

    /**
     * returns an auto_id for auto-file-functions
     *
     * @param  string $cache_id
     * @param  string $compile_id
     * @return string |null
     */
    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;
        } elseif (isset($compile_id)) {
            return $compile_id;
        } else {
            return null;
        }
    }

    /**
     * XoopsTpl::setCompileId()
     *
     * @param  mixed $module_dirname
     * @param  mixed $theme_set
     * @param  mixed $template_set
     * @return void
     */
    public function setCompileId($module_dirname = null, $theme_set = null, $template_set = null)
    {
        global $xoopsConfig;

        $template_set      = empty($template_set) ? $xoopsConfig['template_set'] : $template_set;
        $theme_set         = empty($theme_set) ? $xoopsConfig['theme_set'] : $theme_set;
        if (class_exists('XoopsSystemCpanel', false)) {
            $cPrefix = 'cp-';
            $theme_set =  isset($xoopsConfig['cpanel']) ? $cPrefix .$xoopsConfig['cpanel'] : $cPrefix . 'default';
        }
        $module_dirname    = empty($module_dirname) ? (empty($GLOBALS['xoopsModule']) ? 'system' : $GLOBALS['xoopsModule']->getVar('dirname', 'n')) : $module_dirname;
        $this->compile_id  = substr(md5(XOOPS_URL), 0, 8) . '-' . $module_dirname . '-' . $theme_set . '-' . $template_set;
        $this->_compile_id = $this->compile_id;
    }

    /**
     * XoopsTpl::clearCache()
     *
     * @param  mixed $module_dirname
     * @param  mixed $theme_set
     * @param  mixed $template_set
     * @return bool
     */
    public function clearCache($module_dirname = null, $theme_set = null, $template_set = null)
    {
        $compile_id = $this->compile_id;
        $this->setCompileId($module_dirname, $template_set, $theme_set);
        $_params           = array(
            'auto_base'   => $this->cache_dir,
            'auto_source' => null,
            'auto_id'     => $this->compile_id,
            'exp_time'    => null);
        $this->_compile_id = $this->compile_id = $compile_id;
        require_once SMARTY_CORE_DIR . 'core.rm_auto.php';

        return smarty_core_rm_auto($_params, $this);
    }

    /**
     *
     * @deprecated DO NOT USE THESE METHODS, ACCESS THE CORRESPONDING PROPERTIES INSTEAD
     * @param $dirname
     */
    public function xoops_setTemplateDir($dirname)
    {
        $GLOBALS['xoopsLogger']->addDeprecated('\'$xoopsTpl->xoops_setTemplateDir($value)\' is deprecated since XOOPS 2.5.4, please use \'$xoopsTpl->template_dir=$value;\' instead.');

        $this->template_dir = $dirname;
    }

    /**
     * @return string
     */
    public function xoops_getTemplateDir()
    {
        $GLOBALS['xoopsLogger']->addDeprecated('\'$xoopsTpl->xoops_getTemplateDir()\' is deprecated since XOOPS 2.5.4, please use \'$xoopsTpl->template_dir;\' instead.');

        return $this->template_dir;
    }

    /**
     * @param bool $flag
     */
    public function xoops_setDebugging($flag = false)
    {
        $GLOBALS['xoopsLogger']->addDeprecated('\'$xoopsTpl->xoops_setDebugging($value)\' is deprecated since XOOPS 2.5.4, please use \'$xoopsTpl->debugging=$value;\' instead.');

        $this->debugging = is_bool($flag) ? $flag : false;

The condition is_bool($flag) is always true.

    }

    /**
     * @param int $num
     */
    public function xoops_setCaching($num = 0)
    {
        $GLOBALS['xoopsLogger']->addDeprecated('\'$xoopsTpl->xoops_setCaching($value)\' is deprecated since XOOPS 2.5.4, please use \'$xoopsTpl->caching=$value;\' instead.');

        $this->caching = (int)$num;
    }

    /**
     * @param $dirname
     */
    public function xoops_setCompileDir($dirname)
    {
        $GLOBALS['xoopsLogger']->addDeprecated('\'$xoopsTpl->xoops_setCompileDir($value)\' is deprecated since XOOPS 2.5.4, please use \'$xoopsTpl->compile_dir=$value;\' instead.');

        $this->compile_dir = $dirname;
    }

    /**
     * @param $dirname
     */
    public function xoops_setCacheDir($dirname)
    {
        $GLOBALS['xoopsLogger']->addDeprecated('\'$xoopsTpl->xoops_setCacheDir($value)\' is deprecated since XOOPS 2.5.4, please use \'$xoopsTpl->cache_dir=$value;\' instead.');

        $this->cache_dir = $dirname;
    }

    /**
     * @return bool
     */
    public function xoops_canUpdateFromFile()
    {
        $GLOBALS['xoopsLogger']->addDeprecated('\'$xoopsTpl->xoops_canUpdateFromFile()\' is deprecated since XOOPS 2.5.4, please use \'$xoopsTpl->compile_check;\' instead.');

        return $this->compile_check;
    }

    /**
     * @param $data
     *
     * @return string
     */
    public function xoops_fetchFromData($data)
    {
        $GLOBALS['xoopsLogger']->addDeprecated('\'$xoopsTpl->xoops_fetchFromData($value)\' is deprecated since XOOPS 2.5.4, please use \'$xoopsTpl->fetchFromData($value);\' instead.');

        return $this->fetchFromData($data);
    }

    /**
     * @param int $num
     */
    public function xoops_setCacheTime($num = 0)
    {
        $GLOBALS['xoopsLogger']->addDeprecated('\'$xoopsTpl->xoops_setCacheTime($value)\' is deprecated since XOOPS 2.5.4, please use \'$xoopsTpl->cache_lifetime=$value;\' instead.');

        if (($num = (int)$num) <= 0) {
            $this->caching = 0;
        } else {
            $this->cache_lifetime = $num;
        }
    }
}

/**
 * function to update compiled template file in templates_c folder
 *
 * @param  string  $tpl_id
 * @param  boolean $clear_old
 * @return boolean
 */
function xoops_template_touch($tpl_id, $clear_old = true)

The parameter $clear_old is not used and could be removed.

{
    $tplfile_handler = xoops_getHandler('tplfile');
    $tplfile         = $tplfile_handler->get($tpl_id);

$tpl_id of type string is incompatible with the type integer expected by parameter $int_id of XoopsObjectHandler::get().

    if (is_object($tplfile)) {
        $file = $tplfile->getVar('tpl_file', 'n');
        $tpl  = new XoopsTpl();

        return $tpl->touch('db:' . $file);
    }

    return false;
}

/**
 * Clear the module cache
 *
 * @param  int $mid Module ID
 * @return void
 */
function xoops_template_clear_module_cache($mid)
{
    $block_arr = XoopsBlock::getByModule($mid);

The function XoopsBlock::getByModule() has been deprecated: (This also appears, dead, in XoopsBlockHandler)

    $count     = count($block_arr);
    if ($count > 0) {
        $xoopsTpl          = new XoopsTpl();
        $xoopsTpl->caching = 2;
        for ($i = 0; $i < $count; ++$i) {
            if ($block_arr[$i]->getVar('template') != '') {
                $xoopsTpl->clear_cache('db:' . $block_arr[$i]->getVar('template'), 'blk_' . $block_arr[$i]->getVar('bid'));
            }
        }
    }
}