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
Afficher le fichier Open project: horde/horde

Méthodes publiques

Свойство Type Description
$_attributes Hylax_SQL_Attributes
$_db DB Handle for the database connection.

Méthodes publiques

Méthode 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 méthode

public Hylax_Storage_sql ( $params )

_createFax() public méthode

public _createFax ( &$info )

_getFolder() public méthode

public _getFolder ( $folder, $path = null )

_getMessages() public méthode

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

_getSends() public méthode

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

_listFaxes() public méthode

public _listFaxes ( $folder )

_setFaxNumber() public méthode

public _setFaxNumber ( $fax_id, $number )

_setJobId() public méthode

public _setJobId ( $fax_id, $job_id )

deleteGateway() public méthode

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

getFax() public méthode

public getFax ( $fax_id )

getFaxFolder() public méthode

public getFaxFolder ( $fax_id )

getGateway() public méthode

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

getGateways() public méthode

Fetches a list of available gateways.
public getGateways ( ) : array
Résultat array An array of the available gateways.

initialise() public méthode

public initialise ( )

newFaxId() public méthode

public newFaxId ( )

saveGateway() public méthode

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.
Résultat mixed Gateway id on success or a PEAR error on failure.

saveMessage() public méthode

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.
Résultat mixed True on success or PEAR Error on failure.

saveSend() public méthode

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
Résultat mixed The send id on success or PEAR Error on failure.

Property Details

$_attributes public_oe property

public Hylax_SQL_Attributes $_attributes
Résultat Hylax_SQL_Attributes

$_db public_oe property

Handle for the database connection.
public DB $_db
Résultat DB