grapheme-strpos.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 2245ff665ae4b3037728ee52c247b409ad75de35 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.grapheme-strpos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>grapheme_strpos</refname>
  <refpurpose>Находит позицию (в единицах графемы) первого вхождения строки</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <para>&style.procedural;</para>
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>grapheme_strpos</methodname>
   <methodparam><type>string</type><parameter>haystack</parameter></methodparam>
   <methodparam><type>string</type><parameter>needle</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Находит позицию (в единицах графемы) первого вхождения строки.
  </para>
  </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>haystack</parameter></term>
     <listitem>
      <para>
       Строка для поиска. Должна быть корректным UTF-8.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>needle</parameter></term>
     <listitem>
      <para>
       Строка, которую нужно найти. Должна быть корректным UTF-8.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       Необязательный параметр <parameter>offset</parameter> позволяет указать, где в <parameter>haystack</parameter> начинать поиск в виде смещения в единицах графемы (не в байтах или символах).
       Если смещение отрицательное, оно обрабатывается относительно конца строки.
       Возвращённая позиция по-прежнему относительно начала <parameter>haystack</parameter>, независимо от значения <parameter>offset</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>


 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает позицию как целое число. Если вхождение <parameter>needle</parameter> не найдено,
   функция <function>grapheme_strpos</function> вернёт &false;.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>7.1.0</entry>
      <entry>
       Добавлена поддержка отрицательных значений <parameter>offset</parameter>.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Пример использования <function>grapheme_strpos</function></title>
   <programlisting role="php">
<![CDATA[
<?php

$char_a_ring_nfd = "a\xCC\x8A";  // 'LATIN SMALL LETTER A WITH RING ABOVE' (U+00E5) normalization form "D"
$char_o_diaeresis_nfd = "o\xCC\x88"; // 'LATIN SMALL LETTER O WITH DIAERESIS' (U+00F6) normalization form "D"

print grapheme_strpos( $char_a_ring_nfd . $char_a_ring_nfd . $char_o_diaeresis_nfd, $char_o_diaeresis_nfd);

?>
]]>
   </programlisting>
  </example>
  &example.outputs;
  <screen>
<![CDATA[
2
]]>
  </screen>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>grapheme_stripos</function></member>
    <member><function>grapheme_stristr</function></member>
    <member><function>grapheme_strripos</function></member>
    <member><function>grapheme_strrpos</function></member>
    <member><function>grapheme_strstr</function></member>
    <member>
     <link xlink:href="&uri.unicode.graphemes;">
      Сегментация текста в Unicode: границы кластера графемы
     </link>
    </member>
   </simplelist>
  </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
-->