doc-fr/reference/strings/functions/str-ireplace.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e095023e408c8cb6378ae16bb6870343a3946919 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.str-ireplace" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>str_ireplace</refname>
  <refpurpose>Version insensible à la casse de <function>str_replace</function></refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>array</type></type><methodname>str_ireplace</methodname>
   <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>search</parameter></methodparam>
   <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>replace</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>array</type></type><parameter>subject</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter role="reference">count</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>str_ireplace</function> retourne une chaîne de caractères
   ou un tableau dont toutes les occurrences de <parameter>search</parameter>
   dans <parameter>subject</parameter> (en ignorant la casse), ont été
   remplacées par la valeur de <parameter>replace</parameter>. Si vous n'avez
   pas besoin de règles de recherche complexes, il est recommandé
   d'utiliser cette fonction à la place de
   <function>preg_replace</function> avec l'option <literal>i</literal>.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   Si les paramètres <parameter>search</parameter> et <parameter>replace</parameter>
   sont des tableaux, alors la fonction <function>str_ireplace</function>
   prendra une valeur de chaque tableau et les utilisera pour la recherche et
   le remplacement sur <parameter>subject</parameter>. Si le paramètre
   <parameter>replace</parameter> a moins de valeurs que le paramètre
   <parameter>search</parameter>, alors une &string; vide sera utilisée
   comme valeur pour le reste des valeurs de remplacement. Si le paramètre
   <parameter>search</parameter> est un tableau et que le paramètre
   <parameter>replace</parameter> est une &string;, alors cette &string;
   de remplacement sera utilisée pour chaque valeur de <parameter>search</parameter>.
   L'inverse n'a pas de sens.
  </para>
  <para>
   Si le paramètre <parameter>search</parameter> ou le paramètre
   <parameter>replace</parameter> sont des tableaux, leurs éléments sont traités
   du premier au dernier.
  </para>
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>search</parameter></term>
     <listitem>
      <para>
       La valeur à chercher, connue aussi sous le nom de
       <emphasis>needle</emphasis>. Un tableau peut être utilisé
       pour désigner plusieurs needles.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>replace</parameter></term>
     <listitem>
      <para>
       La valeur de remplacement utilisée pour chaque valeur trouvée
       dans <parameter>search</parameter>. Un tableau peut être utilisé
       pour désigner plusieurs remplacements.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>subject</parameter></term>
     <listitem>
      <para>
       Une &string; ou un &array; dans lequel la recherche s'effectue,
       aussi connu sous le nom de <emphasis>haystack</emphasis>.
      </para>
      <para>
       Si <parameter>subject</parameter> est un tableau, le remplacement est
       effectué sur chacun des éléments du sujet
       <parameter>subject</parameter>, et la valeur retournée est aussi un
       tableau.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>count</parameter></term>
     <listitem>
      <para>
       Si fournie, cette variable contiendra le nombre de remplacements effectués.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne une chaîne ou un tableau de remplacement.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>str_ireplace</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$bodytag = str_ireplace("%body%", "black", "<body text=%BODY%>");
echo $bodytag; // <body text=black>
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="notes">
  &reftitle.notes;
  &note.bin-safe;
  <caution>
   <title>Ordre de remplacement</title>
   <para>
    Vu le fait que la fonction <function>str_ireplace</function> effectue
    les remplacements de la gauche vers la droite, elle peut remplacer
    une valeur précédemment insérée lors de remplacement multpiple.
    L'exemple #2 de la documentation de la fonction
    <function>str_replace</function> sur la façon de traiter cette problématique.
   </para>
  </caution>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>str_replace</function></member>
    <member><function>preg_replace</function></member>
    <member><function>strtr</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
-->