\Hylax_Storage

Hylax_Storage Class

Copyright 2003-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

Summary

Methods
Properties
Constants
Hylax_Storage()
saveFaxData()
createFax()
getFaxData()
listFaxes()
send()
factory()
singleton()
$_params
$_vfs
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$_params

$_params : array

A hash containing any parameters for the current storage driver.

Type

array

$_vfs

$_vfs : \VFS

Type

\VFS

Methods

Hylax_Storage()

Hylax_Storage(array  $params) 

Constructor

Parameters

array $params

Any parameters needed for this storage driver.

Throws

\Horde_Exception

saveFaxData()

saveFaxData(  $data,   $type = '.ps') 

Parameters

$data
$type

createFax()

createFax(  $info,   $fix_owner = false) 

Parameters

$info
$fix_owner

getFaxData()

getFaxData(  $fax_id) 

Parameters

$fax_id

listFaxes()

listFaxes(  $folder) 

Parameters

$folder

send()

send(  $fax_id,   $number) 

Parameters

$fax_id
$number

factory()

factory(string  $driver, array  $params = array()) : \Hylax_Storage

Attempts to return a concrete Hylax_Storage instance based on $driver.

Parameters

string $driver

The type of concrete Hylax_Storage subclass to return.

array $params

A hash containing any additional configuration or connection parameters a subclass might need.

Throws

\Horde_Exception

Returns

\Hylax_Storage

The newly created concrete Hylax_Storage instance, or false on error.

singleton()

singleton(string  $driver, array  $params = array()) : mixed

Attempts to return a reference to a concrete Hylax_Storage instance based on $driver.

It will only create a new instance if no Hylax_Storage instance with the same parameters currently exists.

This should be used if multiple storage sources are required.

This method must be invoked as: $var = &Hylax_Storage::singleton()

Parameters

string $driver

The type of concrete Hylax_Storage subclass to return.

array $params

A hash containing any additional configuration or connection parameters a subclass might need.

Returns

mixed —

The created concrete Hylax_Storage instance, or false on error.