php-doc-en/reference/regex/functions/eregi-replace.xml
Adam Harvey b38c2956ff Begin beefing up our warnings for things removed in 7.0.
First up: ereg.

I've added a couple of new snippets based on the MySQL snippets that allow us
to provide alternatives in the big red warning box atop each page, since that
approach seems to work well there. I'll add more variations as required as I
work through the various extensions that need to be updated.

In general, I'd like to use this approach more consistently moving forward as
we deprecate and remove things, since it gives the user a very obvious link to
follow to find out about the new way of doing things.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338425 c90b9560-bf6c-de11-be94-00142212c4b1
2016-01-08 00:42:05 +00:00

134 lines
3.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.eregi-replace">
<refnamediv>
<refname>eregi_replace</refname>
<refpurpose>Replace regular expression case insensitive</refpurpose>
</refnamediv>
<refsynopsisdiv>
<warning>
&warn.deprecated.function.5-3-0.removed.7-0-0.alternatives;
<simplelist role="alternatives">
<member>
<function>preg_replace</function>
(with the <literal>i</literal> (<constant>PCRE_CASELESS</constant>)
modifier)
</member>
</simplelist>
</warning>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>eregi_replace</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam><type>string</type><parameter>replacement</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
</methodsynopsis>
<para>
This function is identical to <function>ereg_replace</function>
except that this ignores case distinction when matching
alphabetic characters.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>pattern</parameter></term>
<listitem>
<para>
A POSIX extended regular expression.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>replacement</parameter></term>
<listitem>
<para>
If <parameter>pattern</parameter> contains parenthesized substrings,
<parameter>replacement</parameter> may contain substrings of the form
<literal>\<replaceable>digit</replaceable></literal>, which will be
replaced by the text matching the digit'th parenthesized substring;
<literal>\0</literal> will produce the entire contents of string.
Up to nine substrings may be used. Parentheses may be nested, in which
case they are counted by the opening parenthesis.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem>
<para>
The input string.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The modified string is returned. If no matches are found in
<parameter>string</parameter>, then it will be returned unchanged.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Highlight search results</title>
<programlisting role="php">
<![CDATA[
<?php
$pattern = '(>[^<]*)('. quotemeta($_GET['search']) .')';
$replacement = '\\1<span class="search">\\2</span>';
$body = eregi_replace($pattern, $replacement, $body);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ereg</function></member>
<member><function>eregi</function></member>
<member><function>ereg_replace</function></member>
<member><function>preg_replace</function></member>
<member><function>quotemeta</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
-->