phpinfo.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentryxml:id="function.phpinfo"xmlns="http://docbook.org/ns/docbook"xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
 <refname>phpinfo</refname>
 <refpurpose>Outputs information about PHP's configuration</refpurpose>
 </refnamediv>

 <refsect1role="description">
&reftitle.description;
 <methodsynopsis>
 <type>true</type><methodname>phpinfo</methodname>
 <methodparamchoice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>INFO_ALL</constant></initializer></methodparam>
 </methodsynopsis>
 <para>
 Outputs a large amount of information about the current state of PHP. 
 This includes information about PHP compilation options and extensions,
 the PHP version, server information and environment (if compiled as a
 module), the PHP environment, OS version information, paths, master and
 local values of configuration options, HTTP headers, and the PHP License.
 </para>
 <para>
 Because every system is setup differently, <function>phpinfo</function> is
 commonly used to check <linklinkend="configuration">configuration settings</link> and for available
 <linklinkend="language.variables.predefined">predefined variables</link>
 on a given system.
 </para>
 <para>
 <function>phpinfo</function> is also a valuable debugging tool as it
 contains all EGPCS (Environment, GET, POST, Cookie, Server) data.
 </para>
 </refsect1>

 <refsect1role="parameters">
&reftitle.parameters;
 <para>
 <variablelist>
 <varlistentry>
 <term><parameter>flags</parameter></term>
 <listitem>
 <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>flags</parameter> parameter.
 One can also combine the respective constants or bitwise values
 together with the <linklinkend="language.operators.bitwise">bitwise or operator</link>.
 </para>
 <para>
 <table>
 <title><function>phpinfo</function> options</title>
 <tgroupcols="3">
 <thead>
 <row>
 <entry>Name (constant)</entry>
 <entry>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 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 their respective settings. See also
 <function>get_loaded_extensions</function>.
 </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 <linklinkend="language.variables.predefined">
 predefined variables</link> from EGPCS (Environment, GET,
 POST, Cookie, Server).
 </entry>
 </row>
 <row>
 <entry>INFO_LICENSE</entry>
 <entry>64</entry>
 <entry>
 PHP License information. See also the <linkxlink:href="&url.php.license;">license FAQ</link>.
 </entry>
 </row>
 <row>
 <entry>INFO_ALL</entry>
 <entry>-1</entry>
 <entry>
 Shows all of the above.
 </entry>
 </row>
 </tbody>
 </tgroup>
 </table>
 </para>
 </listitem>
 </varlistentry>
 </variablelist>
 </para>
 </refsect1>

 <refsect1role="returnvalues">
&reftitle.returnvalues;
 <para>
&return.true.always;
 </para>
 </refsect1>

 <refsect1role="examples">
&reftitle.examples;
 <para>
 <example>
 <title><function>phpinfo</function> Example</title>
 <programlistingrole="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>
 </refsect1>

 <refsect1role="notes">
&reftitle.notes;
 <note>
 <para>
 In versions of PHP before 5.5, parts of the information displayed are
 disabled when the <linklinkend="ini.expose-php">expose_php</link>
 configuration setting is set to <literal>off</literal>. This includes the
 PHP and Zend logos, and the credits.
 </para>
 </note>
 <note>
 <para>
 <function>phpinfo</function> outputs plain text instead of HTML when
 using the CLI mode.
 </para>
 </note>
 </refsect1>

 <refsect1role="seealso">
&reftitle.seealso;
 <para>
 <simplelist>
 <member><function>phpversion</function></member>
 <member><function>phpcredits</function></member>
 <member><function>ini_get</function></member>
 <member><function>ini_set</function></member>
 <member><function>get_loaded_extensions</function></member>
 <member><linklinkend="language.variables.predefined">Predefined Variables</link></member>
 </simplelist>
 </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
-->