• Home
  • Hylax_Storage_sql

PHP Class Hylax_Storage_sql, horde

Copyright 2003-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.
Author: Marko Djukic ([email protected])
Inheritance: extends Hylax_Storage
ファイルを表示 Open project: horde/horde

Public Properties

Property Type Description
$_attributes Hylax_SQL_Attributes
$_db DB Handle for the database connection.

Public Methods

Method Description
Hylax_Storage_sql ( $params )
_createFax ( &$info )
_getFolder ( $folder, $path = null )
_getMessages ( ) : mixed Gets all the messages for the current user.
_getSends ( $message_ids ) : mixed Fetches all sends for one or more message ids.
_listFaxes ( $folder )
_setFaxNumber ( $fax_id, $number )
_setJobId ( $fax_id, $job_id )
deleteGateway ( integer $gateway_id ) : mixed Deletes a gateway from the backend.
getFax ( $fax_id )
getFaxFolder ( $fax_id )
getGateway ( integer $gateway_id ) : array Fetches a gateway from the backend.
getGateways ( ) : array Fetches a list of available gateways.
initialise ( )
newFaxId ( )
saveGateway ( array &$info ) : mixed Saves a gateway to the backend.
saveMessage ( integer $gateway_id, string $message_text, string $message_params, string $message_batch_id = null ) : mixed Saves a message to the backend.
saveSend ( integer $message_id, string $remote_id, string $recipient, string $error ) : mixed Saves an individual send to the backend. This will be one instance of a message being sent to a recipient.

Method Details

Hylax_Storage_sql() public method

public Hylax_Storage_sql ( $params )

_createFax() public method

public _createFax ( &$info )

_getFolder() public method

public _getFolder ( $folder, $path = null )

_getMessages() public method

Gets all the messages for the current user.
public _getMessages ( ) : mixed
return mixed The array of messages on success or PEAR Error on failure.

_getSends() public method

Fetches all sends for one or more message ids.
public _getSends ( $message_ids ) : mixed
return mixed The send id on success or PEAR Error on failure.

_listFaxes() public method

public _listFaxes ( $folder )

_setFaxNumber() public method

public _setFaxNumber ( $fax_id, $number )

_setJobId() public method

public _setJobId ( $fax_id, $job_id )

deleteGateway() public method

Deletes a gateway from the backend.
public deleteGateway ( integer $gateway_id ) : mixed
$gateway_id integer The gateway id of the gateway to delete.
return mixed True on success or a PEAR error on failure.

getFax() public method

public getFax ( $fax_id )

getFaxFolder() public method

public getFaxFolder ( $fax_id )

getGateway() public method

Fetches a gateway from the backend.
public getGateway ( integer $gateway_id ) : array
$gateway_id integer The gateway id to fetch.
return array An array containing the gateway settings and parameters.

getGateways() public method

Fetches a list of available gateways.
public getGateways ( ) : array
return array An array of the available gateways.

initialise() public method

public initialise ( )

newFaxId() public method

public newFaxId ( )

saveGateway() public method

Saves a gateway to the backend.
public saveGateway ( array &$info ) : mixed
$info array The gateway settings to be saved passed by reference as an array.
return mixed Gateway id on success or a PEAR error on failure.

saveMessage() public method

Saves a message to the backend.
public saveMessage ( integer $gateway_id, string $message_text, string $message_params, string $message_batch_id = null ) : mixed
$gateway_id integer The id of the gateway used to send this message.
$message_text string The text of the message.
$message_params string Any send params used for this message.
$message_batch_id string If batch sending is used, the batch id of this message.
return mixed True on success or PEAR Error on failure.

saveSend() public method

Saves an individual send to the backend. This will be one instance of a message being sent to a recipient.
public saveSend ( integer $message_id, string $remote_id, string $recipient, string $error ) : mixed
$message_id integer The message id.
$remote_id string The text of the message.
$recipient string Any send params used for this
$error string Any send params used for this
return mixed The send id on success or PEAR Error on failure.

Property Details

$_attributes public_oe property

public Hylax_SQL_Attributes $_attributes
return Hylax_SQL_Attributes

$_db public_oe property

Handle for the database connection.
public DB $_db
return DB