Docs For Class SGL_AjaxProvider

Description

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

author: Dmitri Lakachauskis <lakiboy83@gmail.com>
author: Julien Casanova <julien@soluo.fr>
abstract:

Located in /SGL/AjaxProvider.php (line 56)

Variable Summary

array $aMsg

array $conf

DB $dbh

integer $responseFormat

Method Summary

SGL_AjaxProvider SGL_AjaxProvider ()

mixed getAuthResourceId ()

void handleError ( $oError)

boolean isOwner (mixed $resourseId, integer $userId)

void jsonEncode ( $data)

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

void &singleton ()

void &_getDb ()

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

Variables

array $aMsg = array() (line 84)

Array for messages passed back to client

array $conf = array() (line 63)

Holds configuration

DB $dbh = null (line 70)

DB abstract layer

var: resource

integer $responseFormat = SGL_RESPONSEFORMAT_HTML (line 77)

Constant indicating response format

Methods

Constructor SGL_AjaxProvider (line 91)

Constructor.

access: public

SGL_AjaxProvider SGL_AjaxProvider ()

getAuthResourceId (line 190)

Get resource ID.

abstract:

mixed getAuthResourceId ()

handleError (line 231)

void handleError ( $oError)

$oError

isOwner (line 178)

Authorisation routine.

abstract:

boolean isOwner (mixed $resourseId, integer $userId)

mixed $resourseId
integer $userId

jsonEncode (line 219)

void jsonEncode ( $data)

$data

process (line 133)

Main routine of processing ajax requests.

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

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

singleton (line 100)

void &singleton ()

_getDb (line 114)

void &_getDb ()

_raiseMsg (line 205)

Raises notification messages intended for end user.

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

array $message: with string $message['message'] with int $message['messageType'] SGL_MESSAGE_ERROR | SGL_MESSAGE_INFO | SGL_MESSAGE_WARNING
boolean $persist
boolean $translate
$aMessage