1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 292734 $ -->
<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>
<fieldsynopsis><type></type><varname linkend="tidynode.props.value">value</varname></fieldsynopsis>
<fieldsynopsis><type></type><varname linkend="tidynode.props.name">name</varname></fieldsynopsis>
<fieldsynopsis><type></type><varname linkend="tidynode.props.type">type</varname></fieldsynopsis>
<fieldsynopsis><type></type><varname linkend="tidynode.props.line">line</varname></fieldsynopsis>
<fieldsynopsis><type></type><varname linkend="tidynode.props.column">column</varname></fieldsynopsis>
<fieldsynopsis><type></type><varname linkend="tidynode.props.proprietary">proprietary</varname></fieldsynopsis>
<fieldsynopsis><type></type><varname linkend="tidynode.props.id">id</varname></fieldsynopsis>
<fieldsynopsis><type></type><varname linkend="tidynode.props.attribute">attribute</varname></fieldsynopsis>
<fieldsynopsis><type></type><varname linkend="tidynode.props.child">child</varname></fieldsynopsis>
<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:"~/.phpdoc/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
-->
|