php-strip-whitespace.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<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>Return source with stripped comments and whitespace</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>
   Returns the PHP source code in <parameter>filename</parameter> with
   PHP comments and whitespace removed. This may be useful for determining the
   amount of actual code in your scripts compared with the amount of comments.
   This is similar to using <command>php -w</command> from the
   <link linkend="features.commandline">commandline</link>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Path to the PHP file.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The stripped source code will be returned on success, or an empty string
   on failure.
  </para>
  <note>
   <para>
    This function respects the value of the
    <link linkend="ini.short-open-tag">short_open_tag</link>
    ini directive.
   </para>
  </note>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>php_strip_whitespace</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
// PHP comment here

/*
 * Another PHP comment
 */

echo        php_strip_whitespace(__FILE__);
// Newlines are considered whitespace, and are removed too:
do_nothing();
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
<?php
 echo php_strip_whitespace(__FILE__); do_nothing(); ?>
]]>
    </screen>
    <para>
     Notice the PHP comments are gone, as are the whitespace and newline
     after the first echo statement.
    </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
-->