/sources/view_modes.php

Description
Functions
display_validation_results (line 636)

Show results of running a validation function.

  • return: Returned result (won't return it $ret is false)
string display_validation_results (string $out, array $error, [boolean $preview_mode = false], [boolean $ret = false])
  • string $out: The data validated
  • array $error: Error information
  • boolean $preview_mode: Whether we are opening up an XHTML-fragment in a preview box
  • boolean $ret: Whether to return Tempcode
do_xhtml_validation (line 590)

Takes the output from the scripts, and check the XHTML for validity, then echoes the page, plus the validation results.

  • return: Returned result (won't return it $ret is false)
string do_xhtml_validation (string $out, [boolean $display_regardless = false], [integer $preview_mode = 0], [boolean $ret = false])
  • string $out: The XHTML to validate
  • boolean $display_regardless: Display XHTML output regardless of whether there was an error or not
  • integer $preview_mode: Whether we are opening up an XHTML-fragment in a preview box (1 means yes, 2 means we are asking for additional manual check information)
  • boolean $ret: Whether to return Tempcode
erase_cached_language (line 486)

Erase the language cache.

void erase_cached_language ()
erase_cached_templates (line 543)

Erase all template caches (caches in all themes).

void erase_cached_templates ([boolean $preserve_some = false])
  • boolean $preserve_some: Whether to preserve CSS and JS files that might be linked to between requests
erase_tempcode_cache (line 477)

Erase the tempcode cache.

void erase_tempcode_cache ()
find_template_path (line 320)

Finds the path of the given template codename.

  • return: A path (NULL: no such template)
?PATH find_template_path (ID_TEXT $name)
  • ID_TEXT $name: The template codename
find_template_tree_nice (line 350)

Convert a template tree structure into a HTML representation.

  • return: HTML representation
string find_template_tree_nice (ID_TEXT $codename, array $children, boolean $fresh, [boolean $cache_started = false])
  • ID_TEXT $codename: The codename of the current template item in the recursion
  • array $children: The template tree structure for children
  • boolean $fresh: Whether the template tree came from a cache (if so, we can take some liberties with it's presentation)
  • boolean $cache_started: As $fresh, except something underneath at any unknown point did come from the cache, so this must have by extension
initialise_special_page_types (line 27)

Initialise state variables for the special page type being requested.

void initialise_special_page_types (ID_TEXT $special_page_type)
  • ID_TEXT $special_page_type: The special page type.
ocportal_cleanup (line 422)

Rebuild the specified caches.

  • return: Any messages returned
tempcode ocportal_cleanup ([?array $caches = NULL])
  • ?array $caches: The caches to rebuild (NULL: all)
special_page_types (line 69)

Handle special page type output.

void special_page_types (ID_TEXT $special_page_type, tempcode &$out, string $out_evaluated)
  • ID_TEXT $special_page_type: The special page type.
  • tempcode &$out: The normal script tempcode output
  • string $out_evaluated: The normal script evaluated output

Documentation generated on Sun, 02 Jan 2011 23:28:35 +0000 by phpDocumentor 1.4.3