sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 16:38:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

moving to tidyNode folder and function cleanup

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@279258 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Damien Seguy 2009-04-24 13:20:06 +00:00
parent f231e98aa0
commit fc99912654
23 changed files with 1202 additions and 645 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
reference/tidy/book.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<book xml:id="book.tidy" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Tidy</title>
@ -18,6 +18,7 @@
&reference.tidy.setup;
&reference.tidy.constants;
&reference.tidy.examples;
&reference.tidy.tidynode;
&reference.tidy.reference;
</book>

37
reference/tidy/functions/tidy-node-get-attr.xml
View file

@ -1,37 +0,0 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.tidy-node-get-attr" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_node->get_attr</refname>
<refpurpose>Return the attribute with the provided attribute id</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>tidy_attr</type><methodname>tidy_node->get_attr</methodname>
<methodparam><type>int</type><parameter>attrib_id</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
</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
-->

37
reference/tidy/functions/tidy-node-get-nodes.xml
View file

@ -1,37 +0,0 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.tidy-node-get-nodes" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_node->get_nodes</refname>
<refpurpose>Return an array of nodes under this node with the specified id</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>tidy_node->get_nodes</methodname>
<methodparam><type>int</type><parameter>node_id</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
</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
-->

37
reference/tidy/functions/tidy-node-next.xml
View file

@ -1,37 +0,0 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.tidy-node-next" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_node->next</refname>
<refpurpose>Returns the next sibling to this node</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>tidy_node</type><methodname>tidy_node->next</methodname>
<void/>
</methodsynopsis>
&warn.undocumented.func;
</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
-->

37
reference/tidy/functions/tidy-node-prev.xml
View file

@ -1,37 +0,0 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.tidy-node-prev" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_node->prev</refname>
<refpurpose>Returns the previous sibling to this node</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>tidy_node</type><methodname>tidy_node->prev</methodname>
<void/>
</methodsynopsis>
&warn.undocumented.func;
</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
-->

56
reference/tidy/functions/tidyNode-hasChildren.xml
View file

@ -1,56 +0,0 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.tidynode-haschildren" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->hasChildren</refname>
<refpurpose>Returns true if this node has children</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tidyNode->hasChildren</methodname>
<void/>
</methodsynopsis>
<para>
Tells if the current node has children.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the node has children, &false; otherwise.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function was named <function>tidy_node->has_children</function> in
PHP 4/Tidy 1.
</para>
</note>
</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
-->

56
reference/tidy/functions/tidyNode-hasSiblings.xml
View file

@ -1,56 +0,0 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.tidynode-hassiblings" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->hasSiblings</refname>
<refpurpose>Returns true if this node has siblings</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tidyNode->hasSiblings</methodname>
<void/>
</methodsynopsis>
<para>
Tells if the current node has siblings.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the node has siblings, &false; otherwise.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function was named <function>tidy_node->has_siblings</function> in
PHP 4/Tidy 1.
</para>
</note>
</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
-->

56
reference/tidy/functions/tidyNode-isAsp.xml
View file

@ -1,56 +0,0 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.tidynode-isasp" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->isAsp</refname>
<refpurpose>Returns true if this node is ASP</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tidyNode->isAsp</methodname>
<void/>
</methodsynopsis>
<para>
Tells whether the current node is ASP.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the node is ASP, &false; otherwise.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function was named <function>tidy_node->is_asp</function> in
PHP 4/Tidy 1.
</para>
</note>
</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
-->

56
reference/tidy/functions/tidyNode-isComment.xml
View file

@ -1,56 +0,0 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.tidynode-iscomment" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->isComment</refname>
<refpurpose>Returns true if this node represents a comment</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tidyNode->isComment</methodname>
<void/>
</methodsynopsis>
<para>
Tells if the current node is a comment.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the node is a comment, &false; otherwise.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function was named <function>tidy_node->is_comment</function> in
PHP 4/Tidy 1.
</para>
</note>
</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
-->

56
reference/tidy/functions/tidyNode-isHtml.xml
View file

@ -1,56 +0,0 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.tidynode-ishtml" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->isHtml</refname>
<refpurpose>Returns true if this node is part of a HTML document</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tidyNode->isHtml</methodname>
<void/>
</methodsynopsis>
<para>
Tells if the current node is part of HTML document.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the node is part of a HTML document, &false; otherwise.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function was named <function>tidy_node->is_html</function> in
PHP 4/Tidy 1.
</para>
</note>
</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
-->

56
reference/tidy/functions/tidyNode-isJste.xml
View file

@ -1,56 +0,0 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.tidynode-isjste" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->isJste</refname>
<refpurpose>Returns true if this node is JSTE</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tidyNode->isJste</methodname>
<void/>
</methodsynopsis>
<para>
Tells if the current node is JSTE.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the node is JSTE, &false; otherwise.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function was named <function>tidy_node->is_jste</function> in
PHP 4/Tidy 1.
</para>
</note>
</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
-->

56
reference/tidy/functions/tidyNode-isText.xml
View file

@ -1,56 +0,0 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.tidynode-istext" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->isText</refname>
<refpurpose>Returns true if this node represents text (no markup)</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tidyNode->isText</methodname>
<void/>
</methodsynopsis>
<para>
Tells if the node represents a text (no markup).
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the node represent a text, &false; otherwise.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function was named <function>tidy_node->is_text</function> in
PHP 4/Tidy 1.
</para>
</note>
</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
-->

83
reference/tidy/reference.xml
View file

@ -1,92 +1,13 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.17 $ -->
<!-- $Revision: 1.18 $ -->
<!-- Purpose: basic.other -->
<!-- Membership: pecl, bundled, external -->
<reference xml:id="ref.tidy" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Tidy &Functions;</title>
<partintro>
<section xml:id='tidy.classes'>
&reftitle.classes;
&reference.tidy.entities.functions;
<section xml:id='tidy.class.tidynode'>
<title><classname>tidyNode</classname></title>
<section xml:id='tidy.class.tidynode.methods'>
&reftitle.methods;
<itemizedlist>
<listitem>
<para><xref linkend='function.tidynode-getparent' /> - Returns the parent of the current node</para>
</listitem>
<listitem>
<para><xref linkend='function.tidynode-haschildren' /> - Returns &true; if the current node has children</para>
</listitem>
<listitem>
<para><xref linkend='function.tidynode-hassiblings' /> - Returns &true; if the current node has siblings</para>
</listitem>
<listitem>
<para><xref linkend='function.tidynode-isasp' /> - Returns &true; if the current node is ASP code</para>
</listitem>
<listitem>
<para><xref linkend='function.tidynode-iscomment' /> - Returns &true; if the current node is a comment</para>
</listitem>
<listitem>
<para><xref linkend='function.tidynode-ishtml' /> - Returns &true; if the current node is HTML</para>
</listitem>
<listitem>
<para><xref linkend='function.tidynode-isjste' /> - Returns &true; if the current node is JSTE</para>
</listitem>
<listitem>
<para><xref linkend='function.tidynode-isphp' /> - Returns &true; if the current node is PHP</para>
</listitem>
<listitem>
<para><xref linkend='function.tidynode-istext' /> - Returns &true; if the current node is Text (no markup)</para>
</listitem>
</itemizedlist>
</section>
<section xml:id='tidy.class.tidynode.properties'>
&reftitle.properties;
<itemizedlist>
<listitem>
<para>value - the value of the node (e.g. the html text)</para>
</listitem>
<listitem>
<para>name - the name of the tag (e.g. html, a, etc..)</para>
</listitem>
<listitem>
<para>type - the type of the node (one of the constants above, e.g. <constant>TIDY_NODETYPE_PHP</constant>)</para>
</listitem>
<listitem>
<para>line* - the line where the node starts</para>
</listitem>
<listitem>
<para>column* - the column where the node starts</para>
</listitem>
<listitem>
<para>proprietary* - &true; if the node refers to a proprietary tag</para>
</listitem>
<listitem>
<para>id - the ID of the tag (one of the constants above, e.g. <constant>TIDY_TAG_FRAME</constant>)</para>
</listitem>
<listitem>
<para>attribute - an array with the attributes of the current node, or &null; if there aren't any</para>
</listitem>
<listitem>
<para>child - an array with the child <type>tidyNode</type>s, or &null; if there aren't any</para>
</listitem>
</itemizedlist>
<note>
<para>
The properties marked with * are just available since PHP 5.1.0.
</para>
</note>
</section>
</section>
</section>
</partintro>
&reference.tidy.entities.functions;
</reference>
<!-- Keep this comment at the end of the file
Local variables:

157
reference/tidy/tidynode.xml Normal file
View file

@ -0,0 +1,157 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.tidynode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The <classname>TidyNode</classname> class</title>
<titleabbrev>TidyNode</titleabbrev>
<partintro>
<!-- {{{ TidyNode intro -->
<section xml:id="tidynode.intro">
&reftitle.intro;
<para>
An HTML node in an HTML file, as detected by tidy.
</para>
</section>
<!-- }}} -->
<section xml:id="tidynode.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>TidyNode</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>TidyNode</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.tidynode')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ TidyNode properties -->
<section xml:id="tidynode.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="tidynode.props.value">
<term><varname>value</varname></term>
<listitem>
<para>The HTML representation of the node, including the surrounding tags.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="tidynode.props.name">
<term><varname>name</varname></term>
<listitem>
<para>The name of the HTML node</para>
</listitem>
</varlistentry>
<varlistentry xml:id="tidynode.props.type">
<term><varname>type</varname></term>
<listitem>
<para>The type of the tag (one of the constants above, e.g. <constant>TIDY_NODETYPE_PHP</constant>)</para>
</listitem>
</varlistentry>
<varlistentry xml:id="tidynode.props.line">
<term><varname>line</varname></term>
<listitem>
<para>The line number at which the tags is located in the file</para>
</listitem>
</varlistentry>
<varlistentry xml:id="tidynode.props.column">
<term><varname>column</varname></term>
<listitem>
<para>The column number at which the tags is located in the file</para>
</listitem>
</varlistentry>
<varlistentry xml:id="tidynode.props.proprietary">
<term><varname>proprietary</varname></term>
<listitem>
<para>Indicates if the node is a proprietary tag</para>
</listitem>
</varlistentry>
<varlistentry xml:id="tidynode.props.id">
<term><varname>id</varname></term>
<listitem>
<para>The ID of the tag (one of the constants above, e.g. <constant>TIDY_TAG_FRAME</constant>)</para>
</listitem>
</varlistentry>
<varlistentry xml:id="tidynode.props.attribute">
<term><varname>attribute</varname></term>
<listitem>
<para>
An array of string, representing
the attributes names (as keys) of the current node.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="tidynode.props.child">
<term><varname>child</varname></term>
<listitem>
<para>
An array of <classname>TidyNode</classname>, representing
the children of the current node.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.1.0</entry>
<entry><varname>line</varname>, <varname>column</varname>
and <varname>proprietary</varname> were added</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</section>
<!-- }}} -->
</partintro>
&reference.tidy.entities.tidynode;
</phpdoc:classref>
<!-- 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
-->

50
reference/tidy/functions/tidynode-getparent.xml → reference/tidy/tidynode/getparent.xml
View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.tidynode-getparent" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode::getParent</refname>
<refpurpose>returns the parent node of the current node</refpurpose>
<refpurpose>Returns the parent node of the current node</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -17,6 +17,50 @@
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Example with <function>tidyNode::hasChildren</function></title>
<programlisting role="php">
<![CDATA[
<?php
$html = <<< HTML
<html><head>
<?php echo '<title>title</title>'; ?>
<#
/* JSTE code */
alert('Hello World');
#>
</head>
<body>
Hello World
</body>
</html>
HTML;
$tidy = tidy_parse_string($html);
$num = 0;
$node = $tidy->html()->child[0]->child[0];
var_dump($node->getparent()->name);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
string(4) "head"
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

115
reference/tidy/tidynode/haschildren.xml Normal file
View file

@ -0,0 +1,115 @@
<?xml version='1.0' encoding='utf-8'?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.tidynode-haschildren" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode::hasChildren</refname>
<refpurpose>Checks if a node has children</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tidyNode::hasChildren</methodname>
<void/>
</methodsynopsis>
<para>
Tells if the node has children.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the node has children, &false; otherwise.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Example with <function>tidyNode::hasChildren</function></title>
<programlisting role="php">
<![CDATA[
<?php
$html = <<< HTML
<html><head>
<?php echo '<title>title</title>'; ?>
<#
/* JSTE code */
alert('Hello World');
#>
</head>
<body>
<?php
// PHP code
echo 'hello world!';
?>
<%
/* ASP code */
response.write("Hello World!")
%>
<!-- Comments -->
Hello World
</body></html>
Outside HTML
HTML;
$tidy = tidy_parse_string($html);
$num = 0;
// the head tag
var_dump($tidy->html()->child[0]->hasChildren());
// the php inside the head tag
var_dump($tidy->html()->child[0]->child[0]->hasChildren());
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
bool(true)
bool(false)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function was named <function>tidy_node::has_children</function> in
PHP 4/Tidy 1.
</para>
</note>
</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
-->

115
reference/tidy/tidynode/hassiblings.xml Normal file
View file

@ -0,0 +1,115 @@
<?xml version='1.0' encoding='utf-8'?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.tidynode-hassiblings" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode::hasSiblings</refname>
<refpurpose>Checks if a node has siblings</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tidyNode::hasSiblings</methodname>
<void/>
</methodsynopsis>
<para>
Tells if the node has siblings.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the node has siblings, &false; otherwise.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Example with <function>tidyNode::hasSiblings</function></title>
<programlisting role="php">
<![CDATA[
<?php
$html = <<< HTML
<html><head>
<?php echo '<title>title</title>'; ?>
<#
/* JSTE code */
alert('Hello World');
#>
</head>
<body>
<?php
// PHP code
echo 'hello world!';
?>
<%
/* ASP code */
response.write("Hello World!")
%>
<!-- Comments -->
Hello World
</body></html>
Outside HTML
HTML;
$tidy = tidy_parse_string($html);
$num = 0;
// the html tag
var_dump($tidy->html()->hasSiblings());
// the head tag
var_dump($tidy->html()->child[0]->hasSiblings());
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
bool(false)
bool(true)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function was named <function>tidy_node::has_siblings</function> in
PHP 4/Tidy 1.
</para>
</note>
</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
-->

130
reference/tidy/tidynode/isasp.xml Executable file
View file

@ -0,0 +1,130 @@
<?xml version='1.0' encoding='utf-8'?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.tidynode-isasp" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode::isAsp</refname>
<refpurpose>Checks if this node is ASP</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tidyNode->isAsp</methodname>
<void/>
</methodsynopsis>
<para>
Tells whether the current node is ASP.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the node is ASP, &false; otherwise.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Extract ASP code from a mixed HTML document</title>
<programlisting role="php">
<![CDATA[
<?php
$html = <<< HTML
<html><head>
<?php echo '<title>title</title>'; ?>
<#
/* JSTE code */
alert('Hello World');
#>
</head>
<body>
<?php
// PHP code
echo 'hello world!';
?>
<%
/* ASP code */
response.write("Hello World!")
%>
<!-- Comments -->
Hello World
</body></html>
Outside HTML
HTML;
$tidy = tidy_parse_string($html);
$num = 0;
get_nodes($tidy->html(), 'asp');
function get_nodes($node, $node_type) {
// check if the current node is of requested type
if($node->{"is$node_type"}()) {
echo "\n\n# $node_type node #" . ++$GLOBALS['num'] . "\n";
echo $node->value;
}
// check if the current node has childrens
if($node->hasChildren()) {
foreach($node->child as $child) {
get_nodes($child, $node_type);
}
}
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
# asp node #1
<%
/* ASP code */
response.write("Hello World!")
%>
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function was named <function>tidy_node::is_asp</function> in
PHP 4/Tidy 1.
</para>
</note>
</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
-->

135
reference/tidy/tidynode/iscomment.xml Normal file
View file

@ -0,0 +1,135 @@
<?xml version='1.0' encoding='utf-8'?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.tidynode-iscomment" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode::isComment</refname>
<refpurpose>Checks if a node represents a comment</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tidyNode::isComment</methodname>
<void/>
</methodsynopsis>
<para>
Tells if the node is a comment.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the node is a comment, &false; otherwise.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Extract comments from a mixed HTML document</title>
<programlisting role="php">
<![CDATA[
<?php
$html = <<< HTML
<html><head>
<?php echo '<title>title</title>'; ?>
<#
/* JSTE code */
alert('Hello World');
#>
</head>
<body>
<?php
// PHP code
echo 'hello world!';
?>
<%
/* ASP code */
response.write("Hello World!")
%>
<!-- Comments -->
Hello World
</body></html>
Outside HTML
HTML;
$tidy = tidy_parse_string($html);
$num = 0;
get_nodes($tidy->html(), 'comment');
function get_nodes($node, $node_type) {
// check if the current node is of requested type
if($node->{"is$node_type"}()) {
echo "\n\n# $node_type node #" . ++$GLOBALS['num'] . "\n";
echo $node->value;
}
// check if the current node has childrens
if($node->hasChildren()) {
foreach($node->child as $child) {
get_nodes($child, $node_type);
}
}
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
# jste node #1
<#
/* JSTE code */
alert('Hello World');
#>
/*
var_dump($tidy->html()->child[0]->hasChildren());
var_dump($tidy->html()->child[0]->child[0]->hasChildren());
*/
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function was named <function>tidy_node::is_comment</function> in
PHP 4/Tidy 1.
</para>
</note>
</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
-->

202
reference/tidy/tidynode/ishtml.xml Normal file
View file

@ -0,0 +1,202 @@
<?xml version='1.0' encoding='utf-8'?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.tidynode-ishtml" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->isHtml</refname>
<refpurpose>Checks if a node is part of a HTML document</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tidyNode::isHtml</methodname>
<void/>
</methodsynopsis>
<para>
Tells if the node is part of HTML document.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the node is part of a HTML document, &false; otherwise.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Extract HTML code from a mixed HTML document</title>
<programlisting role="php">
<![CDATA[
<?php
$html = <<< HTML
<html><head>
<?php echo '<title>title</title>'; ?>
<#
/* JSTE code */
alert('Hello World');
#>
</head>
<body>
<?php
// PHP code
echo 'hello world!';
?>
<%
/* ASP code */
response.write("Hello World!")
%>
<!-- Comments -->
Hello World
</body></html>
Outside HTML
HTML;
$tidy = tidy_parse_string($html);
$num = 0;
get_nodes($tidy->html(), 'text');
function get_nodes($node, $node_type) {
// check if the current node is of requested type
if($node->{"is$node_type"}()) {
echo "\n\n# $node_type node #" . ++$GLOBALS['num'] . "\n";
echo $node->value;
}
// check if the current node has childrens
if($node->hasChildren()) {
foreach($node->child as $child) {
get_nodes($child, $node_type);
}
}
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
# html node #1
<html>
<head>
<?php echo '<title>title</title>'; ?><#
/* JSTE code */
alert('Hello World');
#>
<title></title>
</head>
<body>
<?php
// PHP code
echo 'hello world!';
?><%
/* ASP code */
response.write("Hello World!")
%><!-- Comments -->
Hello WorldOutside HTML
</body>
</html>
# html node #2
<head>
<?php echo '<title>title</title>'; ?><#
/* JSTE code */
alert('Hello World');
#>
<title></title>
</head>
# html node #3
<?php echo '<title>title</title>'; ?>
# html node #4
<#
/* JSTE code */
alert('Hello World');
#>
# html node #5
<title></title>
# html node #6
<body>
<?php
// PHP code
echo 'hello world!';
?><%
/* ASP code */
response.write("Hello World!")
%><!-- Comments -->
Hello WorldOutside HTML
</body>
# html node #7
<?php
// PHP code
echo 'hello world!';
?>
# html node #8
<%
/* ASP code */
response.write("Hello World!")
%>
# html node #9
<!-- Comments -->
# html node #10
Hello World
# html node #11
Outside HTML
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function was named <function>tidy_node::is_html</function> in
PHP 4/Tidy 1.
</para>
</note>
</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
-->

134
reference/tidy/tidynode/isjste.xml Normal file
View file

@ -0,0 +1,134 @@
<?xml version='1.0' encoding='utf-8'?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.tidynode-isjste" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->isJste</refname>
<refpurpose>Checks if this node is JSTE</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tidyNode::isJste</methodname>
<void/>
</methodsynopsis>
<para>
Tells if the node is JSTE.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the node is JSTE, &false; otherwise.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Extract JSTE code from a mixed HTML document</title>
<programlisting role="php">
<![CDATA[
<?php
$html = <<< HTML
<html><head>
<?php echo '<title>title</title>'; ?>
<#
/* JSTE code */
alert('Hello World');
#>
</head>
<body>
<?php
// PHP code
echo 'hello world!';
?>
<%
/* ASP code */
response.write("Hello World!")
%>
<!-- Comments -->
Hello World
</body></html>
Outside HTML
HTML;
$tidy = tidy_parse_string($html);
$num = 0;
get_nodes($tidy->html(), 'text');
function get_nodes($node, $node_type) {
// check if the current node is of requested type
if($node->{"is$node_type"}()) {
echo "\n\n# $node_type node #" . ++$GLOBALS['num'] . "\n";
echo $node->value;
}
// check if the current node has childrens
if($node->hasChildren()) {
foreach($node->child as $child) {
get_nodes($child, $node_type);
}
}
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
# jste node #1
<#
/* JSTE code */
alert('Hello World');
#>
/*
var_dump($tidy->html()->child[0]->hasChildren());
var_dump($tidy->html()->child[0]->child[0]->hasChildren());
*/
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function was named <function>tidy_node->is_jste</function> in
PHP 4/Tidy 1.
</para>
</note>
</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
-->

53
reference/tidy/functions/tidyNode-isPhp.xml → reference/tidy/tidynode/isphp.xml
View file

@ -1,18 +1,18 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<?xml version='1.0' encoding='utf-8'?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.tidynode-isphp" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->isPhp</refname>
<refpurpose>Returns true if this node is PHP</refpurpose>
<refname>tidyNode::isPhp</refname>
<refpurpose>Checks if a node is PHP</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tidyNode->isPhp</methodname>
<type>bool</type><methodname>tidyNode::isPhp</methodname>
<void/>
</methodsynopsis>
<para>
Tells if the current node is PHP.
Tells if the node is PHP.
</para>
</refsect1>
@ -27,7 +27,7 @@
&reftitle.examples;
<para>
<example>
<title>get the PHP code from a mixed HTML/PHP document</title>
<title>Extract PHP code from a mixed HTML document</title>
<programlisting role="php">
<![CDATA[
<?php
@ -35,35 +35,47 @@
$html = <<< HTML
<html><head>
<?php echo '<title>title</title>'; ?>
<#
/* JSTE code */
alert('Hello World');
#>
</head>
<body>
<?php
echo 'hello world!';
// PHP code
echo 'hello world!';
?>
<%
/* ASP code */
response.write("Hello World!")
%>
<!-- Comments -->
Hello World
</body></html>
Outside HTML
HTML;
$tidy = tidy_parse_string($html);
$num = 0;
get_php($tidy->html());
get_nodes($tidy->html(), 'php');
function get_nodes($node, $node_type) {
function get_php($node) {
// check if the current node is PHP code
if($node->isPhp()) {
echo "\n\n# PHP node #" . ++$GLOBALS['num'] . "\n";
// check if the current node is of requested type
if($node->{"is$node_type"}()) {
echo "\n\n# $node_type node #" . ++$GLOBALS['num'] . "\n";
echo $node->value;
}
// check if the current node has childrens
if($node->hasChildren()) {
foreach($node->child as $child) {
get_php($child);
get_nodes($child, $node_type);
}
}
}
@ -74,24 +86,25 @@ function get_php($node) {
&example.outputs;
<screen>
<![CDATA[
# PHP node #1
# php node #1
<?php echo '<title>title</title>'; ?>
# PHP node #2
# php node #2
<?php
echo 'hello world!';
// PHP code
echo 'hello world!';
?>
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function was named <function>tidy_node->is_php</function> in
This function was named <function>tidy_node::is_php</function> in
PHP 4/Tidy 1.
</para>
</note>

130
reference/tidy/tidynode/istext.xml Normal file
View file

@ -0,0 +1,130 @@
<?xml version='1.0' encoding='utf-8'?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.tidynode-istext" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode::isText</refname>
<refpurpose>Checks if a node represents text (no markup)</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tidyNode::isText</methodname>
<void/>
</methodsynopsis>
<para>
Tells if the node represents a text (without any markup).
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the node represent a text, &false; otherwise.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Extract text from a mixed HTML document</title>
<programlisting role="php">
<![CDATA[
<?php
$html = <<< HTML
<html><head>
<?php echo '<title>title</title>'; ?>
<#
/* JSTE code */
alert('Hello World');
#>
</head>
<body>
<?php
// PHP code
echo 'hello world!';
?>
<%
/* ASP code */
response.write("Hello World!")
%>
<!-- Comments -->
Hello World
</body></html>
Outside HTML
HTML;
$tidy = tidy_parse_string($html);
$num = 0;
get_nodes($tidy->html(), 'text');
function get_nodes($node, $node_type) {
// check if the current node is of requested type
if($node->{"is$node_type"}()) {
echo "\n\n# $node_type node #" . ++$GLOBALS['num'] . "\n";
echo $node->value;
}
// check if the current node has childrens
if($node->hasChildren()) {
foreach($node->child as $child) {
get_nodes($child, $node_type);
}
}
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
# text node #1
Hello World
# text node #2
Outside HTML
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function was named <function>tidy_node::is_text</function> in
PHP 4/Tidy 1.
</para>
</note>
</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
-->