php-doc-en/reference/misc/functions/php-strip-whitespace.xml

85 lines
2 KiB
XML
Raw Normal View History

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.php-strip-whitespace">
<refnamediv>
<refname>php_strip_whitespace</refname>
<refpurpose>
Return source with stripped comments and whitespace
</refpurpose>
</refnamediv>
<refsect1>
&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.
</para>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>
The stripped source code will be returned on success, or an empty string
on failure.
</para>
</refsect1>
<refsect1>
&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($_SERVER['PHP_SELF']);
// Newlines are considered whitespace, and are removed too:
do_nothing();
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
<?php
echo php_strip_whitespace($_SERVER['PHP_SELF']); 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:"../../../../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
-->