grapheme-substr.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d21607e3ecb3bd8bb67e098ab906287229d44572 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.grapheme-substr" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>grapheme_substr</refname>
  <refpurpose>部分文字列を返す</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <para>&style.procedural;</para>
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>grapheme_substr</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   部分文字列を返します。
  </para> 
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       入力文字列。正しい形式の UTF-8 でなければなりません。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       デフォルトの書記素単位での開始位置。
       <parameter>offset</parameter> がゼロ以上である場合は、<parameter>string</parameter> の
       <parameter>offset</parameter> 番目の位置から始まる文字列を返します。位置はゼロから数え始めます。
       <parameter>offset</parameter> が負の場合は、文字列の末尾から数えて
       <parameter>offset</parameter> 番目 (書記素単位) の位置以降の文字列を返します。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       長さを書記素単位で指定します。
       <parameter>length</parameter> が正の値の場合は、<parameter>offset</parameter> から数えて最大
       <parameter>length</parameter> 文字までの文字列を返します (文字列全体の長さによって変わります)。
       <parameter>length</parameter> が負の値の場合は、文字列の末尾から多くの書記素が削除されます
       (<parameter>offset</parameter> が負の場合にはまず開始位置を算出してから行います)。
        <parameter>offset</parameter> がこの削除された場所以降になる場合は、空文字列を返します。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
   
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>string</parameter> の部分文字列を返します。
   &return.falseforfailure;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       この関数は、offset が文字列境界の範囲外になる場合を一貫した形で扱うようになりました。
       これより前のバージョンでは、
       場合によっては空文字列ではなく &false; を返すことがありました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>grapheme_substr</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 urlencode(grapheme_substr( "ao" . $char_a_ring_nfd . "bc" . $char_o_diaeresis_nfd . "O", 2, -1 ));
?>
]]>
   </programlisting>
  </example>
  &example.outputs;
  <screen>
<![CDATA[
a%CC%8Abco%CC%88
]]>
  </screen>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>grapheme_extract</function></member>
    <member>
     <link xlink:href="&uri.unicode.graphemes;">
      Unicode Text Segmentation: Grapheme Cluster Boundaries
     </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
-->