Files
doc-fr/reference/pcre/functions/preg-replace-callback.xml
2021-11-17 13:09:15 +00:00

287 lines
8.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 41c8533ff5a8f93ba9fdf0732d05dd5ab79864c9 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.preg-replace-callback" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>preg_replace_callback</refname>
<refpurpose>Rechercher et remplacer par expression rationnelle standard en utilisant une fonction de callback</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>array</type><type>null</type></type><methodname>preg_replace_callback</methodname>
<methodparam><type class="union"><type>string</type><type>array</type></type><parameter>pattern</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</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>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Le comportement de <function>preg_replace_callback</function> est presque
identique à celui de <function>preg_replace</function>, hormis le fait
qu'à la place du paramètre <parameter>replacement</parameter>, il faut
spécifier une fonction de rappel <parameter>callback</parameter>
qui sera appelée, avec les éléments trouvés en arguments.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>pattern</parameter></term>
<listitem>
<para>
Le masque à chercher. Il peut être une &string; ou un tableau contenant
des chaînes.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callback</parameter></term>
<listitem>
<para>
La fonction de rappel qui recevra le tableau d'éléments
trouvés dans la chaîne <parameter>subject</parameter>.
La fonction de rappel doit retourner la chaîne de
remplacement. Voici la signature de la fonction de rappel :
</para>
<para>
<methodsynopsis>
<type>string</type><methodname><replaceable>handler</replaceable></methodname>
<methodparam><type>array</type><parameter>matches</parameter></methodparam>
</methodsynopsis>
</para>
<para>
Vous aurez souvent besoin de la fonction <parameter>callback</parameter>
avec <function>preg_replace_callback</function> à un seul endroit.
Dans ce cas, vous pouvez simplement utiliser une
<link linkend="functions.anonymous">fonction anonyme</link>
pour déclarer une fonction de rappel pour la fonction
<function>preg_replace_callback</function>.
En faisant cela, vous concentrez toutes les routines liées à
votre remplacement à un seul endroit, et vous ne polluez pas
votre espace de noms de fonctions avec des fonctions à usage unique.
</para>
<para>
<example>
<title><function>preg_replace_callback</function> et
fonction anonyme</title>
<programlisting role="php">
<![CDATA[
<?php
// Un filtre de ligne de commande Unix pour convertir la première lettre
// des paragraphes (commençant par "<p>") en minuscule
$fp = fopen("php://stdin", "r") or die("Impossible de lire la ligne de commande");
while (!feof($fp)) {
$line = fgets($fp);
$line = preg_replace_callback(
'|<p>\s*\w|',
function ($matches) {
return strtolower($matches[0]);
},
$line
);
echo $line;
}
fclose($fp);
?>
]]>
</programlisting>
</example>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>subject</parameter></term>
<listitem>
<para>
La chaîne ou le tableau de chaînes à chercher et à remplacer.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>limit</parameter></term>
<listitem>
<para>
Le nombre maximal de remplacement pour chaque masque
dans chaque chaîne <parameter>subject</parameter>.
Vaut par défaut <literal>-1</literal> (aucune limite).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>count</parameter></term>
<listitem>
<para>
Si fournie, cette variable sera remplie avec le nombre de remplacements effectués.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
<parameter>flags</parameter> peut être une combinaison des drapeaux
<constant>PREG_OFFSET_CAPTURE</constant> et
<constant>PREG_UNMATCHED_AS_NULL</constant>, qui influence le format
du tableau de correspondances.
Voir la description de <function>preg_match</function> pour plus de détail.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>preg_replace_callback</function> retourne un tableau si le paramètre
<parameter>subject</parameter> est un &array;, ou, sinon, une &string;.
Si une erreur survient, la valeur retournée sera &null;.
</para>
<para>
Si des correspondances sont trouvées, le nouveau sujet sera retourné, sinon
<parameter>subject</parameter> sera retourné inchangé.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
&pcre.pattern.warning;
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>7.4.0</entry>
<entry>
Le paramètre <parameter>flags</parameter> a été ajouté.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>preg_replace_callback</function></title>
<programlisting role="php">
<![CDATA[
<?php
// Ce texte était vrai en 2002
// nous voulons le mettre a jour pour 2003
$text = "Le premier avril est le 04/01/2002\n";
$text.= "Le dernier noël était le 12/24/2001\n";
// Fonction de callback
function next_year($matches)
{
// comme d'habitude : $matches[0] représente la valeur totale
// $matches[1] représente la première parenthèse capturante
return $matches[1].($matches[2]+1);
}
echo preg_replace_callback(
"|(\d{2}/\d{2}/)(\d{4})|",
"next_year",
$text);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Le premier avril est le 04/01/2003
Le dernier noël était le 12/24/2002
]]>
</screen>
</example>
</para>
<para>
<example>
<title>Exemple avec <function>preg_replace_callback</function> en utilisant une structure récursive
pour gérer du BB code</title>
<programlisting role="php">
<![CDATA[
<?php
$input = "plain [indent] deep [indent] deeper [/indent] deep [/indent] plain";
function parseTagsRecursive($input)
{
$regex = '#\[indent]((?:[^[]|\[(?!/?indent])|(?R))+)\[/indent]#';
if (is_array($input)) {
$input = '<div style="margin-left: 10px">'.$input[1].'</div>';
}
return preg_replace_callback($regex, 'parseTagsRecursive', $input);
}
$output = parseTagsRecursive($input);
echo $output;
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link linkend="pcre.pattern">Masques PCRE</link></member>
<member><function>preg_replace_callback_array</function></member>
<member><function>preg_quote</function></member>
<member><function>preg_replace</function></member>
<member><function>preg_last_error</function></member>
<member><link linkend="functions.anonymous">Les fonctions anonymes</link></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
-->