. */ /** * Doctrine_Tree_Interface * * @package Doctrine * @subpackage Tree * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @link www.phpdoctrine.org * @since 1.0 * @version $Revision$ * @author Joe Simms */ interface Doctrine_Tree_Interface { /** * creates root node from given record or from a new record * * @param object $record instance of Doctrine_Entity */ public function createRoot(Doctrine_Entity $record = null); /** * returns root node * * @return object $record instance of Doctrine_Entity */ public function findRoot($root_id = 1); /** * optimised method to returns iterator for traversal of the entire tree from root * * @param array $options options * @return object $iterator instance of Doctrine_Node__PreOrderIterator */ public function fetchTree($options = array()); /** * optimised method that returns iterator for traversal of the tree from the given record primary key * * @param mixed $pk primary key as used by table::find() to locate node to traverse tree from * @param array $options options * @return iterator instance of Doctrine_Node__PreOrderIterator */ public function fetchBranch($pk, $options = array()); }