XoopsTpl Class Reference

Inheritance diagram for XoopsTpl:

Public Member Functions
	__construct ()
	_get_auto_id ($cache_id=null, $compile_id=null)
	clearCache ($template_name, $cache_id=null, $compile_id=null, $exp_time=null, $type=null)
	clearModuleCompileCache ($module_dirname=null, $theme_set=null, $template_set=null)
	fetchFromData ($tplSource, $display=false, $vars=null)
	setCompileId ($module_dirname=null, $theme_set=null, $template_set=null)
	touch ($resourceName)

Public Attributes
	$currentTheme = null

Detailed Description

Definition at line 32 of file template.php.

Constructor & Destructor Documentation

XoopsTpl::__construct

(

)

Definition at line 39 of file template.php.

References $xoops, XoopsBaseConfig\get(), Xoops_Locale_Abstract\getCharset(), Xoops\getInstance(), Xoops_Locale_Abstract\getLangCode(), setCompileId(), and Xoops\VERSION.

Here is the call graph for this function:

Member Function Documentation

XoopsTpl::_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

Definition at line 109 of file template.php.

XoopsTpl::clearCache	(		$template_name,
			$cache_id = null,
			$compile_id = null,
			$exp_time = null,
			$type = null
	)

Empty cache for a specific template

This is just a pass thru wrapper with a warning since this method previously existed only in XoopsTpl, but now is also a regulat Smarty method.

clearModuleCompileCache() is the replacement for the old clearCache

Parameters

string	$template_name	template name
string	$cache_id	cache id
string	$compile_id	compile id
integer	$exp_time	expiration time
string	$type	resource type

Returns

integer number of cache files deleted

Definition at line 191 of file template.php.

References $type, and Xoops\getInstance().

Referenced by touch().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsTpl::clearModuleCompileCache	(		$module_dirname = null,
			$theme_set = null,
			$template_set = null
	)

XoopsTpl::clearModuleCompileCache()

Clean up compiled and cached templates for a module

TODO - handle $use_sub_dirs cases

Parameters

mixed	$module_dirname
mixed	$theme_set
mixed	$template_set

Returns

int number of deleted cache and compiler files

Definition at line 153 of file template.php.

References $count, $files, and setCompileId().

Here is the call graph for this function:

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

Renders output from template data

Parameters

string	$tplSource	The template to render
bool	$display	If rendered text should be output or returned
array	$vars

Returns

string Rendered output if $display was false

Definition at line 71 of file template.php.

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

XoopsTpl::setCompileId()

Parameters

mixed	$module_dirname
mixed	$theme_set
mixed	$template_set

Returns

void

Definition at line 130 of file template.php.

References $xoops, XoopsBaseConfig\get(), and Xoops\getInstance().

Referenced by __construct(), and clearModuleCompileCache().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsTpl::touch

(

$resourceName

)

XoopsTpl::touch

Parameters

string

$resourceName

Returns

bool

Definition at line 92 of file template.php.

References $result, and clearCache().

Here is the call graph for this function:

Member Data Documentation

XoopsTpl::$currentTheme = null

Definition at line 37 of file template.php.

---

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

• C:/usr64/htdocs/class/template.php