275 lines
47 KiB
HTML
275 lines
47 KiB
HTML
|
|
||
|
|
<div id="content">
|
||
|
|
<h1 align="center">Source for file Interface.php</h1>
|
||
|
|
<p>Documentation is available at <a href="../Doctrine/_Doctrine---Node---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_Node_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_Node_Interface.html">Doctrine_Node_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"> * test if node has previous sibling</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">@return </span><span class="src-doc-type">bool </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_Node_Interface.html#methodhasPrevSibling">hasPrevSibling</a><span class="src-sym">(</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"> * test if node has next sibling</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">bool </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_Node_Interface.html#methodhasNextSibling">hasNextSibling</a><span class="src-sym">(</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"> * test if node has children</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">@return </span><span class="src-doc-type">bool </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a52"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a53"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodhasChildren">hasChildren</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a54"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a55"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a56"></a><span class="src-doc"> * test if node has parent</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a57"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a58"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a59"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a60"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodhasParent">hasParent</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a61"></a> </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-doc"> * gets record of prev sibling or empty record</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a64"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a65"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">object </span><span class="src-doc-type">Doctrine_Record </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a66"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a67"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodgetPrevSibling">getPrevSibling</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a68"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a69"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a70"></a><span class="src-doc"> * gets record of next sibling or empty record</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a71"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a72"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">object </span><span class="src-doc-type">Doctrine_Record </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a73"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a74"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodgetNextSibling">getNextSibling</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a75"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a76"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a77"></a><span class="src-doc"> * gets siblings for node</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a78"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a79"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array </span><span class="src-doc"> array of sibling Doctrine_Record objects</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a80"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a81"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodgetSiblings">getSiblings</a><span class="src-sym">(</span><span class="src-var">$includeNode </span>= <span class="src-id">false</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a82"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a83"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a84"></a><span class="src-doc"> * gets record of first child or empty record</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a85"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a86"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">object </span><span class="src-doc-type">Doctrine_Record </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a87"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a88"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodgetFirstChild">getFirstChild</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a89"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a90"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a91"></a><span class="src-doc"> * gets record of last child or empty record</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a92"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a93"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">object </span><span class="src-doc-type">Doctrine_Record </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a94"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a95"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodgetLastChild">getLastChild</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a96"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a97"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a98"></a><span class="src-doc"> * gets children for node (direct descendants only)</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a99"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a100"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array </span><span class="src-doc"> array of sibling Doctrine_Record objects</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a101"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a102"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodgetChildren">getChildren</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a103"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a104"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a105"></a><span class="src-doc"> * gets descendants for node (direct descendants only)</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a106"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a107"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">iterator </span><span class="src-doc"> iterator to traverse descendants from node</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a108"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a109"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodgetDescendants">getDescendants</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a110"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a111"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a112"></a><span class="src-doc"> * gets record of parent or empty record</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a113"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a114"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">object </span><span class="src-doc-type">Doctrine_Record </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a115"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a116"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodgetParent">getParent</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a117"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a118"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a119"></a><span class="src-doc"> * gets ancestors for node</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a120"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a121"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">object </span><span class="src-doc-type">Doctrine_Collection </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a122"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a123"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodgetAncestors">getAncestors</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a124"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a125"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a126"></a><span class="src-doc"> * gets path to node from root, uses record::toString() method to get node names</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a127"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a128"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$seperator </span><span class="src-doc"> path seperator</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a129"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$includeNode </span><span class="src-doc"> whether or not to include node at end of path</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a130"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span><span class="src-doc"> string representation of path</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a131"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a132"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodgetPath">getPath</a><span class="src-sym">(</span><span class="src-var">$seperator </span>= <span class="src-str">' > '</span><span class="src-sym">, </span><span class="src-var">$includeNode </span>= <span class="src-id">false</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a133"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a134"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a135"></a><span class="src-doc"> * gets level (depth) of node in the tree</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a136"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a137"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">int </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a138"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a139"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodgetLevel">getLevel</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a140"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a141"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a142"></a><span class="src-doc"> * gets number of children (direct descendants)</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a143"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a144"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">int </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a145"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a146"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodgetNumberChildren">getNumberChildren</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a147"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a148"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a149"></a><span class="src-doc"> * gets number of descendants (children and their children)</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a150"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a151"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">int </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a152"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a153"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodgetNumberDescendants">getNumberDescendants</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a154"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a155"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a156"></a><span class="src-doc"> * inserts node as parent of dest record</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a157"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a158"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a159"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a160"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodinsertAsParentOf">insertAsParentOf</a><span class="src-sym">(</span><span class="src-id">Doctrine_Record </span><span class="src-var">$dest</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a161"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a162"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a163"></a><span class="src-doc"> * inserts node as previous sibling of dest record</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a164"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a165"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a166"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a167"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodinsertAsPrevSiblingOf">insertAsPrevSiblingOf</a><span class="src-sym">(</span><span class="src-id">Doctrine_Record </span><span class="src-var">$dest</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a168"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a169"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a170"></a><span class="src-doc"> * inserts node as next sibling of dest record</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a171"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a172"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a173"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a174"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodinsertAsNextSiblingOf">insertAsNextSiblingOf</a><span class="src-sym">(</span><span class="src-id">Doctrine_Record </span><span class="src-var">$dest</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a175"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a176"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a177"></a><span class="src-doc"> * inserts node as first child of dest record</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a178"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a179"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a180"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a181"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodinsertAsFirstChildOf">insertAsFirstChildOf</a><span class="src-sym">(</span><span class="src-id">Doctrine_Record </span><span class="src-var">$dest</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a182"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a183"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a184"></a><span class="src-doc"> * inserts node as first child of dest record</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a185"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a186"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a187"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a188"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodinsertAsLastChildOf">insertAsLastChildOf</a><span class="src-sym">(</span><span class="src-id">Doctrine_Record </span><span class="src-var">$dest</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a189"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a190"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a191"></a><span class="src-doc"> * moves node as prev sibling of dest record</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a192"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a193"></a><span class="src-doc"> */ </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a194"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodmoveAsPrevSiblingOf">moveAsPrevSiblingOf</a><span class="src-sym">(</span><span class="src-id">Doctrine_Record </span><span class="src-var">$dest</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a195"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a196"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a197"></a><span class="src-doc"> * moves node as next sibling of dest record</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a198"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a199"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a200"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodmoveAsNextSiblingOf">moveAsNextSiblingOf</a><span class="src-sym">(</span><span class="src-id">Doctrine_Record </span><span class="src-var">$dest</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a201"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a202"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a203"></a><span class="src-doc"> * moves node as first child of dest record</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a204"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a205"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a206"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodmoveAsFirstChildOf">moveAsFirstChildOf</a><span class="src-sym">(</span><span class="src-id">Doctrine_Record </span><span class="src-var">$dest</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a207"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a208"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a209"></a><span class="src-doc"> * moves node as last child of dest record</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a210"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a211"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a212"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodmoveAsLastChildOf">moveAsLastChildOf</a><span class="src-sym">(</span><span class="src-id">Doctrine_Record </span><span class="src-var">$dest</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a213"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a214"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a215"></a><span class="src-doc"> * adds node as last child of record</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a216"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a217"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a218"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodaddChild">addChild</a><span class="src-sym">(</span><span class="src-id">Doctrine_Record </span><span class="src-var">$record</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a219"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a220"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a221"></a><span class="src-doc"> * determines if node is leaf</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a222"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a223"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a224"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a225"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodisLeaf">isLeaf</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a226"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a227"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a228"></a><span class="src-doc"> * determines if node is root</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a229"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a230"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a231"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a232"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodisRoot">isRoot</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a233"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a234"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a235"></a><span class="src-doc"> * determines if node is equal to subject node</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a236"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a237"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a238"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a239"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodisEqualTo">isEqualTo</a><span class="src-sym">(</span><span class="src-id">Doctrine_Record </span><span class="src-var">$subj</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a240"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a241"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a242"></a><span class="src-doc"> * determines if node is child of subject node</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a243"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a244"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a245"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a246"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodisDescendantOf">isDescendantOf</a><span class="src-sym">(</span><span class="src-id">Doctrine_Record </span><span class="src-var">$subj</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a247"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a248"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a249"></a><span class="src-doc"> * determines if node is child of or sibling to subject node</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a250"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a251"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a252"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a253"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodisDescendantOfOrEqualTo">isDescendantOfOrEqualTo</a><span class="src-sym">(</span><span class="src-id">Doctrine_Record </span><span class="src-var">$subj</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a254"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a255"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a256"></a><span class="src-doc"> * determines if node is valid</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a257"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a258"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a259"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a260"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methodisValidNode">isValidNode</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a261"></a> </div></li>
|
||
|
|
<li><div class="src-line"><a name="a262"></a> <span class="src-doc">/**</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a263"></a><span class="src-doc"> * deletes node and it's descendants</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a264"></a><span class="src-doc"> *</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a265"></a><span class="src-doc"> */</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a266"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Node_Interface.html#methoddelete">delete</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||
|
|
<li><div class="src-line"><a name="a267"></a><span class="src-sym">}</span></div></li>
|
||
|
|
</ol>
|
||
|
|
</span></div>
|
||
|
|
</div>
|