[ Index ]

PHP Cross Reference of phpBB-3.2.11-deutsch

title

Body

[close]

/phpbb/template/ -> context.php (summary)

This file is part of the phpBB Forum Software package.

Copyright: (c) phpBB Limited
License: GNU General Public License, version 2 (GPL-2.0)
File Size: 631 lines (16 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

context:: (14 methods):
  __construct()
  clear()
  assign_var()
  append_var()
  retrieve_var()
  get_data_ref()
  set_num_rows()
  get_root_ref()
  assign_block_vars()
  assign_block_vars_array()
  retrieve_block_vars()
  find_key_index()
  alter_block_array()
  destroy_block_vars()


Class: context  - X-Ref

Stores variables assigned to template.

__construct()   X-Ref


clear()   X-Ref
Clears template data set.


assign_var($varname, $varval)   X-Ref
Assign a single scalar value to a single key.

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

param: string $varname Variable name
param: string $varval Value to assign to variable
return: true

append_var($varname, $varval)   X-Ref
Append text to the string value stored in a key.

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

param: string $varname Variable name
param: string $varval Value to append to variable
return: true

retrieve_var($varname)   X-Ref
Retreive a single scalar value from a single key.

param: string $varname Variable name
return: mixed Variable value, or null if not set

get_data_ref()   X-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: array template data

set_num_rows(&$loop_data)   X-Ref
Set S_NUM_ROWS for each row in this template block

param: array $loop_data

get_root_ref()   X-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: array template data

assign_block_vars($blockname, array $vararray)   X-Ref
Assign key variable pairs from an array to a specified block

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

assign_block_vars_array($blockname, array $block_vars_array)   X-Ref
Assign key variable pairs from an array to a whole specified block loop

param: string $blockname Name of block to assign $block_vars_array to
param: array $block_vars_array An array of hashes of variable name => value pairs
return: true

retrieve_block_vars($blockname, array $vararray)   X-Ref
Retrieve key variable pairs from the specified block

param: string $blockname Name of block to retrieve $vararray from
param: array $vararray An array of variable names, empty array retrieves all vars
return: array of hashes with variable name as key and retrieved value or null as value

find_key_index($blockname, $key)   X-Ref
Find the index for a specified key in the innermost specified block

param: string    $blockname    the blockname, for example 'loop'
param: mixed    $key        Key to search for
return: mixed false if not found, index position otherwise; be sure to test with ===

alter_block_array($blockname, array $vararray, $key = false, $mode = 'insert')   X-Ref
Change already assigned key variable pair (one-dimensional - single loop entry)

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

param: string    $blockname    the blockname, for example 'loop'
param: array    $vararray    the var array to insert/add or merge
param: mixed    $key        Key to search for
param: string    $mode        Mode to execute (valid modes are 'insert', 'change' and 'delete')
return: bool false on error, true on success

destroy_block_vars($blockname)   X-Ref
Reset/empty complete block

param: string $blockname Name of block to destroy
return: true



Generated: Wed Nov 11 20:33:01 2020 Cross-referenced by PHPXref 0.7.1