API Documentation

Service/DeveloperGarden/BaseUserService.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service  
subpackage
DeveloperGarden  
version
$Id: BaseUserService.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Service_DeveloperGarden_BaseUserService

Extends from
\Zend_Service_DeveloperGarden_Client_ClientAbstract
author
Marco Kaiser  
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service  
subpackage
DeveloperGarden  

Properties

Propertyprotectedarray  $_classMap= 'array'

Response, Request Classmapping

Default valuearrayDetails
Type
array
Propertyprotectedarray  $_moduleIds= 'array'

array with all QuotaModuleIds

Default valuearrayDetails
Type
array
Propertyprotectedstring  $_wsdlFile= 'https://gateway.developer.telekom.com/p3gw-mod-odg-admin/services/ODGBaseUserService?wsdl'

wsdl file

Default valuehttps://gateway.developer.telekom.com/p3gw-mod-odg-admin/services/ODGBaseUserService?wsdlDetails
Type
string
Propertyprotectedstring  $_wsdlFileLocal= 'Wsdl/ODGBaseUserService.wsdl'

wsdl file local

Default valueWsdl/ODGBaseUserService.wsdlDetails
Type
string

Methods

methodpublic__construct( array $options = array ) : void
Parameters
Name Type Description
$options array Associative array of options
methodprotected_buildConstArray( ) : null
static

helper method to create const arrays

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

returns the correct module string

Parameters
Name Type Description
$module string
$environment integer
Returns
Type Description
string
methodprotected_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
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
Name Type Description
$moduleId string
$quotaMax integer
Returns
Type Description
\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
Name Type Description
$moduleId string
Returns
Type Description
\Zend_Service_DeveloperGarden_Response_BaseUserService_GetQuotaInformationResponse
methodpublicchangeConferenceCallQuotaPool( integer $quotaMax = 0, integer $environment = self ) : \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
methodpublicchangeIPLocationQuotaPool( integer $quotaMax = 0, integer $environment = self ) : \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
methodpublicchangeLocalSearchQuotaPool( integer $quotaMax = 0, integer $environment = self ) : \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
methodpublicchangeSmsQuotaPool( integer $quotaMax = 0, integer $environment = self ) : \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
methodpublicchangeVoiceCallQuotaPool( integer $quotaMax = 0, integer $environment = self ) : \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
methodpubliccheckEnvironment( int $environment ) : void
static

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
methodpubliccheckParticipantAction( int $action ) : void
static

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
methodpublicgetAccountBalance( 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
methodpublicgetClientOptions( ) : array

returns an array with configured options for this client

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getClientOptions()
Returns
Type Description
array
methodpublicgetConfernceCallQuotaInformation( int $environment = self ) : \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
methodpublicgetCredential( ) : \Zend_Service_DeveloperGarden_Credential

returns the internal credential object

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getCredential()
Returns
Type Description
\Zend_Service_DeveloperGarden_Credential
methodpublicgetEnvironment( ) : int

returns the current configured environemnt

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getEnvironment()
Returns
Type Description
int
methodpublicgetEnvironments( ) : array
static

returns an array of all available environments

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getEnvironments()
Returns
Type Description
array
methodpublicgetIPLocationQuotaInformation( int $environment = self ) : \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
methodpublicgetLocalSearchQuotaInformation( int $environment = self ) : \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
methodpublicgetModuleIds( ) : array

returns an array with all possible ModuleIDs

Returns
Type Description
array
methodpublicgetOption( string $name ) : mixed

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
methodpublicgetParticipantActions( ) : array
static

returns an array of all available environments

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getParticipantActions()
Returns
Type Description
array
methodpublicgetQuotaInformation( \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
methodpublicgetSmsQuotaInformation( int $environment = self ) : \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
methodpublicgetSoapClient( ) : \Zend_Service_DeveloperGarden_Client_Soap
final

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
 
methodpublicgetVoiceCallQuotaInformation( int $environment = self ) : \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
methodpublicgetWsdl( ) : string

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

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getWsdl()
Returns
Type Description
string
methodpublicsetEnvironment( int $environment ) : \Zend_Service_DeveloperGarden_Client_ClientAbstract
Parameters
Name Type Description
$environment int
Returns
Type Description
\Zend_Service_DeveloperGarden_Client_ClientAbstract
methodpublicsetLocalWsdl( string $wsdlFile = null ) : \Zend_Service_DeveloperGarden_Client_ClientAbstract

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
methodpublicsetOption( string $name, mixed $value ) : \Zend_Service_DeveloperGarden_Client_ClientAbstract
Parameters
Name Type Description
$name string
$value mixed
Returns
Type Description
\Zend_Service_DeveloperGarden_Client_ClientAbstract
Throws
Exception Description
\Zend_Service_DeveloperGarden_Client_Exception
methodpublicsetUseLocalWsdl( \boolen $use = true ) : \Zend_Service_DeveloperGarden_Client_ClientAbstract

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
methodpublicsetWsdl( string $wsdlFile = null ) : \Zend_Service_DeveloperGarden_Client_ClientAbstract
Parameters
Name Type Description
$wsdlFile string
Returns
Type Description
\Zend_Service_DeveloperGarden_Client_ClientAbstract
Documentation was generated by DocBlox 0.13.3.