metaphone.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e095023e408c8cb6378ae16bb6870343a3946919 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
<refentry xml:id="function.metaphone" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>metaphone</refname>
  <refpurpose>文字列の metaphone キーを計算する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>metaphone</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>max_phonemes</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   <parameter>string</parameter> の metaphone キーを計算します。
  </para>
  <para>
   <function>soundex</function> と同様に metaphone は、
   発音が似た単語について同じキーを作成します。metaphone は、
   英語の発音の基本的ルールを知っているので、
   <function>soundex</function> よりも正確です。
   metaphone が生成するキーは可変長です。
  </para>
  <para>
   metaphone は、Lawrence Philips &lt;lphilips at verity dot com&gt; により
   開発されました。["Practical
   Algorithms for Programmers", Binstock &amp; Rex, Addison Wesley,
   1995] で解説されています。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       入力文字列。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>max_phonemes</parameter></term>
     <listitem>
      <para>
       このパラメータは、返される metaphone キーの長さを最大
       <parameter>max_phonemes</parameter> <emphasis>文字</emphasis> までに制限します。
       しかし、phonemes は完全に書き換えられるので、
       結果の文字列の長さは、<parameter>max_phonemes</parameter> よりも少し長くなります。
       デフォルト値の <literal>0</literal> は、無制限であることを意味します。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   metaphone キーを文字列で返します。
  </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.0.0</entry>
      <entry>
       この関数は、失敗時に &false; を返さなくなりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples"><!-- {{{ -->
  &reftitle.examples;
  <para>
   <example xml:id="metaphone.example.basic"><!-- {{{ -->
    <title><function>metaphone</function> の基本的な例</title>
    <programlisting role="php">
<![CDATA[
<?php
var_dump(metaphone('programming'));
var_dump(metaphone('programmer'));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
string(7) "PRKRMNK"
string(6) "PRKRMR"
]]>
    </screen>
   </example><!-- }}} -->
  </para>
  <para>
   <example xml:id="metaphone.example.phonemes"><!-- {{{ -->
    <title><parameter>phonemes</parameter> パラメータの使用例</title>
    <programlisting role="php">
<![CDATA[
<?php
var_dump(metaphone('programming', 5));
var_dump(metaphone('programmer', 5));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
string(5) "PRKRM"
string(5) "PRKRM"
]]>
    </screen>
   </example><!-- }}} -->
  </para>
  <para>
   <example xml:id="metaphone.example.phonemes-overlong">
    <title><parameter>phonemes</parameter> 引数を使う</title>
    <simpara>
     この例では、
     <function>metaphone</function> 関数は5文字の文字列を生成するように指定されていますが、
     最後の音素を分割する必要がある
     (<literal>'x'</literal> は <literal>'KS'</literal> に書き換えられるとします),
     ため、返される文字列は6文字になります。
    </simpara>
    <programlisting role="php">
<![CDATA[
<?php
var_dump(metaphone('Asterix', 5));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
string(6) "ASTRKS"
]]>
    </screen>
   </example>
  </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
-->