/sources/symbols.php

Description
Functions
evaluate_conventional_variable (line 51)

Evaluate a conventional tempcode variable, handling escaping

  • return: The result. Either tempcode, or a string.
mixed evaluate_conventional_variable (LANGUAGE_NAME $lang, array $escaped, integer $type, ID_TEXT $name, array $param)
  • LANGUAGE_NAME $lang: The language to evaluate this symbol in (some symbols refer to language elements)
  • array $escaped: Array of escaping operations
  • integer $type: The type of symbol this is (TC_SYMBOL, TC_LANGUAGE_REFERENCE)
  • ID_TEXT $name: The name of the symbol
  • array $param: Parameters to the symbol. For all but directive it is an array of strings. For directives it is an array of Tempcode objects.
init__symbols (line 24)

Standard code module initialisation function.

void init__symbols ()
keep_symbol (line 2349)

String to tack onto URL to keep 'keep_' parameters

  • return: The result.
string keep_symbol (array $param)
  • array $param: Parameters passed to the symbol (0=whether this starts off the query string, 1=force session append even if it's also available a session cookie e.g. when put into download manager)
symbol_truncator (line 2268)

Handle truncation symbols in all their complexity

  • return: The result.
string symbol_truncator (array $param, string $type, [?mixed $tooltip_if_truncated = NULL])
  • array $param: Parameters passed to the symbol (0=text, 1=amount, 2=tooltip?, 3=is_html?, 4=use as grammatical length rather than HTML byte length, 5=fractional-deviation-tolerance for grammar-preservation)
  • string $type: The type of truncation to do
  • ?mixed $tooltip_if_truncated: Tooltip to add on, but only if we end up creating our own tooltip (NULL: none)

Documentation generated on Sun, 02 Jan 2011 23:25:42 +0000 by phpDocumentor 1.4.3