php-strip-whitespace.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 2f0b3704890ca8e7d533677700699b422fbfa5b9 Maintainer: jpberdejo Status: ready -->
<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>Devuelve el código fuente sin los comentarios y espacios
  blancos</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>
   Devuelve el código fuente PHP en <parameter>nombre_archivo</parameter>,
   habiendo removido los comentarios PHP y los espacios blancos. Esto puede
   ser útil para determinar la cantidad de código real en sus scripts, en
   comparación con la cantidad de comentarios. Esto es similar al uso de
   <command>php -w</command> desde la <link
   linkend="features.commandline">línea de comandos</link>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
   <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Ruta al archivo PHP.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
   </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   El código fuente limpiado será devuelto en caso de éxito, o una cadena
   vacía si ocurre un error.
  </para>
  <note>
   <para>
    Esta función respeta el valor de la directiva ini para
    <link linkend="ini.short-open-tag">short_open_tag</link>
   </para>
  </note>
  <note>
   <para>
    Esta función trabaja como se describe, a partir de PHP 5.0.1. Antes de
    esta versión, solo devolvía una cadena vacía. Para más información sobre
    este fallo y su comportamiento anterior, vea el reporte de fallos <link
    xlink:href="&url.php.bugs;29606">#29606</link>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>php_strip_whitespace</function></title>
    <programlisting role="php">
<![CDATA[
<?php
// Comentario PHP aquí

/*
 * Otro comentario PHP
 */

echo        php_strip_whitespace(__FILE__);
// Los saltos de línea son considerados espacios blancos, y son eliminados también:
hacer_nada();
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
<?php
 echo php_strip_whitespace(__FILE__); hacer_nada(); ?>
]]>
    </screen>
    <para>
     Note que los comentarios PHP han sido eliminados, al igual que los
     espacios blancos y la nueva línea después de la primera sentencia echo.
    </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
-->