str-split.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.str-split" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>str_split</refname>
  <refpurpose>Convert a string to an array</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>
   Converts a string to an array. 
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       The input string.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Maximum length of the chunk.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   If the optional <parameter>length</parameter> parameter is
   specified, the returned array will be broken down into chunks with each
   being <parameter>length</parameter> in length, except the final chunk
   which may be shorter if the string does not divide evenly.  The default
   <parameter>length</parameter> is <literal>1</literal>, meaning every chunk will be one byte in size.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   If <parameter>length</parameter> is less than <literal>1</literal>,
   a <classname>ValueError</classname> will be thrown.
  </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>
       If <parameter>string</parameter> is empty an empty &array; is now returned.
       Previously an &array; containing a single empty string was returned.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       If <parameter>length</parameter> is less than <literal>1</literal>,
       a <classname>ValueError</classname> will be thrown now;
       previously, an error of level <constant>E_WARNING</constant>
       has been raised instead, and the function returned &false;.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Example uses of <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> will split into bytes, rather than characters when dealing with a multi-byte encoded string.
    <function>mb_str_split</function> can be used to split the string into code points.
    <function>grapheme_str_split</function> can be used to split the string into grapheme clusters.
   </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
-->