doc-fr/reference/strings/functions/htmlspecialchars.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!-- EN-Revision: 1.7 Maintainer: didou Status: ready -->
  <refentry id="function.htmlspecialchars">
   <refnamediv>
    <refname>htmlspecialchars</refname> 
    <refpurpose>
     Convertit les caractères spéciaux en entités HTML
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>htmlspecialchars</methodname>
      <methodparam><type>string</type><parameter>string</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>quote_style</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
     </methodsynopsis>
    <para>
     Certains caractères ont des significations spéciales en HTML,
     et doivent être remplacés par des entités HTML pour être affichés.
     <function>htmlspecialchars</function> remplace tous ces caractères
     par leur équivalent dans la chaîne <parameter>string</parameter>.
     Cette conversion est très pratique pour la programmation
     web. Si vous devez remplacer tous les caractères, utilisez 
     plutôt <function>htmlentities</function> à la place.
    </para>
    <simpara>
     <function>htmlspecialchars</function> est pratique pour éviter que
     des données fournies par les utilisateurs contiennent des balises HTML,
     comme pour un forum ou un chat. Cette
     fonction prend un deuxième argument optionnel, qui indique
     comment doivent être traités les guillemets doubles et simples.
     Vous pouvez utiliser l'une des constantes suivantes : 
     <constant>ENT_COMPAT</constant>, la constante par défaut,
     va convertir les guillemets doubles, et ignorer les guillemets
     simples; <constant>ENT_QUOTES</constant> va convertir les guillemets doubles
     et les guillemets simples; <constant>ENT_NOQUOTES</constant> 
     va ignorer les guillemets doubles et les guillemets simples.
    </simpara>
    <para>
     Les remplacements effectués sont : 
     <itemizedlist>
      <listitem>
       <simpara>
        "<literal>&amp;</literal>" (et commercial) devient "<literal>&amp;amp;</literal>"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "<literal>&quot;</literal>" (guillemets doubles) devient "<literal>&amp;quot;</literal>" lorsque <constant>ENT_NOQUOTES</constant>
        n'est pas utilisé.
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "<literal>&#039;</literal>" (single quote) devient "<literal>&amp;#039;</literal>" uniquement lorsque
        <constant>ENT_QUOTES</constant> est utilisé.
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "<literal>&lt;</literal>" (supérieur à) devient "<literal>&amp;lt;</literal>"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "<literal>&gt;</literal>" (inférieur à) devient "<literal>&amp;gt;</literal>"
       </simpara>
      </listitem>
     </itemizedlist>
     <example>
      <title>Exemple avec <function>htmlspecialchars</function></title>
      <programlisting role="php">
<![CDATA[
<?php
$new = htmlspecialchars("<a href='test'>Test</a>", ENT_QUOTES);
echo $new; 
// &lt;a href=&#039;test&#039;&gt;Test&lt;/a&gt;
?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     Notez que cette fonction ne fait aucun autre remplacement que ceux
     qui sont listés ci-dessus. Pour faire un remplacement total, 
     voyez plutôt <function>htmlentities</function>. Le support pour le
     second argument optionnel a été ajouté en &php;
     3.0.17 et &php; 4.0.3.
    </para>
    <para>
     cette fonction prend un troisième argument optionnel 
     qui définit le jeux de caractères utilisé durant la conversion.
     Le jeu de caractères par défaut est ISO-8859-1. Le support de cet 
     argument a été ajouté en &php; 4.1.0.
    </para>
    &reference.strings.charsets;
    <para>
     Voir aussi
     <function>get_html_translation_table</function>,
     <function>strip_tags</function>,
     <function>htmlentities</function> et 
     <function>nl2br</function>.
    </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:"../../../../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
-->