Net_SMS
[ class tree: Net_SMS ] [ index: Net_SMS ] [ all elements ]
Packages:
Net_SMS


Classes:
Net_SMS
Net_SMS_clickatell_http
Net_SMS_generic_smpp
Net_SMS_generic_smtp
Net_SMS_sms2email_http
Net_SMS_textmagic_http
Net_SMS_vodafoneitaly_smtp
Net_SMS_win_http
Files:
clickatell_http.php
Exception.php
Factory.php
generic_smpp.php
generic_smtp.php
SMS.php
sms2email_http.php
textmagic_http.php
vodafoneitaly_smtp.php
win_http.php

Class: Net_SMS_sms2email_http

Source Location: /Net_SMS-0.2.1/Net/SMS/sms2email_http.php

Class Overview

Net_SMS
   |
   --Net_SMS_sms2email_http

Net_SMS_sms2email_http Class implements the HTTP API for accessing the sms2email (www.sms2email.com) SMS gateway.


Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class: Net_SMS

Net_SMS::__construct()
Constructor
Net_SMS::authenticate()
Authenticates against the gateway if required.
Net_SMS::getBalance()
If the current driver has a credit capability, queries the gateway for a credit balance and returns the value.
Net_SMS::getError()
Returns a string representation of an error code.
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::_send()
This function does the actual sending of the message.

Class Details

[line 25]
Net_SMS_sms2email_http Class implements the HTTP API for accessing the sms2email (www.sms2email.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/sms2email_http.php,v 1.41 2008/01/02 11:12:11 jan Exp $



[ Top ]

Class Variables

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

[line 60]

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.


Type:   array


[ Top ]

$password =

[line 32]

  • Access: protected

Type:   mixed


[ Top ]

$request =

[line 29]

  • Access: protected

Type:   mixed


[ Top ]

$username =

[line 31]

  • Access: protected

Type:   mixed


[ Top ]


Method Detail

__construct (Constructor)   [line 34]

Net_SMS_sms2email_http __construct( $params, HTTP_Request2 $request)

  • Access: public

Overrides Net_SMS::__construct() (Constructor)

Parameters:

   $params   — 
HTTP_Request2   $request   — 

[ Top ]

addContact   [line 195]

mixed addContact( string $name, integer $number)

Adds a contact to the gateway's addressbook.
  • Return: The remote contact ID on success or PEAR Error on failure.

Parameters:

string   $name   —  The name for this contact
integer   $number   —  The contact's phone number.

[ Top ]

deleteContact   [line 256]

mixed deleteContact( integer $id)

Deletes a contact in the gateway's addressbook.
  • Return: True on success or PEAR Error on failure.

Parameters:

integer   $id   —  The contact's ID on the gateway.

[ Top ]

getAddressBook   [line 287]

mixed getAddressBook( )

Fetches the entire address book from the gateway.
  • Return: Array of contacts on success or PEAR Error on failure. Format of the returned contacts is for example:
    1.                    array(<uniqueid> => array('name'   => <name>,
      2. 

    2.                                              'number' => <number>),
      3. 

    3.                          <uniqueid> => array('name'   => <name>,
      4. 

    4.                                              'number' => <number>));
      5.

[ Top ]

getDefaultSendParams   [line 581]

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.

[ Top ]

getError   [line 651]

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.

Overrides Net_SMS::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 ]

getInfo   [line 538]

array getInfo( )

Identifies this gateway driver and returns a brief description.
  • Return: Array of driver info.

[ Top ]

getList   [line 496]

mixed getList( string $id)

Fetches a specific distribution list from the gateway.
  • Return: An array of numbers in the list on success or PEAR Error on failure.

Parameters:

string   $id   —  The ID of the distribution list to fetch.

[ Top ]

getLists   [line 450]

mixed getLists( )

Fetches a listing of available distribution lists on the server.
  • Return: An array of lists on success or PEAR Error on failure. Format of the returned lists is for example:
    1.                    array(<uniqueid> => array('name'   => <name>),
      2. 

    2.                          <uniqueid> => array('name'   => <name>));
      3.

[ Top ]

getParams   [line 559]

array getParams( )

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;
   - ssl             - Whether or not to use SSL for communication with
                       the gateway.
   - delivery_report - A URL for a script which would accept delivery
                       report from the gateway.

  • Return: Array of required parameters.

[ Top ]

getPassword   [line 713]

void getPassword( )

  • Access: public

[ Top ]

getSendParams   [line 611]

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 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?

Parameters:

   $params   — 

[ Top ]

getUsername   [line 709]

void getUsername( )

  • Access: public

[ Top ]

listCreate   [line 333]

mixed listCreate( string $name, array $numbers)

Creates a new distribution list on the gateway.
  • Return: Gateway ID for the created list on success or PEAR Error on failure.

Parameters:

string   $name   —  An arbitrary name for the new list.
array   $numbers   —  A simple array of numbers to add to the list.

[ Top ]

listDelete   [line 366]

mixed listDelete( string $id)

Deletes a distribution list from the gateway.
  • Return: True on success or PEAR Error on failure.

Parameters:

string   $id   —  The gateway ID for the list to delete.

[ Top ]

listRename   [line 436]

mixed listRename( string $id, string $name)

Renames a distribution list on the gateway. Does nothing other than calling the listUpdate() function with just the $id and $name variables.
  • Return: True on success or PEAR Error on failure.

Parameters:

string   $id   —  The gateway ID for the list to update.
string   $name   —  The new arbitrary name for the list.

[ Top ]

listUpdate   [line 399]

mixed listUpdate( string $id, string $name, [string $numbers = array()])

Updates a distribution list on the gateway.
  • Return: True on success or PEAR Error on failure.

Parameters:

string   $id   —  The gateway ID for the list to update.
string   $name   —  The arbitrary name of the list. If different from the original name that the list was created under, the list will be renamed.
string   $numbers   —  The new list of numbers in the list. If left empty, the result will be the same as calling the listRename() function.

[ Top ]

setPassword   [line 721]

void setPassword( $password)

  • Access: public

Parameters:

   $password   — 

[ Top ]

setRequest   [line 42]

void setRequest( HTTP_Request2 $request)

  • Access: public

Parameters:

HTTP_Request2   $request   — 

[ Top ]

setUsername   [line 717]

void setUsername( $username)

  • Access: public

Parameters:

   $username   — 

[ Top ]

updateContact   [line 227]

mixed updateContact( integer $id, string $name, integer $number)

Updates a contact in the gateway's addressbook.
  • Return: True on success or PEAR Error on failure.

Parameters:

integer   $id   —  The contact's ID on the gateway.
string   $name   —  The name for this contact
integer   $number   —  The contact's phone number.

[ Top ]
Documentation generated on Mon, 11 Mar 2019 15:57:16 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.