Documentation

Tpl extends Interpreter
in package

Table of Contents

CONDITIONAL_OPERATORS_PATTERN  = ' *(\?|(\?{1,2}[\?\:]))([^\?\:\}]*)'
$localTplDirs  : array<string|int, mixed>
$table_row  : int
$assignVariableParsers  : array<string|int, mixed>
$callbackFunctions  : TplScriptCodeInterpreterStatementCategories
$keywords  : TplScriptCodeInterpreterStatementCategories
$templates  : array<string|int, mixed>
$tplCache  : array<string|int, mixed>
$dataTypes  : array<string|int, mixed>
$nestedHTMLTagParsers  : array<string|int, mixed>
$nestedTags  : array<string|int, mixed>
$nestedTagsGroups  : array<string|int, mixed>
__construct()  : mixed
addTemplate()  : mixed
Store dynamic template from code
addTplDir()  : mixed
footInclude()  : mixed
get()  : mixed
headInclude()  : mixed
insertErrorMessages()  : mixed
invalidVariableHint()  : string
load()  : string
mpager()  : mixed
Table pagination
output()  : mixed
registerAssignVariablesParser()  : mixed
registerNestedHTMLTag()  : mixed
removeTplDir()  : mixed
syntaxError()  : string
table_row_css()  : mixed
addConditionalOperatorsPattern()  : string
checkTemplateMaintenanceMode()  : mixed
parseItem()  : array<string|int, mixed>
parseItems()  : array<string|int, mixed>
parseScriptCodeAndAssignVariables()  : mixed
stripComments()  : string
validateStatementElementsOrder()  : mixed
applyParser()  : mixed
assignConditionalTplAccessibleCallbackFunction()  : int|string|float
assignConditionalVariableCallbackFunction()  : int|string|float
assignTplAccessibleCallbackFunction()  : int|string|float
assignVariableCallbackFunction()  : int|string|float
createLegacyModeURLs()  : mixed
fallbackSwitch()  : bool
getHTMLTagPatterns()  : object
htmlInclude()  : mixed
initVars()  : array<string|int, mixed>
insertTemplateCallbackFunction()  : string
makeShortURLs()  : mixed
numberHTMLTagsCallbackFunction()  : string
parseConditionalFallback()  : int|string|float
parseConditionalStatementVariable()  : array<string|int, mixed>
processHTMLTagsCallbackFunction()  : mixed
registerNestedHTMLTagsParsers()  : mixed
repairAnchorLinks()  : mixed
variableReplaceExists()  : bool

Constants

CONDITIONAL_OPERATORS_PATTERN

protected mixed CONDITIONAL_OPERATORS_PATTERN = ' *(\?|(\?{1,2}[\?\:]))([^\?\:\}]*)'

Properties

$localTplDirs

public static array<string|int, mixed> $localTplDirs = array()

$table_row

public static int $table_row = 0

$assignVariableParsers

protected static array<string|int, mixed> $assignVariableParsers = array()

$templates

protected static array<string|int, mixed> $templates = array()

$tplCache

protected static array<string|int, mixed> $tplCache = array()

$dataTypes

private static array<string|int, mixed> $dataTypes = array('string' => array('^'(.*)'$', '\1'), 'var' => array('^\{\$(.*)\}$', '\1'), 'int' => array('^([0-9]*)$', '\1'), 'float' => array('^([0-9\.]*)$', '\1'), 'init' => array('^([a-zA-Z]+[a-zA-Z0-9]*(,[a-zA-Z]+[a-zA-Z0-9]*)?)$', '\1'))

$nestedHTMLTagParsers

private static array<string|int, mixed> $nestedHTMLTagParsers = array()

$nestedTags

private static array<string|int, mixed> $nestedTags = array()

$nestedTagsGroups

private static array<string|int, mixed> $nestedTagsGroups = array()

Methods

__construct()

public __construct(mixed $pageModule) : mixed
Parameters
$pageModule : mixed
Return values
mixed

addTemplate()

Store dynamic template from code

public static addTemplate(string $tplName, string $html) : mixed
Parameters
$tplName : string
$html : string
Return values
mixed

addTplDir()

public static addTplDir(string $tplDir) : mixed
Parameters
$tplDir : string
Return values
mixed

footInclude()

public static footInclude(array<string|int, mixed> $html_includes_keys[, string $html = '' ]) : mixed
Parameters
$html_includes_keys : array<string|int, mixed>
$html : string = ''
Return values
mixed

get()

public static get(string $tplName) : mixed
Parameters
$tplName : string
Return values
mixed

headInclude()

public static headInclude(array<string|int, mixed> $html_includes_keys[, string $html = '' ]) : mixed
Parameters
$html_includes_keys : array<string|int, mixed>
$html : string = ''
Return values
mixed

insertErrorMessages()

public insertErrorMessages(string &$template) : mixed
Parameters
$template : string
Return values
mixed

invalidVariableHint()

public static invalidVariableHint(string $variable[, string $langVar = '_(exceptions(invalidVariable))' ]) : string
Parameters
$variable : string
$langVar : string = '_(exceptions(invalidVariable))'
Return values
string

load()

public static load(string $tplName) : string
Parameters
$tplName : string
Return values
string

mpager()

Table pagination

public mpager(mixed $page_count) : mixed
Parameters
$page_count : mixed
Return values
mixed

output()

public static output(mixed $tplName) : mixed
Parameters
$tplName : mixed
Return values
mixed

registerAssignVariablesParser()

public static registerAssignVariablesParser(string $pattern, string|array<string|int, mixed> $callbackFunction[, int|null $priority = 100 ][, string|null $variablePattern = null ][, mixed $variables = null ][, bool $onTheFlyVariables = false ][, array<string|int, mixed> &$parsersArray = null ][, bool $variableRegexp = false ][, bool $dontApplyParser = false ][, array<string|int, mixed>|null $args = null ]) : mixed
Parameters
$pattern : string
$callbackFunction : string|array<string|int, mixed>
$priority : int|null = 100
$variablePattern : string|null = null
$variables : mixed = null
$onTheFlyVariables : bool = false
$parsersArray : array<string|int, mixed> = null
$variableRegexp : bool = false
$dontApplyParser : bool = false
$args : array<string|int, mixed>|null = null
Return values
mixed

registerNestedHTMLTag()

public static registerNestedHTMLTag(string $tag, string $group, string|array<string|int, mixed> $callbackFunction) : mixed
Parameters
$tag : string
$group : string
$callbackFunction : string|array<string|int, mixed>
Return values
mixed

removeTplDir()

public static removeTplDir(string $tplDir) : mixed
Parameters
$tplDir : string
Return values
mixed

syntaxError()

public static syntaxError(string $variable[, string $langVar = '_(exceptions(templateSyntaxError))' ]) : string
Parameters
$variable : string
$langVar : string = '_(exceptions(templateSyntaxError))'
Return values
string

table_row_css()

public static table_row_css() : mixed
Return values
mixed

addConditionalOperatorsPattern()

protected addConditionalOperatorsPattern(string $variablePattern) : string
Parameters
$variablePattern : string
Return values
string

checkTemplateMaintenanceMode()

protected static checkTemplateMaintenanceMode(mixed $tplName, mixed $tpl_path) : mixed
Parameters
$tplName : mixed
$tpl_path : mixed
Return values
mixed

parseItem()

protected static parseItem(string $item[, string $statementCategory = null ][, bool $allowInit = false ][, bool $canBeNull = false ]) : array<string|int, mixed>
Parameters
$item : string
$statementCategory : string = null
$allowInit : bool = false
$canBeNull : bool = false
Return values
array<string|int, mixed>

parseItems()

protected static parseItems(array<string|int, mixed> $items, string $statementCategory[, bool $canBeNull = false ]) : array<string|int, mixed>
Parameters
$items : array<string|int, mixed>
$statementCategory : string
$canBeNull : bool = false
Return values
array<string|int, mixed>

parseScriptCodeAndAssignVariables()

protected static parseScriptCodeAndAssignVariables(mixed $tplName) : mixed
Parameters
$tplName : mixed
Return values
mixed

stripComments()

protected static stripComments(string $htmlCode) : string
Parameters
$htmlCode : string
Return values
string

validateStatementElementsOrder()

protected static validateStatementElementsOrder(array<string|int, mixed> $items, array<string|int, mixed> $parsedCondition) : mixed
Parameters
$items : array<string|int, mixed>
$parsedCondition : array<string|int, mixed>
Return values
mixed

applyParser()

private static applyParser(string $tplName, string $pattern, mixed $replace, string|array<string|int, mixed> $callbackFunction, string $variablePattern[, bool $variableRegexp = false ]) : mixed
Parameters
$tplName : string
$pattern : string
$replace : mixed
$callbackFunction : string|array<string|int, mixed>
$variablePattern : string
$variableRegexp : bool = false
Return values
mixed

assignConditionalTplAccessibleCallbackFunction()

private assignConditionalTplAccessibleCallbackFunction(string $statementVariable) : int|string|float
Parameters
$statementVariable : string
Return values
int|string|float

assignConditionalVariableCallbackFunction()

private assignConditionalVariableCallbackFunction(string $statementVariable, array<string|int, mixed> $replace) : int|string|float
Parameters
$statementVariable : string
$replace : array<string|int, mixed>
Return values
int|string|float

assignTplAccessibleCallbackFunction()

private assignTplAccessibleCallbackFunction(string $variable) : int|string|float
Parameters
$variable : string
Return values
int|string|float

assignVariableCallbackFunction()

private assignVariableCallbackFunction(string $variable, array<string|int, mixed> $replace) : int|string|float
Parameters
$variable : string
$replace : array<string|int, mixed>
Return values
int|string|float

createLegacyModeURLs()

private static createLegacyModeURLs(mixed $tplName) : mixed
Parameters
$tplName : mixed
Return values
mixed

fallbackSwitch()

private static fallbackSwitch(mixed $invalidReplace, string $operator) : bool
Parameters
$invalidReplace : mixed
$operator : string
Return values
bool

getHTMLTagPatterns()

private static getHTMLTagPatterns(string $tag[, bool $nested = false ][, bool $caseSensitive = false ]) : object
Parameters
$tag : string
$nested : bool = false
$caseSensitive : bool = false
Return values
object

htmlInclude()

private static htmlInclude(string $target, array<string|int, mixed> $html_includes_keys, string $html) : mixed
Parameters
$target : string
$html_includes_keys : array<string|int, mixed>
$html : string
Return values
mixed

initVars()

private static initVars(string $varNames) : array<string|int, mixed>
Parameters
$varNames : string
Return values
array<string|int, mixed>

insertTemplateCallbackFunction()

private insertTemplateCallbackFunction(string $tplName) : string
Parameters
$tplName : string
Return values
string

makeShortURLs()

private static makeShortURLs(mixed $tplName) : mixed
Parameters
$tplName : mixed
Return values
mixed

numberHTMLTagsCallbackFunction()

private numberHTMLTagsCallbackFunction(array<string|int, mixed> $match, object $nestedHTMLTagVariablePatterns) : string
Parameters
$match : array<string|int, mixed>
$nestedHTMLTagVariablePatterns : object
Return values
string

parseConditionalFallback()

private parseConditionalFallback(mixed $replace, mixed $operator, mixed $fallback) : int|string|float
Parameters
$replace : mixed
$operator : mixed
$fallback : mixed
Return values
int|string|float

parseConditionalStatementVariable()

private parseConditionalStatementVariable(string $statementVariable) : array<string|int, mixed>
Parameters
$statementVariable : string
Return values
array<string|int, mixed>

processHTMLTagsCallbackFunction()

private processHTMLTagsCallbackFunction(string $tplName) : mixed
Parameters
$tplName : string
Return values
mixed

registerNestedHTMLTagsParsers()

private registerNestedHTMLTagsParsers(string $group, int $priority) : mixed
Parameters
$group : string
$priority : int
Return values
mixed
private static repairAnchorLinks(mixed $tplName) : mixed
Parameters
$tplName : mixed
Return values
mixed

variableReplaceExists()

private variableReplaceExists(string $variable, array<string|int, mixed> $replace[, array<string|int, mixed> $possibleReturnTypes = array('integer', 'double', 'string') ]) : bool
Parameters
$variable : string
$replace : array<string|int, mixed>
$possibleReturnTypes : array<string|int, mixed> = array('integer', 'double', 'string')
Return values
bool

Search results