<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Returns a tidyNode object representing the root of the tidy parse tree</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tidy.repairstring.html">tidy::repairString</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.tidynode.html">tidyNode</a></div>
<div class="up"><a href="class.tidy.html">tidy</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="tidy.root" class="refentry">
<div class="refnamediv">
<h1 class="refname">tidy::root</h1>
<h1 class="refname">tidy_get_root</h1>
<p class="verinfo">(PHP 5, PECL tidy 0.5.2-1.0.0)</p><p class="refpurpose"><span class="refname">tidy::root</span> -- <span class="refname">tidy_get_root</span> — <span class="dc-title">Returns a <a href="class.tidynode.html" class="classname">tidyNode</a> object representing the root of the tidy parse tree</span></p>
</div>
<div class="refsect1 description" id="refsect1-tidy.root-description">
<h3 class="title">Description</h3>
<p class="para">Object oriented style</p>
<div class="methodsynopsis dc-description">
<span class="type"><a href="class.tidynode.html" class="type tidyNode">tidyNode</a></span> <span class="methodname"><strong>tidy::root</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">Procedural style</p>
<div class="methodsynopsis dc-description">
<span class="type"><a href="class.tidynode.html" class="type tidyNode">tidyNode</a></span> <span class="methodname"><strong>tidy_get_root</strong></span>
( <span class="methodparam"><span class="type"><a href="class.tidy.html" class="type tidy">tidy</a></span> <code class="parameter">$object</code></span>
)</div>
<p class="para rdfs-comment">
Returns a <a href="class.tidynode.html" class="classname">tidyNode</a> object representing the
root of the tidy parse tree.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-tidy.root-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">object</code></em></span>
<dd>
<p class="para">
The <a href="class.tidy.html" class="classname">Tidy</a> object.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-tidy.root-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the <a href="class.tidynode.html" class="classname">tidyNode</a> object.
</p>
</div>
<div class="refsect1 examples" id="refsect1-tidy.root-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4059">
<p><strong>Example #1 <span class="function"><strong>tidy::root()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$html </span><span style="color: #007700">= <<< HTML<br /></span><span style="color: #DD0000"><html><body><br /><br /><p>paragraph</p><br /><br/><br /><br /></body></html><br /></span><span style="color: #007700">HTML;<br /><br /></span><span style="color: #0000BB">$tidy </span><span style="color: #007700">= </span><span style="color: #0000BB">tidy_parse_string</span><span style="color: #007700">(</span><span style="color: #0000BB">$html</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">dump_nodes</span><span style="color: #007700">(</span><span style="color: #0000BB">$tidy</span><span style="color: #007700">-></span><span style="color: #0000BB">root</span><span style="color: #007700">(), </span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /><br /><br />function </span><span style="color: #0000BB">dump_nodes</span><span style="color: #007700">(</span><span style="color: #0000BB">$node</span><span style="color: #007700">, </span><span style="color: #0000BB">$indent</span><span style="color: #007700">) {<br /><br /> if(</span><span style="color: #0000BB">$node</span><span style="color: #007700">-></span><span style="color: #0000BB">hasChildren</span><span style="color: #007700">()) {<br /> foreach(</span><span style="color: #0000BB">$node</span><span style="color: #007700">-></span><span style="color: #0000BB">child </span><span style="color: #007700">as </span><span style="color: #0000BB">$child</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">str_repeat</span><span style="color: #007700">(</span><span style="color: #DD0000">'.'</span><span style="color: #007700">, </span><span style="color: #0000BB">$indent</span><span style="color: #007700">*</span><span style="color: #0000BB">2</span><span style="color: #007700">) . (</span><span style="color: #0000BB">$child</span><span style="color: #007700">-></span><span style="color: #0000BB">name </span><span style="color: #007700">? </span><span style="color: #0000BB">$child</span><span style="color: #007700">-></span><span style="color: #0000BB">name </span><span style="color: #007700">: </span><span style="color: #DD0000">'"'</span><span style="color: #007700">.</span><span style="color: #0000BB">$child</span><span style="color: #007700">-></span><span style="color: #0000BB">value</span><span style="color: #007700">.</span><span style="color: #DD0000">'"'</span><span style="color: #007700">). </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /> </span><span style="color: #0000BB">dump_nodes</span><span style="color: #007700">(</span><span style="color: #0000BB">$child</span><span style="color: #007700">, </span><span style="color: #0000BB">$indent</span><span style="color: #007700">+</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /> }<br /> }<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
..html
....head
......title
....body
......p
........"paragraph"
......br
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-tidy.root-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara"> This function is only available with
Zend Engine 2 (PHP >= 5.0.0).</span></p></blockquote>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tidy.repairstring.html">tidy::repairString</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.tidynode.html">tidyNode</a></div>
<div class="up"><a href="class.tidy.html">tidy</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
