Class Smarty_Internal_TemplateCompilerBase

Main abstract compiler class

Direct known subclasses

Smarty_Internal_SmartyTemplateCompiler

Abstract
Package: Smarty\Compiler
Author: Uwe Tews
Located at tpl/smarty/sysplugins/smarty_internal_templatecompilerbase.php

Methods summary

`abstract protected boolean`	# `doCompile( mixed $_content, boolean $isTemplateSource = false )` method to compile a Smarty template method to compile a Smarty template Parameters `$_content` template source `$isTemplateSource` Returns boolean true if compiling succeeded, false if it failed
`public`	# `__construct( Smarty $smarty )` Initialize compiler Initialize compiler Parameters `$smarty` global instance
`public boolean`	# `compileTemplate( Smarty_Internal_Template $template, boolean $nocache = null, Smarty_Internal_TemplateCompilerBase $parent_compiler = null )` Method to compile a Smarty template Method to compile a Smarty template Parameters `$template` template object to compile `$nocache` true is shall be compiled in nocache mode `$parent_compiler` Returns boolean true if compiling succeeded, false if it failed Throws Exception
`public string`	# `compileTemplateSource( Smarty_Internal_Template $template, null\|boolean $nocache = null, Smarty_Internal_TemplateCompilerBase $parent_compiler = null )` Compile template source and run optional post filter Compile template source and run optional post filter Parameters `$template` `$nocache` flag if template must be compiled in nocache mode `$parent_compiler` Returns string Throws Exception
`public string`	# `postFilter( string $code )` Optionally process compiled code by post filter Optionally process compiled code by post filter Parameters `$code` compiled code Returns string Throws `SmartyException`
`public string`	# `preFilter( string $_content )` Run optional prefilter Run optional prefilter Parameters `$_content` template source Returns string Throws `SmartyException`
`public string`	# `compileTag( string $tag, array $args, array $parameter = array() )` Compile Tag This is a call back from the lexer/parser 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 string compiled code Throws `SmartyCompilerException` `SmartyException`
`public string`	# `compileVariable( string $variable )` compile variable compile variable Parameters `$variable` Returns string
`public string`	# `compileConfigVariable( string $variable )` compile config variable compile config variable Parameters `$variable` Returns string
`public null\|Smarty_Internal_ParseTree_Text`	# `processText( string $text )` This method is called from parser to process a text content section - remove text from inheritance child templates as they may generate output - strip text if strip is enabled This method is called from parser to process a text content section - remove text from inheritance child templates as they may generate output - strip text if strip is enabled Parameters `$text` Returns null\|Smarty_Internal_ParseTree_Text
`public string`	# `callTagCompiler( string $tag, array $args, mixed $param1 = null, mixed $param2 = null, mixed $param3 = null )` 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 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 string compiled code
`public string`	# `getPlugin( $plugin_name, string $plugin_type )` Check for plugins and return function name Check for plugins and return function name Parameters `$plugin_name` `$plugin_type` type of plugin Returns string call name of function
`public boolean`	# `getPluginFromDefaultHandler( string $tag, string $plugin_type )` Check for plugins by default plugin handler Check for plugins by default plugin handler Parameters `$tag` name of tag `$plugin_type` type of plugin Returns boolean true if found
`public string`	# `appendCode( string $left, string $right )` Append code segments and remove unneeded ?> <?php transitions Append code segments and remove unneeded ?> <?php transitions Parameters `$left` `$right` Returns string
`public string`	# `processNocacheCode( string $content, boolean $is_code )` 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. 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 string content
`public boolean\|string`	# `getId( string $input )` Get Id Get Id Parameters `$input` Returns boolean\|string
`public boolean\|string`	# `getVariableName( string $input )` Get variable name from string Get variable name from string Parameters `$input` Returns boolean\|string
`public`	# `setNocacheInVariable( string $varName )` Set nocache flag in variable or create new variable Set nocache flag in variable or create new variable Parameters `$varName`
`public integer\|string`	# `convertScope( array $_attr, array $validScopes )` Parameters `$_attr` tag attributes `$validScopes` Returns integer\|string Throws `SmartyCompilerException`
`public string`	# `makeNocacheCode( string $code )` Generate nocache code string Generate nocache code string Parameters `$code` PHP code Returns string
`public`	# `trigger_template_error( string $args = null, string $line = null, null\|boolean $tagline = null )` 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 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 string`	# `getVarExport( mixed $value )` Return var_export() value with all white spaces removed Return var_export() value with all white spaces removed Parameters `$value` Returns string
`public boolean\|integer`	# `isVariable( mixed $value )` Check if $value contains variable elements Check if $value contains variable elements Parameters `$value` Returns boolean\|integer
`public string`	# `getNewPrefixVariable( )` Get new prefix variable name Get new prefix variable name Returns string
`public string`	# `getPrefixVariable( )` Get current prefix variable name Get current prefix variable name Returns string
`public`	# `appendPrefixCode( string $code )` append code to prefix buffer append code to prefix buffer Parameters `$code`
`public string`	# `getPrefixCode( )` get prefix code string get prefix code string Returns string

Magic methods summary

`public`	# `registerPostCompileCallback( $callback, $parameter = array(), $key = null, $replace = false )` Parameters `$callback` `$parameter` `$key` `$replace` Returns
`public`	# `unregisterPostCompileCallback( $key )` Parameters `$key` Returns

Properties summary

`public Smarty`	`$smarty` Smarty object Smarty object	# `null`
`public Smarty_Internal_Templateparser`	`$parser` Parser object Parser object	# `null`
`public mixed`	`$nocache_hash` hash for nocache sections hash for nocache sections	# `null`
`public boolean`	`$suppressNocacheProcessing` suppress generation of nocache code suppress generation of nocache code	# `false`
`public static array`	`$_tag_objects` compile tag objects cache compile tag objects cache	# `array()`
`public array`	`$_tag_stack` tag stack tag stack	# `array()`
`public Smarty_Internal_Template`	`$template` current template current template	# `null`
`public array`	`$mergedSubTemplatesData` merged included sub template data merged included sub template data	# `array()`
`public array`	`$mergedSubTemplatesCode` merged sub template code merged sub template code	# `array()`
`public array`	`$templateProperties` collected template properties during compilation collected template properties during compilation	# `array()`
`public integer`	`$trace_line_offset` source line offset for error messages source line offset for error messages	# `0`
`public string`	`$trace_uid` trace uid trace uid	# `''`
`public string`	`$trace_filepath` trace file path trace file path	# `''`
`public array`	`$trace_stack` stack for tracing file and line of nested {block} tags stack for tracing file and line of nested {block} tags	# `array()`
`public array`	`$default_handler_plugins` plugins loaded by default plugin handler plugins loaded by default plugin handler	# `array()`
`public mixed`	`$default_modifier_list` saved preprocessed modifier list saved preprocessed modifier list	# `null`
`public boolean`	`$forceNocache` force compilation of complete template as nocache force compilation of complete template as nocache	# `false`
`public boolean`	`$write_compiled_code` flag if compiled template file shall we written flag if compiled template file shall we written	# `true`
`public array`	`$tpl_function` Template functions Template functions	# `array()`
`public array`	`$called_functions` called sub functions from template function called sub functions from template function	# `array()`
`public string`	`$blockOrFunctionCode` compiled template or block function code compiled template or block function code	# `''`
`public integer`	`$php_handling` php_handling setting either from Smarty or security php_handling setting either from Smarty or security	# `0`
`public array`	`$modifier_plugins` flags for used modifier plugins flags for used modifier plugins	# `array()`
`public array`	`$known_modifier_type` type of already compiled modifier type of already compiled modifier	# `array()`
`public Smarty_Internal_TemplateCompilerBase`	`$parent_compiler` parent compiler object for merged subtemplates and template functions parent compiler object for merged subtemplates and template functions	# `null`
`public boolean`	`$nocache` Flag true when compiling nocache section Flag true when compiling nocache section	# `false`
`public boolean`	`$tag_nocache` Flag true when tag is compiled as nocache Flag true when tag is compiled as nocache	# `false`
`public array`	`$prefix_code` Compiled tag prefix code Compiled tag prefix code	# `array()`
`public array`	`$prefixCodeStack` Prefix code stack Prefix code stack	# `array()`
`public boolean`	`$has_code` Tag has compiled code Tag has compiled code	# `false`
`public boolean`	`$has_variable_string` A variable string was compiled A variable string was compiled	# `false`
`public boolean`	`$has_output` Tag creates output Tag creates output	# `false`
`public array`	`$variable_filter_stack` Stack for {setfilter} {/setfilter} Stack for {setfilter} {/setfilter}	# `array()`
`public array`	`$variable_filters` variable filters for {setfilter} {/setfilter} variable filters for {setfilter} {/setfilter}	# `array()`
`public integer`	`$loopNesting` Nesting count of looping tags like {foreach}, {for}, {section}, {while} Nesting count of looping tags like {foreach}, {for}, {section}, {while}	# `0`
`public string`	`$stripRegEx` Strip preg pattern Strip preg pattern	# `'![\t ][\r\n]+[\t ]!'`
`public array`	`$plugin_search_order` plugin search order plugin search order	# `array('function', 'block', 'compiler', 'class')`
`public array`	`$_cache` General storage area for tag compiler plugins General storage area for tag compiler plugins	# `array()`
`public static integer`	`$prefixVariableNumber` counter for prefix variable number counter for prefix variable number	# `0`

Magic properties

`public Smarty_Internal_SmartyTemplateCompiler`	`$prefixCompiledCode` = ''
`public Smarty_Internal_SmartyTemplateCompiler`	`$postfixCompiledCode` = ''

Classes

Exceptions

Functions

Class Smarty_Internal_TemplateCompilerBase

Direct known subclasses

Methods summary

Parameters

Returns

Parameters

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Throws

Parameters

Returns

Parameters

Throws

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Magic methods summary

Parameters

Returns

Parameters

Returns

Properties summary

Magic properties