doc-fr/reference/dom/domdocument.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 0217f85ed26dc9511fb6b44e87d82f4b77adafa1 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<!-- CREDITS: DAnnebicque -->
<reference xml:id="class.domdocument" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>La classe DOMDocument</title>
 <titleabbrev>DOMDocument</titleabbrev>

 <partintro>

  <!-- {{{ DOMDocument intro -->
  <section xml:id="domdocument.intro">
   &reftitle.intro;
   <para>
    Représente un document HTML ou XML entier ; ce sera la racine
    de l'arbre document.
   </para>
  </section>
  <!-- }}} -->

  <section xml:id="domdocument.synopsis">
   &reftitle.classsynopsis;

   <!-- {{{ Synopsis -->
   <classsynopsis class="class">
     <ooclass>
      <classname>DOMDocument</classname>
     </ooclass>

     <ooclass>
      <modifier>extends</modifier>
      <classname>DOMNode</classname>
     </ooclass>

     <oointerface>
      <modifier>implements</modifier>
      <interfacename>DOMParentNode</interfacename>
     </oointerface>

    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type class="union"><type>DOMDocumentType</type><type>null</type></type>
     <varname linkend="domdocument.props.doctype">doctype</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type>DOMImplementation</type>
     <varname linkend="domdocument.props.implementation">implementation</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type class="union"><type>DOMElement</type><type>null</type></type>
     <varname linkend="domdocument.props.documentelement">documentElement</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type class="union"><type>string</type><type>null</type></type>
     <varname linkend="domdocument.props.actualencoding">actualEncoding</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type class="union"><type>string</type><type>null</type></type>
     <varname linkend="domdocument.props.encoding">encoding</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type class="union"><type>string</type><type>null</type></type>
     <varname linkend="domdocument.props.xmlencoding">xmlEncoding</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>bool</type>
     <varname linkend="domdocument.props.standalone">standalone</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>bool</type>
     <varname linkend="domdocument.props.xmlstandalone">xmlStandalone</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type class="union"><type>string</type><type>null</type></type>
     <varname linkend="domdocument.props.version">version</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type class="union"><type>string</type><type>null</type></type>
     <varname linkend="domdocument.props.xmlversion">xmlVersion</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>bool</type>
     <varname linkend="domdocument.props.stricterrorchecking">strictErrorChecking</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type class="union"><type>string</type><type>null</type></type>
     <varname linkend="domdocument.props.documenturi">documentURI</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type>mixed</type>
     <varname linkend="domdocument.props.config">config</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>bool</type>
     <varname linkend="domdocument.props.formatoutput">formatOutput</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>bool</type>
     <varname linkend="domdocument.props.validateonparse">validateOnParse</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>bool</type>
     <varname linkend="domdocument.props.resolveexternals">resolveExternals</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>bool</type>
     <varname linkend="domdocument.props.preservewhitespace">preserveWhiteSpace</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>bool</type>
     <varname linkend="domdocument.props.recover">recover</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>bool</type>
     <varname linkend="domdocument.props.substituteentities">substituteEntities</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type class="union"><type>DOMElement</type><type>null</type></type>
     <varname linkend="domdocument.props.firstelementchild">firstElementChild</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type class="union"><type>DOMElement</type><type>null</type></type>
     <varname linkend="domdocument.props.lastelementchild">lastElementChild</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type>int</type>
     <varname linkend="domdocument.props.childelementcount">childElementCount</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.domdocument')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='DOMDocument'])">
     <xi:fallback/>
    </xi:include>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domdocument')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='DOMDocument'])">
     <xi:fallback/>
    </xi:include>

    <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[@role='DOMNode'])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
   <!-- }}} -->

  </section>

  <!-- {{{ DOMDocument properties -->
  <section xml:id="domdocument.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="domdocument.props.actualencoding">
     <term><varname>actualEncoding</varname></term>
     <listitem>
      <para>
       <emphasis>Obsolète</emphasis>. L'encodage actuel du document, en lecture seule, équivalent
       à <varname linkend="domdocument.props.encoding">encoding</varname>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.childelementcount">
     <term><varname>childElementCount</varname></term>
     <listitem>
      <para>Le nombre d'éléments enfants.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.config">
     <term><varname>config</varname></term>
     <listitem>
      <para>
       <emphasis>Obsolète</emphasis>. Configuration utilisée lorsque
       <function>DOMDocument::normalizeDocument</function> est appelé.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.doctype">
     <term><varname>doctype</varname></term>
     <listitem>
      <para>Le Document Type Declaration associé avec ce document.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.documentelement">
     <term><varname>documentElement</varname></term>
     <listitem>
      <para>
       L'objet <classname>DOMElement</classname> qui est le premier élément
       du document. S'il n'est pas trouvé, ceci est évalué à &null;.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.documenturi">
     <term><varname>documentURI</varname></term>
     <listitem>
      <para>La localisation du document, ou &null; si indéfini.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.encoding">
     <term><varname>encoding</varname></term>
     <listitem>
      <para>
       L'encodage du document, tel que spécifié par la déclaration XML.
       Cet attribut n'est pas présent dans la spécification DOM Level 3 finale,
       mais représente la seule façon de manipuler l'encodage du document
       XML dans cette implémentation.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.firstelementchild">
     <term><varname>firstElementChild</varname></term>
     <listitem>
      <para>Premier élément enfant ou &null;.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.formatoutput">
     <term><varname>formatOutput</varname></term>
     <listitem>
      <para>
       Formate élégamment le résultat avec une indentation et des espaces
       supplémentaires. Ce paramètre n'a aucun effet si le document a été
       chargé avec l'activation de
       <varname linkend="domdocument.props.preservewhitespace">preserveWhitespace</varname>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.implementation">
     <term><varname>implementation</varname></term>
     <listitem>
      <para>
       L'objet <classname>DOMImplementation</classname> qui gère ce document.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.lastelementchild">
     <term><varname>lastElementChild</varname></term>
     <listitem>
      <para>Dernier élément enfant ou &null;.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.preservewhitespace">
     <term><varname>preserveWhiteSpace</varname></term>
     <listitem>
      <para>
       Ne pas supprimer les espaces redondants. Vaut par défaut &true;.
       Définir ce paramètre à &false; a le même effet de définir
       à <constant>LIBXML_NOBLANKS</constant> le paramètre
       <parameter>option</parameter> de la méthode
       <methodname>DOMDocument::load</methodname>.      
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.recover">
     <term><varname>recover</varname></term>
     <listitem>
      <para>
       <emphasis>Propriétaire</emphasis>. Active le mode "recovery", i.e.
       tente d'analyser un document mal formé. Cet attribut ne fait pas
       partie de la spécification DOM et est spécifique à libxml.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.resolveexternals">
     <term><varname>resolveExternals</varname></term>
     <listitem>
      <para>
       Définissez-le à &true; pour charger des entités externes
       depuis la déclaration doctype. C'est utile pour inclure
       des entités dans vos documents XML.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.standalone">
     <term><varname>standalone</varname></term>
     <listitem>
      <para>
       <emphasis>Obsolète</emphasis>. Si le document est "standalone", ou non,
       tel que spécifié par la déclaration XML, correspondant à
       <varname linkend="domdocument.props.xmlstandalone">xmlStandalone</varname>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.stricterrorchecking">
     <term><varname>strictErrorChecking</varname></term>
     <listitem>
      <para>
       Lance une <classname>DOMException</classname> en cas d'erreur.
       Par défaut, vaut &true;.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.substituteentities">
     <term><varname>substituteEntities</varname></term>
     <listitem>
      <para>
       <emphasis>Propriétaire</emphasis>. Si l'on doit ou non
       substituer les entités. Cet attribut ne fait pas partie de la
       spécification DOM et est spécifique à libxml. Par défaut, &false;
      </para>
      <caution>
       <simpara>
        Activer la substitution d'entités peut faciliter les attaques XML
        External Entity (XXE).
       </simpara>
      </caution>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.validateonparse">
     <term><varname>validateOnParse</varname></term>
     <listitem>
      <para>Charge et valide la DTD. Par défaut, vaut &false;.</para>
      <caution>
       <simpara>
        Activer la validation du DTD peut faciliter les attaques XML External Entity (XXE).
       </simpara>
      </caution>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.version">
     <term><varname>version</varname></term>
     <listitem>
      <para>
       <emphasis>Obsolète</emphasis>. Version du XML, correspond à
       <varname linkend="domdocument.props.xmlversion">xmlVersion</varname>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.xmlencoding">
     <term><varname>xmlEncoding</varname></term>
     <listitem>
      <para>
       Un attribut spécifiant l'encodage du document. Il vaut &null;
       lorsque l'encodage n'est pas spécifié, ou lorsqu'il est inconnu,
       comme c'est le cas lorsque le document a été créé en mémoire.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.xmlstandalone">
     <term><varname>xmlStandalone</varname></term>
     <listitem>
      <para>
       Un attribut spécifiant si le document est "standalone".
       Il vaut &false; lorsque non spécifié.
       Un document standalone est un document où il n'y a pas de déclarations de balisage externes.
       Un exemple d'une telle déclaration de balisage est lorsque la DTD déclare un attribut avec une valeur par défaut.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="domdocument.props.xmlversion">
     <term><varname>xmlVersion</varname></term>
     <listitem>
      <para>
       Un attribut spécifiant le numéro de version du document. S'il n'y
       a pas de déclaration et si le document supporte la fonctionnalité
       "XML", la valeur sera "1.0".
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
  <!-- }}} -->

  <section role="changelog">
   &reftitle.changelog;
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.0.0</entry>
       <entry>
        <classname>DOMDocument</classname> implémente désormais
        <interfacename>DOMParentNode</interfacename>.
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        La méthode non-implémenté <methodname>DOMDocument::renameNode</methodname>
        a été retirée.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </section>

  <!-- {{{ Notes -->
  <section role="notes">
   &reftitle.notes;
   &dom.note.utf8;
   &dom.note.json;
  </section>
  <!-- }}} -->

  <!-- {{{ See also -->
  <section role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
     <member><link xlink:href="&url.spec.dom3.document;">Spécification W3C de Document</link></member>
    </simplelist>
   </para>
  </section>
  <!-- }}} -->

 </partintro>

 &reference.dom.entities.domdocument;

</reference>
<!-- 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
-->