Class Smarty_Internal_TemplateCompilerBase

`abstract`

Main abstract compiler class

Smarty_Internal_TemplateCompilerBase
- Smarty_Internal_SmartyTemplateCompiler

Located at class\libraries\vendor\smarty\smarty\libs\sysplugins\smarty_internal_templatecompilerbase.php

Methods


					
	public

__construct(Smarty $smarty)

Initialize compiler

Parameters

$smarty

global instance

Overriden by

Smarty_Internal_SmartyTemplateCompiler::__construct()


					
	public

compileTemplate(
	Smarty_Internal_Template $template,
	bool $nocache = null,
	null|Smarty_Internal_TemplateCompilerBase $parent_compiler = null,
): bool

Method to compile a Smarty template

Parameters

`$template`	template object to compile
`$nocache`	true is shall be compiled in nocache mode

Returns

true if compiling succeeded, false if it failed

Throws

Exception


					
	public

compileTemplateSource(
	Smarty_Internal_Template $template,
	null|bool $nocache = null,
	Smarty_Internal_TemplateCompilerBase $parent_compiler = null,
): string

Compile template source and run optional post filter

Parameters

$nocache

flag if template must be compiled in nocache mode

Throws

Exception


					
	public

postFilter(string $code): string

Optionally process compiled code by post filter

Parameters

$code

compiled code

Throws

SmartyException


					
	public

preFilter(string $_content): string

Run optional prefilter

Parameters

$_content

template source

Throws

SmartyException


					
	public

compileTag(string $tag, array $args, array $parameter = []): string

Compile Tag This is a call back from the lexer/parser

Save current prefix code Compile tag Merge tag prefix code with saved one (required nested tags in attributes)

Parameters

`$tag`	tag name
`$args`	array with tag attributes
`$parameter`	array with compilation parameter

Returns

compiled code

Throws

`SmartyCompilerException`
`SmartyException`


					
	public

compileVariable(string $variable): string

compile variable


					
	public

compileConfigVariable(string $variable): string

compile config variable


					
	public

compilePHPFunctionCall(string $name, array $parameter): string

compile PHP function call

Throws

SmartyCompilerException


					
	public

processText(string $text): string

This method is called from parser to process a text content section if strip is enabled - remove text from inheritance…

This method is called from parser to process a text content section if strip is enabled

remove text from inheritance child templates as they may generate output


					
	public

callTagCompiler(string $tag, array $args, mixed $param1 = null, mixed $param2 = null, mixed $param3 = null): bool|string

lazy loads internal compile plugin for tag and calls the compile method compile objects cached for reuse. class name…

lazy loads internal compile plugin for tag and calls the compile method compile objects cached for reuse. class name format: Smarty_Internal_Compile_TagName plugin filename format: Smarty_Internal_TagName.php

Parameters

`$tag`	tag name
`$args`	list of tag attributes
`$param1`	optional parameter
`$param2`	optional parameter
`$param3`	optional parameter

Returns

compiled code or false

Throws

SmartyCompilerException


					
	public

getTagCompiler(string $tag): bool|Smarty_Internal_CompileBase

lazy loads internal compile plugin for tag compile objects cached for reuse.

class name format: Smarty_Internal_Compile_TagName plugin filename format: Smarty_Internal_TagName.php

Parameters

$tag

tag name

Returns

tag compiler object or false if not found


					
	public

getPlugin($plugin_name, string $plugin_type): string

Check for plugins and return function name

Parameters

$plugin_type

type of plugin

Returns

call name of function

Throws

SmartyException


					
	public

getPluginFromDefaultHandler(string $tag, string $plugin_type): bool

Check for plugins by default plugin handler

Parameters

`$tag`	name of tag
`$plugin_type`	type of plugin

Returns

true if found

Throws

SmartyCompilerException


					
	public

appendCode(string $left, string $right): string

Append code segments and remove unneeded ?> <?php transitions


					
	public

processNocacheCode(string $content, boolean $is_code): string

Inject inline code for nocache template sections This method gets the content of each template element from the parser.…

Inject inline code for nocache template sections This method gets the content of each template element from the parser. If the content is compiled code and it should be not cached the code is injected into the rendered output.

Parameters

`$content`	content of template element
`$is_code`	true if content is compiled code

Returns

content


					
	public

getId(string $input): bool|string

Get Id


					
	public

getVariableName(string $input): bool|string

Get variable name from string


					
	public

setNocacheInVariable(string $varName)

Set nocache flag in variable or create new variable


					
	public

convertScope(array $_attr, array $validScopes): int|string

Parameters

$_attr

tag attributes

Throws

SmartyCompilerException


					
	public

makeNocacheCode(string $code): string

Generate nocache code string

Parameters

$code

PHP code


					
	public

trigger_template_error(string $args = null, string $line = null, null|bool $tagline = null)

display compiler error messages without dying If parameter $args is empty it is a parser detected syntax error. In this…

display compiler error messages without dying If parameter $args is empty it is a parser detected syntax error. In this case the parser is called to obtain information about expected tokens. If parameter $args contains a string this is used as error message

Parameters

`$args`	individual error message or null
`$line`	line-number
`$tagline`	if true the line number of last tag

Throws

SmartyCompilerException

when an unexpected token is found


					
	public

getVarExport(mixed $value): string

Return var_export() value with all white spaces removed


					
	public

enterDoubleQuote()

enter double quoted string - save tag stack count

enter double quoted string

save tag stack count


					
	public

getTagStackCount(): int

Return tag stack count


					
	public

replaceDelimiter($lexerPreg): mixed


					
	public

initDelimiterPreg()

Build lexer regular expressions for left and right delimiter and user defined literals


					
	public

leaveDoubleQuote()

leave double quoted string - throw exception if block in string was not closed

leave double quoted string

throw exception if block in string was not closed

Throws

SmartyCompilerException


					
	public

getLdelPreg(): string

Get left delimiter preg


					
	public

getRdelPreg(): string

Get right delimiter preg


					
	public

getLdelLength(): int

Get length of left delimiter


					
	public

getRdelLength(): int

Get length of right delimiter


					
	public

getOpenBlockTag(): string|boolean

Get name of current open block tag


					
	public

isVariable(mixed $value): bool|int

Check if $value contains variable elements


					
	public

getNewPrefixVariable(): string

Get new prefix variable name


					
	public

getPrefixVariable(): string

Get current prefix variable name


					
	public

appendPrefixCode(string $code)

append code to prefix buffer


					
	public

getPrefixCode(): string

get prefix code string


					
	public

saveRequiredPlugins(bool $init = false)

Save current required plugins

Parameters

$init

if true init required plugins


					
	public

restoreRequiredPlugins()

Restore required plugins


					
	public

compileRequiredPlugins(): string

Compile code to call Smarty_Internal_Template::_checkPlugins() for required plugins


					
	public

compileCheckPlugins($requiredPlugins): string

Compile code to call Smarty_Internal_Template::_checkPlugins - checks if plugin is callable require otherwise

Compile code to call Smarty_Internal_Template::_checkPlugins

checks if plugin is callable require otherwise


					abstract
	protected

doCompile(mixed $_content, bool $isTemplateSource = false): bool

method to compile a Smarty template

Parameters

$_content

template source

Returns

true if compiling succeeded, false if it failed

Implemented by

Smarty_Internal_SmartyTemplateCompiler::doCompile()


					
	public

cStyleComment($string)


					
	public

registerPostCompileCallback($callback, $parameter = [], $key = null, $replace = false)

Overriden by

Smarty_Internal_SmartyTemplateCompiler::registerPostCompileCallback()


					
	public

unregisterPostCompileCallback($key)

Overriden by

Smarty_Internal_SmartyTemplateCompiler::unregisterPostCompileCallback()

Properties
`public static`	`array`	`$_tag_objects = []`	#
`public static`	`int`	`$prefixVariableNumber = 0`	#
`public`	`Smarty`	`$smarty = null`	#
`public`	`Smarty_Internal_Templateparser`	`$parser = null`	#
`public`	`mixed`	`$nocache_hash = null`	#
`public`	`bool`	`$suppressNocacheProcessing = false`	#
`public`	`int`	`$caching = 0`	#
`public`	`array`	`$_tag_stack = []`	#
`public`	`array`	`$_tag_stack_count = []`	#
`public`	`array`	`$required_plugins = ['compiled' => [], 'nocache' => []]`	#
`public`	`array`	`$required_plugins_stack = []`	#
`public`	`Smarty_Internal_Template`	`$template = null`	#
`public`	`array`	`$mergedSubTemplatesData = []`	#
`public`	`array`	`$mergedSubTemplatesCode = []`	#
`public`	`array`	`$templateProperties = []`	#
`public`	`int`	`$trace_line_offset = 0`	#
`public`	`string`	`$trace_uid = ''`	#
`public`	`string`	`$trace_filepath = ''`	#
`public`	`array`	`$trace_stack = []`	#
`public`	`array`	`$default_handler_plugins = []`	#
`public`	`mixed`	`$default_modifier_list = null`	#
`public`	`boolean`	`$forceNocache = false`	#
`public`	`bool`	`$write_compiled_code = true`	#
`public`	`array`	`$tpl_function = []`	#
`public`	`array`	`$called_functions = []`	#
`public`	`string`	`$blockOrFunctionCode = ''`	#
`public`	`int`	`$php_handling = 0`	#
`public`	`array`	`$modifier_plugins = []`	#
`public`	`array`	`$known_modifier_type = []`	#
`public`	`Smarty_Internal_TemplateCompilerBase`	`$parent_compiler = null`	#
`public`	`bool`	`$nocache = false`	#
`public`	`bool`	`$tag_nocache = false`	#
`public`	`array`	`$prefix_code = []`	#
`public`	`array`	`$usedPrefixVariables = []`	#
`public`	`array`	`$prefixCodeStack = []`	#
`public`	`bool`	`$has_code = false`	#
`public`	`bool`	`$has_variable_string = false`	#
`public`	`array`	`$variable_filter_stack = []`	#
`public`	`array`	`$variable_filters = []`	#
`public`	`int`	`$loopNesting = 0`	#
`public`	`string`	`$stripRegEx = '![\t ][\r\n]+[\t ]!'`	#
`public`	`array`	`$plugin_search_order = ['function', 'block', 'compiler', 'class']`	#
`public`	`array`	`$_cache = []`	#
`public`	`Smarty_Internal_SmartyTemplateCompiler`	`$prefixCompiledCode` = '' = ''	#
`public`	`Smarty_Internal_SmartyTemplateCompiler`	`$postfixCompiledCode` = '' = ''	#

Namespaces

Classes

Interfaces

Exceptions

Functions

Class Smarty_Internal_TemplateCompilerBase

Parameters

Overriden by

Parameters

Returns

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Returns

Throws

Throws

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Parameters

Throws

Parameters

Parameters

Throws

Throws

Parameters

Parameters

Returns

Implemented by

Overriden by

Overriden by