PHP Class Hylax_Storage, 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])
Mostrar archivo Open project: horde/horde Class Usage Examples

Public Properties

Property Type Description
$_params array A hash containing any parameters for the current storage driver.
$_vfs VFS

Public Methods

Method Description
Hylax_Storage ( array $params ) Constructor
createFax ( $info, $fix_owner = false )
factory ( string $driver, array $params = [] ) : Hylax_Storage Attempts to return a concrete Hylax_Storage instance based on $driver.
getFaxData ( $fax_id )
listFaxes ( $folder )
saveFaxData ( $data, $type = '.ps' )
send ( $fax_id, $number )
singleton ( string $driver, array $params = [] ) : mixed Attempts to return a reference to a concrete Hylax_Storage instance based on $driver.

Method Details

Hylax_Storage() public method

Constructor
public Hylax_Storage ( array $params )
$params array Any parameters needed for this storage driver.

createFax() public method

public createFax ( $info, $fix_owner = false )

factory() public method

Attempts to return a concrete Hylax_Storage instance based on $driver.
public factory ( string $driver, array $params = [] ) : Hylax_Storage
$driver string The type of concrete Hylax_Storage subclass to return.
$params array A hash containing any additional configuration or connection parameters a subclass might need.
return Hylax_Storage The newly created concrete Hylax_Storage instance, or false on error.

getFaxData() public method

public getFaxData ( $fax_id )

listFaxes() public method

public listFaxes ( $folder )

saveFaxData() public method

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

send() public method

public send ( $fax_id, $number )

singleton() public method

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()
public singleton ( string $driver, array $params = [] ) : mixed
$driver string The type of concrete Hylax_Storage subclass to return.
$params array A hash containing any additional configuration or connection parameters a subclass might need.
return mixed The created concrete Hylax_Storage instance, or false on error.

Property Details

$_params public_oe property

A hash containing any parameters for the current storage driver.
public array $_params
return array

$_vfs public_oe property

public VFS $_vfs
return VFS