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

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

<refnamediv>

<refname>soundex</refname>

<refpurpose>Calcule la clé 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>

Calcule la clé soundex de la chaîne <parameter>string</parameter>.

</para>

<para>

La clé soundex possède la propriété qui fait que deux mots prononcés

similairement auront la même clé soundex. Cette fonction est

donc utilisée pour simplifier les recherches dans les bases de données, où l'on

connaît la prononciation d'un mot ou nom, mais pas son orthographe

exacte.

</para>

<para>

L'implémentation de la fonction soundex de PHP a été décrite par

Donald Knuth dans <literal>"The Art Of Computer Programming, vol. 3: Sorting And

Searching", Addison-Wesley (1973), pp. 391-392</literal>.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

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

<listitem>

<para>

La chaîne d'entrée.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Retourne la clé soundex en tant que &string; avec quatre caractères.

Si au moins une lettre est contenue dans <parameter>string</parameter>, la

chaîne retournée débute avec une lettre. Sinon <literal>"0000"</literal>

est retourné.

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

Antérieur à cette version, appeler la fonction avec une chaîne vide

retournait &false; pour aucune raison particulière.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Exemples 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>