c14n.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ad24f447d80cb1aec21e98fbd0e8875488279766 Maintainer: takagi Status: ready -->

<refentry xml:id="domnode.c14n" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>DOMNode::C14N</refname>
  <refpurpose>ノードを文字列に正規化する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="DOMNode">
   <modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>DOMNode::C14N</methodname>
   <methodparam choice="opt"><type>bool</type><parameter>exclusive</parameter><initializer>&false;</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>withComments</parameter><initializer>&false;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>xpath</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>nsPrefixes</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   ノードを文字列に正規化します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>exclusive</parameter></term>
    <listitem>
     <para>
      指定した xpath あるいは名前空間プレフィックスにマッチするノードだけを対象としたパースを有効にする。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>withComments</parameter></term>
    <listitem>
     <para>
      コメントを残して出力する。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>xpath</parameter></term>
    &dom.c14n.xpath_array;
   </varlistentry>
   <varlistentry>
    <term><parameter>nsPrefixes</parameter></term>
    <listitem>
     <para>
      ノードを絞り込むための名前空間プレフィックスの配列。
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   正規化したノードを文字列で返します。
   &return.falseforfailure;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>XPath クエリの例</title>
    <para>
     以下のコードは、XPath クエリを使ってノードをフィルタし、
     正規化する高度なやり方を示します。
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$dom = new DOMDocument();
$dom->loadXML(<<<XML
<root xmlns:food="urn:food">
    <!-- redundant namespace declaration will be canonicalized -->
    <food:fruit xmlns:food="urn:food">Apple</food:fruit>
    <food:fruit>Orange</food:fruit>
    <food:fruit>Pear</food:fruit>
    <!-- vegetables here -->
    <food:vegetable>Lettuce</food:vegetable>
</root>
XML);
echo $dom->C14N(true, false, [
    "query" => ".//f:fruit|.//f:fruit/text()",
    "namespaces" => ["f" => "urn:food"],
]);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
<food:fruit>Apple</food:fruit><food:fruit>Orange</food:fruit><food:fruit>Pear</food:fruit>
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>DOMNode::C14NFile</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
-->