72 lines
13 KiB
HTML
72 lines
13 KiB
HTML
|
|
||
|
|
<div id="content">
|
||
|
|
<h1 align="center">Source for file Interface.php</h1>
|
||
|
|
<p>Documentation is available at <a href="../Doctrine/_Doctrine---Tree---Interface.php.html">Interface.php</a></p>
|
||
|
|
<div class="src-code"><span class="php">
|
||
|
|
<ol><li><div class="src-line"><a name="a1"></a><span class="src-php"><?php</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a2"></a><span class="src-comm">/*</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a3"></a><span class="src-comm"> * $Id: Interface.php 1080 2007-02-10 18:17:08Z romanb $</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a4"></a><span class="src-comm"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a5"></a><span class="src-comm"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a6"></a><span class="src-comm"> * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a7"></a><span class="src-comm"> * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a8"></a><span class="src-comm"> * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a9"></a><span class="src-comm"> * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a10"></a><span class="src-comm"> * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a11"></a><span class="src-comm"> * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a12"></a><span class="src-comm"> * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a13"></a><span class="src-comm"> * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a14"></a><span class="src-comm"> * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a15"></a><span class="src-comm"> * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a16"></a><span class="src-comm"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a17"></a><span class="src-comm"> * This software consists of voluntary contributions made by many individuals</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a18"></a><span class="src-comm"> * and is licensed under the LGPL. For more information, see</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a19"></a><span class="src-comm"> * <http://www.phpdoctrine.com>.</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a20"></a><span class="src-comm"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a21"></a><span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a22"></a><span class="src-doc"> * Doctrine_Tree_Interface</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a23"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a24"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> Doctrine</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a25"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@license</span><span class="src-doc"> http://www.opensource.org/licenses/lgpl-license.php LGPL</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a26"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@category</span><span class="src-doc"> Object Relational Mapping</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a27"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@link</span><span class="src-doc"> www.phpdoctrine.com</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a28"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@since</span><span class="src-doc"> 1.0</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a29"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@version</span><span class="src-doc"> $Revision: 1080 $</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a30"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@author</span><span class="src-doc"> Joe Simms <joe.simms@websites4.com></span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a31"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a32"></a><span class="src-key">interface </span><a href="../Doctrine/Doctrine_Tree_Interface.html">Doctrine_Tree_Interface</a> <span class="src-sym">{</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a33"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a34"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a35"></a><span class="src-doc"> * creates root node from given record or from a new record</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a36"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a37"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">object </span><span class="src-doc-var">$record </span><span class="src-doc"> instance of Doctrine_Record</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a38"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a39"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Tree_Interface.html#methodcreateRoot">createRoot</a><span class="src-sym">(</span><span class="src-id">Doctrine_Record </span><span class="src-var">$record </span>= <span class="src-id">null</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a40"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a41"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a42"></a><span class="src-doc"> * returns root node</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a43"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a44"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">object </span><span class="src-doc">$record instance of Doctrine_Record</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a45"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a46"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Tree_Interface.html#methodfindRoot">findRoot</a><span class="src-sym">(</span><span class="src-var">$root_id </span>= <span class="src-num">1</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a47"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a48"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a49"></a><span class="src-doc"> * optimised method to returns iterator for traversal of the entire tree from root</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a50"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a51"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc-var">$options </span><span class="src-doc"> options</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a52"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">object </span><span class="src-doc">$iterator instance of Doctrine_Node_<Implementation>_PreOrderIterator</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a53"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a54"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Tree_Interface.html#methodfetchTree">fetchTree</a><span class="src-sym">(</span><span class="src-var">$options </span>= <span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a55"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a56"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a57"></a><span class="src-doc"> * optimised method that returns iterator for traversal of the tree from the given record primary key</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a58"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a59"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$pk </span><span class="src-doc"> primary key as used by table::find() to locate node to traverse tree from</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a60"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc-var">$options </span><span class="src-doc"> options</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a61"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">iterator </span><span class="src-doc"> instance of Doctrine_Node_<Implementation>_PreOrderIterator</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a62"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a63"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Tree_Interface.html#methodfetchBranch">fetchBranch</a><span class="src-sym">(</span><span class="src-var">$pk</span><span class="src-sym">, </span><span class="src-var">$options </span>= <span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a64"></a><span class="src-sym">}</span></div></li>
|
||
|
|
</ol>
|
||
|
|
</span></div>
|
||
|
|
</div>
|