<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.soundex" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>soundex</refname>

<refpurpose>文字列の soundex キーを計算する</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>string</type><methodname>soundex</methodname>

<methodparam><type>string</type><parameter>string</parameter></methodparam>

</methodsynopsis>

<para>

<parameter>string</parameter> の soundex キーを計算します。

</para>

<para>

soundex キーには、似たような発音の単語に関して同じ

soundex キーが生成されるという特性があります。

このため、発音は知っているが、スペルがわからない場合に、

データベースを検索することを容易にすることができます。

</para>

<para>

この soundex 関数についての説明は、Donald Knuth の "The Art Of Computer Programming,

vol. 3: Sorting And Searching", Addison-Wesley (1973), pp. 391-392

にあります。

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>string</parameter></term>

<listitem>

<para>

入力文字列。

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

soundex キーを、4文字からなる文字列で返します。

少なくとも1文字が <parameter>string</parameter> に含まれていた場合、

返される文字列はその文字から始まります。

そうでない場合、<literal>"0000"</literal> を返します。

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

<title>Soundex の例</title>

<programlisting role="php">

</programlisting>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>levenshtein</function></member>

<member><function>metaphone</function></member>

<member><function>similar_text</function></member>

</simplelist>

</para>

</refsect1>

</refentry>