PageRenderTime 38ms CodeModel.GetById 13ms RepoModel.GetById 0ms app.codeStats 0ms

/php/php-chunked-xhtml/function.split.html

http://github.com/matsubo/matsu-shell-setting
HTML | 200 lines | 168 code | 32 blank | 0 comment | 0 complexity | 07f94a87bcb770dbddbe45b147ce7b10 MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <html>
    3. 

  3.  <head>
    4. 

  4.   <meta http-equiv="content-type" content="text/html; charset=UTF-8">
    5. 

  5.   <title>Split string into array by regular expression</title>
    6. 

  6. 

  7.  </head>
    8. 

  8.  <body><div class="manualnavbar" style="text-align: center;">
    9. 

  9.  <div class="prev" style="text-align: left; float: left;"><a href="function.eregi.html">eregi</a></div>
    10. 

  10.  <div class="next" style="text-align: right; float: right;"><a href="function.spliti.html">spliti</a></div>
    11. 

  11.  <div class="up"><a href="ref.regex.html">POSIX Regex Functions</a></div>
    12. 

  12.  <div class="home"><a href="index.html">PHP Manual</a></div>
    13. 

  13. </div><hr /><div id="function.split" class="refentry">
    14. 

  14.  <div class="refnamediv">
    15. 

  15.   <h1 class="refname">split</h1>
    16. 

  16.   <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">split</span> &mdash; <span class="dc-title">Split string into array by regular expression</span></p>
    17. 

  17. 

  18.  </div>
    19. 

  19.  
    20. 

  20.  <div class="refsect1 description" id="refsect1-function.split-description">
    21. 

  21.   <h3 class="title">Description</h3>
    22. 

  22.   <div class="methodsynopsis dc-description">
    23. 

  23.    <span class="type">array</span> <span class="methodname"><b>split</b></span>
    24. 

  24.     ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$pattern</tt></span>
    25. 

  25.    , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$string</tt></span>
    26. 

  26.    [, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$limit</tt><span class="initializer"> = -1</span></span>
    27. 

  27.   ] )</div>
    28. 

  28. 

  29.   <p class="para rdfs-comment">
    30. 

  30.    Splits a <i><tt class="parameter">string</tt></i> into array by regular expression.
    31. 

  31.   </p>
    32. 

  32.   <div class="warning"><b class="warning">Warning</b><p class="simpara">This function has been
    33. 

  33. <em class="emphasis">DEPRECATED</em> as of PHP 5.3.0. Relying on this feature is
    34. 

  34. highly discouraged.</p></div>
    35. 

  35.  </div>
    36. 

  36. 

  37. 

  38.  <div class="refsect1 parameters" id="refsect1-function.split-parameters">
    39. 

  39.   <h3 class="title">Parameters</h3>
    40. 

  40.   <p class="para">
    41. 

  41.    <dl>
    42. 

  42. 

  43.     <dt>
    44. 

  44. 

  45.      <span class="term"><i><tt class="parameter">pattern</tt></i></span>
    46. 

  46.      <dd>
    47. 

  47. 

  48.       <p class="para">
    49. 

  49.        Case sensitive regular expression.
    50. 

  50.       </p>
    51. 

  51.       <p class="para">
    52. 

  52.        If you want to split on any of the characters which are considered
    53. 

  53.        special by regular expressions, you&#039;ll need to escape them first. If
    54. 

  54.        you think <span class="function"><b>split()</b></span> (or any other regex function, for
    55. 

  55.        that matter) is doing something weird, please read the file
    56. 

  56.        <var class="filename">regex.7</var>, included in the 
    57. 

  57.        <var class="filename">regex/</var> subdirectory of the PHP distribution. It&#039;s
    58. 

  58.        in manpage format, so you&#039;ll want to do something along the lines of
    59. 

  59.        <strong class="command">man /usr/local/src/regex/regex.7</strong> in order to read it.
    60. 

  60.       </p>
    61. 

  61.      </dd>
    62. 

  62. 

  63.     </dt>
    64. 

  64. 

  65.     <dt>
    66. 

  66. 

  67.      <span class="term"><i><tt class="parameter">string</tt></i></span>
    68. 

  68.      <dd>
    69. 

  69. 

  70.       <p class="para">
    71. 

  71.        The input string.
    72. 

  72.       </p>
    73. 

  73.      </dd>
    74. 

  74. 

  75.     </dt>
    76. 

  76. 

  77.     <dt>
    78. 

  78. 

  79.      <span class="term"><i><tt class="parameter">limit</tt></i></span>
    80. 

  80.      <dd>
    81. 

  81. 

  82.       <p class="para">
    83. 

  83.        If <i><tt class="parameter">limit</tt></i> is set, the returned array will
    84. 

  84.        contain a maximum of <i><tt class="parameter">limit</tt></i> elements with the
    85. 

  85.        last element containing the whole rest of
    86. 

  86.        <i><tt class="parameter">string</tt></i>.
    87. 

  87.       </p>
    88. 

  88.      </dd>
    89. 

  89. 

  90.     </dt>
    91. 

  91. 

  92.    </dl>
    93. 

  93. 

  94.   </p>
    95. 

  95.  </div>
    96. 

  96. 

  97. 

  98.  <div class="refsect1 returnvalues" id="refsect1-function.split-returnvalues">
    99. 

  99.   <h3 class="title">Return Values</h3>
    100. 

  100.   <p class="para">
    101. 

  101.    Returns an array of strings, each of which is a substring of
    102. 

  102.    <i><tt class="parameter">string</tt></i> formed by splitting it on boundaries formed
    103. 

  103.    by the case-sensitive regular expression <i><tt class="parameter">pattern</tt></i>.
    104. 

  104.   </p>
    105. 

  105.   <p class="para">
    106. 

  106.    If there are <span class="replaceable">n</span> occurrences of
    107. 

  107.    <i><tt class="parameter">pattern</tt></i>, the returned array will contain
    108. 

  108.    <i><span class="replaceable">n</span>+1</i> items. For example, if
    109. 

  109.    there is no occurrence of <i><tt class="parameter">pattern</tt></i>, an array with
    110. 

  110.    only one element will be returned. Of course, this is also true if
    111. 

  111.    <i><tt class="parameter">string</tt></i> is empty. If an error occurs,
    112. 

  112.    <span class="function"><b>split()</b></span> returns <b><tt>FALSE</tt></b>.
    113. 

  113.   </p>
    114. 

  114.  </div>
    115. 

  115. 

  116. 

  117.  <div class="refsect1 examples" id="refsect1-function.split-examples">
    118. 

  118.   <h3 class="title">Examples</h3>
    119. 

  119.   <p class="para">
    120. 

  120.    <div class="example" id="example-4061">
    121. 

  121.     <p><b>Example #1 <span class="function"><b>split()</b></span> example</b></p>
    122. 

  122.     <div class="example-contents"><p>
    123. 

  123.      To split off the first four fields from a line from
    124. 

  124.      <var class="filename">/etc/passwd</var>:
    125. 

  125.     </p></div>
    126. 

  126.     <div class="example-contents">
    127. 

  127. <div class="phpcode"><code><span style="color: #000000">
    128. 

  128. <span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">list(</span><span style="color: #0000BB">$user</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$pass</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$uid</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$gid</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$extra</span><span style="color: #007700">)&nbsp;=<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">split</span><span style="color: #007700">(</span><span style="color: #DD0000">":"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$passwd_line</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">5</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span>
    129. 

  129. </span>
    130. 

  130. </code></div>
    131. 

  131.     </div>
    132. 

  132. 

  133.    </div>
    134. 

  134.   </p>
    135. 

  135.   <p class="para">
    136. 

  136.    <div class="example" id="example-4062">
    137. 

  137.     <p><b>Example #2 <span class="function"><b>split()</b></span> example</b></p>
    138. 

  138.     <div class="example-contents"><p>
    139. 

  139.      To parse a date which may be delimited with slashes, dots, or hyphens:
    140. 

  140.     </p></div>
    141. 

  141.     <div class="example-contents">
    142. 

  142. <div class="phpcode"><code><span style="color: #000000">
    143. 

  143. <span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">//&nbsp;Delimiters&nbsp;may&nbsp;be&nbsp;slash,&nbsp;dot,&nbsp;or&nbsp;hyphen<br /></span><span style="color: #0000BB">$date&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">"04/30/1973"</span><span style="color: #007700">;<br />list(</span><span style="color: #0000BB">$month</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$day</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$year</span><span style="color: #007700">)&nbsp;=&nbsp;</span><span style="color: #0000BB">split</span><span style="color: #007700">(</span><span style="color: #DD0000">'[/.-]'</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$date</span><span style="color: #007700">);<br />echo&nbsp;</span><span style="color: #DD0000">"Month:&nbsp;</span><span style="color: #0000BB">$month</span><span style="color: #DD0000">;&nbsp;Day:&nbsp;</span><span style="color: #0000BB">$day</span><span style="color: #DD0000">;&nbsp;Year:&nbsp;</span><span style="color: #0000BB">$year</span><span style="color: #DD0000">&lt;br&nbsp;/&gt;\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?&gt;</span>
    144. 

  144. </span>
    145. 

  145. </code></div>
    146. 

  146.     </div>
    147. 

  147. 

  148.    </div>
    149. 

  149.   </p>
    150. 

  150.  </div>
    151. 

  151. 

  152. 

  153.  <div class="refsect1 notes" id="refsect1-function.split-notes">
    154. 

  154.   <h3 class="title">Notes</h3>
    155. 

  155.   <blockquote class="note"><p><b class="note">Note</b>: <p class="para">As of PHP 5.3.0, the
    156. 

  156. regex extension is deprecated in favor of the 
    157. 

  157. <a href="book.pcre.html" class="link">PCRE extension</a>. Calling this function 
    158. 

  158. will issue an <b><tt>E_DEPRECATED</tt></b> notice. See <a href="reference.pcre.pattern.posix.html" class="link">the list of
    159. 

  159. differences</a> for help on converting to PCRE.</p></p></blockquote>
    160. 

  160.   <div class="tip"><b class="tip">Tip</b>
    161. 

  161.    <p class="para">
    162. 

  162.     <span class="function"><a href="function.preg-split.html" class="function">preg_split()</a></span>, which uses a Perl-compatible regular
    163. 

  163.     expression syntax, is often a faster alternative to
    164. 

  164.     <span class="function"><b>split()</b></span>.  If you don&#039;t require the power of regular
    165. 

  165.     expressions, it is faster to use <span class="function"><a href="function.explode.html" class="function">explode()</a></span>, which
    166. 

  166.     doesn&#039;t incur the overhead of the regular expression engine.
    167. 

  167.    </p>
    168. 

  168.   </div>
    169. 

  169.   <div class="tip"><b class="tip">Tip</b>
    170. 

  170.    <p class="para">
    171. 

  171.     For users looking for a way to emulate Perl&#039;s <strong class="command">@chars =
    172. 

  172.     split(&#039;&#039;, $str)</strong> behaviour, please see the examples for
    173. 

  173.     <span class="function"><a href="function.preg-split.html" class="function">preg_split()</a></span> or <span class="function"><a href="function.str-split.html" class="function">str_split()</a></span>.
    174. 

  174.    </p>
    175. 

  175.   </div>
    176. 

  176.  </div>
    177. 

  177. 

  178. 

  179.  <div class="refsect1 seealso" id="refsect1-function.split-seealso">
    180. 

  180.   <h3 class="title">See Also</h3>
    181. 

  181.   <p class="para">
    182. 

  182.    <ul class="simplelist">
    183. 

  183.     <li class="member"><span class="function"><a href="function.preg-split.html" class="function" rel="rdfs-seeAlso">preg_split()</a> - Split string by a regular expression</span></li>
    184. 

  184.     <li class="member"><span class="function"><a href="function.spliti.html" class="function" rel="rdfs-seeAlso">spliti()</a> - Split string into array by regular expression case insensitive</span></li>
    185. 

  185.     <li class="member"><span class="function"><a href="function.str-split.html" class="function" rel="rdfs-seeAlso">str_split()</a> - Convert a string to an array</span></li>
    186. 

  186.     <li class="member"><span class="function"><a href="function.explode.html" class="function" rel="rdfs-seeAlso">explode()</a> - Split a string by string</span></li>
    187. 

  187.     <li class="member"><span class="function"><a href="function.implode.html" class="function" rel="rdfs-seeAlso">implode()</a> - Join array elements with a string</span></li>
    188. 

  188.     <li class="member"><span class="function"><a href="function.chunk-split.html" class="function" rel="rdfs-seeAlso">chunk_split()</a> - Split a string into smaller chunks</span></li>
    189. 

  189.     <li class="member"><span class="function"><a href="function.wordwrap.html" class="function" rel="rdfs-seeAlso">wordwrap()</a> - Wraps a string to a given number of characters</span></li>
    190. 

  190.    </ul>
    191. 

  191.   </p>
    192. 

  192.  </div>
    193. 

  193. 

  194. 

  195. </div><hr /><div class="manualnavbar" style="text-align: center;">
    196. 

  196.  <div class="prev" style="text-align: left; float: left;"><a href="function.eregi.html">eregi</a></div>
    197. 

  197.  <div class="next" style="text-align: right; float: right;"><a href="function.spliti.html">spliti</a></div>
    198. 

  198.  <div class="up"><a href="ref.regex.html">POSIX Regex Functions</a></div>
    199. 

  199.  <div class="home"><a href="index.html">PHP Manual</a></div>
    200. 

  200. </div></body></html>
    201. 

  201.