Docs For Class SGL

Description

Abstract model controller for all the 'manager' classes.

author: Demian Turner <demian@phpkitchen.com>
version: $Revision: 1.19 $
abstract:

Located in /SGL/Manager.php (line 49)

Variable Summary

mixed $conf

mixed $dbh

string $masterTemplate

string $pageTitle

string $sortBy

string $template

boolean $validated

array $_aActionsMapping

Method Summary

void SGL_Manager ()

void display ( &$output, SGL_Output $output)

void getConfig ()

array getDefaultPageParams ()

void handleError ( $oError, &$output)

boolean isValid ()

mixed process ( &$input, &$output, SGL_Registry $input, SGL_Output $output)

void validate (SGL_Request $req, &$input, SGL_Registry $input)

mixed _authorise (integer $mgrPerm, string $mgrName, SGL_Registry $input)

void _cmd_redirectToDefault ( &$input, &$output, SGL_Registry $input, SGL_Output $output)

void &_getDb ()

Variables

mixed $conf = array() (line 99)

mixed $dbh = null (line 100)

string $masterTemplate = 'master.html' (line 58)

Page master-template name.

access: public

string $pageTitle = 'default' (line 73)

Page title, displayed in template and HTML title tags.

access: public

string $sortBy = '' (line 89)

Sortby flag, used in child classes.

access: public

string $template = '' (line 65)

Page template name.

access: public

boolean $validated = false (line 81)

Flag indicated is Page validation passed.

access: public

array $_aActionsMapping = array() (line 97)

Array of action permitted by mgr subclass.

access: private

Methods

Constructor SGL_Manager (line 109)

Constructor.

access: public

void SGL_Manager ()

display (line 306)

Parent page display method.

Sets CSS file if supplied in request

abstract:
access: public

void display ( &$output, SGL_Output $output)

SGL_Output $output: Input object that has passed through validation
&$output

getConfig (line 139)

void getConfig ()

getDefaultPageParams (line 356)

Returns details of the module/manager/params defaults set in configuration, used for logouts and redirects.

array getDefaultPageParams ()

handleError (line 392)

void handleError ( $oError, &$output)

$oError
&$output

isValid (line 325)

Return true if child class has validated.

boolean isValid ()

process (line 166)

Super class for implementing authorisation checks, delegates specific processing to child classses.

return: true on success or PEAR_Error on failure
access: public

mixed process ( &$input, &$output, SGL_Registry $input, SGL_Output $output)

SGL_Registry $input: Input object received from validate()
SGL_Output $output: Processed result
&$input
&$output

validate (line 155)

Specific validations are implemented in sub classes.

abstract:
access: public

void validate (SGL_Request $req, &$input, SGL_Registry $input)

SGL_Request $req: SGL_Request object received from user agent
SGL_Registry $input: SGL_Registry for storing data
&$input

_authorise (line 265)

Perform authorisation on specified action methods.

return: true on success, array of class/method names on failure

mixed _authorise (integer $mgrPerm, string $mgrName, SGL_Registry $input)

integer $mgrPerm
string $mgrName
SGL_Registry $input

_cmd_redirectToDefault (line 336)

Default redirect for all Managers.

void _cmd_redirectToDefault ( &$input, &$output, SGL_Registry $input, SGL_Output $output)

SGL_Registry $input
SGL_Output $output
&$input
&$output

_getDb (line 128)

void &_getDb ()