Service/DeveloperGarden/BaseUserService.php

Show:

inherited

Classes
- \Zend_Service_DeveloperGarden_BaseUserService

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
jump to top

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

 
                ENV_PRODUCTION
                = 1

inherited

constants for using with the odg api

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::ENV_PRODUCTION

Inherited_from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::ENV_PRODUCTION

 
                ENV_SANDBOX
                = 2

inheritedInherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::ENV_SANDBOX

Inherited_from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::ENV_SANDBOX

 
                ENV_MOCK
                = 3

inheritedInherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::ENV_MOCK

Inherited_from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::ENV_MOCK

 
                PARTICIPANT_MUTE_OFF
                = 0

inheritedInherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::PARTICIPANT_MUTE_OFF

Inherited_from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::PARTICIPANT_MUTE_OFF

 
                PARTICIPANT_MUTE_ON
                = 1

inheritedInherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::PARTICIPANT_MUTE_ON

Inherited_from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::PARTICIPANT_MUTE_ON

 
                PARTICIPANT_RECALL
                = 2

inheritedInherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::PARTICIPANT_RECALL

Inherited_from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::PARTICIPANT_RECALL

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')

Response, Request Classmapping

Default 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')

Details

Type: array

int $_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

\Zend_Service_DeveloperGarden_Credential $_credential = null

inherited

class with credentials

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_credential

Default valuenullDetails

Type: \Zend_Service_DeveloperGarden_Credential
Inherited_from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_credential

array $_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 value

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()

inherited

Available options

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_options

Default valuearray()Details

Type: array
Inherited_from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_options

string $_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

int $_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

\Zend_Soap_Client $_soapClient = null

inherited

The internal Soap Client

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_soapClient

Default valuenullDetails

Type: \Zend_Soap_Client
Inherited_from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_soapClient

boolean $_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

string $_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

string $_wsdlFileLocal = 'Wsdl/ODGBaseUserService.wsdl'

wsdl file local

Default value'Wsdl/ODGBaseUserService.wsdl'Details

Type: string

Methods

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

inherited

constructor

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::__construct()

Parameters

Name	Type	Description
$options	array	Associative array of options

_buildConstArray() : null

staticinherited

helper method to create const arrays

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::_buildConstArray()

Returns

Type	Description
null

_buildModuleString(string $module, integer $environment) : string

returns the correct module string

Parameters

Name	Type	Description
$module	string
$environment	integer

Returns

Type	Description
string

_checkModuleId(string $moduleId) : void

checks the moduleId and throws exception if not valid

Parameters

Name	Type	Description
$moduleId	string

Throws

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

Parameters

Name	Type	Description
$moduleId	string
$quotaMax	integer

Returns

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

Parameters

Name	Type	Description
$moduleId	string

Returns

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

Parameters

Name	Type	Description
$quotaMax	integer
$environment	integer

Returns

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

Parameters

Name	Type	Description
$quotaMax	integer
$environment	integer

Returns

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

Parameters

Name	Type	Description
$quotaMax	integer
$environment	integer

Returns

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

Parameters

Name	Type	Description
$request	\Zend_Service_DeveloperGarden_Request_BaseUserService_ChangeQuotaPool

Returns

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

Parameters

Name	Type	Description
$quotaMax	integer
$environment	integer

Returns

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

Parameters

Name	Type	Description
$quotaMax	integer
$environment	integer

Returns

Type	Description
\Zend_Service_DeveloperGarden_Response_BaseUserService_ChangeQuotaPoolResponse

checkEnvironment(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

Name	Type	Description
$environment	int

Throws

Exception	Description
\Zend_Service_DeveloperGarden_Client_Exception

checkParticipantAction(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

Name	Type	Description
$action	int

Throws

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

Parameters

Name	Type	Description
$accounts	array

Returns

Type	Description
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetAccountBalanceResponse

getClientOptions() : array

inherited

returns an array with configured options for this client

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getClientOptions()

Returns

Type	Description
array

getConfernceCallQuotaInformation(int $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse

returns the Quota Information for SMS ConferenceCall

Parameters

Name	Type	Description
$environment	int

Returns

Type	Description
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse

getCredential() : \Zend_Service_DeveloperGarden_Credential

inherited

returns the internal credential object

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getCredential()

Returns

Type	Description
\Zend_Service_DeveloperGarden_Credential

getEnvironment() : int

inherited

returns the current configured environemnt

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getEnvironment()

Returns

Type	Description
int

getEnvironments() : array

staticinherited

returns an array of all available environments

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getEnvironments()

Returns

Type	Description
array

getIPLocationQuotaInformation(int $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse

returns the Quota Information for IPLocation Service

Parameters

Name	Type	Description
$environment	int

Returns

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

Parameters

Name	Type	Description
$environment	int

Returns

Type	Description
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse

getModuleIds() : array

returns an array with all possible ModuleIDs

Returns

Type	Description
array

getOption(string $name) : mixed

inherited

get an option value from the internal options object

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getOption()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
mixed

getParticipantActions() : array

staticinherited

returns an array of all available environments

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getParticipantActions()

Returns

Type	Description
array

getQuotaInformation(\Zend_Service_DeveloperGarden_Request_BaseUserService $request) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse

returns the quota information

Parameters

Name	Type	Description
$request	\Zend_Service_DeveloperGarden_Request_BaseUserService

Returns

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

Parameters

Name	Type	Description
$environment	int

Returns

Type	Description
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse

getSoapClient() : \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

Type	Description
\Zend_Service_DeveloperGarden_Client_Soap

Details

Final

getVoiceCallQuotaInformation(int $environment = self::ENV_PRODUCTION) : \Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse

returns the Quota Information for VoiceCall Service

Parameters

Name	Type	Description
$environment	int

Returns

Type	Description
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse

getWsdl() : string

inherited

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

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getWsdl()

Returns

Type	Description
string

setEnvironment(int $environment) : \Zend_Service_DeveloperGarden_Client_ClientAbstract

inherited

sets new environment

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::setEnvironment()

Parameters

Name	Type	Description
$environment	int

Returns

Type	Description
\Zend_Service_DeveloperGarden_Client_ClientAbstract

setLocalWsdl(string $wsdlFile = null) : \Zend_Service_DeveloperGarden_Client_ClientAbstract

inherited

sets a new local wsdl file

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::setLocalWsdl()

Parameters

Name	Type	Description
$wsdlFile	string

Returns

Type	Description
\Zend_Service_DeveloperGarden_Client_ClientAbstract

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

inherited

Set an option

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::setOption()

Parameters

Name	Type	Description
$name	string
$value	mixed

Returns

Type	Description
\Zend_Service_DeveloperGarden_Client_ClientAbstract

Throws

Exception	Description
\Zend_Service_DeveloperGarden_Client_Exception

setUseLocalWsdl(\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

Name	Type	Description
$use	\boolen

Returns

Type	Description
\Zend_Service_DeveloperGarden_Client_ClientAbstract

setWsdl(string $wsdlFile = null) : \Zend_Service_DeveloperGarden_Client_ClientAbstract

inherited

sets a new wsdl file

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::setWsdl()

Parameters

Name	Type	Description
$wsdlFile	string

Returns

Type	Description
\Zend_Service_DeveloperGarden_Client_ClientAbstract

Service/DeveloperGarden/BaseUserService.php

\Zend_Service_DeveloperGarden_BaseUserServicejump to top

Constants

Properties

Methods

\Zend_Service_DeveloperGarden_BaseUserService
jump to top