mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
148 lines
3.3 KiB
XML
148 lines
3.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.str-split">
|
|
<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>split_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>split_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>split_length</parameter> parameter is
|
|
specified, the returned array will be broken down into chunks with each
|
|
being <parameter>split_length</parameter> in length, otherwise each chunk
|
|
will be one character in length.
|
|
</para>
|
|
<para>
|
|
&false; is returned if <parameter>split_length</parameter> is less than 1.
|
|
If the <parameter>split_length</parameter> length exceeds the length of
|
|
<parameter>string</parameter>, the entire string is returned as the first
|
|
(and only) array element.
|
|
</para>
|
|
</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="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<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
|
|
-->
|