Class Module_admin_sitetree

Description

Located in /adminzone/pages/modules/admin_sitetree.php (line 16)


	
			
Method Summary
tempcode choose_zone (tempcode $title, [?string $no_go = NULL])
tempcode delete ()
tempcode do_next_manager (tempcode $title, ?ID_TEXT $page, ID_TEXT $zone, tempcode $completion_text)
?array get_entry_points ()
?array info ()
void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])
tempcode misc ()
tempcode move ()
tempcode page_wizard ()
tempcode run ()
tempcode site_tree ()
void uninstall ()
tempcode _delete ()
tempcode _move ()
tempcode _page_wizard ()
tempcode __delete ()
Methods
choose_zone (line 366)

The UI to choose a zone.

  • return: The UI
tempcode choose_zone (tempcode $title, [?string $no_go = NULL])
  • tempcode $title: The title for the "choose a zone" page
  • ?string $no_go: Zone to not allow the selection of (NULL: none to filter out)
delete (line 386)

The UI to delete a page.

  • return: The UI
tempcode delete ()
do_next_manager (line 177)

The do-next manager for after content management.

  • return: The UI
tempcode 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)
get_entry_points (line 42)

Standard modular entry-point finder function.

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

Standard modular info function.

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

Standard modular install function.

void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])
  • ?integer $upgrade_from: What version we're upgrading from (NULL: new install)
  • ?integer $upgrade_from_hack: What hack version we're upgrading from (NULL: new-install/not-upgrading-from-a-hacked-version)
misc (line 151)

The do-next manager for before content management. This is intended for exceptional users who cannot use the site-tree editor

  • return: The UI
tempcode misc ()
move (line 547)

The UI to move a page.

  • return: The UI
tempcode move ()
page_wizard (line 220)

The UI for the add-new-page wizard (choose zone, page name).

  • return: The UI
tempcode page_wizard ()
run (line 125)

Standard modular run function.

  • return: The result of execution.
tempcode run ()
site_tree (line 190)

The UI for the site-tree editor.

  • return: The UI
tempcode site_tree ()
uninstall (line 50)

Standard modular uninstall function.

void uninstall ()
_delete (line 426)

The UI to confirm deletion of a page.

  • return: The UI
tempcode _delete ()
_move (line 592)

The actualiser to move a page.

  • return: The UI
tempcode _move ()
_page_wizard (line 247)

The UI for the add-new-page wizard (choose which menu to add it to, and what title to give it - or choose not to add to a menu).

  • return: The UI
tempcode _page_wizard ()
__delete (line 462)

The actualiser to delete a page.

  • return: The UI
tempcode __delete ()

Documentation generated on Thu, 07 Aug 2008 14:06:39 +0100 by phpDocumentor 1.4.1