Class Doctrine_Tree

Doctrine_Tree

Direct known subclasses

Doctrine_Tree_AdjacencyList, Doctrine_Tree_MaterializedPath, Doctrine_Tree_NestedSet

Package: Doctrine\Tree
License: LGPL
Author: Joe Simms <joe.simms@websites4.com>
Version: $Revision: 7490 $
Since: 1.0
Link: www.doctrine-project.org
Located at Tree.php

Methods summary
`public`	# `__construct( Doctrine_Table $table, array $options )` constructor, creates tree with reference to table and any options constructor, creates tree with reference to table and any options Parameters `$table` instance of Doctrine_Table `$options` options
`public`	# `setTableDefinition( )` Used to define table attributes required for the given implementation Used to define table attributes required for the given implementation Throws `Doctrine_Tree_Exception` if table attributes have not been defined
`public`	# `setUp( )` this method is used for setting up relations and attributes and should be used by specific implementations this method is used for setting up relations and attributes and should be used by specific implementations
`public static Doctrine_Tree`	# `factory( Doctrine_Table $table, string $implName, array $options = array() )` Factory method to create a Tree. Factory method to create a Tree. This is a factory method that returns a tree instance based upon chosen implementation. Parameters `$table` instance of Doctrine_Table `$implName` $impName implementation (NestedSet, AdjacencyList, MaterializedPath) `$options` options Returns `Doctrine_Tree` Doctrine_Tree Throws `Doctrine_Exception` if class $implName does not extend Doctrine_Tree
`public`	# `getAttribute( mixed $name )` gets tree attribute value gets tree attribute value
`public`	# `setAttribute( mixed $name, mixed $value )` sets tree attribute value sets tree attribute value Parameters `$name` `$value`
`public`	# `getBaseComponent( )` Returns the base tree component. Returns the base tree component.

Properties summary
`protected mixed`	`$table` Param object $table reference to associated Doctrine_Table instance	#
`protected array`	`$options` Param array $options	#`array()`
`protected mixed`	`$_baseComponent`	#