phpBB API Documentation
Class

phpbb\template\twig\twig

class twig extends base

Twig Template class.

Methods

template set_filenames(array $filename_array)

Sets the template filenames for handles.

 from base
template destroy()

Clears all variables and blocks assigned to this template.

 from base
template destroy_block_vars(string $blockname)

Reset/empty complete block

 from base
template assign_vars(array $vararray)

Assign key variable pairs from an array

 from base
template assign_var(string $varname, string $varval)

Assign a single scalar value to a single key.

 from base
template append_var(string $varname, string $varval)

Append text to the string value stored in a key.

 from base
array retrieve_vars(array $vararray)

Retrieve multiple template values

 from base
mixed retrieve_var(string $varname)

Retreive a single scalar value from a single key.

 from base
template assign_block_vars(string $blockname, array $vararray)

Assign key variable pairs from an array to a specified block

 from base
template assign_block_vars_array(string $blockname, array $block_vars_array)

Assign key variable pairs from an array to a whole specified block loop

 from base
array retrieve_block_vars(string $blockname, array $vararray)

Retrieve variable values from an specified block

 from base
bool alter_block_array($blockname, array $vararray, $key = false, $mode = 'insert')

Change already assigned key variable pair (one-dimensional - single loop entry)

 from base
mixed find_key_index($blockname, $key)

Find the index for a specified key in the innermost specified block

 from base
__construct(path_helper $path_helper, config $config, context $context, environment $twig_environment, string $cache_path, user $user = null, array|ArrayAccess $extensions = array(), manager $extension_manager = null)

Constructor.
template clear_cache()

Clear the cache
array get_user_style()

Get the style tree of the style preferred by the current user
template set_style(array $style_directories = array('styles'))

Set style location based on (current) user's chosen style.
template set_custom_style(string|array $names, string|array $paths)

Set custom style location (able to use directory outside of phpBB).
template display(string $handle)

Display a template for provided handle.
template|string assign_display(string $handle, string $template_var = '', bool $return_content = true)

Display the handle and assign the output to a template variable or return the compiled result.
string get_source_file_for_handle(string $handle)

Get path to template for handle (required for BBCode parser)

Details

in base at line 36
public template set_filenames(array $filename_array)

Sets the template filenames for handles.

Parameters

array $filename_array Should be a hash of handle => filename pairs.

Return Value

template $this

in base at line 57
public template destroy()

Clears all variables and blocks assigned to this template.

Return Value

template $this

in base at line 67
public template destroy_block_vars(string $blockname)

Reset/empty complete block

Parameters

string $blockname Name of block to destroy

Return Value

template $this

in base at line 77
public template assign_vars(array $vararray)

Assign key variable pairs from an array

Parameters

array $vararray A hash of variable name => value pairs

Return Value

template $this

in base at line 90
public template assign_var(string $varname, string $varval)

Assign a single scalar value to a single key.

Value can be a string, an integer or a boolean.

Parameters

string $varname Variable name
string $varval Value to assign to variable

Return Value

template $this

in base at line 100
public template append_var(string $varname, string $varval)

Append text to the string value stored in a key.

Text is appended using the string concatenation operator (.).

Parameters

string $varname Variable name
string $varval Value to append to variable

Return Value

template $this

in base at line 110
public array retrieve_vars(array $vararray)

Retrieve multiple template values

Parameters

array $vararray An array with variable names

Return Value

array A hash of variable name => value pairs (value is null if not set)

in base at line 123
public mixed retrieve_var(string $varname)

Retreive a single scalar value from a single key.

Parameters

string $varname Variable name

Return Value

mixed Variable value, or null if not set

in base at line 131
public template assign_block_vars(string $blockname, array $vararray)

Assign key variable pairs from an array to a specified block

Parameters

string $blockname Name of block to assign $vararray to
array $vararray A hash of variable name => value pairs

Return Value

template $this

in base at line 141
public template assign_block_vars_array(string $blockname, array $block_vars_array)

Assign key variable pairs from an array to a whole specified block loop

Parameters

string $blockname Name of block to assign $blockvarsarray to
array $block_vars_array An array of hashes of variable name => value pairs

Return Value

template $this

in base at line 151
public array retrieve_block_vars(string $blockname, array $vararray)

Retrieve variable values from an specified block

Parameters

string $blockname Name of block to retrieve $vararray from
array $vararray An array with variable names, empty array gets all vars

Return Value

array A hash of variable name => value pairs (value is null if not set)

in base at line 159
public bool alter_block_array($blockname, array $vararray, $key = false, $mode = 'insert')

Change already assigned key variable pair (one-dimensional - single loop entry)

An example of how to use this function: {@example alterblockarray.php}

Parameters

$blockname
array $vararray
$key
$mode

Return Value

bool false on error, true on success

in base at line 167
public mixed find_key_index($blockname, $key)

Find the index for a specified key in the innermost specified block

Parameters

$blockname
$key

Return Value

mixed false if not found, index position otherwise; be sure to test with ===

at line 88
public __construct(path_helper $path_helper, config $config, context $context, environment $twig_environment, string $cache_path, user $user = null, array|ArrayAccess $extensions = array(), manager $extension_manager = null)

Constructor.

Parameters

path_helper $path_helper
config $config
context $context template context
environment $twig_environment
string $cache_path
user $user
array|ArrayAccess $extensions
manager $extension_manager extension manager, if null then template events will not be invoked

at line 117
public template clear_cache()

Clear the cache

Return Value

template

at line 134
public array get_user_style()

Get the style tree of the style preferred by the current user

Return Value

array Style tree, most specific first

Exceptions

user_object_not_available When user service was not set

at line 161
public template set_style(array $style_directories = array('styles'))

Set style location based on (current) user's chosen style.

Parameters

array $style_directories The directories to add style paths for E.g. array('ext/foo/bar/styles', 'styles') Default: array('styles') (phpBB's style directory)

Return Value

template $this

at line 230
public template set_custom_style(string|array $names, string|array $paths)

Set custom style location (able to use directory outside of phpBB).

Note: Templates are still compiled to phpBB's cache directory.

Parameters

string|array $names Array of names (or detailed names) or string of name of template(s) in inheritance tree order, used by extensions. E.g. array( 'name' => 'adm', 'ext_path' => 'adm/style/', )
string|array $paths of string $paths Array of style paths, relative to current root directory

Return Value

template $this

at line 309
public template display(string $handle)

Display a template for provided handle.

The template will be loaded and compiled, if necessary, first.

This function calls hooks.

Parameters

string $handle Handle to display

Return Value

template $this

at line 331
public template|string assign_display(string $handle, string $template_var = '', bool $return_content = true)

Display the handle and assign the output to a template variable or return the compiled result.

Parameters

string $handle Handle to operate on
string $template_var Template variable to assign compiled handle to
bool $return_content If true return compiled handle, otherwise assign to $template_var

Return Value

template|string if $return_content is true return string of the compiled handle, otherwise return $this

at line 380
public string get_source_file_for_handle(string $handle)

Get path to template for handle (required for BBCode parser)

Parameters

string $handle Handle to retrieve the source file

Return Value

string