Docs For Class Net

Net_SMS __construct(
array
$params)

Constructor

Access: public

Overridden in child classes as:

Net_SMS_sms2email_http::__construct()

Net_SMS_win_http::__construct()

Net_SMS_generic_smtp::__construct(): Constructor.

Net_SMS_vodafoneitaly_smtp::__construct(): Constructor.

Net_SMS_textmagic_http::__construct()

Net_SMS_generic_smpp::__construct(): Constructor.

Net_SMS_clickatell_http::__construct()

Parameters:

array $params — Any parameters needed for this gateway driver.

[ Top ]

mixed authenticate(
)

Authenticates against the gateway if required.

Return: True on success or PEAR Error on failure.

[ Top ]

integer getBalance(
)

If the current driver has a credit capability, queries the gateway for a credit balance and returns the value.

Return: Value indicating available credit or null if not supported.

[ Top ]

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

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.
Access: public

Overridden in child classes as:

Net_SMS_sms2email_http::getError(): Returns a string representation of an error code.

Net_SMS_win_http::getError(): Returns a string representation of an error code.

Net_SMS_textmagic_http::getError(): Returns a string representation of an error code.

Net_SMS_clickatell_http::getError(): Returns a string representation of an error code.

Parameters:

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

[ Top ]

mixed hasCapability(
string
$capability)

Query the current Gateway object to find out if it supports the given capability.

Return: Whether or not the capability is supported or any other value that the capability wishes to report.

Parameters:

string $capability — The capability to test for.

[ Top ]

mixed send(
array
$message)

Sends a message to one or more recipients. Hands off the actual sending to the gateway driver.

Return: True on success or PEAR Error on failure.
Access: public

Parameters:

array

$message

—

The message to be sent, which is composed of:

                          id   - A unique ID for the message;
                          to   - An array of recipients;
                          text - The text of the message;

[ Top ]

array _send(
array
$message, array
$to)

This function does the actual sending of the message.

Return: An array with the success status and additional information.
Access: protected

Overridden in child classes as:

Net_SMS_win_http::_send(): This function does the actual sending of the message.

Net_SMS_vodafoneitaly_smtp::_send(): This function does the actual sending of the message.

Parameters:

array	`$message`	—	The array containing the message and its send parameters.
array	`$to`	—	The recipients.

[ Top ]

Class: Net_SMS

Class Overview

Author(s):

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Method Detail

__construct (Constructor) [line 35]

Parameters:

authenticate [line 67]

getBalance [line 190]

getError [line 232]

Parameters:

hasCapability [line 54]

Parameters:

send [line 91]

Parameters:

_send [line 215]

Parameters: