<?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 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.grapheme-substr.php',
    1 => 'grapheme_substr',
    2 => 'Возвращает часть строки в графемных кластерах',
  ),
  'up' => 
  array (
    0 => 'ref.intl.grapheme.php',
    1 => 'Функции Grapheme',
  ),
  'prev' => 
  array (
    0 => 'function.grapheme-strstr.php',
    1 => 'grapheme_strstr',
  ),
  'next' => 
  array (
    0 => 'ref.intl.idn.php',
    1 => 'Функции IDN',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/intl/grapheme/grapheme-substr.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.grapheme-substr" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">grapheme_substr</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_substr</span> &mdash; <span class="dc-title">Возвращает часть строки в графемных кластерах</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.grapheme-substr-description">
  <h3 class="title">Описание</h3>
  <p class="para">Процедурный стиль</p>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>grapheme_substr</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">$string</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">$offset</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></span> <code class="parameter">$length</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></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">$locale</code><span class="initializer"> = &quot;&quot;</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">
   Функция возвращает часть строки. Смещение и длина измеряются в графемных кластерах.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.grapheme-substr-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">string</code></dt>
     <dd>
      <p class="para">
       Входная строка по стандарту UTF-8, часть которой требуется вернуть.
      </p>
     </dd>
    
    
     <dt><code class="parameter">offset</code></dt>
     <dd>
      <p class="para">
       Начальная позиция подстроки в графемных кластерах, а не в байтах или кодовых точках.
       При передаче в параметр <code class="parameter">offset</code> нуля или положительного значения началом подстроки станет позиция <code class="parameter">offset</code>,
       которую функция при подсчёте с нуля найдёт с начала строки <code class="parameter">string</code>. При передаче в параметр <code class="parameter">offset</code>
       отрицательного значения началом подстроки станет позиция <code class="parameter">offset</code>, которую функция также вычислит
       в графемных кластерах, но с конца строки.
      </p>
     </dd>
    
    
     <dt><code class="parameter">length</code></dt>
     <dd>
      <p class="para">
       Длина подстроки в графемных кластерах.
       Положительное значение параметра <code class="parameter">length</code> ограничит длину подстроки;
       функция вернёт подстроку меньшей длины, если количество графемных кластеров с позиции <code class="parameter">offset</code>
       до конца строки окажется меньше значения <code class="parameter">length</code>. При отрицательном значении параметра <code class="parameter">length</code>
       функция отбросит графемные кластеры с конца строки; при отрицательном значении смещения <code class="parameter">offset</code>
       усечение выполняется после вычисления начальной позиции.
       При пересечении позиций смещения <code class="parameter">offset</code> и усечения функция вернёт пустую строку.
      </p>
     </dd>
    
    
     <dt><code class="parameter">locale</code></dt>
     <dd>
      <span class="simpara">Идентификатор языковых и региональных параметров.</span>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.grapheme-substr-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Функция возвращает подстроку, которую извлекла из строки <code class="parameter">string</code>, или <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>, если возникла ошибка.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.grapheme-substr-changelog">
  <h3 class="title">Список изменений</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Версия</th>
      <th>Описание</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.5.0</td>
 <td>
  Добавили необязательный параметр <code class="parameter">locale</code>.
 </td>
</tr>

     <tr>
      <td>8.0.0</td>
      <td>
       Функция теперь автоматически уменьшает или увеличивает значение смещения, которое выходит за пределы строки;
       раньше при выходе смещения за границы строки вместо пустой строки возвращалось значение <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.grapheme-substr-examples">
  <h3 class="title">Примеры</h3>
  <div class="example" id="example-1">
   <p><strong>Пример #1 Пример извлечения подстроки в графемных кластерах функцией <span class="function"><strong>grapheme_substr()</strong></span></strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #FF8000">// Символ | Название | Кодовая точка | Форма нормализации<br /><br />// å: 'LATIN SMALL LETTER A WITH RING ABOVE', U+00E5, NFD<br /></span><span style="color: #0000BB">$char_a_ring_nfd </span><span style="color: #007700">= </span><span style="color: #DD0000">"a\xCC\x8A"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// ö: 'LATIN SMALL LETTER O WITH DIAERESIS', U+00F6, 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">;<br /><br />echo </span><span style="color: #0000BB">urlencode</span><span style="color: #007700">(</span><span style="color: #0000BB">grapheme_substr</span><span style="color: #007700">(</span><span style="color: #DD0000">"ao" </span><span style="color: #007700">. </span><span style="color: #0000BB">$char_a_ring_nfd </span><span style="color: #007700">. </span><span style="color: #DD0000">"bc" </span><span style="color: #007700">. </span><span style="color: #0000BB">$char_o_diaeresis_nfd </span><span style="color: #007700">. </span><span style="color: #DD0000">"O"</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">, -</span><span style="color: #0000BB">1</span><span style="color: #007700">));</span></span></code></div>
   </div>

  </div>
  
<p class="para">
 Результат выполнения приведённого примера:
</p>

  <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">a%CC%8Abco%CC%88</pre>
</div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.grapheme-substr-seealso">
  <h3 class="title">Смотрите также</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.grapheme-extract.php" class="function" rel="rdfs-seeAlso">grapheme_extract()</a> - Функция для извлечения последовательности кластеров графем по умолчанию из текстового буфера, которая должна быть закодирована в UTF-8</span></li>
    <li>
     <a href="http://unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries" class="link external">&raquo;&nbsp;
      Сегментация текста в Юникоде: Границы графемных кластеров
     </a>
    </li>
   </ul>
  </p>
 </div>

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