File: str-split.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (130 lines) | stat: -rw-r--r-- 2,999 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
  <refentry id="function.str-split">
   <refnamediv>
    <refname>str_split</refname>
    <refpurpose>
     Convert a string to an array
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <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></methodparam>
    </methodsynopsis>
    <para>
     Converts a string to an array. 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>
    <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>
      <para>
       Output may look like:
      </para>
      <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>
    <para>
     <example>
      <title>Examples related to <function>str_split</function></title>
      <programlisting role="php">
<![CDATA[
<?php

$str = "Hello Friend";

echo $str{0};  // H
echo $str{8};  // i

// Creates: array('H','e','l','l','o',' ','F','r','i','e','n','d')
$arr1 = preg_split('//', $str, -1, PREG_SPLIT_NO_EMPTY);

?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     See also <function>chunk_split</function>,
     <function>preg_split</function>,
     <function>split</function>,
     <function>count_chars</function>,
     <function>str_word_count</function>, and 
     <link linkend="control-structures.for">for</link>.
    </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:"../../../../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
-->