__construct()
__toString()
addRequiredExternal()
callTemplateHook()
create()
getParam()
getParams()
getRequiredCssAsHtml()
getRequiredCssUrl()
getRequiredExternals()
getRequiredExternalsAsHtml()
getRequiredExternalsAsJson()
getRequiredJavaScriptAsHtml()
getTemplateName()
getToLoadList()
handleTemplateError()
preloadTemplate()
render()
reset()
setLanguageId()
setParam()
setParams()
setTemplate()
_getRequiredExternals()
_getTemplatesFromDataSource()
_loadTemplate()
_loadTemplateFilePath()
_loadTemplateFromCache()
_loadTemplates()
_mergeExtraContainerData()
_mergeIntoTemplateCache()
_preloadTemplate()
_processJsUrls()
_renderInternal()
_resetToLoadList()
_setRequiredExternals()
_usingTemplateFiles()
$_filePath
$_languageId
$_params
$_required
$_templateCache
$_templateErrors
$_templateName
$_toLoad
Base template rendering class.
Note that due to a lack of late static binding support, all static properties and any method that deals with those properties (via "self", regardless of whether it's static or not) must be (re)defined in child classes!
| package | XenForo_Core |
|---|
__construct(string $templateName, array $params)
stringTemplate name
arrayKey-value parameters
__toString() : string
stringaddRequiredExternal(string $type, string $requirement)
stringType of requirement
stringValue for requirement
callTemplateHook(string $name, string $contents, array $params) : string
Params passed by template explicitly will respect mappings and greater context. Raw params are still available via the template object.
stringName of the hook
stringContents of the hook; may be empty
arrayList of params to pass specifically; these will respect mappings.
stringNew version of the contents (could be modified)create(string $templateName, array $params) : \XenForo_Template_Abstract
Mainly helpful if an event only has the current template object in scope.
stringarraygetParam($key) : mixed
string
mixedNull if not found.getParams() : array
arraygetRequiredCssAsHtml(string $requirement) : string
Expected arg is simple a URL.
stringstringgetRequiredCssUrl(array $requirements) : string
Requirements should be a list of CSS templates, not including the trailing ".css".
arraystringgetRequiredExternals(string $type) : array
Values will be returned as a list of URLs.
stringarrayList of URLsgetRequiredExternalsAsHtml(string $type) : string
stringType of requirement to fetch
stringRequirements as HTMLgetRequiredExternalsAsJson()
getRequiredJavaScriptAsHtml(array $requirements) : string
arrayArray of paths to JS files.
stringgetTemplateName() : string
stringgetToLoadList() : array
arrayhandleTemplateError(integer $errorType, string $errorString, string $file, integer $line)
integerType of error (one of the E_* constants)
stringstringintegerpreloadTemplate(string $templateName)
This is useful if you think a render is going to be called before the template you require is to be used.
stringTemplate to preload
render() : string
stringreset()
setLanguageId(integer $languageId)
integersetParam($key, $value)
Overwrites parameters with the same name.
string
setParams(array $params)
Overwrites parameters with the same name.
array
setTemplate(string $templateName, string $templateValue)
This is primarily useful for testing.
stringName of the template
stringValue for the template
_getRequiredExternals() : array
array_getTemplatesFromDataSource(array $templateList) : array
arrayTemplate list
arrayKey-value pairs of template titles/compiled templates_loadTemplate(string $templateName) : string
stringTemplate name
stringCompiled version of the template_loadTemplateFilePath(string $templateName)
stringTemplate name
_loadTemplateFromCache(string $templateName) : string
If the template does not exist, it will be set to an empty string. This will be overwritten if the template is loaded from the data source.
stringTemplate name
stringCompiled template_loadTemplates()
_mergeExtraContainerData(array $extraData)
array
_mergeIntoTemplateCache(array $templates)
arrayTemplates (key: name, value: compiled output)
_preloadTemplate(string $templateName)
stringTemplate name
_processJsUrls(array $jsFiles)
_renderInternal(string $__template, array $__extraData) : string
stringTemplate text or name of template file
arrayReturned extra data from the render
stringRendered template_resetToLoadList()
_setRequiredExternals(array $required)
array
_usingTemplateFiles() : boolean
boolean$_filePath : string
All child classes must redefine this property!
$_languageId : integer
$_params : array
$_required : array
All child classes must redefine this property!
$_templateCache : array
Key is the template name; value is the compiled template. All child classes must redefine this property!
$_templateErrors : array
$_templateName : string
$_toLoad : array
Key is the template name. All child classes must redefine this property!