Class: Net_SMS_clickatell_http

Source Location: /Net_SMS-0.0.2/SMS/clickatell_http.php

Class Overview

Net_SMS
   |
   --Net_SMS_clickatell_http

Net_SMS_clickatell_http Class implements the HTTP API for accessing the Clickatell (www.clickatell.com) SMS gateway.

Author(s):

Marko Djukic <marko at oblo.com>

Variables

$capabilities

Methods

Inherited Variables

Inherited Methods

Class: Net_SMS

Net_SMS::Net_SMS(): Constructor
Net_SMS::authenticate(): Authenticates against the gateway if required.
Net_SMS::factory(): Attempts to return a concrete Gateway instance based on $driver.
Net_SMS::getBalance(): If the current driver has a credit capability, queries the gateway for a credit balance and returns the value.
Net_SMS::getDefaultSendParams(): Returns send parameters for a gateway from the driver subclass
Net_SMS::getDrivers(): Returns a list of available gateway drivers.
Net_SMS::getGatewayInfo(): Returns information on a gateway, such as name and a brief description, from the driver subclass getInfo() function.
Net_SMS::getGatewayParams(): Returns parameters for a gateway from the driver subclass getParams() function.
Net_SMS::hasCapability(): Query the current Gateway object to find out if it supports the given capability.
Net_SMS::send(): Sends a message to one or more recipients. Hands off the actual sending to the gateway driver.
Net_SMS::singleton(): Attempts to return a reference to a concrete Net_SMS instance based on $driver. It wil only create a new instance if no Net_SMS instance with the same parameters currently exists.

Class Details

[line 16]
Net_SMS_clickatell_http Class implements the HTTP API for accessing the Clickatell (www.clickatell.com) SMS gateway.

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/clickatell_http.php,v 1.12 2004/04/24 17:01:39 mdjukic Exp $

Author: Marko Djukic <marko@oblo.com>

[ Top ]

Class Variables

$capabilities = array('auth'        => true,
                              'batch'       => 100,
                              'multi'       => true,
                              'receive'     => false,
                              'credit'      => true,
                              'addressbook' => false,
                              'lists'       => false)

[line 35]

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 require 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.

Type:

array

[ Top ]

Method Detail

getDefaultSendParams [line 219]

array getDefaultSendParams(
)

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.
Todo: Set up batch fields/params, would be nice to have ringtone/logo support too, queue choice, unicode choice.
Access: public

Overrides Net_SMS::getDefaultSendParams() (Returns send parameters for a gateway from the driver subclass)

[ Top ]

getError [line 293]

mixed getError(
int
$error, [
$error_text = ''], string
$text)

Returns a string representation of an error code.

Return: A textual message corrisponding 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.
Access: public

Parameters:

int	`$error`	—	The error code to look up.
string	`$text`	—	An existing error text to use to raise a PEAR Error.
	`$error_text`	—

[ Top ]

getInfo [line 184]

array getInfo(
)

Identifies this gateway driver and returns a brief description.

Return: Array of driver info.
Access: public

[ Top ]

getParams [line 199]

array getParams(
)

Returns the required parameters for this gateway driver.

Return: Array of required parameters.
Access: public

[ Top ]

getSendParams [line 251]

array getSendParams(

$params)

Returns the parameters for sending messages using this gateway driver, displayed when sending messages. These are filtered out using the default values set for 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?
Access: public

Parameters:

$params —

[ Top ]

Class: Net_SMS_clickatell_http

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class: Net_SMS

Class Details

Class Variables

$capabilities = array('auth' => true, 'batch' => 100, 'multi' => true, 'receive' => false, 'credit' => true, 'addressbook' => false, 'lists' => false)

Method Detail

getDefaultSendParams [line 219]

getError [line 293]

Parameters:

getInfo [line 184]

getParams [line 199]

getSendParams [line 251]

Parameters:

$capabilities = array('auth' => true,
'batch' => 100,
'multi' => true,
'receive' => false,
'credit' => true,
'addressbook' => false,
'lists' => false)