API - XOOPS 2.5.11 Beta 2
By monxoops.fr
XoopsTpl Class Reference
Inheritance diagram for XoopsTpl:
Collaboration diagram for XoopsTpl:

Public Member Functions

 __construct ()
 
 fetchFromData ($tplSource, $display=false, $vars=null)
 
 touch ($resourceName)
 
 _get_auto_id ($cache_id=null, $compile_id=null)
 
 setCompileId ($module_dirname=null, $theme_set=null, $template_set=null)
 
 clearCache ($module_dirname=null, $theme_set=null, $template_set=null)
 
 xoops_setTemplateDir ($dirname)
 
 xoops_getTemplateDir ()
 
 xoops_setDebugging ($flag=false)
 
 xoops_setCaching ($num=0)
 
 xoops_setCompileDir ($dirname)
 
 xoops_setCacheDir ($dirname)
 
 xoops_canUpdateFromFile ()
 
 xoops_fetchFromData ($data)
 
 xoops_setCacheTime ($num=0)
 
- Public Member Functions inherited from Smarty
 __construct ()
 
 assign ($tpl_var, $value=null)
 
 assign_by_ref ($tpl_var, &$value)
 
 append ($tpl_var, $value=null, $merge=false)
 
 append_by_ref ($tpl_var, &$value, $merge=false)
 
 clear_assign ($tpl_var)
 
 register_function ($function, $function_impl, $cacheable=true, $cache_attrs=null)
 
 unregister_function ($function)
 
 register_object ($object, &$object_impl, $allowed=array(), $smarty_args=true, $block_methods=array())
 
 unregister_object ($object)
 
 register_block ($block, $block_impl, $cacheable=true, $cache_attrs=null)
 
 unregister_block ($block)
 
 register_compiler_function ($function, $function_impl, $cacheable=true)
 
 unregister_compiler_function ($function)
 
 register_modifier ($modifier, $modifier_impl)
 
 unregister_modifier ($modifier)
 
 register_resource ($type, $functions)
 
 unregister_resource ($type)
 
 register_prefilter ($function)
 
 unregister_prefilter ($function)
 
 register_postfilter ($function)
 
 unregister_postfilter ($function)
 
 register_outputfilter ($function)
 
 unregister_outputfilter ($function)
 
 load_filter ($type, $name)
 
 clear_cache ($tpl_file=null, $cache_id=null, $compile_id=null, $exp_time=null)
 
 clear_all_cache ($exp_time=null)
 
 is_cached ($tpl_file, $cache_id=null, $compile_id=null)
 
 clear_all_assign ()
 
 clear_compiled_tpl ($tpl_file=null, $compile_id=null, $exp_time=null)
 
 template_exists ($tpl_file)
 
get_template_vars ($name=null)
 
get_config_vars ($name=null)
 
 trigger_error ($error_msg, $error_type=E_USER_WARNING)
 
 display ($resource_name, $cache_id=null, $compile_id=null)
 
 fetch ($resource_name, $cache_id=null, $compile_id=null, $display=false)
 
 config_load ($file, $section=null, $scope='global')
 
get_registered_object ($name)
 
 clear_config ($var=null)
 
 _get_plugin_filepath ($type, $name)
 
 _is_compiled ($resource_name, $compile_path)
 
 _compile_resource ($resource_name, $compile_path)
 
 _compile_source ($resource_name, &$source_content, &$compiled_content, $cache_include_path=null)
 
 _get_compile_path ($resource_name)
 
 _fetch_resource_info (&$params)
 
 _parse_resource_name (&$params)
 
 _run_mod_handler ()
 
 _dequote ($string)
 
 _read_file ($filename)
 
 _get_auto_filename ($auto_base, $auto_source=null, $auto_id=null)
 
 _unlink ($resource, $exp_time=null)
 
 _get_auto_id ($cache_id=null, $compile_id=null)
 
 _trigger_fatal_error ($error_msg, $tpl_file=null, $tpl_line=null, $file=null, $line=null, $error_type=E_USER_ERROR)
 
 _process_compiled_include_callback ($match)
 
 _smarty_include ($params)
 
_smarty_cache_attrs ($cache_serial, $count)
 
 _include ($filename, $once=false, $params=null)
 
 _eval ($code, $params=null)
 
 _get_filter_name ($function)
 

Additional Inherited Members

- Data Fields inherited from Smarty
 $template_dir = 'templates'
 
 $compile_dir = 'templates_c'
 
 $config_dir = 'configs'
 
 $plugins_dir = array('plugins')
 
 $debugging = false
 
 $error_reporting = null
 
 $debug_tpl = ''
 
 $debugging_ctrl = 'NONE'
 
 $compile_check = true
 
 $force_compile = false
 
 $caching = 0
 
 $cache_dir = 'cache'
 
 $cache_lifetime = 3600
 
 $cache_modified_check = false
 
 $php_handling = SMARTY_PHP_PASSTHRU
 
 $security = false
 
 $secure_dir = array()
 
 $security_settings
 
 $trusted_dir = array()
 
 $left_delimiter = '{'
 
 $right_delimiter = '}'
 
 $request_vars_order = 'EGPCS'
 
 $request_use_auto_globals = true
 
 $compile_id = null
 
 $use_sub_dirs = false
 
 $default_modifiers = array()
 
 $default_resource_type = 'file'
 
 $cache_handler_func = null
 
 $autoload_filters = array()
 
 $config_overwrite = true
 
 $config_booleanize = true
 
 $config_read_hidden = false
 
 $config_fix_newlines = true
 
 $default_template_handler_func = ''
 
 $compiler_file = 'Smarty_Compiler.class.php'
 
 $compiler_class = 'Smarty_Compiler'
 
 $config_class = 'Config_File'
 
 $_tpl_vars = array()
 
 $_smarty_vars = null
 
 $_sections = array()
 
 $_foreach = array()
 
 $_tag_stack = array()
 
 $_conf_obj = null
 
 $_config = array(array('vars' => array(), 'files' => array()))
 
 $_smarty_md5 = 'f8d698aea36fcbead2b9d5359ffca76f'
 
 $_version = '2.6.32'
 
 $_inclusion_depth = 0
 
 $_compile_id = null
 
 $_smarty_debug_id = 'SMARTY_DEBUG'
 
 $_smarty_debug_info = array()
 
 $_cache_info = array()
 
 $_file_perms = 0644
 
 $_dir_perms = 0771
 
 $_reg_objects = array()
 
 $_plugins
 
 $_cache_serials = array()
 
 $_cache_include = null
 
 $_cache_including = false
 
 $_filepaths_cache = array()
 

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

XoopsTpl constructor.

Reimplemented from Smarty.

Here is the call graph for this function:

Member Function Documentation

◆ _get_auto_id()

_get_auto_id (   $cache_id = null,
  $compile_id = null 
)

returns an auto_id for auto-file-functions

Parameters
string$cache_id
string$compile_id
Returns
string |null

Reimplemented from Smarty.

◆ clearCache()

clearCache (   $module_dirname = null,
  $theme_set = null,
  $template_set = null 
)

XoopsTpl::clearCache()

Parameters
mixed$module_dirname
mixed$theme_set
mixed$template_set
Returns
bool
Here is the call graph for this function:

◆ fetchFromData()

fetchFromData (   $tplSource,
  $display = false,
  $vars = null 
)

Renders output from template data

Parameters
string$tplSourceThe template to render
bool$displayIf rendered text should be output or returned
null$vars
Returns
string Rendered output if $display was false
Here is the call graph for this function:

◆ setCompileId()

setCompileId (   $module_dirname = null,
  $theme_set = null,
  $template_set = null 
)

XoopsTpl::setCompileId()

Parameters
mixed$module_dirname
mixed$theme_set
mixed$template_set
Returns
void
Here is the caller graph for this function:

◆ touch()

touch (   $resourceName)

XoopsTpl::touch

Parameters
mixed$resourceName
Returns
bool
Here is the call graph for this function:

◆ xoops_canUpdateFromFile()

xoops_canUpdateFromFile ( )
Returns
bool

◆ xoops_fetchFromData()

xoops_fetchFromData (   $data)
Parameters
$data
Returns
string

◆ xoops_getTemplateDir()

xoops_getTemplateDir ( )
Returns
string

◆ xoops_setCacheDir()

xoops_setCacheDir (   $dirname)
Parameters
$dirname

◆ xoops_setCacheTime()

xoops_setCacheTime (   $num = 0)
Parameters
int$num

◆ xoops_setCaching()

xoops_setCaching (   $num = 0)
Parameters
int$num

◆ xoops_setCompileDir()

xoops_setCompileDir (   $dirname)
Parameters
$dirname

◆ xoops_setDebugging()

xoops_setDebugging (   $flag = false)
Parameters
bool$flag

◆ xoops_setTemplateDir()

xoops_setTemplateDir (   $dirname)
Deprecated:
DO NOT USE THESE METHODS, ACCESS THE CORRESPONDING PROPERTIES INSTEAD
Parameters
$dirname

The documentation for this class was generated from the following file: