phpinfo: Expanded documentation for 'what' parameter, added an example and

some other information.
phpversion: minor update


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@68414 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2002-01-22 20:12:41 +00:00
parent b9d01d362f
commit eba0daf2cc

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.86 $ -->
<!-- $Revision: 1.87 $ -->
<reference id="ref.info">
<title>PHP options &amp; information</title>
<titleabbrev>PHP options/info</titleabbrev>
@ -1503,21 +1503,105 @@ phpcredits(CREDITS_GROUP + CREDITS_DOCS + CREDITS_FULLPAGE);
options, HTTP headers, and the PHP License.
</para>
<para>
The output may be customized by passing one or more of the
following values summed together in the optional parameter
<parameter>what</parameter> (one can also combine them together
with the <link linkend="language.operators.bitwise">or</link> operator.
<itemizedlist>
<listitem><simpara>INFO_GENERAL</simpara></listitem>
<listitem><simpara>INFO_CREDITS</simpara></listitem>
<listitem><simpara>INFO_CONFIGURATION</simpara></listitem>
<listitem><simpara>INFO_MODULES</simpara></listitem>
<listitem><simpara>INFO_ENVIRONMENT</simpara></listitem>
<listitem><simpara>INFO_VARIABLES</simpara></listitem>
<listitem><simpara>INFO_LICENSE</simpara></listitem>
<listitem><simpara>INFO_ALL</simpara></listitem>
</itemizedlist>
Because every system is setup differently, <function>phpinfo</function>
is commonly used to check <link linkend="configuration">configuration
settings</link> and for available
<link linkend="language.variables.predefined">predefined variables</link>
on a given system. Also, <function>phpinfo</function> is a valuable
debugging tool as it contains all EGPCS (Environment, GET, POST,
Cookie, Server) data.
</para>
<para>
The output may be customized by passing one or more of the following
<emphasis>constants</emphasis> bitwise values summed together in the
optional <parameter>what</parameter> parameter. One can also combine
the respective constants or bitwise values together with the
<link linkend="language.operators.bitwise">or</link> operator.
<table>
<title><function>phpinfo</function> options</title>
<tgroup cols="3">
<thead>
<row>
<entry>Name (constant)</entry>
<entry>Bitwise value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>INFO_GENERAL</entry>
<entry>1</entry>
<entry>The configuration line, php.ini location, build date,
Web Server, System and more.
</entry>
</row>
<row>
<entry>INFO_CREDITS</entry>
<entry>2</entry>
<entry>PHP 4 Credits. See also <function>phpcredits</function>.</entry>
</row>
<row>
<entry>INFO_CONFIGURATION</entry>
<entry>4</entry>
<entry>Current Local and Master values for php directives.
See also <function>ini_get</function>.</entry>
</row>
<row>
<entry>INFO_MODULES</entry>
<entry>8</entry>
<entry>Loaded modules and there respective settings.</entry>
</row>
<row>
<entry>INFO_ENVIRONMENT</entry>
<entry>16</entry>
<entry>Environment Variable information that's also
available in <varname>$_ENV</varname>.</entry>
</row>
<row>
<entry>INFO_VARIABLES</entry>
<entry>32</entry>
<entry>Shows all predefined variables, from EGPCS
(Environment, GET, POST, Cookie, Server).
</entry>
</row>
<row>
<entry>INFO_LICENSE</entry>
<entry>64</entry>
<entry>PHP License information. See also the
<ulink url="&url.php.license;">license faq</ulink>.
</entry>
</row>
<row>
<entry>INFO_ALL</entry>
<entry>-1</entry>
<entry>Shows all of the above. This is the default.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
<example>
<title><function>phpinfo</function> examples</title>
<programlisting role="php">
<![CDATA[
<?php
// Show all information, defaults to INFO_ALL
phpinfo();
// Show just the module information.
// phpinfo(8) yields identical results.
phpinfo(INFO_MODULES);
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
Parts of the information displayed are disabled when the
@ -1528,8 +1612,9 @@ phpcredits(CREDITS_GROUP + CREDITS_DOCS + CREDITS_FULLPAGE);
</note>
<para>
See also <function>phpversion</function>,
<function>phpcredits</function>,
<function>php_logo_guid</function>
<function>phpcredits</function>, <function>php_logo_guid</function>,
<function>ini_get</function>, <function>ini_set</function>, and the section
on <link linkend="language.variables.predefined">Predefined Variables</link>.
</para>
</refsect1>
</refentry>
@ -1558,11 +1643,13 @@ phpcredits(CREDITS_GROUP + CREDITS_DOCS + CREDITS_FULLPAGE);
</note>
<para>
<example>
<title>phpversion() example</title>
<title><function>phpversion</function> example</title>
<programlisting role="php">
<![CDATA[
// prints e.g. 'Current PHP version: 3.0rel-dev'
echo "Current PHP version: ".phpversion();
<?php
// prints e.g. 'Current PHP version: 4.1.1'
echo 'Current PHP version: ' . phpversion();
?>
]]>
</programlisting>
</example>