Moodle  2.2.1
http://www.collinsharper.com
Zend_Service_DeveloperGarden_Client_ClientAbstract Class Reference
Inheritance diagram for Zend_Service_DeveloperGarden_Client_ClientAbstract:

Public Member Functions

 __construct (array $options=array())
 setOption ($name, $value)
 getOption ($name)
 getSoapClient ()
 setEnvironment ($environment)
 getEnvironment ()
 getWsdl ()
 setUseLocalWsdl ($use=true)
 setWsdl ($wsdlFile=null)
 setLocalWsdl ($wsdlFile=null)
 getClientOptions ()
 getCredential ()

Static Public Member Functions

static getParticipantActions ()
static checkParticipantAction ($action)
static getEnvironments ()
static checkEnvironment ($environment)

Data Fields

const ENV_PRODUCTION = 1
const ENV_SANDBOX = 2
const ENV_MOCK = 3
const PARTICIPANT_MUTE_OFF = 0
const PARTICIPANT_MUTE_ON = 1
const PARTICIPANT_RECALL = 2

Static Protected Member Functions

static _buildConstArray ()

Protected Attributes

 $_options = array()
 $_serviceAuthId = 'https://odg.t-online.de'
 $_serviceEnvironment = Zend_Service_DeveloperGarden_Client_ClientAbstract::ENV_PRODUCTION
 $_wsdlFile = null
 $_wsdlFileLocal = null
 $_useLocalWsdl = true
 $_credential = null
 $_soapClient = null
 $_classMap = array()

Static Protected Attributes

static $_consts = null

Detailed Description

Definition at line 46 of file ClientAbstract.php.


Constructor & Destructor Documentation

__construct ( array options = array())

constructor

Parameters:
array$optionsAssociative array of options

Definition at line 134 of file ClientAbstract.php.

Here is the call graph for this function:


Member Function Documentation

static _buildConstArray ( ) [static, protected]

helper method to create const arrays

Returns:
null

Definition at line 357 of file ClientAbstract.php.

Here is the caller graph for this function:

static checkEnvironment ( environment) [static]

checks if the given environemnt is valid otherwise it

Exceptions:
Zend_Service_DeveloperGarden_Client_Exception
Parameters:
int$environment
Exceptions:
Zend_Service_DeveloperGarden_Client_Exception
Returns:
void

Definition at line 421 of file ClientAbstract.php.

Here is the caller graph for this function:

static checkParticipantAction ( action) [static]

checks if the given action is valid otherwise it

Exceptions:
Zend_Service_DeveloperGarden_Exception
Parameters:
int$action
Exceptions:
Zend_Service_DeveloperGarden_Client_Exception
Returns:
void

Definition at line 390 of file ClientAbstract.php.

Here is the caller graph for this function:

returns an array with configured options for this client

Returns:
array

Definition at line 328 of file ClientAbstract.php.

Here is the call graph for this function:

Here is the caller graph for this function:

returns the internal credential object

Returns:
Zend_Service_DeveloperGarden_Credential

Definition at line 348 of file ClientAbstract.php.

returns the current configured environemnt

Returns:
int

Definition at line 258 of file ClientAbstract.php.

Here is the caller graph for this function:

static getEnvironments ( ) [static]

returns an array of all available environments

Returns:
array

Definition at line 405 of file ClientAbstract.php.

Here is the call graph for this function:

getOption ( name)

get an option value from the internal options object

Parameters:
string$name
Returns:
mixed

Definition at line 197 of file ClientAbstract.php.

static getParticipantActions ( ) [static]

returns an array of all available environments

Returns:
array

Definition at line 374 of file ClientAbstract.php.

Here is the call graph for this function:

getSoapClient ( ) [final]

returns the internal soap client if not allready exists we create an instance of Zend_Soap_Client

Returns:
Zend_Service_DeveloperGarden_Client_Soap

init the soapClient

Definition at line 215 of file ClientAbstract.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getWsdl ( )

returns the wsdl file path, a uri or the local path

Returns:
string

Definition at line 268 of file ClientAbstract.php.

Here is the caller graph for this function:

setEnvironment ( environment)

sets new environment

Parameters:
int$environment
Returns:
Zend_Service_DeveloperGarden_Client_ClientAbstract

Definition at line 246 of file ClientAbstract.php.

Here is the call graph for this function:

Here is the caller graph for this function:

setLocalWsdl ( wsdlFile = null)

sets a new local wsdl file

Parameters:
string$wsdlFile
Returns:
Zend_Service_DeveloperGarden_Client_ClientAbstract

Definition at line 313 of file ClientAbstract.php.

setOption ( name,
value 
)

Set an option

Parameters:
string$name
mixed$value
Exceptions:
Zend_Service_DeveloperGarden_Client_Exception
Returns:
Zend_Service_DeveloperGarden_Client_ClientAbstract

Definition at line 177 of file ClientAbstract.php.

setUseLocalWsdl ( use = true)

switch to the local wsdl file usage

Parameters:
boolen$use
Returns:
Zend_Service_DeveloperGarden_Client_ClientAbstract

Definition at line 285 of file ClientAbstract.php.

setWsdl ( wsdlFile = null)

sets a new wsdl file

Parameters:
string$wsdlFile
Returns:
Zend_Service_DeveloperGarden_Client_ClientAbstract

Definition at line 297 of file ClientAbstract.php.


Field Documentation

$_consts = null [static, protected]

Definition at line 64 of file ClientAbstract.php.

$_credential = null [protected]

Definition at line 113 of file ClientAbstract.php.

$_options = array() [protected]

Definition at line 71 of file ClientAbstract.php.

$_serviceAuthId = 'https://odg.t-online.de' [protected]

Definition at line 78 of file ClientAbstract.php.

Definition at line 85 of file ClientAbstract.php.

$_soapClient = null [protected]

Definition at line 120 of file ClientAbstract.php.

$_useLocalWsdl = true [protected]

Definition at line 106 of file ClientAbstract.php.

const ENV_MOCK = 3

Definition at line 53 of file ClientAbstract.php.

const ENV_PRODUCTION = 1

constants for using with the odg api

Definition at line 51 of file ClientAbstract.php.

const ENV_SANDBOX = 2

Definition at line 52 of file ClientAbstract.php.

Definition at line 55 of file ClientAbstract.php.

Definition at line 56 of file ClientAbstract.php.

const PARTICIPANT_RECALL = 2

Definition at line 57 of file ClientAbstract.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations