php-doc-en/reference/tidy/functions/tidy-get-root.xml
Nuno Lopes 1b39e2c563 tidy docs revision part 1
fix return/parameter types
add some examples
rename some files, tidy_node to tidyNode


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@172700 c90b9560-bf6c-de11-be94-00142212c4b1
2004-11-15 15:54:28 +00:00

96 lines
2 KiB
XML

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.6 $ -->
<refentry id="function.tidy-get-root">
<refnamediv>
<refname>tidy_get_root</refname>
<refpurpose>
Returns a tidyNode object representing the root of the tidy parse tree
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>tidyNode</type><methodname>tidy_get_root</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>tidyNode</type><methodname>tidy->root</methodname>
<void />
</methodsynopsis>
<para>
Returns a tidyNode object representing the root of the tidy parse tree.
</para>
<para>
<example>
<title>dump nodes</title>
<programlisting role="php">
<![CDATA[
<?php
$html = <<< HTML
<html><body>
<p>paragraph</p>
<br/>
</body></html>
HTML;
$tidy = tidy_parse_string($html);
dump_nodes($tidy->root(), 1);
function dump_nodes($node, $indent) {
if($node->hasChildren()) {
foreach($node->child as $child) {
echo str_repeat('.', $indent*2) . ($child->name ? $child->name : '"'.$child->value.'"'). "\n";
dump_nodes($child, $indent+1);
}
}
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
..html
....head
......title
....body
......p
........"paragraph"
......br
]]>
</screen>
</example>
</para>
&note.tidy.ze2;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->