Class Net_SMS_win_http

Description

Net_SMS_win_http Class implements the HTTP API for accessing the WIN (www.winplc.com) SMS gateway.

Copyright 2003-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

$Horde: framework/Net_SMS/SMS/win_http.php,v 1.9.2.7 2009/01/06 15:23:28 jan Exp $

Located in /Net_SMS/SMS/win_http.php (line 25)

Net_SMS
   |
   --Net_SMS_win_http
Variable Summary
Method Summary
 mixed getError (integer $error, [ $error_text = ''], string $text)
 array getInfo ()
 array getParams ()
 array getSendParams ( $params)
Variables
array $capabilities = array('auth' => false,
'batch' => 100,
'multi' => true,
'receive' => false,
'credit' => false,
'addressbook' => false,
'lists' => false)
(line 43)

An array of capabilities, so that the driver can report which operations

it supports and which it doesn't. Possible values are:

   auth        - The gateway requires authentication before sending;
   batch       - Batch sending is supported;
   multi       - Sending of messages to multiple recipients is supported;
   receive     - Whether this driver is capable of receiving SMS;
   credit      - Is use of the gateway based on credits;
   addressbook - Are gateway addressbooks supported;
   lists       - Gateway support for distribution lists.

mixed $_base_url = 'gateway3.go2mobile.net:10030/gateway/v3/gateway.aspx' (line 27)

Inherited Variables

Inherited from Net_SMS

Net_SMS::$_auth
Net_SMS::$_params
Methods
getDefaultSendParams (line 171)

Returns the parameters that can be set as default for sending messages using this gateway driver and displayed when sending messages.

  • return: Array of parameters that can be set as default.
array getDefaultSendParams ()

Redefinition of:
Net_SMS::getDefaultSendParams()
Returns send parameters for a gateway from the driver subclass getDefaultSendParams()function. These are parameters which are available to the user during sending, such as setting a time for delivery, or type of SMS (normal text or flash), or source address, etc.
getError (line 224)

Returns a string representation of an error code.

  • return: A textual message corresponding to the error code or a PEAR Error if passed an existing error text.
  • todo: Check which of these are actually required and trim down the list.
mixed getError (integer $error, [ $error_text = ''], string $text)
  • integer $error: The error code to look up.
  • string $text: An existing error text to use to raise a PEAR Error.
  • $error_text
getInfo (line 140)

Identifies this gateway driver and returns a brief description.

  • return: Array of driver info.
array getInfo ()
getParams (line 156)

Returns the required parameters for this gateway driver. The settable

parameters for this gateway are:

  • user - The username for authentication on the gateway;
  • password - The password for authentication on the gateway;

  • return: Array of required parameters.
array getParams ()
getSendParams (line 194)

Returns the parameters for sending messages using this gateway driver, displayed when sending messages. These are filtered out using the default values set up when creating the gateway.

  • return: Array of required parameters.
  • todo: Would be nice to use a time/date setup rather than minutes from now for the delivery time. Upload field for ringtones/logos?
array getSendParams ( $params)
  • $params

Inherited Methods

Inherited From Net_SMS

 Net_SMS::Net_SMS()
 Net_SMS::authenticate()
 Net_SMS::factory()
 Net_SMS::getBalance()
 Net_SMS::getDefaultSendParams()
 Net_SMS::getDrivers()
 Net_SMS::getGatewayInfo()
 Net_SMS::getGatewayParams()
 Net_SMS::hasCapability()
 Net_SMS::send()
 Net_SMS::singleton()

Documentation generated on Sun, 30 Jan 2011 05:23:27 +0000 by phpDocumentor 1.4.3