/sources/zones3.php

Description
Functions
actual_delete_zone (line 154)

Delete a zone.

void actual_delete_zone (ID_TEXT $zone)
  • ID_TEXT $zone: The name of the zone
actual_delete_zone_lite (line 186)

Delete a zones database stuff.

void actual_delete_zone_lite (ID_TEXT $zone)
  • ID_TEXT $zone: The name of the zone
actual_edit_zone (line 55)

Edit a zone.

void actual_edit_zone (ID_TEXT $zone, SHORT_TEXT $title, ID_TEXT $default_page, SHORT_TEXT $header_text, ID_TEXT $theme, BINARY $wide, BINARY $require_session, BINARY $displayed_in_menu, ID_TEXT $new_zone)
  • ID_TEXT $zone: The current name of the zone
  • SHORT_TEXT $title: The zone title
  • ID_TEXT $default_page: The zones default page
  • SHORT_TEXT $header_text: The header text
  • ID_TEXT $theme: The theme
  • BINARY $wide: Whether the zone is wide
  • BINARY $require_session: Whether the zone requires a session for pages to be used
  • BINARY $displayed_in_menu: Whether the zone in displayed in the menu coded into some themes
  • ID_TEXT $new_zone: The new name of the zone
actual_rename_zone_lite (line 108)

Rename a zone in the database.

void actual_rename_zone_lite (ID_TEXT $zone, ID_TEXT $new_zone, [boolean $dont_bother_with_main_row = false])
  • ID_TEXT $zone: The old name of the zone
  • ID_TEXT $new_zone: The new name of the zone
  • boolean $dont_bother_with_main_row: Whether to assume the main zone row has already been renamed as part of a wider editing operation
erase_comcode_page_cache (line 24)

Erase the comcode page cache

void erase_comcode_page_cache ()
get_zone_chooser (line 312)

Get a zone chooser interface.

  • return: The zone chooser
tempcode get_zone_chooser ([boolean $inline = false], [?array $no_go = NULL], [?array $reorder = NULL])
  • boolean $inline: Whether the zone chooser will be shown inline to something else (as opposed to providing it's own borderings)
  • ?array $no_go: A list of zone to not put into the list (NULL: none to skip)
  • ?array $reorder: A reordering (NULL: no reordering)
nice_get_zones (line 276)

Get a list of zones.

  • return: The list
tempcode nice_get_zones ([?ID_TEXT $sel = NULL], [?array $no_go = NULL], [?array $reorder = NULL])
  • ?ID_TEXT $sel: The zone in the list to select by default (NULL: use first)
  • ?array $no_go: A list of zone to not put into the list (NULL: none to skip)
  • ?array $reorder: A reordering (NULL: no reordering)
site_tree_do_next_manager (line 226)

The do-next manager for after content management.

  • return: The UI
tempcode site_tree_do_next_manager (tempcode $title, ?ID_TEXT $page, ID_TEXT $zone, tempcode $completion_text)
  • tempcode $title: The title (output of get_page_title)
  • ?ID_TEXT $page: The name of the page just handled (NULL: none)
  • ID_TEXT $zone: The name of the zone just handled (blank: none/welcome-zone)
  • tempcode $completion_text: The text to show (blank: default)

Documentation generated on Sun, 02 Jan 2011 23:29:40 +0000 by phpDocumentor 1.4.3