1. class
  2. phpbb
  3. \
  4. template
  5. \
  6. context

context

class context

Stores variables assigned to template.

Methods

__construct()

No description

clear()

Clears template data set.

true
assign_var(string $varname, string $varval)

Assign a single scalar value to a single key.

true
append_var(string $varname, string $varval)

Append text to the string value stored in a key.

mixed
retrieve_var(string $varname)

Retrieve a single scalar value from a single key.

array
get_data_ref()

Returns a reference to template data array.

set_num_rows(array $loop_data)

Set S_NUM_ROWS for each row in this template block

array
get_root_ref()

Returns a reference to template root scope.

true
assign_block_vars(string $blockname, array $vararray)

Assign key variable pairs from an array to a specified block

true
assign_block_vars_array(string $blockname, array $block_vars_array)

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

array
retrieve_block_vars(string $blockname, array $vararray)

Retrieve key variable pairs from the specified block

mixed
find_key_index(string $blockname, mixed $key)

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

bool
alter_block_array(string $blockname, array $vararray, mixed $key = false, string $mode = 'insert')

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

true
destroy_block_vars(string $blockname)

Reset/empty complete block

Details

at line 42
__construct()

No description

at line 50
clear()

Clears template data set.

at line 66
true 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

true

at line 82
true 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

true

at line 95
mixed retrieve_var(string $varname)

Retrieve a single scalar value from a single key.

Parameters

string $varname

Variable name

Return Value

mixed

Variable value, or null if not set

at line 110
array get_data_ref()

Returns a reference to template data array.

This function is public so that template renderer may invoke it. Users should alter template variables via functions in \phpbb\template\template.

Note: modifying returned array will affect data stored in the context.

Return Value

array

template data

at line 143
protected set_num_rows(array $loop_data)

Set S_NUM_ROWS for each row in this template block

Parameters

array $loop_data

at line 177
array get_root_ref()

Returns a reference to template root scope.

This function is public so that template renderer may invoke it. Users should not need to invoke this function.

Note: modifying returned array will affect data stored in the context.

Return Value

array

template data

at line 190
true 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

true

at line 248
true 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 $block_vars_array to
array $block_vars_array

An array of hashes of variable name => value pairs

Return Value

true

at line 265
array retrieve_block_vars(string $blockname, array $vararray)

Retrieve key variable pairs from the specified block

Parameters

string $blockname

Name of block to retrieve $vararray from
array $vararray

An array of variable names, empty array retrieves all vars

Return Value

array

of hashes with variable name as key and retrieved value or null as value

at line 345
mixed find_key_index(string $blockname, mixed $key)

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

Parameters

string $blockname

the blockname, for example 'loop'
mixed $key

Key to search for

array: KEY => VALUE [the key/value pair to search for within the loop to determine the correct position]

int: Position [the position to search for]

If key is false the position is set to 0 If key is true the position is set to the last entry

Return Value

mixed

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

at line 430
bool alter_block_array(string $blockname, array $vararray, mixed $key = false, string $mode = 'insert')

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

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

Parameters

string $blockname

the blockname, for example 'loop'
array $vararray

the var array to insert/add or merge
mixed $key

Key to search for

array: KEY => VALUE [the key/value pair to search for within the loop to determine the correct position]

int: Position [the position to change or insert at directly given]

If key is false the position is set to 0 If key is true the position is set to the last entry
string $mode

Mode to execute (valid modes are 'insert', 'change' and 'delete')

If insert, the vararray is inserted at the given position (position counting from zero). If change, the current block gets merged with the vararray (resulting in new key/value pairs be added and existing keys be replaced by the new \value). If delete, the vararray is ignored, and the block at the given position (counting from zero) is removed.

Since counting begins by zero, inserting at the last position will result in this array: array(vararray, last positioned array) and inserting at position 1 will result in this array: array(first positioned array, vararray, following vars)

Return Value

bool

false on error, true on success

at line 608
true destroy_block_vars(string $blockname)

Reset/empty complete block

Parameters

string $blockname

Name of block to destroy

Return Value

true