API Documentation

Zend/Service/DeveloperGarden/Client/ClientAbstract.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service  
Subpackage
DeveloperGarden  
Version
$Id: ClientAbstract.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Service_DeveloperGarden_Client_ClientAbstract

Package: Zend\Service\DeveloperGarden

Children
\Zend_Service_DeveloperGarden_LocalSearch
\Zend_Service_DeveloperGarden_SendSms
\Zend_Service_DeveloperGarden_VoiceCall
\Zend_Service_DeveloperGarden_SecurityTokenServer
\Zend_Service_DeveloperGarden_SmsValidation
\Zend_Service_DeveloperGarden_ConferenceCall
\Zend_Service_DeveloperGarden_IpLocation
\Zend_Service_DeveloperGarden_BaseUserService
Author
Marco Kaiser  
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  ENV_PRODUCTION = 1

constants for using with the odg api

Constant  ENV_SANDBOX = 2
Constant  ENV_MOCK = 3
Constant  PARTICIPANT_MUTE_OFF = 0
Constant  PARTICIPANT_MUTE_ON = 1
Constant  PARTICIPANT_RECALL = 2

Properties

Propertyprotectedarray  $_classMap= 'array()'

array with options for classmapping

Default valuearray()Details
Type
array
Propertyprotectedint  $_consts= 'null'
static

array of all possible env types

Default valuenullDetails
Type
int
Propertyprotected\Zend_Service_DeveloperGarden_Credential  $_credential= 'null'

class with credentials

Default valuenullDetails
Type
\Zend_Service_DeveloperGarden_Credential
Propertyprotectedarray  $_options= 'array()'

Available options

available options
Default valuearray()Details
Type
array
Propertyprotectedstring  $_serviceAuthId= ''https://odg.t-online.de''

The service id to generate the auth service token

Default value'https://odg.t-online.de'Details
Type
string
Propertyprotectedint  $_serviceEnvironment= 'Zend_Service_DeveloperGarden_Client_ClientAbstract::ENV_PRODUCTION'

Variable that holds the Zend_Service_DeveloperGarden env value

Default valueZend_Service_DeveloperGarden_Client_ClientAbstract::ENV_PRODUCTIONDetails
Type
int
Propertyprotected\Zend_Soap_Client  $_soapClient= 'null'

The internal Soap Client

Default valuenullDetails
Type
\Zend_Soap_Client
Propertyprotectedboolean  $_useLocalWsdl= 'true'

should we use the local wsdl file?

Default valuetrueDetails
Type
boolean
Propertyprotectedstring  $_wsdlFile= 'null'

wsdl file

Default valuenullDetails
Type
string
Propertyprotectedstring  $_wsdlFileLocal= 'null'

the local wsdlFile

Default valuenullDetails
Type
string

Methods

methodpublic__construct( array $options = array() ) : void

constructor

Parameters
Name Type Description
$options array

Associative array of options

methodprotected_buildConstArray( ) : null
static

helper method to create const arrays

Returns
Type Description
null
methodpubliccheckEnvironment( int $environment ) : void
static

checks if the given environemnt is valid otherwise it @throws Zend_Service_DeveloperGarden_Client_Exception

Parameters
Name Type Description
$environment int
Throws
Exception Description
\Zend_Service_DeveloperGarden_Client_Exception
methodpubliccheckParticipantAction( int $action ) : void
static

checks if the given action is valid otherwise it @throws Zend_Service_DeveloperGarden_Exception

Parameters
Name Type Description
$action int
Throws
Exception Description
\Zend_Service_DeveloperGarden_Client_Exception
methodpublicgetClientOptions( ) : array

returns an array with configured options for this client

Returns
Type Description
array
methodpublicgetCredential( ) : \Zend_Service_DeveloperGarden_Credential

returns the internal credential object

Returns
Type Description
\Zend_Service_DeveloperGarden_Credential
methodpublicgetEnvironment( ) : int

returns the current configured environemnt

Returns
Type Description
int
methodpublicgetEnvironments( ) : array
static

returns an array of all available environments

Returns
Type Description
array
methodpublicgetOption( string $name ) : mixed

get an option value from the internal options object

Parameters
Name Type Description
$name string
Returns
Type Description
mixed
methodpublicgetParticipantActions( ) : array
static

returns an array of all available environments

Returns
Type Description
array
methodpublicgetSoapClient( ) : \Zend_Service_DeveloperGarden_Client_Soap
final

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

Returns
Type Description
\Zend_Service_DeveloperGarden_Client_Soap
Details
Final
 
methodpublicgetWsdl( ) : string

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

Returns
Type Description
string
methodpublicsetEnvironment( int $environment ) : \Zend_Service_DeveloperGarden_Client_ClientAbstract

sets new environment

Parameters
Name Type Description
$environment int
Returns
Type Description
\Zend_Service_DeveloperGarden_Client_ClientAbstract
methodpublicsetLocalWsdl( string $wsdlFile = null ) : \Zend_Service_DeveloperGarden_Client_ClientAbstract

sets a new local wsdl file

Parameters
Name Type Description
$wsdlFile string
Returns
Type Description
\Zend_Service_DeveloperGarden_Client_ClientAbstract
methodpublicsetOption( string $name, mixed $value ) : \Zend_Service_DeveloperGarden_Client_ClientAbstract

Set an option

Parameters
Name Type Description
$name string
$value mixed
Returns
Type Description
\Zend_Service_DeveloperGarden_Client_ClientAbstract
Throws
Exception Description
\Zend_Service_DeveloperGarden_Client_Exception
methodpublicsetUseLocalWsdl( \boolen $use = true ) : \Zend_Service_DeveloperGarden_Client_ClientAbstract

switch to the local wsdl file usage

Parameters
Name Type Description
$use \boolen
Returns
Type Description
\Zend_Service_DeveloperGarden_Client_ClientAbstract
methodpublicsetWsdl( string $wsdlFile = null ) : \Zend_Service_DeveloperGarden_Client_ClientAbstract

sets a new wsdl file

Parameters
Name Type Description
$wsdlFile string
Returns
Type Description
\Zend_Service_DeveloperGarden_Client_ClientAbstract
Documentation was generated by DocBlox 0.15.1.