mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
65d4ed89fb
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@277593 c90b9560-bf6c-de11-be94-00142212c4b1
124 lines
2.5 KiB
XML
124 lines
2.5 KiB
XML
<?xml version='1.0' encoding='iso-8859-1'?>
|
|
<!-- $Revision: 1.9 $ -->
|
|
<refentry xml:id="function.tidy-get-root" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>tidy_get_root</refname>
|
|
<refpurpose>Returns a tidyNode object representing the root of the tidy parse tree</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<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>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>object</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The tidy object.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the <classname>tidyNode</classname> object.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<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>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
¬e.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
|
|
-->
|