| 1 |
lars |
1 |
<?php
|
|
|
2 |
/*
|
|
|
3 |
* $Id: Interface.php 7490 2010-03-29 19:53:27Z jwage $
|
|
|
4 |
*
|
|
|
5 |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
6 |
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
7 |
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
|
8 |
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
|
9 |
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
|
10 |
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
|
11 |
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
|
12 |
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
|
13 |
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
14 |
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
|
15 |
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
16 |
*
|
|
|
17 |
* This software consists of voluntary contributions made by many individuals
|
|
|
18 |
* and is licensed under the LGPL. For more information, see
|
|
|
19 |
* <http://www.doctrine-project.org>.
|
|
|
20 |
*/
|
|
|
21 |
|
|
|
22 |
/**
|
|
|
23 |
* Doctrine_Tree_Interface
|
|
|
24 |
*
|
|
|
25 |
* @package Doctrine
|
|
|
26 |
* @subpackage Tree
|
|
|
27 |
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
|
|
|
28 |
* @link www.doctrine-project.org
|
|
|
29 |
* @since 1.0
|
|
|
30 |
* @version $Revision: 7490 $
|
|
|
31 |
* @author Joe Simms <joe.simms@websites4.com>
|
|
|
32 |
*/
|
|
|
33 |
interface Doctrine_Tree_Interface {
|
|
|
34 |
|
|
|
35 |
/**
|
|
|
36 |
* creates root node from given record or from a new record
|
|
|
37 |
*
|
|
|
38 |
* @param Doctrine_Record $record instance of Doctrine_Record
|
|
|
39 |
*/
|
|
|
40 |
public function createRoot(Doctrine_Record $record = null);
|
|
|
41 |
|
|
|
42 |
/**
|
|
|
43 |
* returns root node
|
|
|
44 |
*
|
|
|
45 |
* @return Doctrine_Record
|
|
|
46 |
*/
|
|
|
47 |
public function fetchRoot($root_id = 1);
|
|
|
48 |
|
|
|
49 |
/**
|
|
|
50 |
* optimised method to returns iterator for traversal of the entire tree from root
|
|
|
51 |
*
|
|
|
52 |
* @param array $options options
|
|
|
53 |
* @param integer $fetchmode One of the Doctrine_Core::HYDRATE_* constants.
|
|
|
54 |
* @return Iterator instance of Doctrine_Node_<Implementation>_PreOrderIterator
|
|
|
55 |
*/
|
|
|
56 |
public function fetchTree($options = array(), $hydrationMode = null);
|
|
|
57 |
|
|
|
58 |
/**
|
|
|
59 |
* optimised method that returns iterator for traversal of the tree from the given record primary key
|
|
|
60 |
*
|
|
|
61 |
* @param mixed $pk primary key as used by table::find() to locate node to traverse tree from
|
|
|
62 |
* @param array $options options
|
|
|
63 |
* @param integer $fetchmode One of the Doctrine_Core::HYDRATE_* constants.
|
|
|
64 |
* @return iterator instance of Doctrine_Node_<Implementation>_PreOrderIterator
|
|
|
65 |
*/
|
|
|
66 |
public function fetchBranch($pk, $options = array(), $hydrationMode = null);
|
|
|
67 |
}
|