File: phpinfo.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (186 lines) | stat: -rw-r--r-- 5,665 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.13 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.2 -->
  <refentry id="function.phpinfo">
   <refnamediv>
    <refname>phpinfo</refname>
    <refpurpose>Outputs lots of PHP information</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
     <type>int</type><methodname>phpinfo</methodname>
     <methodparam choice="opt"><type>int</type><parameter>what</parameter></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 <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.
    </para>
    <para>
     <table>
      <title><function>phpinfo</function> options</title>
      <tgroup cols="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 <link linkend="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 <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 value.
         </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
      <link linkend="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>
    <para>
    See also <function>phpversion</function>,
    <function>phpcredits</function>,
    <function>php_logo_guid</function>, 
    <function>ini_get</function>,
    <function>ini_set</function>, 
    <function>get_loaded_extensions</function>,
    and the section on <link
    linkend="language.variables.predefined">Predefined
    Variables</link>.
    </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
-->