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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mb-ereg" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mb_ereg</refname>
<refpurpose>Regular expression match with multibyte support</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mb_ereg</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">matches</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<simpara>
Executes the regular expression match with multibyte support.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>pattern</parameter></term>
<listitem>
<para>
The search pattern.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem>
<para>
The search <type>string</type>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>matches</parameter></term>
<listitem>
<para>
If matches are found for parenthesized substrings of
<parameter>pattern</parameter> and the function is called with the
third argument <parameter>matches</parameter>, the matches will be stored
in the elements of the array <parameter>matches</parameter>.
If no matches are found, <parameter>matches</parameter> is set to an empty
array.
</para>
<para>
<varname>$matches[1]</varname> will contain the substring which starts at
the first left parenthesis; <varname>$matches[2]</varname> will contain
the substring starting at the second, and so on.
<varname>$matches[0]</varname> will contain a copy of the complete string
matched.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns whether <parameter>pattern</parameter> matches <parameter>string</parameter>.
</para>
</refsect1>
<refsect1 role="changelog"><!-- {{{ -->
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
This function returns &true; on success now. Previously, it returned the byte length
of the matched string if a match for <parameter>pattern</parameter> was found in
<parameter>string</parameter> and <parameter>matches</parameter> was passed.
If the optional parameter <parameter>matches</parameter> was not passed or
the length of the matched string was <literal>0</literal>, this function returned <literal>1</literal>.
</entry>
</row>
<row>
<entry>7.1.0</entry>
<entry>
<function>mb_ereg</function> will now set <parameter>matches</parameter> to
an empty <type>array</type>, if nothing matched. Formerly,
<parameter>matches</parameter> was not modified in that case.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1><!-- }}} -->
<refsect1 role="notes">
&reftitle.notes;
¬e.mbstring.encoding.internal;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mb_regex_encoding</function></member>
<member><function>mb_eregi</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
-->
|