highlight-file.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 443d81b33e6537a000cc235c2a11748ba8d56232 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.highlight-file" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>highlight_file</refname>
  <refpurpose>Colorisation syntaxique d'un fichier</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>bool</type></type><methodname>highlight_file</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>return</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Affiche la syntaxe colorisée du fichier <parameter>filename</parameter>,
   en utilisant les couleurs définies dans le moteur interne de PHP.
  </para>
  <para>
   De nombreux serveurs sont configurés pour automatiquement
   afficher le source colorisé, avec l'extension
   <emphasis>phps</emphasis>. Par exemple,
   <filename>example.phps</filename> va afficher le source du script.
   Pour activer cette fonctionnalité, utilisez cette ligne dans
   &httpd.conf; :
  </para>
  <screen>
<![CDATA[
AddType application/x-httpd-php-source .phps
]]>
  </screen>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Le chemin vers le fichier PHP à coloriser.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>return</parameter></term>
     <listitem>
      <para>
       En passant ce paramètre à &true;, la fonction
       retourne le code colorisé au lieu de l'afficher.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Si le second paramètre optionnel <parameter>return</parameter> vaut &true;
   alors <function>highlight_file</function> retournera le code généré,
   au lieu de l'afficher. Si le second paramètre ne vaut pas &true; alors
   <function>highlight_file</function> retournera &true; en cas de succès, et
   &false; sinon.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.3.0</entry>
       <entry>
        Le HTML résultant a changé.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <caution>
   <para>
    Beaucoup de soin doit être apporté lors de l'utilisation de
    <function>highlight_file</function> pour s'assurer que vous ne
    révélez pas d'informations critiques telles que des mots de passe
    ou d'autres informations qui pourraient créer des fuites d'informations.
   </para>
  </caution>
  &note.uses-ob;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>highlight_string</function></member>
    <member><link linkend="ini.syntax-highlighting">Les directives INI de coloration</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
-->