category OSS
package OSS_Service
subpackage Clickatell
copyright Copyright (c) 2007 - 2012, Open Source Solutions Limited, Dublin, Ireland
license New BSD License

 Methods

Constructor

__construct(\$options $options) 

Accepted associated array parameters: username, password, ssl, api_id

retrun void

Parameters

$options

\$options

array An associated array of options (see above for accepted keys).

Get the API ID

getApiId() : string

Returns

string

Get the text description for a given state

getMessageStateDescription(string $state) : void

Get the password

getPassword() : string

Returns

string

Is SSL enabled? Returns a boolean indicating whether SSL is enabled or not

getSSL() : bool

Returns

bool

Get the last batch of send errors

getSendErrors() : array

Returns an associated array of number => error_message where number is the destination SMS number and error is that as returned from the Clickatell API.

Returns

array

Get the last batch of send IDs

getSendIds() : array

Returns an associated array of number => ID where number is the destination SMS number and ID is the send ID from the Clickatell API.

Returns

array

Get the username

getUsername() : string

Returns

string

Set the API ID

setApiId(\$api_id $api_id) : void

Parameters

$api_id

\$api_id

the API ID to set

Set the log level

setLogLevel(int $loglevel) : void

Parameters

$loglevel

int

The log level

Set the logger object

setLogger(\Zend_Logger $logger) : void

Parameters

$logger

\Zend_Logger

The Zend_Logger object

Set the API password

setPassword(\$password $password) : void

Parameters

$password

\$password

the password to set

Set SSL enabled

setSSL(\$ssl $ssl) : void

Parameters

$ssl

\$ssl

Pass boolean true to set SSL enabled

Set the username parameter

setUsername(\$username $username) 
retrn void

Parameters

$username

\$username

The username to set

Get the log level

getLogLevel() : int

Returns

int

Get the logger object

getLogger() : \Zend_Logger

Returns

\Zend_Logger

Add an entry to the log

log(string $log) : void

Parameters

$log

string

Log message

 Properties

 

An array of Clickatell delivery states (e.g.

$MESSAGE_STATES : array

@see OSS_Service_Clickatell_Http::getQueryMessage() )

 

API access ID

$_api_id : string
 

A logger object

$_logger : \Zend_Logger
 

The log level

$_loglevel : integer
 

API access password

$_password : string
 

An array of errors per phone number from the last send Keys are the numbers and values are the error messages

$_send_errors : array
 

Send IDs of the last batch of messages sent Keys are the numbers and values are the IDs

$_send_ids : array
 

Use an SSL connection?

$_ssl : bool
 

API access username

$_username : string