Service/DeveloperGarden/BaseUserService.php
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: BaseUserService.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Service_DeveloperGarden_BaseUserService
- Parent(s)
- \Zend_Service_DeveloperGarden_Client_ClientAbstract
- Author
- Marco Kaiser
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants

ENV_PRODUCTION
= 1

ENV_SANDBOX
= 2

PARTICIPANT_MUTE_OFF
= 0

PARTICIPANT_MUTE_ON
= 1

PARTICIPANT_RECALL
= 2
Properties


array $_classMap = array('getQuotaInformationResponse' => 'Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse', 'changeQuotaPoolResponse' => 'Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse', 'getAccountBalanceResponse' => 'Zend_Service_DeveloperGarden_Response_BaseUserService_GetAccountBalanceResponse', 'AccountBalance' => 'Zend_Service_DeveloperGarden_BaseUserService_AccountBalance')
array('getQuotaInformationResponse' => 'Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse', 'changeQuotaPoolResponse' => 'Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse', 'getAccountBalanceResponse' => 'Zend_Service_DeveloperGarden_Response_BaseUserService_GetAccountBalanceResponse', 'AccountBalance' => 'Zend_Service_DeveloperGarden_BaseUserService_AccountBalance')
Details- Type
- array


int $_consts = null
null
Details- Type
- int
- Inherited_from
- \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_consts


\Zend_Service_DeveloperGarden_Credential $_credential = null
null
Details

array $_moduleIds = array('SmsProduction' => 'SmsProduction', 'SmsSandbox' => 'SmsSandbox', 'VoiceCallProduction' => 'VoiceButlerProduction', 'VoiceCallSandbox' => 'VoiceButlerSandbox', 'ConferenceCallProduction' => 'CCSProduction', 'ConferenceCallSandbox' => 'CCSSandbox', 'LocalSearchProduction' => 'localsearchProduction', 'LocalSearchSandbox' => 'localsearchSandbox', 'IPLocationProduction' => 'IPLocationProduction', 'IPLocationSandbox' => 'IPLocationSandbox')
array('SmsProduction' => 'SmsProduction', 'SmsSandbox' => 'SmsSandbox', 'VoiceCallProduction' => 'VoiceButlerProduction', 'VoiceCallSandbox' => 'VoiceButlerSandbox', 'ConferenceCallProduction' => 'CCSProduction', 'ConferenceCallSandbox' => 'CCSSandbox', 'LocalSearchProduction' => 'localsearchProduction', 'LocalSearchSandbox' => 'localsearchSandbox', 'IPLocationProduction' => 'IPLocationProduction', 'IPLocationSandbox' => 'IPLocationSandbox')
Details- Type
- array


array $_options = array()
array()
Details- Type
- array
- Inherited_from
- \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_options


string $_serviceAuthId = 'https://odg.t-online.de'
'https://odg.t-online.de'
Details- Type
- string
- Inherited_from
- \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_serviceAuthId


int $_serviceEnvironment = \Zend_Service_DeveloperGarden_Client_ClientAbstract::ENV_PRODUCTION
\Zend_Service_DeveloperGarden_Client_ClientAbstract::ENV_PRODUCTION
Details- Type
- int
- Inherited_from
- \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_serviceEnvironment


\Zend_Soap_Client $_soapClient = null
null
Details

boolean $_useLocalWsdl = true
true
Details- Type
- boolean
- Inherited_from
- \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_useLocalWsdl


string $_wsdlFile = 'https://gateway.developer.telekom.com/p3gw-mod-odg-admin/services/ODGBaseUserService?wsdl'
'https://gateway.developer.telekom.com/p3gw-mod-odg-admin/services/ODGBaseUserService?wsdl'
Details- Type
- string
Methods


__construct(array $options = array()) : void
constructor
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::__construct()Name | Type | Description |
---|---|---|
$options | array | Associative array of options |


_buildConstArray() : null
helper method to create const arrays
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::_buildConstArray()Type | Description |
---|---|
null |


_buildModuleString(string $module, integer $environment) : string
returns the correct module string
Name | Type | Description |
---|---|---|
$module | string | |
$environment | integer |
Type | Description |
---|---|
string |


_checkModuleId(string $moduleId) : void
checks the moduleId and throws exception if not valid
Name | Type | Description |
---|---|---|
$moduleId | string |
Exception | Description |
---|---|
\Zend_Service_DeveloperGarden_Client_Exception |


_getChangeRequestModule(string $moduleId, integer $quotaMax) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
returns the request object with the specific moduleId and new quotaMax value
Name | Type | Description |
---|---|---|
$moduleId | string | |
$quotaMax | integer |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse |


_getRequestModule(string $moduleId) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
returns the request object with the specific moduleId
Name | Type | Description |
---|---|---|
$moduleId | string |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse |


changeConferenceCallQuotaPool(integer $quotaMax = 0, integer $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse
sets new user quota for the Conference Call service
Name | Type | Description |
---|---|---|
$quotaMax | integer | |
$environment | integer |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse |


changeIPLocationQuotaPool(integer $quotaMax = 0, integer $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse
sets new user quota for the IPLocation service
Name | Type | Description |
---|---|---|
$quotaMax | integer | |
$environment | integer |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse |


changeLocalSearchQuotaPool(integer $quotaMax = 0, integer $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse
sets new user quota for the Local Search service
Name | Type | Description |
---|---|---|
$quotaMax | integer | |
$environment | integer |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse |


changeQuotaPool(\Zend_Service_DeveloperGarden_Request_BaseUserService_ChangeQuotaPool $request) : \Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse
set new quota values for the defined module
Name | Type | Description |
---|---|---|
$request | \Zend_Service_DeveloperGarden_Request_BaseUserService_ChangeQuotaPool |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse |


changeSmsQuotaPool(integer $quotaMax = 0, integer $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse
sets new user quota for the sms service
Name | Type | Description |
---|---|---|
$quotaMax | integer | |
$environment | integer |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse |


changeVoiceCallQuotaPool(integer $quotaMax = 0, integer $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse
sets new user quota for the voice call service
Name | Type | Description |
---|---|---|
$quotaMax | integer | |
$environment | integer |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse |


checkEnvironment(int $environment) : void
checks if the given environemnt is valid otherwise it @throws Zend_Service_DeveloperGarden_Client_Exception
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::checkEnvironment()Name | Type | Description |
---|---|---|
$environment | int |
Exception | Description |
---|---|
\Zend_Service_DeveloperGarden_Client_Exception |


checkParticipantAction(int $action) : void
checks if the given action is valid otherwise it @throws Zend_Service_DeveloperGarden_Exception
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::checkParticipantAction()Name | Type | Description |
---|---|---|
$action | int |
Exception | Description |
---|---|
\Zend_Service_DeveloperGarden_Client_Exception |


getAccountBalance(array $accounts = array()) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetAccountBalanceResponse
get the result for a list of accounts
Name | Type | Description |
---|---|---|
$accounts | array |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetAccountBalanceResponse |


getClientOptions() : array
returns an array with configured options for this client
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getClientOptions()Type | Description |
---|---|
array |


getConfernceCallQuotaInformation(int $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
returns the Quota Information for SMS ConferenceCall
Name | Type | Description |
---|---|---|
$environment | int |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse |


getCredential() : \Zend_Service_DeveloperGarden_Credential
returns the internal credential object
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getCredential()Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Credential |


getEnvironment() : int
returns the current configured environemnt
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getEnvironment()Type | Description |
---|---|
int |


getEnvironments() : array
returns an array of all available environments
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getEnvironments()Type | Description |
---|---|
array |


getIPLocationQuotaInformation(int $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
returns the Quota Information for IPLocation Service
Name | Type | Description |
---|---|---|
$environment | int |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse |


getLocalSearchQuotaInformation(int $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
returns the Quota Information for LocaleSearch Service
Name | Type | Description |
---|---|---|
$environment | int |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse |


getOption(string $name) : mixed
get an option value from the internal options object
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getOption()Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
mixed |


getParticipantActions() : array
returns an array of all available environments
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getParticipantActions()Type | Description |
---|---|
array |


getQuotaInformation(\Zend_Service_DeveloperGarden_Request_BaseUserService $request) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
returns the quota information
Name | Type | Description |
---|---|---|
$request | \Zend_Service_DeveloperGarden_Request_BaseUserService |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse |


getSmsQuotaInformation(int $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
returns the Quota Information for SMS Service
Name | Type | Description |
---|---|---|
$environment | int |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse |


getSoapClient() : \Zend_Service_DeveloperGarden_Client_Soap
returns the internal soap client if not allready exists we create an instance of Zend_Soap_Client
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getSoapClient()Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Client_Soap |
- Final


getVoiceCallQuotaInformation(int $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
returns the Quota Information for VoiceCall Service
Name | Type | Description |
---|---|---|
$environment | int |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse |


getWsdl() : string
returns the wsdl file path, a uri or the local path
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getWsdl()Type | Description |
---|---|
string |


setEnvironment(int $environment) : \Zend_Service_DeveloperGarden_Client_ClientAbstract
sets new environment
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::setEnvironment()Name | Type | Description |
---|---|---|
$environment | int |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Client_ClientAbstract |


setLocalWsdl(string $wsdlFile = null) : \Zend_Service_DeveloperGarden_Client_ClientAbstract
sets a new local wsdl file
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::setLocalWsdl()Name | Type | Description |
---|---|---|
$wsdlFile | string |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Client_ClientAbstract |


setOption(string $name, mixed $value) : \Zend_Service_DeveloperGarden_Client_ClientAbstract
Set an option
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::setOption()Name | Type | Description |
---|---|---|
$name | string | |
$value | mixed |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Client_ClientAbstract |
Exception | Description |
---|---|
\Zend_Service_DeveloperGarden_Client_Exception |


setUseLocalWsdl(\boolen $use = true) : \Zend_Service_DeveloperGarden_Client_ClientAbstract
switch to the local wsdl file usage
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::setUseLocalWsdl()Name | Type | Description |
---|---|---|
$use | \boolen |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Client_ClientAbstract |


setWsdl(string $wsdlFile = null) : \Zend_Service_DeveloperGarden_Client_ClientAbstract
sets a new wsdl file
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::setWsdl()Name | Type | Description |
---|---|---|
$wsdlFile | string |
Type | Description |
---|---|
\Zend_Service_DeveloperGarden_Client_ClientAbstract |