User management for the world wide web

GenieGate_Controller_Admin Class Reference

This is the Controller for the Admin utility. More...

Inheritance diagram for GenieGate_Controller_Admin:

[legend]Collaboration diagram for GenieGate_Controller_Admin:

[legend]List of all members.


Public Member Functions
	GenieGate_Controller_Admin (&$conf)
	Constructor, this creates the Controller with the given configuration.
	run ($method=FALSE)
	Run the controller.
	addListener (&$listener)
	Adds a listener object.
	do_logout ()
	Performs the logout.
	do_main ()
	Show the main menu.
	do_general_search ()
	Does a general scan of users.
	do_expunge ()
	Expunge all accounts.
	do_user_search ()
	Search for users.
	do_update_user ()
	Update the user info.
	do_user_main ()
	Shows the main screen for working with users.
	do_show_create_screen ()
	Show the screen for user creation.
	do_delete_user ()
	Deletes one or more users.
	do_create_user ()
	Saves the data from do_show_create_screen().
	do_lookup_uid ()
	Lookup the user in UID.
	do_create_group ()
	Takes form data and creates a group.
	do_show_group ()
	Get a group for display.
	do_update_group ()
	Updates a group.
	do_delete_group ()
	Remove a group.
	do_property_main ()
	Main screen for properties.
	do_show_edit_prop ()
	Show the screen with a form for editing a property.
	do_alter_property ()
	Changes the label of a property.
	do_export_main ()
	Show main menu for the Export function.
	addPlugins ()
	Add all the plugins.
	getView ($view_id, $params=FALSE)
	Get a view object.
	finish ()
	Finish the application, call this after the display() routine.
	fireDispatchStart ($trigger, $method)
	Fire off the dispatchStart() trigger.
	fireDispatchEnd ($method, &$view)
	Fire off the dispatchEnd() method.
Public Attributes
	$APP_NAME = "Admin"
	The Application name, plugins and views might need this to determine the context they are running under.
	$DISPATCH
	Dispatch table, you need to assign the KEY => method_calls to this so it knows what to run.
	$CFG
	Configuration associative array.
	$DBH
	MySQL resource link.
	$API_VERSION = "1.0"
	API_VERSION - The Version number for Plugins to use.

Detailed Description

This is the Controller for the Admin utility.

Definition at line 16 of file Admin.php.

Constructor & Destructor Documentation

GenieGate_Controller_Admin ( &$ conf )

Constructor, this creates the Controller with the given configuration.

Parameters:

$conf - Associative array of config values.

Definition at line 56 of file Admin.php.
References GenieGate_Controller::addPlugins().

Member Function Documentation

addListener ( &$ listener )

Adds a listener object.
This should be extended so that objects (such as UserAccount and Properties are also populated)

Parameters:

$listener - The Plugin object.

Reimplemented from GenieGate_Controller.
Definition at line 75 of file Admin.php.

addPlugins ( ) [inherited]

Add all the plugins.
(provided here for subclasses to use)
Subclasses should call this after they've initialized themselves for any plugins to use.
Definition at line 81 of file Controller.php.
Referenced by GenieGate_Controller_Admin(), and GenieGate_Controller_User::GenieGate_Controller_User().

do_delete_user ( )

Deletes one or more users.
UID or UID[]
Definition at line 217 of file Admin.php.
References GenieGate_Controller::getView().

do_general_search ( )

Does a general scan of users.
(for a lookup w/out specifying fields)
Definition at line 101 of file Admin.php.
References do_main(), and GenieGate_Controller::getView().

do_logout ( )

Performs the logout.

Definition at line 85 of file Admin.php.
References GenieGate_Controller::getView().

finish ( ) [inherited]

Finish the application, call this after the display() routine.

Definition at line 154 of file Controller.php.

fireDispatchEnd ( $ method,

&$ view

) [inherited]

Fire off the dispatchEnd() method.

Parameters:

$method - the method that was just run.

$view - the view that is about to be displayed.

Definition at line 175 of file Controller.php.
Referenced by GenieGate_Controller::run().

fireDispatchStart ( $ trigger,

$ method

) [inherited]

Fire off the dispatchStart() trigger.

Parameters:

$trigger - Form variable that invoked the method.

$method - The method to be run.

Definition at line 164 of file Controller.php.
Referenced by GenieGate_Controller::run().

run ( $ method = FALSE )

Run the controller.
It does this by looping through the keys in the request looking for DISPATCH keys.

Parameters:

$method - OPTIONAL, used to force a given method.

Returns:
A View object for displaying the results, or FALSE if there were no methods found.

Reimplemented from GenieGate_Controller.
Definition at line 67 of file Admin.php.
References do_main().

Member Data Documentation

$API_VERSION = "1.0" [inherited]

API_VERSION - The Version number for Plugins to use.
(optional, recommend inheriting from GenieGate_Api_Plugin)
Definition at line 41 of file Controller.php.

The documentation for this class was generated from the following file:

Admin.php

Documentation generated by DoxyGen