Docs For Class SGL_AjaxProvider2

Description

Abstract model controller for all the 'ajax provider' classes.

abstract:

Located in /SGL/AjaxProvider2.php (line 57)

Variable Summary

array $aMsg

array $conf

SGL_Delegator $da

DB $dbh

SGL_Request $req

integer $responseFormat

string $_actionName

string $_moduleName

Method Summary

static array handleError (PEAR_Error $oError)

static string jsonEncode (mixed $data)

SGL_AjaxProvider2 __construct ()

void process (SGL_Registry $input, SGL_Output $output)

void _getDb ()

boolean _isOwner (integer $requestedUserId)

void _raiseMsg (array $aMessage, [boolean $translate = false], [boolean $persist = false])

string _renderTemplate (SGL_Output $output, mixed $aParams)

Variables

array $aMsg = array() (line 99)

Message information passed back to client.

access: public

array $conf = array() (line 64)

Holds configuration.

access: public

SGL_Delegator $da (line 85)

Data access object.

access: public

DB $dbh (line 71)

DB abstraction layer

var: resource
access: public

SGL_Request $req (line 78)

SGL_Request.

access: public

integer $responseFormat = SGL_RESPONSEFORMAT_JSON (line 92)

Constant indicating response format.

access: public

string $_actionName (line 113)

Current action.

access: protected

string $_moduleName (line 106)

Current module.

access: protected

Methods

static handleError (line 243)

Get formatted error.

access: public

array handleError (PEAR_Error $oError)

PEAR_Error $oError

static jsonEncode (line 231)

Encode data to JSON.

access: public

string jsonEncode (mixed $data)

mixed $data

Constructor __construct (line 118)

Constructor.

access: public

SGL_AjaxProvider2 __construct ()

process (line 151)

Main workflow.

access: public

void process (SGL_Registry $input, SGL_Output $output)

SGL_Registry $input
SGL_Output $output

_getDb (line 132)

access: private

void _getDb ()

_isOwner (line 192)

Ensure the current user can perform requested action.

abstract:
access: protected

boolean _isOwner (integer $requestedUserId)

integer $requestedUserId

_raiseMsg (line 204)

Raises notification messages intended for end user.

access: protected

void _raiseMsg (array $aMessage, [boolean $translate = false], [boolean $persist = false])

boolean $translate
boolean $persist
array $aMessage: mixed string $message['message'] int $message['type'] SGL_MESSAGE_ERROR SGL_MESSAGE_INFO SGL_MESSAGE_WARNING

_renderTemplate (line 265)

Render template.

todo: do we really need to clone output object?
access: protected

string _renderTemplate (SGL_Output $output, mixed $aParams)

SGL_Output $output
mixed $aParams