<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.intl.grapheme.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.grapheme-extract.php',
    1 => 'grapheme_extract',
    2 => 'Extrai uma sequ&ecirc;ncia de grupos padr&atilde;o de grafemas de um buffer de texto em UTF-8',
  ),
  'up' => 
  array (
    0 => 'ref.intl.grapheme.php',
    1 => 'Fun&ccedil;&otilde;es de Grapheme',
  ),
  'prev' => 
  array (
    0 => 'ref.intl.grapheme.php',
    1 => 'Fun&ccedil;&otilde;es de Grapheme',
  ),
  'next' => 
  array (
    0 => 'function.grapheme-str-split.php',
    1 => 'grapheme_str_split',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/intl/grapheme/grapheme-extract.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.grapheme-extract" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">grapheme_extract</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.3.0, PHP 7, PHP 8, PECL intl &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">grapheme_extract</span> &mdash; <span class="dc-title">Extrai uma sequência de grupos padrão de grafemas de um buffer de texto em UTF-8</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.grapheme-extract-description">
  <h3 class="title">Descrição</h3>
  <p class="para">Estilo procedural</p>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>grapheme_extract</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$haystack</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$size</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$type</code><span class="initializer"> = <strong><code><a href="intl.constants.php#constant.grapheme-extr-count">GRAPHEME_EXTR_COUNT</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$offset</code><span class="initializer"> = 0</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter reference">&$next</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span><br>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   Esta função extrai uma sequência de grupos padrão de grafemas a partir de um buffer de texto codificado em UTF-8.
  </p>
  </div>


 <div class="refsect1 parameters" id="refsect1-function.grapheme-extract-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">haystack</code></dt>
     <dd>
      <p class="para">
       A string onde a pesquisa será feita.
      </p>
     </dd>
    
    
     <dt><code class="parameter">size</code></dt>
     <dd>
      <p class="para">
       Número máximo de itens - baseado no tipo <code class="parameter">type</code> - a retornar.
      </p>
     </dd>
    
    
     <dt><code class="parameter">type</code></dt>
     <dd>
      <p class="para">
       Define o tipo de unidades referidas pelo parâmetro <code class="parameter">size</code>:
      </p>
       <p class="para">
        <ul class="simplelist">
         <li>GRAPHEME_EXTR_COUNT (padrão) - <code class="parameter">size</code> é o número de grupos padrão
         de grafemas a extrair.</li>
         <li>GRAPHEME_EXTR_MAXBYTES - <code class="parameter">size</code> é o número máximo de bytes
         retornados.</li>
         <li>GRAPHEME_EXTR_MAXCHARS - <code class="parameter">size</code> é o número máximo de caracteres
         UTF-8 retornados.</li>
        </ul>
       </p>
     </dd>
    
    
     <dt><code class="parameter">offset</code></dt>
     <dd>
      <p class="para">
       Posição inicial no <code class="parameter">haystack</code> em bytes - se informado, precisa ser zero
       ou um inteiro positivo que seja menor ou igual ao comprimento de <code class="parameter">haystack</code> em
       bytes, ou um valor negativo que conta a partir do final de <code class="parameter">haystack</code>.
       Se <code class="parameter">offset</code> não apontar para o primeiro byte de um caractere
       UTF-8, a posição de início é movida para o primeiro byte do caractere seguinte.
      </p>
     </dd>
    
    
     <dt><code class="parameter">next</code></dt>
     <dd>
      <p class="para">
       Referência a um valor que será definido para a próxima posição de início.
       Quando a chamada retornar, esta variável poderá apontar para a primeira posição em bytes após o final da string.
      </p>
     </dd>
    

   </dl>
  </p>
 </div>



 <div class="refsect1 returnvalues" id="refsect1-function.grapheme-extract-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Um string com deslocamento em <code class="parameter">offset</code> e terminando em um limite de grupo padrão
   de grafema que esteja em conformidade com os parâmetros <code class="parameter">size</code> e <code class="parameter">type</code> especificados,
    ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> em caso de falha.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.grapheme-extract-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>7.1.0</td>
      <td>
       Suporte para <code class="parameter">offset</code> negativo foi adicionado.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.grapheme-extract-examples">
  <h3 class="title">Exemplos</h3>
  <div class="example" id="example-1">
   <p><strong>Exemplo #1 Exemplo de <span class="function"><strong>grapheme_extract()</strong></span></strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$char_a_ring_nfd </span><span style="color: #007700">= </span><span style="color: #DD0000">"a\xCC\x8A"</span><span style="color: #007700">;  </span><span style="color: #FF8000">// 'LATIN SMALL LETTER A WITH RING ABOVE' (U+00E5) NFD<br /></span><span style="color: #0000BB">$char_o_diaeresis_nfd </span><span style="color: #007700">= </span><span style="color: #DD0000">"o\xCC\x88"</span><span style="color: #007700">; </span><span style="color: #FF8000">// 'LATIN SMALL LETTER O WITH DIAERESIS' (U+00F6) NFD<br /><br /></span><span style="color: #007700">print </span><span style="color: #0000BB">urlencode</span><span style="color: #007700">(</span><span style="color: #0000BB">grapheme_extract</span><span style="color: #007700">( </span><span style="color: #0000BB">$char_a_ring_nfd </span><span style="color: #007700">. </span><span style="color: #0000BB">$char_o_diaeresis_nfd</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">GRAPHEME_EXTR_COUNT</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
  <p class="para">O exemplo acima produzirá:</p>
  <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">o%CC%88</pre>
</div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.grapheme-extract-seealso">
  <h3 class="title">Veja Também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.grapheme-substr.php" class="function" rel="rdfs-seeAlso">grapheme_substr()</a> - Retorna parte de uma string</span></li>
     <li>
      <a href="http://unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries" class="link external">&raquo;&nbsp;
       Unicode Text Segmentation: Grapheme Cluster Boundaries
      </a>
     </li>
   </ul>
  </p>
 </div>

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