/sources/site2.php

Description
Description | Functions
Functions
Description | Functions
assign_refresh (line 60)

Assign a page refresh to the specified URL.

void assign_refresh (mixed $url, float $multiplier)
  • mixed $url: Refresh to this URL (URLPATH or Tempcode URL)
  • float $multiplier: Take this many times longer than a 'standard ocPortal refresh'
clean_html_title (line 335)

Turn an HTML title, which could be complex with images, into a nice simple string we can use in <title> and ;.

  • return: Fixed
string clean_html_title (string $title)
  • string $title: The relative (to ocPortal's base directory) path to the page (e.g. pages/comcode/EN/start.txt)
closed_site (line 96)

Render the site as closed.

void closed_site ()
get_page_warning_details (line 29)

A page is not validated, so show a warning.

  • return: The warning
tempcode get_page_warning_details (ID_TEXT $zone, ID_TEXT $codename, tempcode $edit_url)
  • ID_TEXT $zone: The zone the page is being loaded from
  • ID_TEXT $codename: The codename of the page
  • tempcode $edit_url: The edit URL (blank if no edit access)
page_not_found (line 132)

Render that the page wasn't found. Show alternate likely candidates based on misspellings.

  • return: Message
tempcode page_not_found (ID_TEXT $codename, ID_TEXT $zone)
  • ID_TEXT $codename: The codename of the page to load
  • ID_TEXT $zone: The zone the page is being loaded in
_load_comcode_page_cache_off (line 290)

Load Comcode page from disk.

  • return: A tuple: The page, New Comcode page row, Title
array _load_comcode_page_cache_off (PATH $string, ID_TEXT $zone, ID_TEXT $codename, PATH $file_base, array $new_comcode_page_row)
  • PATH $string: The relative (to ocPortal's base directory) path to the page (e.g. pages/comcode/EN/start.txt)
  • ID_TEXT $zone: The zone the page is being loaded from
  • ID_TEXT $codename: The codename of the page
  • PATH $file_base: The file base to load from
  • array $new_comcode_page_row: New row for database, used if nesessary (holds submitter etc)
_load_comcode_page_not_cached (line 198)

Load Comcode page from disk, then cache it.

  • return: A triple: The page, Title to use, New Comcode page row
array _load_comcode_page_not_cached (PATH $string, ID_TEXT $zone, ID_TEXT $codename, PATH $file_base, ?array $comcode_page_row, array $new_comcode_page_row)
  • PATH $string: The relative (to ocPortal's base directory) path to the page (e.g. pages/comcode/EN/start.txt)
  • ID_TEXT $zone: The zone the page is being loaded from
  • ID_TEXT $codename: The codename of the page
  • PATH $file_base: The file base to load from
  • ?array $comcode_page_row: Row from database (holds submitter etc) (NULL: no row, originated first from disk)
  • array $new_comcode_page_row: New row for database, used if necessary (holds submitter etc)

Documentation generated on Sun, 02 Jan 2011 23:24:52 +0000 by phpDocumentor 1.4.3