mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
af4410a7e1
still using this, after discussion on the phpdoc list. From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
135 lines
3.7 KiB
XML
135 lines
3.7 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.eregi">
|
|
<refnamediv>
|
|
<refname>eregi</refname>
|
|
<refpurpose>Case insensitive regular expression match</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>eregi</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">regs</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function is identical to <function>ereg</function> except that it
|
|
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>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>string</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The input string.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>regs</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>regs</parameter>, the matches will be stored
|
|
in the elements of the array <parameter>regs</parameter>.
|
|
</para>
|
|
<para>
|
|
$regs[1] will contain the substring which starts at the first left
|
|
parenthesis; $regs[2] will contain the substring starting at the
|
|
second, and so on. $regs[0] will contain a copy of the complete string
|
|
matched.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the length of the matched string if a match for
|
|
<parameter>pattern</parameter> was found in <parameter>string</parameter>,
|
|
or &false; if no matches were found or an error occurred.
|
|
</para>
|
|
<para>
|
|
If the optional parameter <parameter>regs</parameter> was not passed or
|
|
the length of the matched string is 0, this function returns 1.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>eregi</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$string = 'XYZ';
|
|
if (eregi('z', $string)) {
|
|
echo "'$string' contains a 'z' or 'Z'!";
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
¬e.regex.deprecated;
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>ereg</function></member>
|
|
<member><function>ereg_replace</function></member>
|
|
<member><function>eregi_replace</function></member>
|
|
<member><function>stripos</function></member>
|
|
<member><function>stristr</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
|
|
-->
|