<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class NestedSet</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class NestedSet</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A class to use nested sets easiely</p>
<ul class="tags">
<li><span class="field">author:</span> Mark Stuppacher <<a href="mailto:hide@address.com">hide@address.com</a>></li>
<li><span class="field">version:</span> 0.6</li>
<li><span class="field">license:</span> <a href="http://opensource.org/licenses/gpl-3.0.html">GNU General Public License version 3 (GPLv3)</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_nestedset.class.php.html">/nestedset.class.php</a> (line <span class="field"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a10">10</a></span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">object</span>
<a href="#$db" title="details" class="var-name">$db</a>
</div>
<div class="var-title">
<span class="var-type">unknown_type</span>
<a href="#$name" title="details" class="var-name">$name</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$pk" title="details" class="var-name">$pk</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$table" title="details" class="var-name">$table</a>
</div>
</div>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
(<span class="var-type">object</span> <span class="var-name">$mysqli</span>)
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#createRootNode" title="details" class="method-name">createRootNode</a>
(<span class="var-type">string</span> <span class="var-name">$name</span>)
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#deleteNode" title="details" class="method-name">deleteNode</a>
(<span class="var-type">integer</span> <span class="var-name">$id</span>)
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#deleteSingleNode" title="details" class="method-name">deleteSingleNode</a>
(<span class="var-type">integer</span> <span class="var-name">$id</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#error" title="details" class="method-name">error</a>
(<span class="var-type">int</span> <span class="var-name">$id</span>, [<span class="var-type">boolean</span> <span class="var-name">$continue</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">integer</span>
<a href="#getIdLft" title="details" class="method-name">getIdLft</a>
(<span class="var-type">integer</span> <span class="var-name">$lft</span>)
</div>
<div class="method-definition">
<span class="method-result">integer</span>
<a href="#getIdRgt" title="details" class="method-name">getIdRgt</a>
(<span class="var-type">integer</span> <span class="var-name">$rgt</span>)
</div>
<div class="method-definition">
<span class="method-result">object object</span>
<a href="#getNode" title="details" class="method-name">getNode</a>
(<span class="var-type">integer</span> <span class="var-name">$id</span>)
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#getPath" title="details" class="method-name">getPath</a>
(<span class="var-type">integer</span> <span class="var-name">$id</span>)
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#getTree" title="details" class="method-name">getTree</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#insertChildNode" title="details" class="method-name">insertChildNode</a>
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">integer</span> <span class="var-name">$parent</span>)
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#insertNode" title="details" class="method-name">insertNode</a>
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">integer</span> <span class="var-name">$lft</span>, <span class="var-type">integer</span> <span class="var-name">$rgt</span>)
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#moveLft" title="details" class="method-name">moveLft</a>
(<span class="var-type">$nodeId</span> <span class="var-name">$nodeId</span>)
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#moveRgt" title="details" class="method-name">moveRgt</a>
(<span class="var-type">$nodeId</span> <span class="var-name">$nodeId</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#treeAsHtml" title="details" class="method-name">treeAsHtml</a>
()
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="var$db" id="$db"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">object</span>
<span class="var-name">$db</span>
(line <span class="line-number"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a18">18</a></span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Mysqli object</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$name" id="$name"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">unknown_type</span>
<span class="var-name">$name</span>
= <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a36">36</a></span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Namefield in the database table</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$pk" id="$pk"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$pk</span>
= <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a30">30</a></span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Primary key of the database table</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$table" id="$table"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$table</span>
= <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a24">24</a></span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Name of the database table</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a45">45</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Stores a Mysqli object for further use</p>
<ul class="tags">
<li><span class="field">return:</span> true</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
__construct
</span>
(<span class="var-type">object</span> <span class="var-name">$mysqli</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">object</span>
<span class="var-name">$mysqli</span><span class="var-description">: Mysqli object</span> </li>
</ul>
</div>
<a name="methodcreateRootNode" id="createRootNode"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">createRootNode</span> (line <span class="line-number"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a56">56</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Creates the root node</p>
<ul class="tags">
<li><span class="field">return:</span> true</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
createRootNode
</span>
(<span class="var-type">string</span> <span class="var-name">$name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: Name of the new node</span> </li>
</ul>
</div>
<a name="methoddeleteNode" id="deleteNode"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">deleteNode</span> (line <span class="line-number"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a172">172</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Deletes a node an all it's children</p>
<ul class="tags">
<li><span class="field">return:</span> true</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
deleteNode
</span>
(<span class="var-type">integer</span> <span class="var-name">$id</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$id</span><span class="var-description">: id of the node to delete</span> </li>
</ul>
</div>
<a name="methoddeleteSingleNode" id="deleteSingleNode"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">deleteSingleNode</span> (line <span class="line-number"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a191">191</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Deletes a node and increases the level of all children by one</p>
<ul class="tags">
<li><span class="field">return:</span> true</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
deleteSingleNode
</span>
(<span class="var-type">integer</span> <span class="var-name">$id</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$id</span><span class="var-description">: id of the node to delete</span> </li>
</ul>
</div>
<a name="methoderror" id="error"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">error</span> (line <span class="line-number"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a342">342</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Prints a error message</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
error
</span>
(<span class="var-type">int</span> <span class="var-name">$id</span>, [<span class="var-type">boolean</span> <span class="var-name">$continue</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">int</span>
<span class="var-name">$id</span><span class="var-description">: array-key of the message</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$continue</span><span class="var-description">: continue script or not</span> </li>
</ul>
</div>
<a name="methodgetIdLft" id="getIdLft"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getIdLft</span> (line <span class="line-number"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a287">287</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the id of a node depending on it's lft value</p>
<ul class="tags">
<li><span class="field">return:</span> id of the node</li>
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">integer</span>
<span class="method-name">
getIdLft
</span>
(<span class="var-type">integer</span> <span class="var-name">$lft</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$lft</span><span class="var-description">: lft value of the node</span> </li>
</ul>
</div>
<a name="methodgetIdRgt" id="getIdRgt"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getIdRgt</span> (line <span class="line-number"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a233">233</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the id of a node depending on it's rgt value</p>
<ul class="tags">
<li><span class="field">return:</span> id of the node</li>
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">integer</span>
<span class="method-name">
getIdRgt
</span>
(<span class="var-type">integer</span> <span class="var-name">$rgt</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$rgt</span><span class="var-description">: rgt value of the node</span> </li>
</ul>
</div>
<a name="methodgetNode" id="getNode"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getNode</span> (line <span class="line-number"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a98">98</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets an object with all data of a node</p>
<ul class="tags">
<li><span class="field">return:</span> with node-data (id, lft, rgt)</li>
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">object object</span>
<span class="method-name">
getNode
</span>
(<span class="var-type">integer</span> <span class="var-name">$id</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$id</span><span class="var-description">: id of the node</span> </li>
</ul>
</div>
<a name="methodgetPath" id="getPath"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getPath</span> (line <span class="line-number"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a212">212</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets a multidimensional array containing the path to defined node</p>
<ul class="tags">
<li><span class="field">return:</span> multidimensional array with the data of the nodes in the tree</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
getPath
</span>
(<span class="var-type">integer</span> <span class="var-name">$id</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$id</span><span class="var-description">: id of the node to which the path should point</span> </li>
</ul>
</div>
<a name="methodgetTree" id="getTree"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getTree</span> (line <span class="line-number"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a128">128</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Creates a multi-dimensional array of the whole tree</p>
<ul class="tags">
<li><span class="field">return:</span> multi-dimenssional array of the whole tree</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
getTree
</span>
()
</div>
</div>
<a name="methodinsertChildNode" id="insertChildNode"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">insertChildNode</span> (line <span class="line-number"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a115">115</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Creates a new child node of the node with the given id</p>
<ul class="tags">
<li><span class="field">return:</span> true</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
insertChildNode
</span>
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">integer</span> <span class="var-name">$parent</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: name of the new node</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$parent</span><span class="var-description">: id of the parent node</span> </li>
</ul>
</div>
<a name="methodinsertNode" id="insertNode"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">insertNode</span> (line <span class="line-number"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a82">82</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Creates a new node</p>
<ul class="tags">
<li><span class="field">return:</span> true</li>
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
insertNode
</span>
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">integer</span> <span class="var-name">$lft</span>, <span class="var-type">integer</span> <span class="var-name">$rgt</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: name of the new node</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$lft</span><span class="var-description">: lft of parent node</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$rgt</span><span class="var-description">: rgt of parent node</span> </li>
</ul>
</div>
<a name="methodmoveLft" id="moveLft"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">moveLft</span> (line <span class="line-number"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a249">249</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Moves a node one position to the left staying in the same level</p>
<ul class="tags">
<li><span class="field">return:</span> true</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
moveLft
</span>
(<span class="var-type">$nodeId</span> <span class="var-name">$nodeId</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">$nodeId</span>
<span class="var-name">$nodeId</span><span class="var-description">: id of the node to move</span> </li>
</ul>
</div>
<a name="methodmoveRgt" id="moveRgt"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">moveRgt</span> (line <span class="line-number"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a303">303</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Moves a node one position to the right staying in the same level</p>
<ul class="tags">
<li><span class="field">return:</span> true</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
moveRgt
</span>
(<span class="var-type">$nodeId</span> <span class="var-name">$nodeId</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">$nodeId</span>
<span class="var-name">$nodeId</span><span class="var-description">: id of the node to move</span> </li>
</ul>
</div>
<a name="methodtreeAsHtml" id="treeAsHtml"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">treeAsHtml</span> (line <span class="line-number"><a href="../__filesource/fsource_Nestedset__nestedset.class.php.html#a148">148</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the HTML code for an unordered list of the tree</p>
<ul class="tags">
<li><span class="field">return:</span> HTML code for an unordered list of the whole tree</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
treeAsHtml
</span>
()
</div>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Mon, 16 Feb 2009 22:00:16 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
</p>
</div></body>
</html>