Docs For Class Module_admin

Class Module_admin_staff

Description

Module page class.

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

Method Summary

?array get_entry_points ()

?array info ()

void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])

tempcode run ()

tempcode staff_edit ()

tempcode staff_interface ()

void uninstall ()

void _staff_add (MEMBER $id)

void _staff_edit (MEMBER $id, SHORT_TEXT $role, SHORT_TEXT $fullname)

void _staff_remove (MEMBER $id)

Methods

get_entry_points (line 92)

Standard modular entry-point finder function.

return: A map of entry points (type-code=>language-code) (NULL: disabled).

?array get_entry_points ()

info (line 32)

Standard modular info function.

return: Map of module info (NULL: module is disabled).

?array info ()

install (line 61)

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)

run (line 102)

Standard modular run function.

return: The result of execution.

tempcode run ()

staff_edit (line 178)

The actualiser for editing staff information.

return: The UI

tempcode staff_edit ()

staff_interface (line 122)

The UI for editing staff information.

return: The UI

tempcode staff_interface ()

uninstall (line 48)

Standard modular uninstall function.

void uninstall ()

_staff_add (line 220)

Add a member of staff.

void _staff_add (MEMBER $id)

MEMBER $id: The ID of the member to add as staff

_staff_edit (line 207)

Edit a member of staff.

void _staff_edit (MEMBER $id, SHORT_TEXT $role, SHORT_TEXT $fullname)

MEMBER $id: The member ID of the staff being edited
SHORT_TEXT $role: The role of the staff member
SHORT_TEXT $fullname: The full-name of the staff member

_staff_remove (line 235)

Remove a member of staff.

void _staff_remove (MEMBER $id)

MEMBER $id: The ID of the member to remove from the staff

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