abstract class Doctrine_Tree_MaterializedPath extends Doctrine_Tree implements Doctrine_Tree_Interface (View source)

Doctrine_Tree_MaterializedPath

Properties

protected $table from Doctrine_Tree
protected $options from Doctrine_Tree
protected $_baseComponent from Doctrine_Tree

Methods

__construct(Doctrine_Table $table, array $options)

constructor, creates tree with reference to table and any options

setTableDefinition()

Used to define table attributes required for the given implementation

setUp()

this method is used for setting up relations and attributes and should be used by specific implementations

static Doctrine_Tree
factory(Doctrine_Table $table, $implName, $options = array())

Factory method to create a Tree.

getAttribute($name)

gets tree attribute value

setAttribute($name, $value)

sets tree attribute value

getBaseComponent()

Returns the base tree component.

Details

__construct(Doctrine_Table $table, array $options)

constructor, creates tree with reference to table and any options

Parameters

Doctrine_Table $table instance of Doctrine_Table
array $options options

setTableDefinition()

Used to define table attributes required for the given implementation

Exceptions

Doctrine_Tree_Exception if table attributes have not been defined

setUp()

this method is used for setting up relations and attributes and should be used by specific implementations

static Doctrine_Tree factory(Doctrine_Table $table, $implName, $options = array())

Factory method to create a Tree.

This is a factory method that returns a tree instance based upon chosen implementation.

Parameters

Doctrine_Table $table
$implName
$options

Return Value

Doctrine_Tree

Exceptions

Doctrine_Exception if class $implName does not extend Doctrine_Tree

getAttribute($name)

gets tree attribute value

Parameters

$name

setAttribute($name, $value)

sets tree attribute value

Parameters

$name
$value

getBaseComponent()

Returns the base tree component.