TemplateManager Class Reference
[Template]

Class for accessing the underlying template engine. Currently integrated with Smarty (from http://smarty.php.net/). More...

List of all members.

Public Member Functions

clearTemplateCache ()

display ($template, $sendContentType= 'text/html', $hookName= 'TemplateManager::display')

& getManager ()

setCacheability ($cacheability=CACHEABILITY_PUBLIC)

smartyAssign ($value, $varName, $passThru=false)

smartyAssignMailto ($params, &$smarty)

smartyCallHook ($params, &$smarty)

smartyDisplayTemplate ($params, &$smarty)

smartyEscape ($string, $esc_type= 'html', $char_set=null)

smartyExplode ($string, $separator)

smartyFlush ($params, &$smarty)

smartyGetDebugInfo ($params, &$smarty)

smartyGetHelpId ($params, &$smarty)

smartyHelpTopic ($params, &$smarty)

smartyHtmlOptionsTranslate ($params, &$smarty)

smartyIcon ($params, &$smarty)

smartyIterate ($params, $content, &$smarty, &$repeat)

smartyPageInfo ($params, &$smarty)

smartyPageLinks ($params, &$smarty)

smartyToArray ()

smartyTranslate ($params, &$smarty)

smartyUrl ($params, &$smarty)

TemplateManager ()

Detailed Description

Class for accessing the underlying template engine. Currently integrated with Smarty (from http://smarty.php.net/).

Definition at line 37 of file TemplateManager.inc.php.

Member Function Documentation

TemplateManager.clearTemplateCache ( )

Clear template compile and cache directories.

Definition at line 271 of file TemplateManager.inc.php.

TemplateManager.display	(	$	template,
		$	sendContentType = `'text/html'`,
		$	hookName = `'TemplateManager::display'`
	)

Display the template.

Definition at line 220 of file TemplateManager.inc.php.

References HookRegistry.call(), and Config.getVar().

& TemplateManager.getManager ( )

Return an instance of the template manager.

Returns:: TemplateManager the template manager object

Definition at line 280 of file TemplateManager.inc.php.

References TemplateManager().

TemplateManager.setCacheability ( $ cacheability = CACHEABILITY_PUBLIC )

Flag the page as cacheable (or not).

Parameters:

$cacheability

boolean optional

Definition at line 199 of file TemplateManager.inc.php.

TemplateManager.smartyAssign	(	$	value,
		$	varName,
		$	passThru = `false`
	)

Assign a value to a template variable.

Definition at line 724 of file TemplateManager.inc.php.

References getManager().

TemplateManager.smartyAssignMailto	(	$	params,
		&$	smarty
	)

Smarty usage: {assign_mailto var="varName" address="email.com" ...]}

Generates a hex-encoded mailto address and assigns it to the variable name specified..

Definition at line 324 of file TemplateManager.inc.php.

TemplateManager.smartyCallHook	(	$	params,
		&$	smarty
	)

Call hooks from a template.

Definition at line 549 of file TemplateManager.inc.php.

References HookRegistry.call().

TemplateManager.smartyDisplayTemplate	(	$	params,
		&$	smarty
	)

Display templates from Smarty and allow hook overrides

Smarty usage: {display_template template="name.tpl" hookname="MyHook.Name"}

Definition at line 259 of file TemplateManager.inc.php.

References getManager().

TemplateManager.smartyEscape	(	$	string,
		$	esc_type = `'html'`,
		$	char_set = `null`
	)

Override the built-in smarty escape modifier to set the charset properly; also add the jsparam escaping method.

Definition at line 698 of file TemplateManager.inc.php.

TemplateManager.smartyExplode	(	$	string,
		$	separator
	)

Split the supplied string by the supplied separator.

Definition at line 717 of file TemplateManager.inc.php.

TemplateManager.smartyFlush	(	$	params,
		&$	smarty
	)

Flush the output buffer. This is useful in cases where Smarty templates are calling functions that take a while to execute so that they can display a progress indicator or a message stating that the operation may take a while.

Definition at line 535 of file TemplateManager.inc.php.

TemplateManager.smartyGetDebugInfo	(	$	params,
		&$	smarty
	)

Get debugging information and assign it to the template.

Definition at line 558 of file TemplateManager.inc.php.

References Registry.get(), DBConnection.getInstance(), Config.getVar(), and Core.microtime().

TemplateManager.smartyGetHelpId	(	$	params,
		&$	smarty
	)

Smarty usage: {get_help_id key="(dir)*.page.topic" url="boolean"}

Custom Smarty function for retrieving help topic ids. Direct mapping of page topic key to a numerical value representing the associated help topic xml file $params array associative array, must contain "key" parameter for string to translate $smarty Smarty

Returns:: numerical help topic id

Definition at line 426 of file TemplateManager.inc.php.

References Help.getHelp(), and Request.url().

TemplateManager.smartyHelpTopic	(	$	params,
		&$	smarty
	)

Smarty usage: {help_topic key="(dir)*.page.topic" text="foo"}

Custom Smarty function for creating anchor tags $params array associative array $smarty Smarty

Returns:: anchor link to related help topic

Definition at line 453 of file TemplateManager.inc.php.

References Help.getHelp(), and Request.url().

TemplateManager.smartyHtmlOptionsTranslate	(	$	params,
		&$	smarty
	)

Smarty usage: {html_options_translate ...} For parameter usage, see http://smarty.php.net/manual/en/language.function.html.options.php

Identical to Smarty's "html_options" function except option values are translated from i18n keys. $params array $smarty Smarty

Definition at line 355 of file TemplateManager.inc.php.

References Locale.translate().

TemplateManager.smartyIcon	(	$	params,
		&$	smarty
	)

Smarty usage: {icon name="image name" alt="alternative name" url="url path"}

Custom Smarty function for generating anchor tag with optional url $params array associative array, must contain "name" paramater to create image anchor tag

Returns:: string <img src="path to image/image name" ... />

Definition at line 470 of file TemplateManager.inc.php.

References Locale.translate().

TemplateManager.smartyIterate	(	$	params,
		$	content,
		&$	smarty,
		&$	repeat
	)

Iterator function for looping through objects extending the ItemIterator class. Parameters:

from: Name of template variable containing iterator
item: Name of template variable to receive each item
key: (optional) Name of variable to receive index of current item

Definition at line 390 of file TemplateManager.inc.php.

TemplateManager.smartyPageInfo	(	$	params,
		&$	smarty
	)

Display page information for a listing of items that has been divided onto multiple pages. Usage: {page_info from=$myIterator}

Definition at line 511 of file TemplateManager.inc.php.

References Locale.translate().

TemplateManager.smartyPageLinks	(	$	params,
		&$	smarty
	)

Display page links for a listing of items that has been divided onto multiple pages. Usage: {page_links name="nameMustMatchGetRangeInfoCall" iterator=$myIterator additional_param=myAdditionalParameterValue }

Definition at line 624 of file TemplateManager.inc.php.

References Request.getRequestedArgs(), and Request.url().

TemplateManager.smartyToArray ( )

Convert the parameters of a function to an array.

Definition at line 690 of file TemplateManager.inc.php.

TemplateManager.smartyTranslate	(	$	params,
		&$	smarty
	)

Smarty usage: {translate key="localization.key.name" [paramName="paramValue" ...]}

Custom Smarty function for translating localization keys. Substitution works by replacing tokens like "{$foo}" with the value of the parameter named "foo" (if supplied). $params array associative array, must contain "key" parameter for string to translate plus zero or more named parameters for substitution. Translation variables can be specified also as an optional associative array named "params". $smarty Smarty

Returns:: string the localized string, including any parameter substitutions

Definition at line 304 of file TemplateManager.inc.php.

References Locale.translate().

TemplateManager.smartyUrl	(	$	params,
		&$	smarty
	)

Generate a URL into OJS. (This is a wrapper around Request.url to make it available to Smarty templates.)

Definition at line 572 of file TemplateManager.inc.php.

References Request.url().

TemplateManager.TemplateManager ( )

Constructor. Initialize template engine and assign basic template variables.

Definition at line 52 of file TemplateManager.inc.php.

References Core.getBaseDir(), Request.getBaseUrl(), Request.getCompleteUrl(), DAORegistry.getDAO(), Request.getJournal(), PublicFileManager.getJournalFilesPath(), Locale.getLocale(), OJSPaymentManager.getManager(), Request.getRequestedPage(), Request.getSite(), PublicFileManager.getSiteFilesPath(), Config.getVar(), Validation.isLoggedIn(), and PluginRegistry.loadPlugin().

Referenced by getManager().

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

classes/template/TemplateManager.inc.php


Public Member Functions
	clearTemplateCache ()
	display ($template, $sendContentType= 'text/html', $hookName= 'TemplateManager::display')
&	getManager ()
	setCacheability ($cacheability=CACHEABILITY_PUBLIC)
	smartyAssign ($value, $varName, $passThru=false)
	smartyAssignMailto ($params, &$smarty)
	smartyCallHook ($params, &$smarty)
	smartyDisplayTemplate ($params, &$smarty)
	smartyEscape ($string, $esc_type= 'html', $char_set=null)
	smartyExplode ($string, $separator)
	smartyFlush ($params, &$smarty)
	smartyGetDebugInfo ($params, &$smarty)
	smartyGetHelpId ($params, &$smarty)
	smartyHelpTopic ($params, &$smarty)
	smartyHtmlOptionsTranslate ($params, &$smarty)
	smartyIcon ($params, &$smarty)
	smartyIterate ($params, $content, &$smarty, &$repeat)
	smartyPageInfo ($params, &$smarty)
	smartyPageLinks ($params, &$smarty)
	smartyToArray ()
	smartyTranslate ($params, &$smarty)
	smartyUrl ($params, &$smarty)
	TemplateManager ()

TemplateManager Class Reference [Template]

Public Member Functions

Detailed Description

Member Function Documentation

TemplateManager Class Reference
[Template]