php-strip-whitespace.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f9c4a68ef4f89e51e6d9b905ad3ddb6492386dd3 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="function.php-strip-whitespace" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>php_strip_whitespace</refname>
  <refpurpose>Retourne la source sans commentaires, ni espaces blancs</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>php_strip_whitespace</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
  </methodsynopsis>
  <para>
   Retourne le code source PHP du paramètre <parameter>filename</parameter>
   en ayant supprimé les commentaires ainsi que les espaces. Cela peut être
   utile pour comparer la quantité de code avec la quantité de commentaire dans
   votre code. Cela revient à utiliser la commande <command>php -w</command>
   depuis la <link linkend="features.commandline">ligne de commande</link>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Chemin vers le fichier PHP.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Le code source nettoyé sera retourné en cas de succès ou une chaîne
   vide en cas d'échec.
  </para>
  <note>
   <para>
    Cette fonction respecte la valeur de la directive INI 
    <link linkend="ini.short-open-tag">short_open_tag</link>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>php_strip_whitespace</function></title>
    <programlisting role="php">
<![CDATA[
<?php
// Commentaire PHP ici

/*
 * Un autre commentaire PHP
 */

echo        php_strip_whitespace(__FILE__);
// Les nouvelles lignes sont considérées comme des espaces et sont donc également effacées :
do_nothing();
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
<?php
 echo php_strip_whitespace(__FILE__); do_nothing(); ?>
]]>
    </screen>
    <para>
     Notez que les commentaires PHP ne sont plus là, tout comme les espaces et les 
     nouvelles lignes après le premier <literal>echo</literal>.
    </para>
   </example>
  </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
-->