mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-21 11:28:55 +00:00
af4410a7e1
still using this, after discussion on the phpdoc list. From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
112 lines
2.8 KiB
XML
112 lines
2.8 KiB
XML
<?xml version='1.0' encoding='iso-8859-1'?>
|
|
<!-- $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 works as described as of PHP 5.0.1. Before this it would
|
|
only return an empty string. For more information on this bug and its
|
|
prior behavior, see bug report
|
|
<link xlink:href="&url.php.bugs;29606">#29606</link>.
|
|
</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
|
|
-->
|