138 lines
27 KiB
HTML
138 lines
27 KiB
HTML
|
|
<div id="content">
|
|
<h1 align="center">Source for file Tree.php</h1>
|
|
<p>Documentation is available at <a href="../Doctrine/_Doctrine---Tree.php.html">Tree.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: Tree.php 2097 2007-07-29 19:38:11Z 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</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: 2097 $</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">class </span><a href="../Doctrine/Doctrine_Tree.html">Doctrine_Tree</a></div></li>
|
|
<li><div class="src-line"><a name="a33"></a><span class="src-sym">{</span></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"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">object </span><span class="src-doc-var">$table </span><span class="src-doc"> reference to associated Doctrine_Table instance</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-key">protected </span><a href="../Doctrine/Doctrine_Tree.html#var$table">$table</a><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a38"></a> </div></li>
|
|
<li><div class="src-line"><a name="a39"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a40"></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></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-key">protected </span><a href="../Doctrine/Doctrine_Tree.html#var$options">$options</a> = <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="a43"></a> </div></li>
|
|
<li><div class="src-line"><a name="a44"></a> <span class="src-key">protected </span><a href="../Doctrine/Doctrine_Tree.html#var$_baseComponent">$_baseComponent</a><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a45"></a> </div></li>
|
|
<li><div class="src-line"><a name="a46"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a47"></a><span class="src-doc"> * constructor, creates tree with reference to table and any options</span></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"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">object </span><span class="src-doc-var">$table </span><span class="src-doc"> instance of Doctrine_Table</span></div></li>
|
|
<li><div class="src-line"><a name="a50"></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="a51"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a52"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Tree.html#method__construct">__construct</a><span class="src-sym">(</span><span class="src-id">Doctrine_Table </span><span class="src-var">$table</span><span class="src-sym">, </span><span class="src-var">$options</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a53"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a54"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Doctrine/Doctrine_Tree.html#var$table">table</a> = <span class="src-var">$table</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a55"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Doctrine/Doctrine_Tree.html#var$options">options</a> = <span class="src-var">$options</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a56"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Doctrine/Doctrine_Tree.html#var$_baseComponent">_baseComponent</a> = <span class="src-var">$table</span><span class="src-sym">-></span><span class="src-id">getComponentName</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="a57"></a> <span class="src-var">$class </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Doctrine/Doctrine_Tree.html#var$_baseComponent">_baseComponent</a><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a58"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$table</span><span class="src-sym">-></span><span class="src-id">getOption</span><span class="src-sym">(</span><span class="src-str">'inheritanceMap'</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a59"></a> <span class="src-var">$subclasses </span>= <span class="src-var">$table</span><span class="src-sym">-></span><span class="src-id">getOption</span><span class="src-sym">(</span><span class="src-str">'subclasses'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a60"></a> <span class="src-key">while </span><span class="src-sym">(</span><a href="http://www.php.net/in_array">in_array</a><span class="src-sym">(</span><span class="src-var">$class</span><span class="src-sym">, </span><span class="src-var">$subclasses</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a61"></a> <span class="src-var">$class </span>= <a href="http://www.php.net/get_parent_class">get_parent_class</a><span class="src-sym">(</span><span class="src-var">$class</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a62"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a63"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Doctrine/Doctrine_Tree.html#var$_baseComponent">_baseComponent</a> = <span class="src-var">$class</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a64"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a65"></a> <span class="src-comm">//echo $this->_baseComponent;</span></div></li>
|
|
<li><div class="src-line"><a name="a66"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a67"></a> </div></li>
|
|
<li><div class="src-line"><a name="a68"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a69"></a><span class="src-doc"> * Used to define table attributes required for the given implementation</span></div></li>
|
|
<li><div class="src-line"><a name="a70"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a71"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@throws</span><span class="src-doc"> Doctrine_Tree_Exception if table attributes have not been defined</span></div></li>
|
|
<li><div class="src-line"><a name="a72"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a73"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Tree.html#methodsetTableDefinition">setTableDefinition</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a74"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a75"></a> throw <span class="src-key">new </span><span class="src-id"><a href="../Doctrine/Doctrine_Tree_Exception.html">Doctrine_Tree_Exception</a></span><span class="src-sym">(</span><span class="src-str">'Table attributes have not been defined for this Tree implementation.'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a76"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a77"></a> </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"> * this method is used for setting up relations and attributes and should be used by specific implementations</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-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a82"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Tree.html#methodsetUp">setUp</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a83"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a84"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a85"></a> </div></li>
|
|
<li><div class="src-line"><a name="a86"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a87"></a><span class="src-doc"> * factory method to return tree instance based upon chosen implementation</span></div></li>
|
|
<li><div class="src-line"><a name="a88"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a89"></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">$table </span><span class="src-doc"> instance of Doctrine_Table</span></div></li>
|
|
<li><div class="src-line"><a name="a90"></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">$impName </span><span class="src-doc"> implementation (NestedSet, AdjacencyList, MaterializedPath)</span></div></li>
|
|
<li><div class="src-line"><a name="a91"></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="a92"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">object </span><span class="src-doc">$options instance of Doctrine_Node</span></div></li>
|
|
<li><div class="src-line"><a name="a93"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@throws</span><span class="src-doc"> Doctrine_Exception if class does not extend Doctrine_Tree</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">static </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Tree.html#methodfactory">factory</a><span class="src-sym">(</span><span class="src-id">Doctrine_Table </span><span class="src-var">$table</span><span class="src-sym">, </span><span class="src-var">$implName</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></div></li>
|
|
<li><div class="src-line"><a name="a96"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a97"></a> <span class="src-var">$class </span>= <span class="src-str">'Doctrine_Tree_' </span>. <span class="src-var">$implName</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a98"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><a href="http://www.php.net/class_exists">class_exists</a><span class="src-sym">(</span><span class="src-var">$class</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a99"></a> throw <span class="src-key">new </span><span class="src-id"><a href="../Doctrine/Doctrine_Exception.html">Doctrine_Exception</a></span><span class="src-sym">(</span><span class="src-str">'The chosen class must extend Doctrine_Tree'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a100"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a101"></a> <span class="src-key">return </span><span class="src-key">new </span><span class="src-var">$class</span><span class="src-sym">(</span><span class="src-var">$table</span><span class="src-sym">, </span><span class="src-var">$options</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a102"></a> <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 tree attribute value</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></div></li>
|
|
<li><div class="src-line"><a name="a108"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Tree.html#methodgetAttribute">getAttribute</a><span class="src-sym">(</span><span class="src-var">$name</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a109"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a110"></a> <span class="src-key">return </span>isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Doctrine/Doctrine_Tree.html#var$options">options</a><span class="src-sym">[</span><span class="src-var">$name</span><span class="src-sym">]</span><span class="src-sym">) </span>? <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Doctrine/Doctrine_Tree.html#var$options">options</a><span class="src-sym">[</span><span class="src-var">$name</span><span class="src-sym">] </span>: <span class="src-id">null</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a111"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a112"></a> </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"> * sets tree attribute value</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-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span></div></li>
|
|
<li><div class="src-line"><a name="a117"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a118"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Tree.html#methodsetAttribute">setAttribute</a><span class="src-sym">(</span><span class="src-var">$name</span><span class="src-sym">, </span><span class="src-var">$value</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a119"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a120"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Doctrine/Doctrine_Tree.html#var$options">options</a><span class="src-sym">[</span><span class="src-var">$name</span><span class="src-sym">] </span>= <span class="src-var">$value</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a121"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a122"></a> </div></li>
|
|
<li><div class="src-line"><a name="a123"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a124"></a><span class="src-doc"> * Returns the base tree component.</span></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-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Tree.html#methodgetBaseComponent">getBaseComponent</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a127"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a128"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Doctrine/Doctrine_Tree.html#var$_baseComponent">_baseComponent</a><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a129"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a130"></a><span class="src-sym">}</span></div></li>
|
|
</ol>
|
|
</span></div>
|
|
</div> |