\Hylax_Driver

Hylax_Driver 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
__construct()
getFolder()
factory()
singleton()
No public properties found
No constants found
No protected methods found
$_params
N/A
No private methods found
No private properties found
N/A

Properties

$_params

$_params : 

Type

Methods

__construct()

__construct(  $params) 

Parameters

$params

getFolder()

getFolder(  $folder,   $path = null) 

Parameters

$folder
$path

factory()

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

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

Parameters

string $driver

The type of concrete Hylax_Driver subclass to return.

array $params

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

Returns

\Hylax_Driver

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

singleton()

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

Attempts to return a reference to a concrete Hylax_Driver instance based on $driver. It will only create a new instance if no Hylax_Driver 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_Driver::singleton()

Parameters

string $driver

The type of concrete Hylax_Driver subclass to return.

array $params

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

Returns

mixed —

The created concrete Hylax_Driver instance, or false on error.