Files
doc-fr/reference/strings/functions/soundex.xml
George Peter Banyard b9ba145e64 Apply commit 230b56bf45d3871657573097a2be90d77ed2bfc8
Fix #76314: Specify failure return type for soundex
2021-02-17 03:34:21 +00:00

136 lines
3.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 230b56bf45d3871657573097a2be90d77ed2bfc8 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<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ù vous
connaissez 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é 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">
<![CDATA[
<?php
soundex("Euler") == soundex("Ellery"); // E460
soundex("Gauss") == soundex("Ghosh"); // G200
soundex("Hilbert") == soundex("Heilbronn"); // H416
soundex("Knuth") == soundex("Kant"); // K530
soundex("Lloyd") == soundex("Ladd"); // L300
soundex("Lukasiewicz") == soundex("Lissajous"); // L222
?>
]]>
</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>
<!-- 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
-->