<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.strings.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.metaphone.php',
    1 => 'metaphone',
    2 => 'Calcula a chave de Metaphone de uma string',
  ),
  'up' => 
  array (
    0 => 'ref.strings.php',
    1 => 'Fun&ccedil;&otilde;es de String',
  ),
  'prev' => 
  array (
    0 => 'function.md5-file.php',
    1 => 'md5_file',
  ),
  'next' => 
  array (
    0 => 'function.money-format.php',
    1 => 'money_format',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/strings/functions/metaphone.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.metaphone" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">metaphone</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">metaphone</span> &mdash; <span class="dc-title">Calcula a chave de Metaphone de uma string</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.metaphone-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>metaphone</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$string</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$max_phonemes</code><span class="initializer"> = 0</span></span>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

  <p class="para rdfs-comment">
   Calcula a chave de Metaphone da <code class="parameter">string</code>.
  </p>
  <p class="para">
   Parecida com a função <span class="function"><a href="function.soundex.php" class="function">soundex()</a></span>, metaphone cria a mesma chave para
   palavras que soam de forma similar. É mais precisa que
   <span class="function"><a href="function.soundex.php" class="function">soundex()</a></span> já que ela conhece as regras básicas de pronúncia
   em inglês. As chaves geradas têm comprimento variável.
  </p>
  <p class="para">
   Metaphone foi desenvolvido por Lawrence Philips
   &lt;lphilips at verity dot com&gt;. É descrita em [&quot;Practical
   Algorithms for Programmers&quot;, Binstock &amp; Rex, Addison Wesley,
   1995].
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.metaphone-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">string</code></dt>
     <dd>
      <p class="para">
       A string de entrada.
      </p>
     </dd>
    
    
     <dt><code class="parameter">max_phonemes</code></dt>
     <dd>
      <p class="para">
       Este parâmetro restringe o comprimento da chave retornada ao número máximo de
       <em>characters</em> especificado em <code class="parameter">max_phonemes</code>.
       Entretanto, os fonemas resultantes são sempre transcritos completamente, portanto o
       comprimento resultante da string pode ser um pouco maior que <code class="parameter">max_phonemes</code>.
       O valor padrão de <code class="literal">0</code> significa sem restrição.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.metaphone-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Retorna a chave de Metaphone como uma string.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.metaphone-changelog">
  <h3 class="title">Registro de Alterações</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Versão</th>
      <th>Descrição</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.0.0</td>
      <td>
       Esta função retornava <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> em caso de falha.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.metaphone-examples">
  <h3 class="title">Exemplos</h3>
  <p class="para">
   <div class="example" id="metaphone.example.basic">
    <p><strong>Exemplo #1 Exemplo básico de <span class="function"><strong>metaphone()</strong></span></strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">metaphone</span><span style="color: #007700">(</span><span style="color: #DD0000">'programming'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">metaphone</span><span style="color: #007700">(</span><span style="color: #DD0000">'programmer'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>O exemplo acima produzirá:</p></div>
    <div class="example-contents screen">
<div class="annotation-interactive examplescode"><pre class="examplescode">string(7) &quot;PRKRMNK&quot;
string(6) &quot;PRKRMR&quot;</pre>
</div>
    </div>
   </div>
  </p>
  <p class="para">
   <div class="example" id="metaphone.example.phonemes">
    <p><strong>Exemplo #2 Usando o parâmetro <code class="parameter">max_phonemes</code></strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">metaphone</span><span style="color: #007700">(</span><span style="color: #DD0000">'programming'</span><span style="color: #007700">, </span><span style="color: #0000BB">5</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">metaphone</span><span style="color: #007700">(</span><span style="color: #DD0000">'programmer'</span><span style="color: #007700">, </span><span style="color: #0000BB">5</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>O exemplo acima produzirá:</p></div>
    <div class="example-contents screen">
<div class="annotation-interactive examplescode"><pre class="examplescode">string(5) &quot;PRKRM&quot;
string(5) &quot;PRKRM&quot;</pre>
</div>
    </div>
   </div>
  </p>
  <p class="para">
   <div class="example" id="metaphone.example.phonemes-overlong">
    <p><strong>Exemplo #3 Usando o parâmetro <code class="parameter">max_phonemes</code></strong></p>
    <div class="example-contents"><p>
     Neste exemplo, <span class="function"><strong>metaphone()</strong></span> é instruída a produzir uma string
     de cinco caracteres, mas isso iria separar o fonema final
     (<code class="literal">&#039;x&#039;</code> deve ser transcrito para <code class="literal">&#039;KS&#039;</code>),
     portanto a função retorna uma string com seis caracteres.
    </p></div>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">metaphone</span><span style="color: #007700">(</span><span style="color: #DD0000">'Asterix'</span><span style="color: #007700">, </span><span style="color: #0000BB">5</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>O exemplo acima produzirá:</p></div>
    <div class="example-contents screen">
<div class="annotation-interactive examplescode"><pre class="examplescode">string(6) &quot;ASTRKS&quot;</pre>
</div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.metaphone-seealso">
  <h3 class="title">Veja Também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.levenshtein.php" class="function" rel="rdfs-seeAlso">levenshtein()</a> - Calcula a dist&acirc;ncia Levenshtein entre duas strings</span></li>
    <li><span class="function"><a href="function.similar-text.php" class="function" rel="rdfs-seeAlso">similar_text()</a> - Calcula a similaridade entre duas strings</span></li>
    <li><span class="function"><a href="function.soundex.php" class="function" rel="rdfs-seeAlso">soundex()</a> - Calcula a chave soundex de uma string</span></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>