Doctrine


Doctrine\Doctrine_Node
/Doctrine/Node.php at line 33

Class Doctrine_Node

Doctrine_Node

public class Doctrine_Node

Doctrine_Node

Package:
Doctrine
Subpackage:
Node
License:
http://www.opensource.org/licenses/lgpl-license.php LGPL
See Also:
www.doctrine-project.org
Since:
1.0
Version:
$Revision: 7490 $
Author:
Joe Simms

Field Summary
protected unknown_type

$_tree

The tree to which the node belongs..

protected mixed

$iteratorOptions

.

protected mixed

$iteratorType

.

protected mixed

$options

.

protected mixed

$record

.

Constructor Summary

Doctrine_Node(object record, array options)

contructor, creates node with reference to record and any options.

Method Summary
static Doctrine_Node

factory(object record, string implName, array options)

Factory method for creating a Node.

void

getIterator(string type, array options)

get iterator.

Doctrine_Record

getRecord()

getter for record attribute.

void

setIteratorOptions(mixed options, int )

sets node's iterator options.

void

setIteratorType(mixed type, int )

sets node's iterator type.

void

setRecord(object record)

setter for record attribute.

void

traverse(string type, array options)

convenience function for getIterator.

Field Detail

/Doctrine/Node.php at line 60

_tree

protected unknown_type $_tree

The tree to which the node belongs.


/Doctrine/Node.php at line 53

iteratorOptions

protected mixed $iteratorOptions


/Doctrine/Node.php at line 48

iteratorType

protected mixed $iteratorType


/Doctrine/Node.php at line 43

options

protected mixed $options


/Doctrine/Node.php at line 38

record

protected mixed $record


Constructor Detail

/Doctrine/Node.php at line 68

Doctrine_Node

public Doctrine_Node(object record, array options)

contructor, creates node with reference to record and any options

Parameters:
record - instance of Doctrine_Record
options - options

Method Detail

/Doctrine/Node.php at line 115

factory

public static Doctrine_Node factory(object record, string implName, array options)

Factory method for creating a Node.

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

Parameters:
record - instance of Doctrine_Record
implName - implementation (NestedSet, AdjacencyList, MaterializedPath)
options - options
Throws:
if $implName is not a valid class

/Doctrine/Node.php at line 163

getIterator

public void getIterator(string type, array options)

get iterator

Parameters:
type - type of iterator (Pre | Post | Level)
options - options

/Doctrine/Node.php at line 141

getRecord

public Doctrine_Record getRecord()

getter for record attribute


/Doctrine/Node.php at line 194

setIteratorOptions

public void setIteratorOptions(mixed options, int )

sets node's iterator options


/Doctrine/Node.php at line 184

setIteratorType

public void setIteratorType(mixed type, int )

sets node's iterator type


/Doctrine/Node.php at line 131

setRecord

public void setRecord(object record)

setter for record attribute

Parameters:
record - instance of Doctrine_Record

/Doctrine/Node.php at line 152

traverse

public void traverse(string type, array options)

convenience function for getIterator

Parameters:
type - type of iterator (Pre | Post | Level)
options - options

Doctrine