Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Service_DeveloperGarden_BaseUserService Class Reference

Public Member Functions

 getModuleIds ()
 returns an array with all possible ModuleIDs
 
 getSmsQuotaInformation ($environment=self::ENV_PRODUCTION)
 returns the Quota Information for SMS Service
 
 getVoiceCallQuotaInformation ($environment=self::ENV_PRODUCTION)
 returns the Quota Information for VoiceCall Service
 
 getConfernceCallQuotaInformation ($environment=self::ENV_PRODUCTION)
 returns the Quota Information for SMS ConferenceCall
 
 getLocalSearchQuotaInformation ($environment=self::ENV_PRODUCTION)
 returns the Quota Information for LocaleSearch Service
 
 getIPLocationQuotaInformation ($environment=self::ENV_PRODUCTION)
 returns the Quota Information for IPLocation Service
 
 getQuotaInformation (Zend_Service_DeveloperGarden_Request_BaseUserService_GetQuotaInformation $request)
 returns the quota information
 
 changeSmsQuotaPool ($quotaMax=0, $environment=self::ENV_PRODUCTION)
 sets new user quota for the sms service
 
 changeVoiceCallQuotaPool ($quotaMax=0, $environment=self::ENV_PRODUCTION)
 sets new user quota for the voice call service
 
 changeIPLocationQuotaPool ($quotaMax=0, $environment=self::ENV_PRODUCTION)
 sets new user quota for the IPLocation service
 
 changeConferenceCallQuotaPool ($quotaMax=0, $environment=self::ENV_PRODUCTION)
 sets new user quota for the Conference Call service
 
 changeLocalSearchQuotaPool ($quotaMax=0, $environment=self::ENV_PRODUCTION)
 sets new user quota for the Local Search service
 
 changeQuotaPool (Zend_Service_DeveloperGarden_Request_BaseUserService_ChangeQuotaPool $request)
 set new quota values for the defined module
 
 getAccountBalance (array $accounts=array())
 get the result for a list of accounts
 
- Public Member Functions inherited from Zend_Service_DeveloperGarden_Client_ClientAbstract
 __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
 

Protected Member Functions

 _checkModuleId ($moduleId)
 checks the moduleId and throws exception if not valid
 
 _buildModuleString ($module, $environment)
 returns the correct module string
 
 _getRequestModule ($moduleId)
 returns the request object with the specific moduleId
 
 _getChangeRequestModule ($moduleId, $quotaMax)
 returns the request object with the specific moduleId and new quotaMax value
 

Protected Attributes

 $_wsdlFile = 'https://gateway.developer.telekom.com/p3gw-mod-odg-admin/services/ODGBaseUserService?wsdl'
 
 $_wsdlFileLocal = 'Wsdl/ODGBaseUserService.wsdl'
 
 $_classMap
 
 $_moduleIds
 
- Protected Attributes inherited from Zend_Service_DeveloperGarden_Client_ClientAbstract
 $_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()
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Service_DeveloperGarden_Client_ClientAbstract
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 inherited from Zend_Service_DeveloperGarden_Client_ClientAbstract
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 inherited from Zend_Service_DeveloperGarden_Client_ClientAbstract
static _buildConstArray ()
 helper method to create const arrays
 
- Static Protected Attributes inherited from Zend_Service_DeveloperGarden_Client_ClientAbstract
static $_consts = null
 

Member Function Documentation

_buildModuleString (   $module,
  $environment 
)
protected

returns the correct module string

Parameters
string$module
integer$environment
Returns
string
_checkModuleId (   $moduleId)
protected

checks the moduleId and throws exception if not valid

Parameters
string$moduleId
Exceptions
Zend_Service_DeveloperGarden_Client_Exception
Returns
void
_getChangeRequestModule (   $moduleId,
  $quotaMax 
)
protected

returns the request object with the specific moduleId and new quotaMax value

Parameters
string$moduleId
integer$quotaMax
Returns
Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
_getRequestModule (   $moduleId)
protected

returns the request object with the specific moduleId

Parameters
string$moduleId
Returns
Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
changeConferenceCallQuotaPool (   $quotaMax = 0,
  $environment = self::ENV_PRODUCTION 
)

sets new user quota for the Conference Call service

Parameters
integer$quotaMax
integer$environment
Returns
Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse
changeIPLocationQuotaPool (   $quotaMax = 0,
  $environment = self::ENV_PRODUCTION 
)

sets new user quota for the IPLocation service

Parameters
integer$quotaMax
integer$environment
Returns
Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse
changeLocalSearchQuotaPool (   $quotaMax = 0,
  $environment = self::ENV_PRODUCTION 
)

sets new user quota for the Local Search service

Parameters
integer$quotaMax
integer$environment
Returns
Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse
changeSmsQuotaPool (   $quotaMax = 0,
  $environment = self::ENV_PRODUCTION 
)

sets new user quota for the sms service

Parameters
integer$quotaMax
integer$environment
Returns
Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse
changeVoiceCallQuotaPool (   $quotaMax = 0,
  $environment = self::ENV_PRODUCTION 
)

sets new user quota for the voice call service

Parameters
integer$quotaMax
integer$environment
Returns
Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse
getAccountBalance ( array  $accounts = array())

get the result for a list of accounts

Parameters
array$accounts
Returns
Zend_Service_DeveloperGarden_Response_BaseUserService_GetAccountBalanceResponse
getConfernceCallQuotaInformation (   $environment = self::ENV_PRODUCTION)

returns the Quota Information for SMS ConferenceCall

Parameters
int$environment
Returns
Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
getIPLocationQuotaInformation (   $environment = self::ENV_PRODUCTION)

returns the Quota Information for IPLocation Service

Parameters
int$environment
Returns
Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
getLocalSearchQuotaInformation (   $environment = self::ENV_PRODUCTION)

returns the Quota Information for LocaleSearch Service

Parameters
int$environment
Returns
Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
getModuleIds ( )

returns an array with all possible ModuleIDs

Returns
array

returns the quota information

Parameters
Zend_Service_DeveloperGarden_Request_BaseUserService$request
Returns
Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
getSmsQuotaInformation (   $environment = self::ENV_PRODUCTION)

returns the Quota Information for SMS Service

Parameters
int$environment
Returns
Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
getVoiceCallQuotaInformation (   $environment = self::ENV_PRODUCTION)

returns the Quota Information for VoiceCall Service

Parameters
int$environment
Returns
Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse

Member Data Documentation

$_classMap
protected
Initial value:
= 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',
)
$_moduleIds
protected
Initial value:
= array(
'SmsProduction' => 'SmsProduction',
'SmsSandbox' => 'SmsSandbox',
'VoiceCallProduction' => 'VoiceButlerProduction',
'VoiceCallSandbox' => 'VoiceButlerSandbox',
'ConferenceCallProduction' => 'CCSProduction',
'ConferenceCallSandbox' => 'CCSSandbox',
'LocalSearchProduction' => 'localsearchProduction',
'LocalSearchSandbox' => 'localsearchSandbox',
'IPLocationProduction' => 'IPLocationProduction',
'IPLocationSandbox' => 'IPLocationSandbox'
)
$_wsdlFile = 'https://gateway.developer.telekom.com/p3gw-mod-odg-admin/services/ODGBaseUserService?wsdl'
protected
$_wsdlFileLocal = 'Wsdl/ODGBaseUserService.wsdl'
protected