[ Index ]

PHP Cross Reference of phpBB-3.3.2-deutsch

title

Body

[close]

/phpbb/template/ -> template.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: 224 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

template:: (20 methods):
  clear_cache()
  set_filenames()
  get_user_style()
  set_style()
  set_custom_style()
  destroy()
  destroy_block_vars()
  display()
  assign_display()
  assign_vars()
  assign_var()
  append_var()
  retrieve_vars()
  retrieve_var()
  assign_block_vars()
  assign_block_vars_array()
  retrieve_block_vars()
  alter_block_array()
  find_key_index()
  get_source_file_for_handle()


Interface: template  - X-Ref

clear_cache()   X-Ref
Clear the cache

return: \phpbb\template\template

set_filenames(array $filename_array)   X-Ref
Sets the template filenames for handles.

param: array $filename_array Should be a hash of handle => filename pairs.
return: \phpbb\template\template $this

get_user_style()   X-Ref
Get the style tree of the style preferred by the current user

return: array Style tree, most specific first

set_style($style_directories = array('styles')   X-Ref
Set style location based on (current) user's chosen style.

param: array $style_directories The directories to add style paths for
return: \phpbb\template\template $this

set_custom_style($names, $paths)   X-Ref
Set custom style location (able to use directory outside of phpBB).

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

param: string|array $names Array of names or string of name of template(s) in inheritance tree order, used by extensions.
param: string|array or string $paths Array of style paths, relative to current root directory
return: \phpbb\template\template $this

destroy()   X-Ref
Clears all variables and blocks assigned to this template.

return: \phpbb\template\template $this

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

param: string $blockname Name of block to destroy
return: \phpbb\template\template $this

display($handle)   X-Ref
Display a template for provided handle.

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

This function calls hooks.

param: string $handle Handle to display
return: \phpbb\template\template $this

assign_display($handle, $template_var = '', $return_content = true)   X-Ref
Display the handle and assign the output to a template variable
or return the compiled result.

param: string $handle Handle to operate on
param: string $template_var Template variable to assign compiled handle to
param: bool $return_content If true return compiled handle, otherwise assign to $template_var
return: \phpbb\template\template|string if $return_content is true return string of the compiled handle, otherwise return $this

assign_vars(array $vararray)   X-Ref
Assign key variable pairs from an array

param: array $vararray A hash of variable name => value pairs
return: \phpbb\template\template $this

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: \phpbb\template\template $this

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: \phpbb\template\template $this

retrieve_vars(array $vararray)   X-Ref
Retrieve multiple template values

param: array $vararray An array with variable names
return: array A hash of variable name => value pairs (value is null if not set)

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

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

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: \phpbb\template\template $this

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: \phpbb\template\template $this

retrieve_block_vars($blockname, array $vararray)   X-Ref
Retrieve variable values from an specified block

param: string $blockname Name of block to retrieve $vararray from
param: array $vararray An array with variable names, empty array gets all vars
return: array A hash of variable name => value pairs (value is null if not set)

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

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 ===

get_source_file_for_handle($handle)   X-Ref
Get path to template for handle (required for BBCode parser)

param: string $handle Handle to retrieve the source file
return: string



Generated: Wed Nov 11 20:28:18 2020 Cross-referenced by PHPXref 0.7.1