Compiler

Compiler for Smarty templates

This class handles the compilation of Smarty template syntax into executable PHP code. It parses Smarty tags, variables, modifiers, and directives and transforms them into their PHP equivalents. The Compiler manages template delimiters, section and foreach loops, variable captures, and includes.

The compilation process follows these main steps:

1. Template content is parsed for Smarty syntax using delimiters
2. Tags and variables are identified and processed by their respective handlers
3. PHP code is generated that, when executed, will render the template output

This class is used internally by the Smarty template engine and should not be instantiated directly by application code.

Properties

tags

protected array $tags = array (
  0 => 'if',
  1 => 'elseif',
  2 => 'else',
  3 => 'section',
  4 => 'sectionelse',
  5 => 'foreach',
  6 => 'foreachelse',
  7 => 'ldelim',
  8 => 'rdelim',
  9 => 'capture',
  10 => 'assign',
  11 => 'include',
  12 => NULL,
  13 => 'function',
  14 => 'call',
  15 => 'php',
)

conditionalMap

Map of conditional operators to PHP operators.

protected array $conditionalMap = array (
  'eq' => '==',
  'eqeq' => '===',
  'ne' => '!=',
  'neq' => '!==',
  'lt' => '<',
  'gt' => '>',
  'lte' => '<=',
  'gte' => '>=',
  'and' => '&&',
  'or' => '||',
)

ldelim

private string $ldelim = '{'

rdelim

private string $rdelim = '}'

cwd

public string $cwd

sectionStack

private array $sectionStack

foreachStack

private array $foreachStack

captureStack

private array $captureStack

compiledContent

private string $compiledContent

Methods

__construct

public __construct(string $ldelim = '{', string $rdelim = '}'): void

Parameters

Parameter	Type	Description
$ldelim	string
$rdelim	string

setCWD

public setCWD(string $cwd): void

Parameters

Parameter	Type	Description
$cwd	string

setDelimiters

public setDelimiters(string $ldelim, string $rdelim): void

Parameters

Parameter	Type	Description
$ldelim	string
$rdelim	string

reset

public reset(): void

exec

public exec(?string $content): bool

Parameters

Parameter	Type	Description
$content	string

getCompiledContent

public getCompiledContent(): string

isCompiled

public isCompiled(): bool

getCode

public getCode(string $templateObjectId): string

Parameters

Parameter	Type	Description
$templateObjectId	string

compilePHP

public compilePHP(): string

compileENDPHP

public compileENDPHP(): string

setType

Transforms the provided value into the specified type with optional formatting arguments.

protected setType(mixed $value, string $type = 'string', ?string $args): string

Parameters

Parameter	Type	Description
$value	mixed	The value to be type converted
$type	string	The target type to convert to ('date' or 'string')
$args	string	Optional formatting arguments (e.g., date format string)

parsePARAMS

Parses a parameter string into an associative array of parameter values.

protected parsePARAMS(string $params): void

Handles complex parameter strings including arrays, quoted strings, and variable references.

Parameters

Parameter	Type	Description
$params	string	The parameter string to parse

parseVALUE

Parses a value string that may represent an array or simple value.

protected parseVALUE(string $valueString): mixed

Handles array syntax with brackets and arrow notation.

Parameters

Parameter	Type	Description
$valueString	string	The string to parse as a value

compileVAR

Compiles a variable reference into its PHP equivalent.

protected compileVAR(string $name): string

Handles variable modifiers, array access, object properties, and section variables.

Parameters

Parameter	Type	Description
$name	string	The variable name/reference to compile

compileVARS

Compiles variables within a string into their PHP equivalents.

protected compileVARS(string $string): string

Replaces all variable references with their compiled versions.

Parameters

Parameter	Type	Description
$string	string	The string containing variables to compile

replaceVAR

Generates PHP code to write a variable value to output.

protected replaceVAR(string $name): string

Parameters

Parameter	Type	Description
$name	string	The variable reference to output

replaceCONFIGVAR

Generates PHP code to write a configuration variable value to output.

protected replaceCONFIGVAR(string $name): string

Parameters

Parameter	Type	Description
$name	string	The configuration variable name

compileCONDITIONS

Compiles parameters into valid PHP code expressions.

protected compileCONDITIONS(string $params): string

Handles arrays, variables, logical operators, and literal values.

Parameters

Parameter	Type	Description
$params	string	Parameters to compile

compileARRAY

Recursively compiles an array into its PHP array syntax representation.

protected compileARRAY(array $array): string

Parameters

Parameter	Type	Description
$array	array	The array to compile

compileIF

Compiles an IF statement into its PHP equivalent.

protected compileIF(string $params): string

Parameters

Parameter	Type	Description
$params	string	The condition expression to evaluate

compileELSEIF

Compiles an ELSEIF statement into its PHP equivalent.

protected compileELSEIF(string $params): string

Parameters

Parameter	Type	Description
$params	string	The condition expression to evaluate

compileELSE

Compiles an ELSE statement into its PHP equivalent.

protected compileELSE(): string

compileENDIF

protected compileENDIF(): string

compileSECTION

protected compileSECTION(string $params): string

Parameters

Parameter	Type	Description
$params	string

compileSECTIONELSE

protected compileSECTIONELSE(): string

compileENDSECTION

protected compileENDSECTION(): string

compileFOREACH

protected compileFOREACH(string $params): string

Parameters

Parameter	Type	Description
$params	string

compileFOREACHELSE

protected compileFOREACHELSE(): string

compileENDFOREACH

protected compileENDFOREACH(): string

compileLDELIM

protected compileLDELIM(): string

compileRDELIM

protected compileRDELIM(): string

compileCAPTURE

protected compileCAPTURE(string $params): string

Parameters

Parameter	Type	Description
$params	string

compileENDCAPTURE

protected compileENDCAPTURE(): string

compileASSIGN

protected compileASSIGN(string $params): string

Parameters

Parameter	Type	Description
$params	string

compileFUNCTION

protected compileFUNCTION(string $params): string

Parameters

Parameter	Type	Description
$params	string

compileENDFUNCTION

protected compileENDFUNCTION(): string

compileFUNCTIONHANDLER

protected compileFUNCTIONHANDLER(string $name, mixed $params): string

Parameters

Parameter	Type	Description
$name	string
$params	mixed

compileCALL

protected compileCALL(string $params): string

Parameters

Parameter	Type	Description
$params	string

compileINCLUDE

protected compileINCLUDE(string $params): string

Parameters

Parameter	Type	Description
$params	string

---

Generated by Hazaar API Doc Generator on Mon, 27 Oct 2025 13:01:29 +0000