savexml.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 40476b2960f884b088d77f38b6bef2c43b662d10 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="domdocument.savexml" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>DOMDocument::saveXML</refname>
  <refpurpose>
   内部の XML ツリーを文字列として出力する
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="DOMDocument">
   <modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>DOMDocument::saveXML</methodname>
   <methodparam choice="opt"><type class="union"><type>DOMNode</type><type>null</type></type><parameter>node</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   DOM 表現から XML ドキュメントを作成します。この関数は、通常は以下の例のように
   DOM ドキュメントを新しく作成した後にコールされます。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>node</parameter></term>
     <listitem>
      <para>
       ドキュメント全体ではなく、XML 宣言以外の特定のノードだけを
       出力したい場合にこのパラメータを使用します。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       追加のオプション。<link linkend="libxml.constants">LIBXML_NOEMPTYTAG</link> と <link linkend="libxml.constants">LIBXML_NOXMLDECL</link> がサポートされています。
       PHP 8.3.0 より前のバージョンでは、<link linkend="libxml.constants">LIBXML_NOEMPTYTAG</link> だけがサポートされていました。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   XML、あるいはエラーが発生した場合は &false; を返します。
  </para>
 </refsect1>
 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <variablelist>
    <varlistentry>
     <term><constant>DOM_WRONG_DOCUMENT_ERR</constant></term>
     <listitem>
      <para>
       <parameter>node</parameter> が別のドキュメントのものである場合に
       発生します。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.3.0</entry>
      <entry>
       <link linkend="libxml.constants">LIBXML_NOXMLDECL</link> がサポートされました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>DOM ツリーを文字列に保存する</title>
    <programlisting role="php">
<![CDATA[
<?php

$doc = new DOMDocument('1.0');
// 出力はきれいに整形したいですね。
$doc->formatOutput = true;

$root = $doc->createElement('book');
$root = $doc->appendChild($root);

$title = $doc->createElement('title');
$title = $root->appendChild($title);

$text = $doc->createTextNode('これはタイトルです');
$text = $title->appendChild($text);

echo "ドキュメント全体を保存します\n";
echo $doc->saveXML() . "\n";

echo "タイトルの部分のみを保存します\n";
echo $doc->saveXML($title);

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
ドキュメント全体を保存します
<?xml version="1.0"?>
<book>
  <title>これはタイトルです</title>
</book>

タイトルの部分のみを保存します
<title>これはタイトルです</title>
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>DOMDocument::save</methodname></member>
    <member><methodname>DOMDocument::load</methodname></member>
    <member><methodname>DOMDocument::loadXML</methodname></member>
   </simplelist>
  </para>
 </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:"~/.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
-->