Class Overview

Doctrine_Tree

Author(s):

Joe Simms <joe.simms@websites4.com>

Information Tags:

Version:	$Revision: 2097 $
Link:	www.phpdoctrine.com
Since:	1.0
License:	LGPL

Properties

Methods

[ Top ]

Direct descendents

Child Class	Description
Doctrine_Tree_AdjacencyList	Doctrine_Tree_AdjacencyList
Doctrine_Tree_MaterializedPath	Doctrine_Tree_MaterializedPath
Doctrine_Tree_NestedSet	Doctrine_Tree_NestedSet

[ Top ]

Property Summary

mixed	$options
mixed	$table
mixed	$_baseComponent

[ Top ]

Method Summary

static object	factory()	factory method to return tree instance based upon chosen implementation
Doctrine_Tree	__construct()	constructor, creates tree with reference to table and any options
void	getAttribute()	gets tree attribute value
void	getBaseComponent()	Returns the base tree component.
void	setAttribute()	sets tree attribute value
void	setTableDefinition()	Used to define table attributes required for the given implementation
void	setUp()	this method is used for setting up relations and attributes and should be used by specific implementations

[ Top ]

Properties

mixed $options = array() [line 42]

API Tags:

Access:

protected

[ Top ]

mixed $table [line 37]

API Tags:

Access:

protected

[ Top ]

mixed $_baseComponent [line 44]

API Tags:

Access:

protected

[ Top ]

Methods

static method factory [line 95]

static object factory(
Doctrine_Table
$table, 
$implName, [array
$options = array()], string
$impName 
)

factory method to return tree instance based upon chosen implementation

Parameters:

object	$table:	instance of Doctrine_Table
string	$impName:	implementation (NestedSet, AdjacencyList, MaterializedPath)
array	$options:	options
	$implName:

API Tags:

Return:	instance of Doctrine_Node
Access:	public

Information Tags:

Throws:

Doctrine_Exception if class does not extend Doctrine_Tree

[ Top ]

Constructor __construct [line 52]

Doctrine_Tree __construct(
Doctrine_Table
$table, array
$options 
)

constructor, creates tree with reference to table and any options

Parameters:

object	$table:	instance of Doctrine_Table
array	$options:	options

API Tags:

Access:

public

Redefined in descendants as:

Doctrine_Tree_NestedSet::__construct() : constructor, creates tree with reference to table and sets default root options

[ Top ]

getAttribute [line 108]

void getAttribute(

$name 
)

gets tree attribute value

Parameters:

$name:

API Tags:

Access:

public

[ Top ]

getBaseComponent [line 126]

void getBaseComponent(
)

Returns the base tree component.

API Tags:

Access:

public

[ Top ]

setAttribute [line 118]

void setAttribute(
mixed
$name, 
$value 
)

sets tree attribute value

Parameters:

mixed	$name:
	$value:

API Tags:

Access:

public

[ Top ]

setTableDefinition [line 73]

void setTableDefinition(
)

Used to define table attributes required for the given implementation

API Tags:

Access:

public

Information Tags:

Throws:

Doctrine_Tree_Exception if table attributes have not been defined

Redefined in descendants as:

Doctrine_Tree_NestedSet::setTableDefinition() : used to define table attributes required for the NestetSet implementation

[ Top ]

setUp [line 82]

void setUp(
)

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

API Tags:

Access:

public

[ Top ]

Class: Doctrine_Tree

Class Doctrine_Tree