\Smarty_Internal_Compile_Private_Block_Plugin

Smarty Internal Plugin Compile Block Plugin Class

Summary

Methods
Properties
Constants
getAttributes()
openTag()
closeTag()
compile()
setup()
$required_attributes
$optional_attributes
$shorttag_order
$option_flags
$optionMap
$mapCache
$nesting
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$required_attributes

$required_attributes : array

Array of names of required attribute required by tag

Type

array

$optional_attributes

$optional_attributes : array

Attribute definition: Overwrites base class.

Type

array

$shorttag_order

$shorttag_order : array

Shorttag attribute order defined by its names

Type

array

$option_flags

$option_flags : array

Array of names of valid option flags

Type

array

$optionMap

$optionMap : array

Mapping array for boolqn option value

Type

array

$mapCache

$mapCache : array

Mapping array with attributes as key

Type

array

$nesting

$nesting : integer

nesting level

Type

integer

Methods

getAttributes()

getAttributes(object  $compiler, array  $attributes) : array

This function checks if the attributes passed are valid The attributes passed for the tag to compile are checked against the list of required and optional attributes. Required attributes must be present. Optional attributes are check against the corresponding list. The keyword '_any' specifies that any attribute will be accepted as valid

Parameters

object $compiler

compiler object

array $attributes

attributes applied to the tag

Returns

array —

of mapped attributes for further processing

openTag()

openTag(object  $compiler, string  $openTag, mixed  $data = null) 

Push opening tag name on stack Optionally additional data can be saved on stack

Parameters

object $compiler

compiler object

string $openTag

the opening tag's name

mixed $data

optional data saved

closeTag()

closeTag(object  $compiler, array|string  $expectedTag) : mixed

Pop closing tag Raise an error if this stack-top doesn't match with expected opening tags

Parameters

object $compiler

compiler object

array|string $expectedTag

the expected opening tag names

Returns

mixed —

any type the opening tag's name or saved data

compile()

compile(array  $args, \Smarty_Internal_TemplateCompilerBase  $compiler, array  $parameter, string  $tag, string  $function = null) : string

Compiles code for the execution of block plugin

Parameters

array $args

array with attributes from parser

\Smarty_Internal_TemplateCompilerBase $compiler

compiler object

array $parameter

array with compilation parameter

string $tag

name of block plugin

string $function

PHP function name

Returns

string —

compiled code

setup()

setup(\Smarty_Internal_TemplateCompilerBase  $compiler, array  $_attr, string  $tag, string  $function) : array

Setup callback and parameter array

Parameters

\Smarty_Internal_TemplateCompilerBase $compiler
array $_attr

attributes

string $tag
string $function

Returns

array