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_clickatell_http

Source Location: /Net_SMS-0.2.1/Net/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):

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 27]
Net_SMS_clickatell_http Class implements the HTTP API for accessing the Clickatell (www.clickatell.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/clickatell_http.php,v 1.29 2008/01/02 11:12:11 jan Exp $



[ Top ]

Class Variables

$api_id =

[line 36]

  • Access: protected

Type:   mixed


[ Top ]

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

[line 65]

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 ]

$password =

[line 35]

  • Access: protected

Type:   mixed


[ Top ]

$request =

[line 32]

  • Access: protected

Type:   mixed


[ Top ]

$username =

[line 34]

  • Access: protected

Type:   mixed


[ Top ]


Method Detail

__construct (Constructor)   [line 38]

Net_SMS_clickatell_http __construct( [ $params = null], HTTP_Request2 $request)

  • Access: public

Overrides Net_SMS::__construct() (Constructor)

Parameters:

   $params   — 
HTTP_Request2   $request   — 

[ Top ]

getAPIId   [line 389]

void getAPIId( )

  • Access: public

[ Top ]

getDefaultSendParams   [line 243]

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.

[ Top ]

getError   [line 313]

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 213]

array getInfo( )

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

[ Top ]

getParams   [line 226]

array getParams( )

Returns the required parameters for this gateway driver.
  • Return: Array of required parameters.

[ Top ]

getPassword   [line 385]

void getPassword( )

  • Access: public

[ Top ]

getSendParams   [line 273]

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?

Parameters:

   $params   — 

[ Top ]

getUsername   [line 381]

void getUsername( )

  • Access: public

[ Top ]

setAPIId   [line 393]

void setAPIId( $id)

  • Access: public

Parameters:

   $id   — 

[ Top ]

setPassword   [line 401]

void setPassword( $password)

  • Access: public

Parameters:

   $password   — 

[ Top ]

setRequest   [line 47]

void setRequest( HTTP_Request2 $request)

  • Access: public

Parameters:

HTTP_Request2   $request   — 

[ Top ]

setUsername   [line 397]

void setUsername( $username)

  • Access: public

Parameters:

   $username   — 

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