cvs: /phpdoc/functions strings.sgml
| From: | Thies C . Arntzen | Date: | Mon, 13 Sep 1999 16:15:17 +0000 |
| Subject: | cvs: /phpdoc/functions strings.sgml | ||
| Groups: | php.dev | ||
| Request: | Send a blank email to php-dev+get-10856@lists.php.net to get a copy of this message | ||
thies Mon Sep 13 12:15:17 1999 EDT
Modified files:
/phpdoc/functions strings.sgml
Log:
docs for metaphone
Index: phpdoc/functions/strings.sgml
diff -u phpdoc/functions/strings.sgml:1.12 phpdoc/functions/strings.sgml:1.13
--- phpdoc/functions/strings.sgml:1.12 Sun Sep 5 23:40:25 1999
+++ phpdoc/functions/strings.sgml Mon Sep 13 12:15:17 1999
@@ -577,6 +577,38 @@
</refsect1>
</refentry>
+ <refentry id="function.metaphone">
+ <refnamediv>
+ <refname>Metaphone</refname>
+ <refpurpose>calculate the metaphone key of a string</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>string <function>metaphone</function></funcdef>
+ <paramdef>string <parameter>str</parameter></paramdef>
+ </funcsynopsis>
+
+ <para>
+ Calculates the metaphone key of <parameter>str</parameter>.
+
+ <para>
+ Similar to <function>soundex</function> metaphone creates the same key for similar
sounding words. It's
+ more accurate than <function>soundex</function> as it knows the basic rules of
English pronunciation.
+ the metaphone generated keys are of variable length.
+
+ <para>
+ Metaphone was developed by Lawrence Philips <lphilips@verity.com>. It is described in
["Practical Algorithms for
+ Programmers", Binstock & Rex, Addison Wesley, 1995].
+
+ <note>
+ <para>
+ This function was added in PHP 4.0.
+ </note>
+ </refsect1>
+ </refentry>
+
+
<refentry id="function.nl2br">
<refnamediv>
<refname>nl2br</refname>