Service/DeveloperGarden/Client/ClientAbstract.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service
subpackage: DeveloperGarden
version: $Id: ClientAbstract.php 20419 2010-01-19 13:20:12Z bate $
Classes: Zend_Service_DeveloperGarden_Client_ClientAbstract

Description

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.

Zend_Service_DeveloperGarden_Client_ClientAbstract
jump to top

author: Marco Kaiser
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service
subpackage: DeveloperGarden
Constants: ENV_PRODUCTION; ENV_SANDBOX; ENV_MOCK; PARTICIPANT_MUTE_OFF; PARTICIPANT_MUTE_ON; PARTICIPANT_RECALL
Properties: $_consts; $_options; $_serviceAuthId; $_serviceEnvironment; $_wsdlFile; $_wsdlFileLocal; $_useLocalWsdl; $_credential; $_soapClient; $_classMap
Methods: __construct; setOption; getOption; getSoapClient; setEnvironment; getEnvironment; getWsdl; setUseLocalWsdl; setWsdl; setLocalWsdl; getClientOptions; getCredential; _buildConstArray; getParticipantActions; checkParticipantAction; getEnvironments; checkEnvironment

Description

Constants

ENV_PRODUCTION
jump to class

 ENV_PRODUCTION = '1'

constants for using with the odg api

Details

value: 1

ENV_SANDBOX
jump to class

 ENV_SANDBOX = '2'

Details

value: 2

ENV_MOCK
jump to class

 ENV_MOCK = '3'

Details

value: 3

PARTICIPANT_MUTE_OFF
jump to class

 PARTICIPANT_MUTE_OFF = '0'

Details

value: 0

PARTICIPANT_MUTE_ON
jump to class

 PARTICIPANT_MUTE_ON = '1'

Details

value: 1

PARTICIPANT_RECALL
jump to class

 PARTICIPANT_RECALL = '2'

Details

value: 2

Properties

$_classMap
jump to class

array $_classMap = 'array'

array with options for classmapping

Details

$_classMap: array
visibility: protected
default: array
final: false
static: false

$_consts
jump to class

int $_consts = 'null'

array of all possible env types

Details

$_consts: int
visibility: protected
default: null
final: false
static: true

$_credential
jump to class

Zend_Service_DeveloperGarden_Credential $_credential = 'null'

class with credentials

Details

$_credential: Zend_Service_DeveloperGarden_Credential
visibility: protected
default: null
final: false
static: false

$_options
jump to class

array $_options = 'array'

Available options

Details

$_options: array
available options
visibility: protected
default: array
final: false
static: false

$_serviceAuthId
jump to class

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

The service id to generate the auth service token

Details

$_serviceAuthId: string
visibility: protected
default: https://odg.t-online.de
final: false
static: false

$_serviceEnvironment
jump to class

int $_serviceEnvironment = 'Zend_Service_DeveloperGarden_Client_ClientAbstract'

Variable that holds the Zend_Service_DeveloperGarden env value

Details

$_serviceEnvironment: int
visibility: protected
default: Zend_Service_DeveloperGarden_Client_ClientAbstract
final: false
static: false

$_soapClient
jump to class

Zend_Soap_Client $_soapClient = 'null'

The internal Soap Client

Details

$_soapClient: Zend_Soap_Client
visibility: protected
default: null
final: false
static: false

$_useLocalWsdl
jump to class

boolean $_useLocalWsdl = 'true'

should we use the local wsdl file?

Details

$_useLocalWsdl: boolean
visibility: protected
default: true
final: false
static: false

$_wsdlFile
jump to class

string $_wsdlFile = 'null'

wsdl file

Details

$_wsdlFile: string
visibility: protected
default: null
final: false
static: false

$_wsdlFileLocal
jump to class

string $_wsdlFileLocal = 'null'

the local wsdlFile

Details

$_wsdlFileLocal: string
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
          array $options
              =
              array
          )
        
        :

constructor

Arguments

$options: array
Associative array of options

Details

visibility: public
final: false
static: false

_buildConstArray
jump to class

_buildConstArray(
          
          )
        
        :
        null

helper method to create const arrays

Output

null

Details

visibility: protected
final: false
static: true

checkEnvironment
jump to class

checkEnvironment(
          int $environment
          )
        
        :
        void

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

Arguments

$environment: int

Details

visibility: public
final: false
static: true
throws

checkParticipantAction
jump to class

checkParticipantAction(
          int $action
          )
        
        :
        void

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

Arguments

$action: int

Details

visibility: public
final: false
static: true
throws

getClientOptions
jump to class

getClientOptions(
          
          )
        
        :
        array

returns an array with configured options for this client

Output

array

Details

visibility: public
final: false
static: false

getCredential
jump to class

getCredential(
          
          )
        
        :
        Zend_Service_DeveloperGarden_Credential

returns the internal credential object

Output

Zend_Service_DeveloperGarden_Credential

Details

visibility: public
final: false
static: false

getEnvironment
jump to class

getEnvironment(
          
          )
        
        :
        int

returns the current configured environemnt

Output

int

Details

visibility: public
final: false
static: false

getEnvironments
jump to class

getEnvironments(
          
          )
        
        :
        array

returns an array of all available environments

Output

array

Details

visibility: public
final: false
static: true

getOption
jump to class

getOption(
          string $name
          )
        
        :
        mixed

get an option value from the internal options object

Arguments

$name: string

Output

mixed

Details

visibility: public
final: false
static: false

getParticipantActions
jump to class

getParticipantActions(
          
          )
        
        :
        array

returns an array of all available environments

Output

array

Details

visibility: public
final: false
static: true

getSoapClient
jump to class

getSoapClient(
          
          )
        
        :
        Zend_Service_DeveloperGarden_Client_Soap

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

Output

Zend_Service_DeveloperGarden_Client_Soap

Details

visibility: public
final: true
static: false
final

getWsdl
jump to class

getWsdl(
          
          )
        
        :
        string

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

Output

string

Details

visibility: public
final: false
static: false

setEnvironment
jump to class

setEnvironment(
          int $environment
          )
        
        :
        Zend_Service_DeveloperGarden_Client_ClientAbstract

sets new environment

Arguments

$environment: int

Output

Zend_Service_DeveloperGarden_Client_ClientAbstract

Details

visibility: public
final: false
static: false

setLocalWsdl
jump to class

setLocalWsdl(
          string $wsdlFile
              =
              null
          )
        
        :
        Zend_Service_DeveloperGarden_Client_ClientAbstract

sets a new local wsdl file

Arguments

$wsdlFile: string

Output

Zend_Service_DeveloperGarden_Client_ClientAbstract

Details

visibility: public
final: false
static: false

setOption
jump to class

setOption(
          string $name, mixed $value
          )
        
        :
        Zend_Service_DeveloperGarden_Client_ClientAbstract

Set an option

Arguments

$name: string
$value: mixed

Output

Zend_Service_DeveloperGarden_Client_ClientAbstract

Details

visibility: public
final: false
static: false
throws

setUseLocalWsdl
jump to class

setUseLocalWsdl(
          boolen $use
              =
              true
          )
        
        :
        Zend_Service_DeveloperGarden_Client_ClientAbstract

switch to the local wsdl file usage

Arguments

$use: boolen

Output

Zend_Service_DeveloperGarden_Client_ClientAbstract

Details

visibility: public
final: false
static: false

setWsdl
jump to class

setWsdl(
          string $wsdlFile
              =
              null
          )
        
        :
        Zend_Service_DeveloperGarden_Client_ClientAbstract

sets a new wsdl file

Arguments

$wsdlFile: string

Output

Zend_Service_DeveloperGarden_Client_ClientAbstract

Details

visibility: public
final: false
static: false

API Documentation

Service/DeveloperGarden/Client/ClientAbstract.php

Description

Zend_Service_DeveloperGarden_Client_ClientAbstractjump to top

Description

Constants

ENV_PRODUCTIONjump to class

Details

ENV_SANDBOXjump to class

Details

ENV_MOCKjump to class

Details

PARTICIPANT_MUTE_OFFjump to class

Details

PARTICIPANT_MUTE_ONjump to class

Details

PARTICIPANT_RECALLjump to class

Details

Properties

$_classMapjump to class

Details

$_constsjump to class

Details

$_credentialjump to class

Details

$_optionsjump to class

Details

$_serviceAuthIdjump to class

Details

$_serviceEnvironmentjump to class

Details

$_soapClientjump to class

Details

$_useLocalWsdljump to class

Details

$_wsdlFilejump to class

Details

$_wsdlFileLocaljump to class

Details

Methods

__constructjump to class

Arguments

Details

_buildConstArrayjump to class

Output

Details

checkEnvironmentjump to class

Arguments

Details

checkParticipantActionjump to class

Arguments

Details

getClientOptionsjump to class

Output

Details

getCredentialjump to class

Output

Details

getEnvironmentjump to class

Output

Details

getEnvironmentsjump to class

Output

Details

getOptionjump to class

Arguments

Output

Details

getParticipantActionsjump to class

Output

Details

getSoapClientjump to class

Output

Details

getWsdljump to class

Output

Details

setEnvironmentjump to class

Arguments

Output

Zend_Service_DeveloperGarden_Client_ClientAbstract
jump to top

ENV_PRODUCTION
jump to class

ENV_SANDBOX
jump to class

ENV_MOCK
jump to class

PARTICIPANT_MUTE_OFF
jump to class

PARTICIPANT_MUTE_ON
jump to class

PARTICIPANT_RECALL
jump to class

$_classMap
jump to class

$_consts
jump to class

$_credential
jump to class

$_options
jump to class

$_serviceAuthId
jump to class

$_serviceEnvironment
jump to class

$_soapClient
jump to class

$_useLocalWsdl
jump to class

$_wsdlFile
jump to class

$_wsdlFileLocal
jump to class

__construct
jump to class

_buildConstArray
jump to class

checkEnvironment
jump to class

checkParticipantAction
jump to class

getClientOptions
jump to class

getCredential
jump to class

getEnvironment
jump to class

getEnvironments
jump to class

getOption
jump to class

getParticipantActions
jump to class

getSoapClient
jump to class

getWsdl
jump to class

setEnvironment
jump to class

setLocalWsdl
jump to class

setOption
jump to class

setUseLocalWsdl
jump to class

setWsdl
jump to class