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 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.6 $ -->
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.domentity" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DOMEntity class</title>
<titleabbrev>DOMEntity</titleabbrev>
<partintro>
<!-- {{{ DOMEntity intro -->
<section xml:id="domentity.intro">
&reftitle.intro;
<para>
This interface represents a known entity, either parsed or unparsed, in an XML document.
</para>
</section>
<!-- }}} -->
<section xml:id="domentity.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DOMEntity</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DOMEntity</classname>
</ooclass>
<!-- If the class extends another one, use this -->
<ooclass>
<modifier>extends</modifier>
<classname>DOMNode</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<!-- If the property is documented below (xml:id=domentity.props) use this -->
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domentity.props.publicid">publicId</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domentity.props.systemid">systemId</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domentity.props.notationname">notationName</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domentity.props.actualencoding">actualEncoding</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domentity.props.encoding">encoding</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domentity.props.version">version</varname>
</fieldsynopsis>
<!--
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domentity')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
-->
<!-- Again, if the class extends a class use this -->
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ DOMEntity properties -->
<section xml:id="domentity.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="domentity.props.publicid">
<term><varname>publicId</varname></term>
<listitem>
<para>
The public identifier associated with the entity if specified, and
&null; otherwise.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domentity.props.systemid">
<term><varname>systemId</varname></term>
<listitem>
<para>
The system identifier associated with the entity if specified, and
&null; otherwise. This may be an absolute URI or not.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domentity.props.notationname">
<term><varname>notationName</varname></term>
<listitem>
<para>
For unparsed entities, the name of the notation for the entity. For
parsed entities, this is &null;.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domentity.props.actualencoding">
<term><varname>actualEncoding</varname></term>
<listitem>
<para>
An attribute specifying the encoding used for this entity at the
time of parsing, when it is an external parsed entity. This is
&null; if it an entity from the internal subset or if it is not
known.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domentity.props.encoding">
<term><varname>encoding</varname></term>
<listitem>
<para>
An attribute specifying, as part of the text declaration, the
encoding of this entity, when it is an external parsed entity. This
is &null; otherwise.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domentity.props.version">
<term><varname>version</varname></term>
<listitem>
<para>
An attribute specifying, as part of the text declaration, the
version number of this entity, when it is an external parsed
entity. This is &null; otherwise.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ See also -->
<!--
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&url.spec.dom3.;">W3C specification for</link></member>
</simplelist>
</para>
</section>
-->
<!-- }}} -->
</partintro>
<!-- FIXME: this class has no methods -->
<!--&reference.dom.entities.domentity;-->
<refentry>
<refnamediv>
<refname />
<refpurpose />
</refnamediv>
<refsect1 />
</refentry>
</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
-->
|