mirror of
https://github.com/php/doc-pt_br.git
synced 2026-03-23 22:52:12 +01:00
377 lines
13 KiB
XML
377 lines
13 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- EN-Revision: d6f54016d62904cfd8200604aadd5e3f0d9bad97 Maintainer: leonardolara Status: ready --><!-- CREDITS: FelipeBarth, adiel, leonardolara -->
|
|
<refentry xml:id="function.preg-replace" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>preg_replace</refname>
|
|
<refpurpose>Realiza uma pesquisa por uma expressão regular e substitui</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>string</type><type>array</type><type>null</type></type><methodname>preg_replace</methodname>
|
|
<methodparam><type class="union"><type>string</type><type>array</type></type><parameter>pattern</parameter></methodparam>
|
|
<methodparam><type class="union"><type>string</type><type>array</type></type><parameter>replacement</parameter></methodparam>
|
|
<methodparam><type class="union"><type>string</type><type>array</type></type><parameter>subject</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>limit</parameter><initializer>-1</initializer></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter role="reference">count</parameter><initializer>&null;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Pesquisa <parameter>subject</parameter> por correspondências a
|
|
<parameter>pattern</parameter> e substitui-as por
|
|
<parameter>replacement</parameter>.
|
|
</para>
|
|
<para>
|
|
Para procurar correspondência a uma string exata, e não a uma expressão,
|
|
considere usar <function>str_replace</function> ou
|
|
<function>str_ireplace</function> no lugar desta função.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>pattern</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A expressão a ser pesquisada. Pode ser uma string ou um array com
|
|
strings.
|
|
</para>
|
|
<para>
|
|
Diversos <link linkend="reference.pcre.pattern.modifiers">modificadores PCRE</link>
|
|
também estão disponíveis.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>replacement</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A string ou array com strings para substituir. Se este parâmetro for uma string
|
|
e o parâmetro <parameter>pattern</parameter> for um array, todas as expressões do array
|
|
serão substituídos por esta string. Se ambos os parâmetros
|
|
<parameter>pattern</parameter> e <parameter>replacement</parameter>
|
|
forem arrays, cada expressão correspondida de <parameter>pattern</parameter> será
|
|
substituída pelo seu <parameter>replacement</parameter> correspondente. Se
|
|
houver menos elementos no array <parameter>replacement</parameter>
|
|
que no array <parameter>pattern</parameter> array, qualquer
|
|
<parameter>pattern</parameter> extra será substituído por uma string vazia.
|
|
</para>
|
|
<para>
|
|
<parameter>replacement</parameter> pode conter referências na forma
|
|
<literal>\<replaceable>n</replaceable></literal> ou
|
|
<literal>$<replaceable>n</replaceable></literal>, com a última forma sendo
|
|
a preferível. Cada referência desse tipo será substituída pelo texto capturado pelo
|
|
<replaceable>n</replaceable>-ésimo padrão entre parentêses.
|
|
<replaceable>n</replaceable> pode ser de 0 to 99, e
|
|
<literal>\0</literal> ou <literal>$0</literal> referem-se ao texto correspondente
|
|
à expressão inteira. Parênteses de abertura são contados da esquerda para direita
|
|
(iniciando em 1) para obter o número da sub-expressão de captura.
|
|
Note que a barra invertida em &string;s literais pode precisar ser escapada.
|
|
</para>
|
|
<para>
|
|
Quando se trabalha com uma expressão de substituição, onde a referência retroativa
|
|
é imediatamente seguida por outro número (isto é, inserido um número literal
|
|
imediatamente após uma expressão correspondente), não se pode usar a habitual
|
|
notação <literal>\1</literal> para a referência retroativa.
|
|
<literal>\11</literal>, por exemplo, iria confundir a função
|
|
<function>preg_replace</function> pois ela não saberá
|
|
se o desejado é a referência <literal>\1</literal> seguida por um literal
|
|
<literal>1</literal>, ou a referência <literal>\11</literal>
|
|
seguida por nada. Neste caso, a solução é usar
|
|
<literal>${1}1</literal>. Isto cria uma referência
|
|
<literal>$1</literal> isolada, deixando o <literal>1</literal>
|
|
como um literal.
|
|
</para>
|
|
<para>
|
|
Ao usar o modificador <literal>e</literal> que foi descontinuado, esta função escapa
|
|
alguns caracteres (nomeadamente <literal>'</literal>, <literal>"</literal>,
|
|
<literal>\</literal> e NULL) nas strings que substituem as
|
|
referências retroativas. Isto é feito para garantir que nenhum erro de sintaxe surja
|
|
pelo uso de referência retroativa com aspas simples ou duplas (por exemplo,
|
|
<literal>'strlen(\'$1\')+strlen("$2")'</literal>). Certifique-se de estar ciente da
|
|
<link linkend="language.types.string">sintaxe string</link> do PHP
|
|
para ter uma visão exata de como será a string interpretada.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>subject</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
String ou um array com strings para pesquisar e substituir.
|
|
</para>
|
|
<para>
|
|
Se <parameter>subject</parameter> for um array, então a pesquisa e
|
|
a substituição serão executadas em cada entrada de <parameter>subject</parameter>,
|
|
e o valor de retorno será um array também.
|
|
</para>
|
|
<para>
|
|
Se o array <parameter>subject</parameter> for associativo, as chaves
|
|
são preservadas no valor de retorno.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>limit</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
O máximo possível de substituições para cada expressão em cada string de
|
|
<parameter>subject</parameter>. O padrão é
|
|
<literal>-1</literal> (sem limite).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>count</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Se especificada, essa variável será preenchida com o número de
|
|
substiuições realizadas.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
<function>preg_replace</function> retorna um array se o
|
|
parâmetro <parameter>subject</parameter> for um array, caso contrário
|
|
retorna uma string.
|
|
</para>
|
|
<para>
|
|
Se correspondências forem encontradas, o novo <parameter>subject</parameter>
|
|
será devolvido, caso contrário <parameter>subject</parameter> será
|
|
devolvido inalterado ou &null; se um erro tiver ocorrido.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
Usar o modificador "\e" é um erro;
|
|
um erro de nível <constant>E_WARNING</constant> é emitido neste caso.
|
|
</para>
|
|
&pcre.pattern.warning;
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Usando referências retroativas seguidas por literais numéricos</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$string = 'April 15, 2003';
|
|
$pattern = '/(\w+) (\d+), (\d+)/i';
|
|
$replacement = '${1}1,$3';
|
|
echo preg_replace($pattern, $replacement, $string);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
April1,2003
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title>Usando arrays indexados com <function>preg_replace</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$string = 'The quick brown fox jumped over the lazy dog.';
|
|
$patterns = array();
|
|
$patterns[0] = '/quick/';
|
|
$patterns[1] = '/brown/';
|
|
$patterns[2] = '/fox/';
|
|
$replacements = array();
|
|
$replacements[2] = 'bear';
|
|
$replacements[1] = 'black';
|
|
$replacements[0] = 'slow';
|
|
echo preg_replace($patterns, $replacements, $string);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
The bear black slow jumped over the lazy dog.
|
|
]]>
|
|
</screen>
|
|
<para>
|
|
Ao ordenar expressões e substituições com ksort, obtém-se o desejado.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$string = 'The quick brown fox jumps over the lazy dog.';
|
|
$patterns = array();
|
|
$patterns[0] = '/quick/';
|
|
$patterns[1] = '/brown/';
|
|
$patterns[2] = '/fox/';
|
|
$replacements = array();
|
|
$replacements[2] = 'bear';
|
|
$replacements[1] = 'black';
|
|
$replacements[0] = 'slow';
|
|
ksort($patterns);
|
|
ksort($replacements);
|
|
echo preg_replace($patterns, $replacements, $string);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
The slow black bear jumped over the lazy dog.
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title>Substituindo vários valores</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$patterns = array ('/(19|20)(\d{2})-(\d{1,2})-(\d{1,2})/',
|
|
'/^\s*{(\w+)}\s*=/');
|
|
$replace = array ('\3/\4/\1\2', '$\1 =');
|
|
echo preg_replace($patterns, $replace, '{startDate} = 1999-5-27');
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
$startDate = 5/27/1999
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title>Removendo espaços</title>
|
|
<para>
|
|
Este exemplo retira o excesso de espaçoes em branco de uma string.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$str = 'foo o';
|
|
$str = preg_replace('/\s\s+/', ' ', $str);
|
|
// O resultado será 'foo o'
|
|
echo $str;
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title>Usando o parâmetro <parameter>count</parameter></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$count = 0;
|
|
|
|
echo preg_replace(array('/\d/', '/\s/'), '*', 'xp 4 to', -1 , $count);
|
|
echo $count; //3
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
xp***to
|
|
3
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
Ao usar arrays com <parameter>pattern</parameter> e
|
|
<parameter>replacement</parameter>, as chaves são processadas na ordem em que
|
|
aparecem no array. Isto <emphasis>não é necessariamente</emphasis> o
|
|
mesmo que a ordem dos índices numéricos. Se os índices forem utilizados para
|
|
indentificar qual <parameter>pattern</parameter> deve ser substituído por qual
|
|
<parameter>replacement</parameter>, é necessário executar a função
|
|
<function>ksort</function> em cada array antes de chamar a função
|
|
<function>preg_replace</function>.
|
|
</para>
|
|
</note>
|
|
<note>
|
|
<para>
|
|
Quando ambos <parameter>pattern</parameter> e <parameter>replacement</parameter> forem
|
|
arrays, as regras de correspondência irão operar sequencialmente. Isto é, o segundo par <parameter>pattern</parameter>/<parameter>replacement</parameter>
|
|
irá operar na string que resulta do primeiro par <parameter>pattern</parameter>/<parameter>replacement</parameter>,
|
|
e não na string original. Se for desejado simular substituições operando em paralelo,
|
|
como inversão de dois valores, substitua uma expressão por uma referência intermediária, e então em um par
|
|
posterior substitua a referência intermediária pelo substituto desejado.
|
|
</para>
|
|
<informalexample>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$p = array('/a/', '/b/', '/c/');
|
|
$r = array('b', 'c', 'd');
|
|
print_r(preg_replace($p, $r, 'a'));
|
|
// prints d
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</informalexample>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><link linkend="pcre.pattern">Expressões PCRE</link></member>
|
|
<member><function>preg_quote</function></member>
|
|
<member><function>preg_filter</function></member>
|
|
<member><function>preg_match</function></member>
|
|
<member><function>preg_replace_callback</function></member>
|
|
<member><function>preg_split</function></member>
|
|
<member><function>preg_last_error</function></member>
|
|
<member><function>str_replace</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
|
|
-->
|