Zend_Service_DeveloperGarden_Client_ClientAbstract Class Reference

Public Member Functions
	__construct (array $options=array())
	constructor
	setOption ($name, $value)
	Set an option.
	getOption ($name)
	get an option value from the internal options object
	getSoapClient ()
	returns the internal soap client if not allready exists we create an instance of Zend_Soap_Client
	setEnvironment ($environment)
	sets new environment
	getEnvironment ()
	returns the current configured environemnt
	getWsdl ()
	returns the wsdl file path, a uri or the local path
	setUseLocalWsdl ($use=true)
	switch to the local wsdl file usage
	setWsdl ($wsdlFile=null)
	sets a new wsdl file
	setLocalWsdl ($wsdlFile=null)
	sets a new local wsdl file
	getClientOptions ()
	returns an array with configured options for this client
	getCredential ()
	returns the internal credential object

Static Public Member Functions
static	getParticipantActions ()
	returns an array of all available environments
static	checkParticipantAction ($action)
	checks if the given action is valid otherwise it
static	getEnvironments ()
	returns an array of all available environments
static	checkEnvironment ($environment)
	checks if the given environemnt is valid otherwise it

Public Attributes
const	ENV_PRODUCTION = 1
	constants for using with the odg api
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 ()
	helper method to create const arrays

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

Constructor & Destructor Documentation

__construct

(

array

$options = array()

)

constructor

Parameters

array

$options

Associative array of options

Member Function Documentation

static _buildConstArray ( )

staticprotected

helper method to create const arrays

Returns

null

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

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

getClientOptions

(

)

returns an array with configured options for this client

Returns

array

getCredential

(

)

returns the internal credential object

Returns

Zend_Service_DeveloperGarden_Credential

getEnvironment

(

)

returns the current configured environemnt

Returns

int

static getEnvironments ( )

static

returns an array of all available environments

Returns

array

getOption

(

$name

)

get an option value from the internal options object

Parameters

string

$name

Returns

mixed

static getParticipantActions ( )

static

returns an array of all available environments

Returns

array

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

getWsdl

(

)

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

Returns

string

setEnvironment

(

$environment

)

sets new environment

Parameters

int

$environment

Returns

Zend_Service_DeveloperGarden_Client_ClientAbstract

setLocalWsdl

(

$wsdlFile = null

)

sets a new local wsdl file

Parameters

string

$wsdlFile

Returns

Zend_Service_DeveloperGarden_Client_ClientAbstract

setOption	(		$name,
			$value
	)

Set an option.

Parameters

string	$name
mixed	$value

Exceptions

Zend_Service_DeveloperGarden_Client_Exception

Returns

Zend_Service_DeveloperGarden_Client_ClientAbstract

setUseLocalWsdl

(

$use = true

)

switch to the local wsdl file usage

Parameters

boolen

$use

Returns

Zend_Service_DeveloperGarden_Client_ClientAbstract

setWsdl

(

$wsdlFile = null

)

sets a new wsdl file

Parameters

string

$wsdlFile

Returns

Zend_Service_DeveloperGarden_Client_ClientAbstract

Member Data Documentation

$_classMap = array()

protected

$_consts = null

staticprotected

$_credential = null

protected

$_options = array()

protected

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

protected

$_serviceEnvironment = Zend_Service_DeveloperGarden_Client_ClientAbstract::ENV_PRODUCTION

protected

$_soapClient = null

protected

$_useLocalWsdl = true

protected

$_wsdlFile = null

protected

$_wsdlFileLocal = null

protected

const ENV_MOCK = 3

const ENV_PRODUCTION = 1

constants for using with the odg api

const ENV_SANDBOX = 2

const PARTICIPANT_MUTE_OFF = 0

const PARTICIPANT_MUTE_ON = 1

const PARTICIPANT_RECALL = 2