File: explode.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 (141 lines) | stat: -rw-r--r-- 3,932 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
131
132
133
134
135
136
137
138
139
140
141
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!-- splitted from ./en/functions/strings.xml, last change in rev 1.2 -->
  <refentry id="function.explode">
   <refnamediv>
    <refname>explode</refname>
    <refpurpose>Split a string by string</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>array</type><methodname>explode</methodname>
      <methodparam><type>string</type><parameter>separator</parameter></methodparam>
      <methodparam><type>string</type><parameter>string</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>limit</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns an array of strings, each of which is a substring of
     <parameter>string</parameter> formed by splitting it on
     boundaries formed by the string <parameter>separator</parameter>.
     If <parameter>limit</parameter> is set, the returned array will
     contain a maximum of <parameter>limit</parameter> elements with
     the last element containing the rest of
     <parameter>string</parameter>.
    </para>
    <para>
     If <parameter>separator</parameter> is an empty string (""),
     <function>explode</function> will return &false;.  If
     <parameter>separator</parameter> contains a value that is not contained
     in <parameter>string</parameter>, then <function>explode</function> will
     return an array containing <parameter>string</parameter>.
    </para>
    <para>
     If the <parameter>limit</parameter> parameter is negative, all components
     except the last <parameter>limit</parameter> are returned. This feature
     was added in PHP 5.1.0.
    </para>
    <para>
     Although <function>implode</function> can, for historical reasons,
     accept its parameters in either order,
     <function>explode</function> cannot. You must ensure that the
     <parameter>separator</parameter> argument comes before the
     <parameter>string</parameter> argument.
    </para>
    <note>
     <para>
      The <parameter>limit</parameter> parameter was added in PHP
      4.0.1 
     </para>
    </note>
    <para>
     <example>
      <title><function>explode</function> examples</title>
      <programlisting role="php">
<![CDATA[
<?php
// Example 1
$pizza  = "piece1 piece2 piece3 piece4 piece5 piece6";
$pieces = explode(" ", $pizza);
echo $pieces[0]; // piece1
echo $pieces[1]; // piece2

// Example 2
$data = "foo:*:1023:1000::/home/foo:/bin/sh";
list($user, $pass, $uid, $gid, $gecos, $home, $shell) = explode(":", $data);
echo $user; // foo
echo $pass; // *

?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     <example>
      <title><parameter>limit</parameter> parameter examples</title>
      <programlisting role="php">
<![CDATA[
<?php
$str = 'one|two|three|four';

// positive limit
print_r(explode('|', $str, 2));

// negative limit (since PHP 5.1)
print_r(explode('|', $str, -1));
?>
]]>
      </programlisting>
      &example.outputs;
      <screen>
<![CDATA[
Array
(
    [0] => one
    [1] => two|three|four
)
Array
(
    [0] => one
    [1] => two
    [2] => three
)
]]>
      </screen>
     </example>
    </para>

    &note.bin-safe;

    <para>
     See also 
     <function>preg_split</function>,
     <function>spliti</function>,
     <function>split</function>,
     <function>strtok</function>, and
     <function>implode</function>.
    </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
-->