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

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

<refnamediv>

<refname>soundex</refname>

<refpurpose>Calcula la clave 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>

Calcula la clave soundex de la cadena <parameter>string</parameter>.

</para>

<para>

La clave soundex posee la propiedad de que dos palabras pronunciadas

de manera similar tendrán la misma clave soundex. Esta función se

utiliza, por lo tanto, para simplificar las búsquedas en las bases de datos, donde se

conoce la pronunciación de una palabra o nombre, pero no su ortografía

exacta.

</para>

<para>

La implementación de la función soundex de PHP ha sido descrita por

Donald Knuth en <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 cadena de entrada.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Retorna la clave soundex como &string; con cuatro caracteres.

Si al menos una letra está contenida en <parameter>string</parameter>, la

cadena retornada comienza con una letra. De lo contrario, se retorna <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>

Antes de esta versión, llamar a la función con una cadena vacía

retornaba &false; sin ninguna razón en particular.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Ejemplos de 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>