Service/DeveloperGarden/BaseUserService.php

Show: PublicProtectedPrivateinherited
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: BaseUserService.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Service_DeveloperGarden_BaseUserService

Package: Zend\Service\DeveloperGarden
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

>VConstant  ENV_PRODUCTION = 1
inherited
constants for using with the odg api
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::ENV_PRODUCTION

Properties

>VPropertyprotectedarray $_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')
Response, Request Classmapping
Default valuearray('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
>VPropertyprotectedint $_consts = null
staticinherited
array of all possible env types
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_consts
Default valuenullDetails
Type
int
Inherited_from
\Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_consts  
>VPropertyprotected\Zend_Service_DeveloperGarden_Credential $_credential = null
inherited
class with credentials
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_credential
>VPropertyprotectedarray $_moduleIds = array('SmsProduction' => 'SmsProduction', 'SmsSandbox' => 'SmsSandbox', 'VoiceCallProduction' => 'VoiceButlerProduction', 'VoiceCallSandbox' => 'VoiceButlerSandbox', 'ConferenceCallProduction' => 'CCSProduction', 'ConferenceCallSandbox' => 'CCSSandbox', 'LocalSearchProduction' => 'localsearchProduction', 'LocalSearchSandbox' => 'localsearchSandbox', 'IPLocationProduction' => 'IPLocationProduction', 'IPLocationSandbox' => 'IPLocationSandbox')
array with all QuotaModuleIds
Default valuearray('SmsProduction' => 'SmsProduction', 'SmsSandbox' => 'SmsSandbox', 'VoiceCallProduction' => 'VoiceButlerProduction', 'VoiceCallSandbox' => 'VoiceButlerSandbox', 'ConferenceCallProduction' => 'CCSProduction', 'ConferenceCallSandbox' => 'CCSSandbox', 'LocalSearchProduction' => 'localsearchProduction', 'LocalSearchSandbox' => 'localsearchSandbox', 'IPLocationProduction' => 'IPLocationProduction', 'IPLocationSandbox' => 'IPLocationSandbox')Details
Type
array
>VPropertyprotectedarray $_options = array()
inherited
Available options
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_options
Default valuearray()Details
Type
array
Inherited_from
\Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_options  
>VPropertyprotectedstring $_serviceAuthId = 'https://odg.t-online.de'
inherited
The service id to generate the auth service token
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_serviceAuthId
Default value'https://odg.t-online.de'Details
Type
string
Inherited_from
\Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_serviceAuthId  
>VPropertyprotectedint $_serviceEnvironment = \Zend_Service_DeveloperGarden_Client_ClientAbstract::ENV_PRODUCTION
inherited
Variable that holds the Zend_Service_DeveloperGarden env value
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_serviceEnvironment
Default value\Zend_Service_DeveloperGarden_Client_ClientAbstract::ENV_PRODUCTIONDetails
Type
int
Inherited_from
\Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_serviceEnvironment  
>VPropertyprotected\Zend_Soap_Client $_soapClient = null
inherited
The internal Soap Client
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_soapClient
>VPropertyprotectedboolean $_useLocalWsdl = true
inherited
should we use the local wsdl file?
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_useLocalWsdl
Default valuetrueDetails
Type
boolean
Inherited_from
\Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_useLocalWsdl  
>VPropertyprotectedstring $_wsdlFile = 'https://gateway.developer.telekom.com/p3gw-mod-odg-admin/services/ODGBaseUserService?wsdl'
wsdl file
Default value'https://gateway.developer.telekom.com/p3gw-mod-odg-admin/services/ODGBaseUserService?wsdl'Details
Type
string
>VPropertyprotectedstring $_wsdlFileLocal = 'Wsdl/ODGBaseUserService.wsdl'
wsdl file local
Default value'Wsdl/ODGBaseUserService.wsdl'Details
Type
string

Methods

methodpublic__construct(array $options = array()) : void
Parameters
NameTypeDescription
$optionsarray

Associative array of options

methodprotected_buildConstArray() : null
staticinherited

helper method to create const arrays

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::_buildConstArray()
Returns
TypeDescription
null
methodprotected_buildModuleString(string $module, integer $environment) : string

returns the correct module string

Parameters
NameTypeDescription
$modulestring
$environmentinteger
Returns
TypeDescription
string
methodprotected_checkModuleId(string $moduleId) : void

checks the moduleId and throws exception if not valid

Parameters
NameTypeDescription
$moduleIdstring
Throws
ExceptionDescription
\Zend_Service_DeveloperGarden_Client_Exception
methodprotected_getChangeRequestModule(string $moduleId, integer $quotaMax) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse

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

Parameters
NameTypeDescription
$moduleIdstring
$quotaMaxinteger
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
methodprotected_getRequestModule(string $moduleId) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse

returns the request object with the specific moduleId

Parameters
NameTypeDescription
$moduleIdstring
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
methodpublicchangeConferenceCallQuotaPool(integer $quotaMax = 0, integer $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse

sets new user quota for the Conference Call service

Parameters
NameTypeDescription
$quotaMaxinteger
$environmentinteger
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse
methodpublicchangeIPLocationQuotaPool(integer $quotaMax = 0, integer $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse

sets new user quota for the IPLocation service

Parameters
NameTypeDescription
$quotaMaxinteger
$environmentinteger
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse
methodpublicchangeLocalSearchQuotaPool(integer $quotaMax = 0, integer $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse

sets new user quota for the Local Search service

Parameters
NameTypeDescription
$quotaMaxinteger
$environmentinteger
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse
methodpublicchangeSmsQuotaPool(integer $quotaMax = 0, integer $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse

sets new user quota for the sms service

Parameters
NameTypeDescription
$quotaMaxinteger
$environmentinteger
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse
methodpublicchangeVoiceCallQuotaPool(integer $quotaMax = 0, integer $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse

sets new user quota for the voice call service

Parameters
NameTypeDescription
$quotaMaxinteger
$environmentinteger
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse
methodpubliccheckEnvironment(int $environment) : void
staticinherited

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

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::checkEnvironment()
Parameters
NameTypeDescription
$environmentint
Throws
ExceptionDescription
\Zend_Service_DeveloperGarden_Client_Exception
methodpubliccheckParticipantAction(int $action) : void
staticinherited

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

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::checkParticipantAction()
Parameters
NameTypeDescription
$actionint
Throws
ExceptionDescription
\Zend_Service_DeveloperGarden_Client_Exception
methodpublicgetAccountBalance(array $accounts = array()) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetAccountBalanceResponse

get the result for a list of accounts

Parameters
NameTypeDescription
$accountsarray
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetAccountBalanceResponse
methodpublicgetClientOptions() : array
inherited

returns an array with configured options for this client

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getClientOptions()
Returns
TypeDescription
array
methodpublicgetConfernceCallQuotaInformation(int $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse

returns the Quota Information for SMS ConferenceCall

Parameters
NameTypeDescription
$environmentint
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
methodpublicgetCredential() : \Zend_Service_DeveloperGarden_Credential
inherited

returns the internal credential object

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getCredential()
methodpublicgetEnvironment() : int
inherited

returns the current configured environemnt

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getEnvironment()
Returns
TypeDescription
int
methodpublicgetEnvironments() : array
staticinherited

returns an array of all available environments

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getEnvironments()
Returns
TypeDescription
array
methodpublicgetIPLocationQuotaInformation(int $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse

returns the Quota Information for IPLocation Service

Parameters
NameTypeDescription
$environmentint
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
methodpublicgetLocalSearchQuotaInformation(int $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse

returns the Quota Information for LocaleSearch Service

Parameters
NameTypeDescription
$environmentint
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
methodpublicgetModuleIds() : array

returns an array with all possible ModuleIDs

Returns
TypeDescription
array
methodpublicgetOption(string $name) : mixed
inherited

get an option value from the internal options object

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getOption()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
mixed
methodpublicgetParticipantActions() : array
staticinherited

returns an array of all available environments

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getParticipantActions()
Returns
TypeDescription
array
methodpublicgetQuotaInformation(\Zend_Service_DeveloperGarden_Request_BaseUserService $request) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse

returns the quota information

Parameters
NameTypeDescription
$request\Zend_Service_DeveloperGarden_Request_BaseUserService
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
methodpublicgetSmsQuotaInformation(int $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse

returns the Quota Information for SMS Service

Parameters
NameTypeDescription
$environmentint
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
methodpublicgetSoapClient() : \Zend_Service_DeveloperGarden_Client_Soap
finalinherited

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()
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Client_Soap
Details
Final
 
methodpublicgetVoiceCallQuotaInformation(int $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse

returns the Quota Information for VoiceCall Service

Parameters
NameTypeDescription
$environmentint
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
methodpublicgetWsdl() : string
inherited

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

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getWsdl()
Returns
TypeDescription
string
methodpublicsetEnvironment(int $environment) : \Zend_Service_DeveloperGarden_Client_ClientAbstract
Parameters
NameTypeDescription
$environmentint
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Client_ClientAbstract
methodpublicsetLocalWsdl(string $wsdlFile = null) : \Zend_Service_DeveloperGarden_Client_ClientAbstract
inherited

sets a new local wsdl file

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::setLocalWsdl()
Parameters
NameTypeDescription
$wsdlFilestring
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Client_ClientAbstract
methodpublicsetOption(string $name, mixed $value) : \Zend_Service_DeveloperGarden_Client_ClientAbstract
Parameters
NameTypeDescription
$namestring
$valuemixed
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Client_ClientAbstract
Throws
ExceptionDescription
\Zend_Service_DeveloperGarden_Client_Exception
methodpublicsetUseLocalWsdl(\boolen $use = true) : \Zend_Service_DeveloperGarden_Client_ClientAbstract
inherited

switch to the local wsdl file usage

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::setUseLocalWsdl()
Parameters
NameTypeDescription
$use\boolen
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Client_ClientAbstract
methodpublicsetWsdl(string $wsdlFile = null) : \Zend_Service_DeveloperGarden_Client_ClientAbstract
inherited

sets a new wsdl file

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::setWsdl()
Parameters
NameTypeDescription
$wsdlFilestring
Returns
TypeDescription
\Zend_Service_DeveloperGarden_Client_ClientAbstract
Documentation was generated by phpDocumentor 2.0.0a12.