Source for file Interface.php

Documentation is available at Interface.php

  1. <?php
  2. /*
  3.  *  $Id: Interface.php 1080 2007-02-10 18:17:08Z romanb $
  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.phpdoctrine.com>.
  20.  */
  21. /**
  22.  * Doctrine_Tree_Interface
  23.  *
  24.  * @package     Doctrine
  25.  * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
  26.  * @category    Object Relational Mapping
  27.  * @link        www.phpdoctrine.com
  28.  * @since       1.0
  29.  * @version     $Revision: 1080 $
  30.  * @author      Joe Simms <joe.simms@websites4.com>
  31.  */
  32. interface Doctrine_Tree_Interface {
  33.  
  34.     /**
  35.      * creates root node from given record or from a new record
  36.      *
  37.      * @param object $record                    instance of Doctrine_Record
  38.      */
  39.     public function createRoot(Doctrine_Record $record = null);
  40.  
  41.     /**
  42.      * returns root node
  43.      *
  44.      * @return object $record                   instance of Doctrine_Record
  45.      */
  46.     public function findRoot($root_id = 1);
  47.  
  48.     /**
  49.      * optimised method to returns iterator for traversal of the entire tree from root
  50.      *
  51.      * @param array $options                    options
  52.      * @return object $iterator                 instance of Doctrine_Node_<Implementation>_PreOrderIterator
  53.      */
  54.     public function fetchTree($options = array());
  55.  
  56.     /**
  57.      * optimised method that returns iterator for traversal of the tree from the given record primary key
  58.      *
  59.      * @param mixed $pk                         primary key as used by table::find() to locate node to traverse tree from
  60.      * @param array $options                    options
  61.      * @return iterator                         instance of Doctrine_Node_<Implementation>_PreOrderIterator
  62.      */
  63.     public function fetchBranch($pk, $options = array());
  64. }