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 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.spliti">
<refnamediv>
<refname>spliti</refname>
<refpurpose>Split string into array by regular expression case insensitive</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>spliti</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>limit</parameter></methodparam>
</methodsynopsis>
<para>
Splits a <parameter>string</parameter> into array by regular expression.
</para>
<para>
This function is identical to <function>split</function> except that this
ignores case distinction when matching alphabetic characters.
</para>
&warn.deprecated.function-5-3-0.removed-6-0-0;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>pattern</parameter></term>
<listitem>
<para>
Case insensitive regular expression.
</para>
<para>
If you want to split on any of the characters which are considered
special by regular expressions, you'll need to escape them first. If
you think <function>spliti</function> (or any other regex function, for
that matter) is doing something weird, please read the file
<filename>regex.7</filename>, included in the
<filename>regex/</filename> subdirectory of the PHP distribution. It's
in manpage format, so you'll want to do something along the lines of
<command>man /usr/local/src/regex/regex.7</command> in order to read it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem>
<para>
The input string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>limit</parameter></term>
<listitem>
<para>
If <parameter>limit</parameter> is set, the returned array will
contain a maximum of <parameter>limit</parameter> elements with the
last element containing the whole rest of
<parameter>string</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<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 case insensitive regular expression <parameter>pattern</parameter>.
</para>
<para>
If there are <replaceable>n</replaceable> occurrences of
<parameter>pattern</parameter>, the returned array will contain
<literal><replaceable>n</replaceable>+1</literal> items. For example, if
there is no occurrence of <parameter>pattern</parameter>, an array with
only one element will be returned. Of course, this is also true if
<parameter>string</parameter> is empty. If an error occurs,
<function>spliti</function> returns &false;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
This example splits a string using 'a' as the separator :
<example>
<title><function>spliti</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$string = "aBBBaCCCADDDaEEEaGGGA";
$chunks = spliti ("a", $string, 5);
print_r($chunks);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Array
(
[0] =>
[1] => BBB
[2] => CCC
[3] => DDD
[4] => EEEaGGGA
)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
¬e.regex.deprecated;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>preg_split</function></member>
<member><function>split</function></member>
<member><function>explode</function></member>
<member><function>implode</function></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
-->
|