str-split.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 31e301590744e91ee5903f3e20973ddb9f3dadbb Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.str-split" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>str_split</refname>
  <refpurpose>文字列を配列に変換する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>str_split</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>1</initializer></methodparam>
  </methodsynopsis>
  <para>
   文字列を配列に変換します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       入力文字列。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       分割した部分の最大長。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   オプションのパラメータ
   <parameter>length</parameter> が指定されている場合、
   返される配列の各要素は、<parameter>length</parameter>
   の長さとなります。但し、平等に分割できない場合、
   最後の要素だけはその長さより短くなります。
   デフォルトでは、
   <parameter>length</parameter> の値は <literal>1</literal> です。
   つまり、
   1バイトずつ分割された配列となります。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <parameter>length</parameter> が1より小さい場合、
   <classname>ValueError</classname> がスローされます。
  </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.2.0</entry>
      <entry>
       <parameter>string</parameter> が空の場合、
       空の配列が返されるようになりました。
       これより前のバージョンでは、空文字列がひとつ入った配列が返されていました。
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>length</parameter> が1より小さい場合、
       <classname>ValueError</classname> がスローされるようになりました。
       それより前のバージョンでは、
       <constant>E_WARNING</constant> レベルの警告が発生し、
       &false; を返していました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>str_split</function> の使用例</title>
    <programlisting role="php">
<![CDATA[
<?php

$str = "Hello Friend";

$arr1 = str_split($str);
$arr2 = str_split($str, 3);

print_r($arr1);
print_r($arr2);

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [0] => H
    [1] => e
    [2] => l
    [3] => l
    [4] => o
    [5] =>
    [6] => F
    [7] => r
    [8] => i
    [9] => e
    [10] => n
    [11] => d
)

Array
(
    [0] => Hel
    [1] => lo
    [2] => Fri
    [3] => end
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    <function>str_split</function> でのマルチバイト文字列の扱いは、文字単位ではなくバイト単位での分割になります。
    コードポイント単位で文字列を分割するには、
    <function>mb_str_split</function> を使います。
    文字列を書記素クラスターに分割するには、
    <function>grapheme_str_split</function> を使います。
   </para>
  </note>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mb_str_split</function></member>
    <member><function>grapheme_str_split</function></member>
    <member><function>chunk_split</function></member>
    <member><function>preg_split</function></member>
    <member><function>explode</function></member>
    <member><function>count_chars</function></member>
    <member><function>str_word_count</function></member>
    <member><link linkend="control-structures.for">for</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
-->