mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 13:58:55 +00:00
1729bde5fb
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@298115 c90b9560-bf6c-de11-be94-00142212c4b1
131 lines
3.3 KiB
XML
131 lines
3.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.metaphone">
|
|
<refnamediv>
|
|
<refname>metaphone</refname>
|
|
<refpurpose>Calculate the metaphone key of a string</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>metaphone</methodname>
|
|
<methodparam><type>string</type><parameter>str</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>phonemes</parameter><initializer>0</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Calculates the metaphone key of <parameter>str</parameter>.
|
|
</para>
|
|
<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>
|
|
<para>
|
|
Metaphone was developed by Lawrence Philips
|
|
<lphilips at verity dot com>. It is described in ["Practical
|
|
Algorithms for Programmers", Binstock & Rex, Addison Wesley,
|
|
1995].
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>str</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The input string.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>phonemes</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
This parameter restricts the returned metaphone key to
|
|
<parameter>phonemes</parameter> characters in length.
|
|
The default value of <literal>0</literal> means no restriction.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the metaphone key as a string, &return.falseforfailure;.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples"><!-- {{{ -->
|
|
&reftitle.examples;
|
|
<para>
|
|
<example xml:id="metaphone.example.basic"><!-- {{{ -->
|
|
<title><function>metaphone</function> basic example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
var_dump(metaphone('programming'));
|
|
var_dump(metaphone('programmer'));
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
string(7) "PRKRMNK"
|
|
string(6) "PRKRMR"
|
|
]]>
|
|
</screen>
|
|
</example><!-- }}} -->
|
|
</para>
|
|
<para>
|
|
<example xml:id="metaphone.example.phonemes"><!-- {{{ -->
|
|
<title>Using the <parameter>phonemes</parameter> parameter</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
var_dump(metaphone('programming', 5));
|
|
var_dump(metaphone('programmer', 5));
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
string(5) "PRKRM"
|
|
string(5) "PRKRM"
|
|
]]>
|
|
</screen>
|
|
</example><!-- }}} -->
|
|
</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
|
|
-->
|