Class Module_admin_zones

Description

Module page class.

Located in /adminzone/pages/modules/admin_zones.php (line 24)


	
			
Method Summary
tempcode add_zone ()
tempcode editor ()
tempcode edit_zone ([string $type = '_edit'], [?tempcode $title = NULL])
?array get_entry_points ()
array get_form_fields ([boolean $in_zone_editor = false], [SHORT_TEXT $title = ''], [ID_TEXT $default_page = 'start'], [SHORT_TEXT $header_text = ''], [?ID_TEXT $theme = NULL], [BINARY $wide = 0], [BINARY $require_session = 0], [BINARY $displayed_in_menu = 1], [?ID_TEXT $zone = NULL])
?array info ()
tempcode misc ()
tempcode run ()
void set_permissions (ID_TEXT $zone)
void uninstall ()
tempcode _add_zone ()
tempcode _editor ()
tempcode _edit_zone ()
tempcode __editor ()
tempcode __edit_zone ()
Methods
add_zone (line 523)

The UI to add a zone.

  • return: The UI
tempcode add_zone ()
editor (line 128)

The UI to choose a zone to edit using the zone editor.

  • return: The UI
tempcode editor ()
edit_zone (line 592)

The UI to choose a zone to edit.

  • return: The UI
tempcode edit_zone ([string $type = '_edit'], [?tempcode $title = NULL])
  • string $type: The follow-on type
  • ?tempcode $title: The title to use (NULL: the EDIT_ZONE title)
get_entry_points (line 49)

Standard modular entry-point finder function.

  • return: A map of entry points (type-code=>language-code) (NULL: disabled).
?array get_entry_points ()
get_form_fields (line 446)

Get tempcode for a zone adding/editing form.

  • return: A tuple: The tempcode for the fields, hidden fields, and extra Javascript
array get_form_fields ([boolean $in_zone_editor = false], [SHORT_TEXT $title = ''], [ID_TEXT $default_page = 'start'], [SHORT_TEXT $header_text = ''], [?ID_TEXT $theme = NULL], [BINARY $wide = 0], [BINARY $require_session = 0], [BINARY $displayed_in_menu = 1], [?ID_TEXT $zone = NULL])
  • boolean $in_zone_editor: Whether the zone editor will be used
  • 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 (NULL: no override)
  • 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 $zone: Name of the zone (NULL: unknown)
info (line 32)

Standard modular info function.

  • return: Map of module info (NULL: module is disabled).
?array info ()
misc (line 107)

The do-next manager for before content management.

  • return: The UI
tempcode misc ()
run (line 81)

Standard modular run function.

  • return: The result of execution.
tempcode run ()
set_permissions (line 758)

Set zone access permissions from info in the POST request.

void set_permissions (ID_TEXT $zone)
  • ID_TEXT $zone: The zone that we're setting permissions for
uninstall (line 57)

Standard modular uninstall function.

void uninstall ()
_add_zone (line 557)

The actualiser to add a zone.

  • return: The UI
tempcode _add_zone ()
_editor (line 140)

The UI for the zone editor.

  • return: The UI
tempcode _editor ()
_edit_zone (line 626)

The UI to edit a zone.

  • return: The UI
tempcode _edit_zone ()
__editor (line 338)

The actualiser to edit a zone (via zone editor).

  • return: The UI
tempcode __editor ()
__edit_zone (line 679)

The actualiser to edit a zone.

  • return: The UI
tempcode __edit_zone ()

Documentation generated on Sun, 02 Jan 2011 23:08:13 +0000 by phpDocumentor 1.4.3