Class: Doctrine_Node
Source Location: /Doctrine/Node.phpClass Doctrine_Node
Class Overview
|
Implements interfaces:
Doctrine_Node Located in /Doctrine/Node.php [line 32] Author(s):
|
[ Top ]
Direct descendents
| Child Class | Description |
|---|---|
| Doctrine_Node_AdjacencyList | Doctrine_Node_AdjacencyList |
| Doctrine_Node_MaterializedPath | Doctrine_Node_MaterializedPath |
| Doctrine_Node_NestedSet | Doctrine_Node_NestedSet |
[ Top ]
Property Summary
| mixed | $iteratorOptions | |
| mixed | $iteratorType | |
| mixed | $options | |
| mixed | $record | |
| unknown_type | $_tree | The tree to which the node belongs. |
[ Top ]
Method Summary
| static object | factory() | factory method to return node instance based upon chosen implementation |
| Doctrine_Node | __construct() | contructor, creates node with reference to record and any options |
| void | getIterator() | get iterator |
| object instance | getRecord() | getter for record attribute |
| void | setIteratorOptions() | sets node's iterator options |
| void | setIteratorType() | sets node's iterator type |
| void | setRecord() | setter for record attribute |
| void | traverse() | convenience function for getIterator |
[ Top ]
Methods
static method factory [line 82]
|
factory method to return node instance based upon chosen implementation
Parameters:| object | $record: | instance of Doctrine_Record |
| string | $impName: | implementation (NestedSet, AdjacencyList, MaterializedPath) |
| array | $options: | options |
| $implName: |
API Tags:
| Return: | instance of Doctrine_Node |
| Access: | public |
[ Top ]
Constructor __construct [line 67]
|
contructor, creates node with reference to record and any options
Parameters:| object | $record: | instance of Doctrine_Record |
| array | $options: | options |
API Tags:
| Access: | public |
[ Top ]
getIterator [line 130]
|
get iterator
Parameters:| string | $type: | type of iterator (Pre | Post | Level) |
| array | $options: | options |
API Tags:
| Access: | public |
Implementation of:
- IteratorAggregate::getIterator
[ Top ]
getRecord [line 108]
|
getter for record attribute
API Tags:
| Return: | of Doctrine_Record |
| Access: | public |
[ Top ]
setIteratorOptions [line 161]
|
sets node's iterator options
Parameters:| int | $options: |
API Tags:
| Access: | public |
[ Top ]
setIteratorType [line 151]
|
sets node's iterator type
Parameters:| int | $type: |
API Tags:
| Access: | public |
[ Top ]
setRecord [line 98]
|
setter for record attribute
Parameters:| object | $record: | instance of Doctrine_Record |
API Tags:
| Access: | public |
[ Top ]