PHP Класс 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.
Автор: Marko Djukic ([email protected])
Наследование: extends Hylax_Storage
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$_attributes Hylax_SQL_Attributes
$_db DB Handle for the database connection.

Открытые методы

Метод Описание
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.

Описание методов

Hylax_Storage_sql() публичный Метод

public Hylax_Storage_sql ( $params )

_createFax() публичный Метод

public _createFax ( &$info )

_getFolder() публичный Метод

public _getFolder ( $folder, $path = null )

_getMessages() публичный Метод

Gets all the messages for the current user.
public _getMessages ( ) : mixed
Результат mixed The array of messages on success or PEAR Error on failure.

_getSends() публичный Метод

Fetches all sends for one or more message ids.
public _getSends ( $message_ids ) : mixed
Результат mixed The send id on success or PEAR Error on failure.

_listFaxes() публичный Метод

public _listFaxes ( $folder )

_setFaxNumber() публичный Метод

public _setFaxNumber ( $fax_id, $number )

_setJobId() публичный Метод

public _setJobId ( $fax_id, $job_id )

deleteGateway() публичный Метод

Deletes a gateway from the backend.
public deleteGateway ( integer $gateway_id ) : mixed
$gateway_id integer The gateway id of the gateway to delete.
Результат mixed True on success or a PEAR error on failure.

getFax() публичный Метод

public getFax ( $fax_id )

getFaxFolder() публичный Метод

public getFaxFolder ( $fax_id )

getGateway() публичный Метод

Fetches a gateway from the backend.
public getGateway ( integer $gateway_id ) : array
$gateway_id integer The gateway id to fetch.
Результат array An array containing the gateway settings and parameters.

getGateways() публичный Метод

Fetches a list of available gateways.
public getGateways ( ) : array
Результат array An array of the available gateways.

initialise() публичный Метод

public initialise ( )

newFaxId() публичный Метод

public newFaxId ( )

saveGateway() публичный Метод

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.
Результат mixed Gateway id on success or a PEAR error on failure.

saveMessage() публичный Метод

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.
Результат mixed True on success or PEAR Error on failure.

saveSend() публичный Метод

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
Результат mixed The send id on success or PEAR Error on failure.

Описание свойств

$_attributes публичное свойство

public Hylax_SQL_Attributes $_attributes
Результат Hylax_SQL_Attributes

$_db публичное свойство

Handle for the database connection.
public DB $_db
Результат DB