Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
TemplateManager Class Reference

Inherits PKPTemplateManager.

Public Member Functions

 smartyGetHelpId ($params, &$smarty)
 
 smartyHelpTopic ($params, &$smarty)
 
 smartyPageLinks ($params, &$smarty)
 
 TemplateManager ($request=null)
 
- Public Member Functions inherited from PKPTemplateManager
 _closeTags ($string, $open=false)
 
 _reinsertTags ($string, &$tags, $reverse=false)
 
 _removeTags ($string, &$tags, $reverse=false, $length)
 
 _removeTagsAux ($string, $loc, &$tags, $length)
 
 _removeTagsAuxReverse ($string, $loc, &$tags, $length)
 
 _smarty_include ($params)
 
 addJavaScript ($url)
 
 addStyleSheet ($url)
 
 clearTemplateCache ()
 
 display ($template, $sendContentType=null, $hookName=null, $display=true)
 
 fetch ($resource_name, $cache_id=null, $compile_id=null, $display=false)
 
 fetchJson ($template, $status=true)
 
getFBV ()
 
getManager ($request=null)
 
 initialize ()
 
 PKPTemplateManager ($request=null)
 
 setCacheability ($cacheability=CACHEABILITY_PUBLIC)
 
 setProgressFunction ($progressFunction)
 
 smartyAssign ($value, $varName, $passThru=false)
 
 smartyAssignMailto ($params, &$smarty)
 
 smartyCallHook ($params, &$smarty)
 
 smartyCallProgressFunction ($params, &$smarty)
 
 smartyConcat ()
 
 smartyConfirm ($params, &$smarty)
 
 smartyDisplayTemplate ($params, &$smarty)
 
 smartyEscape ($string, $esc_type= 'html', $char_set=null)
 
 smartyExplode ($string, $separator)
 
 smartyFlush ($params, &$smarty)
 
 smartyGetDebugInfo ($params, &$smarty)
 
 smartyGetValue ($name)
 
 smartyHtmlOptionsTranslate ($params, &$smarty)
 
 smartyIcon ($params, &$smarty)
 
 smartyIterate ($params, $content, &$smarty, &$repeat)
 
 smartyLoadUrlInDiv ($params, &$smarty)
 
 smartyModal ($params, &$smarty)
 
 smartyNullLinkAction ($params, &$smarty)
 
 smartyPageInfo ($params, &$smarty)
 
 smartyPageLinks ($params, &$smarty)
 
 smartyResourceCoreGetSecure ($template, &$smarty)
 
 smartyResourceCoreGetTemplate ($template, &$templateSource, &$smarty)
 
 smartyResourceCoreGetTimestamp ($template, &$templateTimestamp, &$smarty)
 
 smartyResourceCoreGetTrusted ($template, &$smarty)
 
 smartySortHeading ($params, &$smarty)
 
 smartySortSearch ($params, &$smarty)
 
 smartyStrtotime ($string)
 
 smartyToArray ()
 
 smartyTranslate ($params, &$smarty)
 
 smartyTruncate ($string, $length=80, $etc= '...', $break_words=false, $middle=false, $skip_tags=true)
 
 smartyUrl ($parameters, &$smarty)
 

Detailed Description

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

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

Member Function Documentation

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 151 of file TemplateManager.inc.php.

References PKPHelp\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 179 of file TemplateManager.inc.php.

References PKPHelp\getHelp(), and Request\url().

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 200 of file TemplateManager.inc.php.

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

TemplateManager::TemplateManager (   $request = null)

Constructor. Initialize template engine and assign basic template variables.

Parameters
$requestPKPRequest FIXME: is optional for backwards compatibility only - make mandatory

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

References Config\getVar(), and PluginRegistry\loadPlugin().


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