php-doc-en/reference/dom/domentity.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<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>public</modifier>
     <modifier>readonly</modifier>
     <type>string</type>
     <varname linkend="domentity.props.publicid">publicId</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type>string</type>
     <varname linkend="domentity.props.systemid">systemId</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</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>public</modifier>
     <modifier>readonly</modifier>
     <type>string</type>
     <varname linkend="domentity.props.encoding">encoding</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type>string</type>
     <varname linkend="domentity.props.version">version</varname>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Properties;']]))">
     <xi:fallback />
    </xi:include>

 <!--
    <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">&InheritedMethods;</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>
 
 
</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
-->