Overview

Packages

  • Hylax
  • None

Classes

  • Hylax
  • Hylax_Driver
  • Hylax_Driver_hylafax
  • Hylax_Driver_spandsp
  • Hylax_Image
  • Hylax_SQL_Attributes
  • Hylax_Storage
  • Hylax_Storage_sql
  • Overview
  • Package
  • Class
  • Tree

Class Hylax_Storage_sql

Hylax_Storage_sql Class

Copyright 2003-2012 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.

Hylax_Storage
Extended by Hylax_Storage_sql
Package: Hylax
Author: Marko Djukic marko@oblo.com
Located at Storage/sql.php
Methods summary
public
# Hylax_Storage_sql( mixed $params )
public
# newFaxId( )
public
# _createFax( mixed & $info )
public
# _listFaxes( mixed $folder )
public
# getFax( mixed $fax_id )
public
# getFaxFolder( mixed $fax_id )
public
# _setFaxNumber( mixed $fax_id, mixed $number )
public
# _setJobId( mixed $fax_id, mixed $job_id )
public
# _getFolder( mixed $folder, mixed $path = null )
public array
# getGateways( )

Fetches a list of available gateways.

Fetches a list of available gateways.

Returns

array
An array of the available gateways.
public array &
# getGateway( integer $gateway_id )

Fetches a gateway from the backend.

Fetches a gateway from the backend.

Parameters

$gateway_id
The gateway id to fetch.

Returns

array
An array containing the gateway settings and parameters.
public mixed
# saveGateway( array & $info )

Saves a gateway to the backend.

Saves a gateway to the backend.

Parameters

$info
<p>The gateway settings to be saved passed by reference as an array.</p>

Returns

mixed
Gateway id on success or a PEAR error on failure.
public mixed
# deleteGateway( integer $gateway_id )

Deletes a gateway from the backend.

Deletes a gateway from the backend.

Parameters

$gateway_id
The gateway id of the gateway to delete.

Returns

mixed
True on success or a PEAR error on failure.
public mixed
# saveMessage( integer $gateway_id, string $message_text, string $message_params, string $message_batch_id = null )

Saves a message to the backend.

Saves a message to the backend.

Parameters

$gateway_id
<p>The id of the gateway used to send this message.</p>
$message_text
The text of the message.
$message_params
Any send params used for this message.
$message_batch_id
<p>If batch sending is used, the batch id of this message.</p>

Returns

mixed
True on success or PEAR Error on failure.
public mixed
# saveSend( integer $message_id, string $remote_id, string $recipient, string $error )

Saves an individual send to the backend. This will be one instance of a message being sent to a recipient.

Saves an individual send to the backend. This will be one instance of a message being sent to a recipient.

Parameters

$message_id
The message id.
$remote_id
The text of the message.
$recipient
Any send params used for this
$error
Any send params used for this

Returns

mixed
The send id on success or PEAR Error on failure.
public mixed
# _getMessages( )

Gets all the messages for the current user.

Gets all the messages for the current user.

Returns

mixed
The array of messages on success or PEAR Error on failure.
public mixed
# _getSends( integer|array $message_ids )

Fetches all sends for one or more message ids.

Fetches all sends for one or more message ids.

Parameters

$message_ids
$message_id The message id(s).

Returns

mixed
The send id on success or PEAR Error on failure.
public
# initialise( )
Methods inherited from Hylax_Storage
Hylax_Storage(), createFax(), factory(), getFaxData(), listFaxes(), saveFaxData(), send(), singleton()
Properties summary
public DB $_db

Handle for the database connection.

Handle for the database connection.

#
public Hylax_SQL_Attributes $_attributes
#
Properties inherited from Hylax_Storage
$_params, $_vfs
API documentation generated by ApiGen