Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

SMS Class Reference
[Simple Message Service]

List of all members.

Detailed Description

SMS is a class for easy sending of SMS messages.

Definition at line 13 of file sms.inc.php.

Public Member Functions

 __construct ()
 setup our SMS class.
 setTo ($number, $provider)
 setup our to number.
 setFrom ($number, $provider)
 setup our from number
 send ($message, $from=null)
 send the actual SMS message
 getProvider ($number, $provider)
 get the provider from the array of providers.

Public Attributes

 $toNumber = null
 the 10 digit number you are sending the text from.
 $fromNumber = null
 the 10 digit number you are sending the text to.
 $providers
 an array of SMSProviders


Member Function Documentation

SMS::__construct  ) 
 

setup our SMS class.

Create providers array, etc.

Definition at line 35 of file sms.inc.php.

SMS::getProvider number,
provider
 

get the provider from the array of providers.

Parameters:
$number the 10 digit phone number
$provider a string name of the provider that matches a key in the providers array

Definition at line 111 of file sms.inc.php.

SMS::send message,
from = null
 

send the actual SMS message

Parameters:
$message our message to send. warning: must be <= 160 characters.
$from an optional from email, if not sending from another cell number.

Definition at line 84 of file sms.inc.php.

References Config::get().

SMS::setFrom number,
provider
 

setup our from number

Parameters:
$number a 10 digit phone number
$provider a string that matches the a key in the providers array

Definition at line 73 of file sms.inc.php.

SMS::setTo number,
provider
 

setup our to number.

Parameters:
$number a 10 digit phone number
$provider a string that matches the a key in the providers array

Definition at line 62 of file sms.inc.php.


Member Data Documentation

SMS::$fromNumber = null
 

the 10 digit number you are sending the text to.

Definition at line 23 of file sms.inc.php.

SMS::$providers
 

an array of SMSProviders

Definition at line 28 of file sms.inc.php.

SMS::$toNumber = null
 

the 10 digit number you are sending the text from.

Definition at line 18 of file sms.inc.php.


The documentation for this class was generated from the following file:
Generated on Fri Oct 27 12:26:42 2006 for BaseJumper by doxygen 1.3.9.1