Documentation

Horde_Core_Factory_Tree extends Horde_Core_Factory_Base
in package

A Horde_Injector:: based Horde_Tree:: factory.

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

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

Tags
category

Horde

author

Michael Slusarz slusarz@horde.org

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Table of Contents

Properties

$_injector  : Horde_Injector
The injector.
$_instances  : array<string|int, mixed>
Singleton instances.

Methods

__construct()  : mixed
Constructor.
create()  : Horde_Tree_Renderer_Base
Return the Horde_Tree:: instance.
getSession()  : mixed
setSession()  : mixed
_getDriverName()  : string
Return the classname of the driver to load.

Properties

$_injector

The injector.

protected Horde_Injector $_injector

$_instances

Singleton instances.

private array<string|int, mixed> $_instances = array()

Methods

__construct()

Constructor.

public __construct(Horde_Injector $injector) : mixed
Parameters
$injector : Horde_Injector

The injector to use.

create()

Return the Horde_Tree:: instance.

public create(string $name, mixed $renderer[, array<string|int, mixed> $params = array() ]) : Horde_Tree_Renderer_Base
Parameters
$name : string

The name of this tree instance.

$renderer : mixed

The type of tree renderer.

$params : array<string|int, mixed> = array()

Any additional parameters the constructor needs. Defined by this class:

'nosession' - (boolean) Don't store tree state in the session.
              DEFAULT: false
Tags
throws
Horde_Tree_Exception
Return values
Horde_Tree_Renderer_Base

The singleton instance.

getSession()

public static getSession(mixed $instance, mixed $id[, mixed $mask = 0 ]) : mixed
Parameters
$instance : mixed
$id : mixed
$mask : mixed = 0

setSession()

public static setSession(mixed $instance, mixed $id, mixed $val) : mixed
Parameters
$instance : mixed
$id : mixed
$val : mixed

_getDriverName()

Return the classname of the driver to load.

protected _getDriverName(string $driver, string $base) : string
Parameters
$driver : string

Driver name.

$base : string

The base classname.

Tags
throws
Horde_Exception
Return values
string

Classname.


        
On this page

Search results