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

Public Member Functions

 validate ($keyword=null, $number=null)
 validate the given number with the keyword
 
 inValidate ($number=null)
 invalidate the given number
 
 sendValidationKeyword ($number=null, $message=null, $originator=null, $account=null)
 this function sends the validation sms to the given number, if message is provided it should have to placeholder: #key# = the validation key #validUntil# = the valid until date
 
 getValidatedNumbers ()
 returns a list of validated numbers
 
- 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 Attributes

 $_wsdlFile = 'https://gateway.developer.telekom.com/p3gw-mod-odg-sms-validation/services/SmsValidationUserService?wsdl'
 
 $_wsdlFileLocal = 'Wsdl/SmsValidationUserService.wsdl'
 
 $_classMap
 
- 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

getValidatedNumbers ( )
inValidate (   $number = null)

invalidate the given number

Parameters
string$number
Returns
Zend_Service_DeveloperGarden_Response_SmsValidation_InvalidateResponse
sendValidationKeyword (   $number = null,
  $message = null,
  $originator = null,
  $account = null 
)

this function sends the validation sms to the given number, if message is provided it should have to placeholder: #key# = the validation key #validUntil# = the valid until date

Parameters
string$number
string$message
string$originator
integer$account
Returns
Zend_Service_DeveloperGarden_Request_SmsValidation_SendValidationKeywordResponse
validate (   $keyword = null,
  $number = null 
)

validate the given number with the keyword

Parameters
string$keyword
string$number
Returns
Zend_Service_DeveloperGarden_Response_SmsValidation_ValidateResponse

Member Data Documentation

$_classMap
protected
Initial value:
= array(
'getValidatedNumbersResponse' => 'Zend_Service_DeveloperGarden_Response_SmsValidation_GetValidatedNumbersResponse',
'ValidatedNumber' => 'Zend_Service_DeveloperGarden_Response_SmsValidation_ValidatedNumber',
'sendValidationKeywordResponse' => 'Zend_Service_DeveloperGarden_Response_SmsValidation_SendValidationKeywordResponse',
'validateResponse' => 'Zend_Service_DeveloperGarden_Response_SmsValidation_ValidateResponse',
'invalidateResponse' => 'Zend_Service_DeveloperGarden_Response_SmsValidation_InvalidateResponse',
)
$_wsdlFile = 'https://gateway.developer.telekom.com/p3gw-mod-odg-sms-validation/services/SmsValidationUserService?wsdl'
protected
$_wsdlFileLocal = 'Wsdl/SmsValidationUserService.wsdl'
protected