[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] cvs: phpdoc /en/appendices ini.xml
From: "Richard Quadling" <rquadling () php ! net>
Date: 2008-06-12 9:15:05
Message-ID: cvsrquadling1213262105 () cvsserver
[Download RAW message or body]
rquadling Thu Jun 12 09:15:05 2008 UTC
Modified files:
/phpdoc/en/appendices ini.xml
Log:
WS
["rquadling-20080612091505.txt" (text/plain)]
http://cvs.php.net/viewvc.cgi/phpdoc/en/appendices/ini.xml?r1=1.68&r2=1.69&diff_format=u
Index: phpdoc/en/appendices/ini.xml
diff -u phpdoc/en/appendices/ini.xml:1.68 phpdoc/en/appendices/ini.xml:1.69
--- phpdoc/en/appendices/ini.xml:1.68 Wed Apr 23 15:22:20 2008
+++ phpdoc/en/appendices/ini.xml Thu Jun 12 09:15:05 2008
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.68 $ -->
+<!-- $Revision: 1.69 $ -->
<appendix xml:id="ini" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>&php.ini; directives</title>
@@ -3553,232 +3553,232 @@
<section xml:id="ini.sect.httpd-options">
<title>Httpd Options</title>
- <para>
- <table>
- <title>Httpd Options</title>
- <tgroup cols="4">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Default</entry>
- <entry>Changeable</entry>
- <entry>Changelog</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>async_send</entry>
- <entry>"0"</entry>
- <entry>PHP_INI_ALL</entry>
- <entry></entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </para>
- <para>
- </para>
- </section>
+ <para>
+ <table>
+ <title>Httpd Options</title>
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Default</entry>
+ <entry>Changeable</entry>
+ <entry>Changelog</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>async_send</entry>
+ <entry>"0"</entry>
+ <entry>PHP_INI_ALL</entry>
+ <entry></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+ <para>
+ </para>
+ </section>
<section xml:id="ini.sect.language-options">
<title>Language Options</title>
<para>
- <table>
- <title>Language and Misc Configuration Options</title>
- <tgroup cols="4">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Default</entry>
- <entry>Changeable</entry>
- <entry>Changelog</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>short_open_tag</entry>
- <entry>"1"</entry>
- <entry>PHP_INI_ALL</entry>
- <entry>PHP_INI_ALL in PHP <= 4.0.0. PHP_INI_PERDIR in PHP < 5.3.0</entry>
- </row>
- <row>
- <entry>asp_tags</entry>
- <entry>"0"</entry>
- <entry>PHP_INI_PERDIR</entry>
- <entry>PHP_INI_ALL in PHP <= 4.0.0.</entry>
- </row>
- <row>
- <entry>precision</entry>
- <entry>"14"</entry>
- <entry>PHP_INI_ALL</entry>
- <entry></entry>
- </row>
- <row>
- <entry>y2k_compliance</entry>
- <entry>"1"</entry>
- <entry>PHP_INI_ALL</entry>
- <entry></entry>
- </row>
- <row>
- <entry>allow_call_time_pass_reference</entry>
- <entry>"1"</entry>
- <entry>PHP_INI_PERDIR</entry>
- <entry>PHP_INI_ALL in PHP <= 4.0.0.</entry>
- </row>
- <row>
- <entry>expose_php</entry>
- <entry>"1"</entry>
- <entry>&php.ini; only</entry>
- <entry></entry>
- </row>
- <row>
- <entry>zend.ze1_compatibility_mode</entry>
- <entry>"0"</entry>
- <entry>PHP_INI_ALL</entry>
- <entry>Available since PHP 5.0.0. Removed in PHP 5.3.0</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
+ <table>
+ <title>Language and Misc Configuration Options</title>
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Default</entry>
+ <entry>Changeable</entry>
+ <entry>Changelog</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>short_open_tag</entry>
+ <entry>"1"</entry>
+ <entry>PHP_INI_ALL</entry>
+ <entry>PHP_INI_ALL in PHP <= 4.0.0. PHP_INI_PERDIR in PHP < 5.3.0</entry>
+ </row>
+ <row>
+ <entry>asp_tags</entry>
+ <entry>"0"</entry>
+ <entry>PHP_INI_PERDIR</entry>
+ <entry>PHP_INI_ALL in PHP <= 4.0.0.</entry>
+ </row>
+ <row>
+ <entry>precision</entry>
+ <entry>"14"</entry>
+ <entry>PHP_INI_ALL</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>y2k_compliance</entry>
+ <entry>"1"</entry>
+ <entry>PHP_INI_ALL</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>allow_call_time_pass_reference</entry>
+ <entry>"1"</entry>
+ <entry>PHP_INI_PERDIR</entry>
+ <entry>PHP_INI_ALL in PHP <= 4.0.0.</entry>
+ </row>
+ <row>
+ <entry>expose_php</entry>
+ <entry>"1"</entry>
+ <entry>&php.ini; only</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>zend.ze1_compatibility_mode</entry>
+ <entry>"0"</entry>
+ <entry>PHP_INI_ALL</entry>
+ <entry>Available since PHP 5.0.0. Removed in PHP 5.3.0</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
</para>
-
- &ini.descriptions.title;
-
- <para>
- <variablelist>
- <varlistentry xml:id="ini.short-open-tag">
- <term>
- <parameter>short_open_tag</parameter>
- <type>boolean</type>
- </term>
- <listitem>
- <para>
- Tells whether the short form (<userinput><? ?></userinput>)
- of PHP's open tag should be allowed. If you want to use PHP in
- combination with XML, you can disable this option in order to
- use <userinput><?xml ?></userinput> inline. Otherwise, you
- can print it with PHP, for example: <userinput><?php echo '<?xml
- version="1.0"'; ?></userinput>. Also if disabled, you must use the
- long form of the PHP open tag (<userinput><?php ?></userinput>).
- </para>
- <note>
- <para>
- This directive also affects the shorthand <userinput><?=</userinput>,
- which is identical to <userinput><? echo</userinput>. Use of this
- shortcut requires <systemitem role="directive">short_open_tag</systemitem>
- to be on.
- </para>
- </note>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="ini.asp-tags">
- <term>
- <parameter>asp_tags</parameter>
- <type>boolean</type>
- </term>
- <listitem>
- <simpara>
- Enables the use of ASP-like <% %> tags in addition to
- the usual <?php ?> tags. This includes the
- variable-value printing shorthand of <%= $value %>. For
- more information, see <link
- linkend="language.basic-syntax.phpmode">Escaping from HTML</link>.
- </simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry xml:id="ini.precision">
- <term>
- <parameter>precision</parameter>
- <type>integer</type>
- </term>
- <listitem>
- <simpara>
- The number of significant digits displayed in floating point numbers.
- </simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry xml:id="ini.y2k-compliance">
- <term>
- <parameter>y2k_compliance</parameter>
- <type>boolean</type>
- </term>
- <listitem>
- <simpara>
- Enforce year 2000 compliance (will cause problems with non-compliant browsers)
- </simpara>
- </listitem>
- </varlistentry>
-
-
- <varlistentry xml:id="ini.allow-call-time-pass-reference">
- <term>
- <parameter>allow_call_time_pass_reference</parameter>
- <type>boolean</type>
- </term>
- <listitem>
- <para>
- Whether to warn when arguments are passed by reference
- at function call time. This method is deprecated and is likely to be
- unsupported in future versions of PHP/Zend. The encouraged method of
- specifying which arguments should be passed by reference is in the function
- declaration. You're encouraged to try and turn this option Off and make
- sure your scripts work properly with it in order to ensure they will work
- with future versions of the language (you will receive a warning each time
- you use this feature).
- </para>
- <para>
- Passing arguments by reference at function call time was deprecated for
- code cleanliness reason. Function can modify its argument in
- undocumented way if it didn't declared that the argument is passed by
- reference. To prevent side-effects it's better to specify which
- arguments are passed by reference in function declaration only.
- </para>
- <para>
- See also <link linkend="language.references">References Explained</link>.
- </para>
- </listitem>
- </varlistentry>
+ &ini.descriptions.title;
- <varlistentry xml:id="ini.expose-php">
- <term>
- <parameter>expose_php</parameter>
- <type>boolean</type>
- </term>
- <listitem>
+ <para>
+ <variablelist>
+ <varlistentry xml:id="ini.short-open-tag">
+ <term>
+ <parameter>short_open_tag</parameter>
+ <type>boolean</type>
+ </term>
+ <listitem>
+ <para>
+ Tells whether the short form (<userinput><? ?></userinput>)
+ of PHP's open tag should be allowed. If you want to use PHP in
+ combination with XML, you can disable this option in order to
+ use <userinput><?xml ?></userinput> inline. Otherwise, you
+ can print it with PHP, for example: <userinput><?php echo '<?xml
+ version="1.0"'; ?></userinput>. Also if disabled, you must use the
+ long form of the PHP open tag (<userinput><?php ?></userinput>).
+ </para>
+ <note>
<para>
- Decides whether PHP may expose the fact that it is installed on the server
- (e.g. by adding its signature to the Web server header). It is no security
- threat in any way, but it makes it possible to determine whether you use PHP
- on your server or not.
+ This directive also affects the shorthand <userinput><?=</userinput>,
+ which is identical to <userinput><? echo</userinput>. Use of this
+ shortcut requires <systemitem role="directive">short_open_tag</systemitem>
+ to be on.
</para>
- </listitem>
- </varlistentry>
+ </note>
+ </listitem>
+ </varlistentry>
- <varlistentry xml:id="ini.zend.ze1-compatibility-mode">
- <term>
- <parameter>zend.ze1_compatibility_mode</parameter>
- <type>boolean</type>
- </term>
- <listitem>
- <para>
- Enable compatibility mode with Zend Engine 1 (PHP 4). It affects
- the cloning, casting (objects with no properties cast to &false; or 0), and <link
- linkend="language.oop5.object-comparison">comparing of objects</link>.
- In this mode, objects are passed by value instead of reference by
- default.
- </para>
- <para>
- See also the section titled
- <link linkend="migration5">Migrating from PHP 4 to PHP 5</link>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </section>
+ <varlistentry xml:id="ini.asp-tags">
+ <term>
+ <parameter>asp_tags</parameter>
+ <type>boolean</type>
+ </term>
+ <listitem>
+ <simpara>
+ Enables the use of ASP-like <% %> tags in addition to
+ the usual <?php ?> tags. This includes the
+ variable-value printing shorthand of <%= $value %>. For
+ more information, see <link
+ linkend="language.basic-syntax.phpmode">Escaping from HTML</link>.
+ </simpara>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry xml:id="ini.precision">
+ <term>
+ <parameter>precision</parameter>
+ <type>integer</type>
+ </term>
+ <listitem>
+ <simpara>
+ The number of significant digits displayed in floating point numbers.
+ </simpara>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry xml:id="ini.y2k-compliance">
+ <term>
+ <parameter>y2k_compliance</parameter>
+ <type>boolean</type>
+ </term>
+ <listitem>
+ <simpara>
+ Enforce year 2000 compliance (will cause problems with non-compliant browsers)
+ </simpara>
+ </listitem>
+ </varlistentry>
+
+
+ <varlistentry xml:id="ini.allow-call-time-pass-reference">
+ <term>
+ <parameter>allow_call_time_pass_reference</parameter>
+ <type>boolean</type>
+ </term>
+ <listitem>
+ <para>
+ Whether to warn when arguments are passed by reference
+ at function call time. This method is deprecated and is likely to be
+ unsupported in future versions of PHP/Zend. The encouraged method of
+ specifying which arguments should be passed by reference is in the function
+ declaration. You're encouraged to try and turn this option Off and make
+ sure your scripts work properly with it in order to ensure they will work
+ with future versions of the language (you will receive a warning each time
+ you use this feature).
+ </para>
+ <para>
+ Passing arguments by reference at function call time was deprecated for
+ code cleanliness reason. Function can modify its argument in
+ undocumented way if it didn't declared that the argument is passed by
+ reference. To prevent side-effects it's better to specify which
+ arguments are passed by reference in function declaration only.
+ </para>
+ <para>
+ See also <link linkend="language.references">References Explained</link>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry xml:id="ini.expose-php">
+ <term>
+ <parameter>expose_php</parameter>
+ <type>boolean</type>
+ </term>
+ <listitem>
+ <para>
+ Decides whether PHP may expose the fact that it is installed on the server
+ (e.g. by adding its signature to the Web server header). It is no security
+ threat in any way, but it makes it possible to determine whether you use PHP
+ on your server or not.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry xml:id="ini.zend.ze1-compatibility-mode">
+ <term>
+ <parameter>zend.ze1_compatibility_mode</parameter>
+ <type>boolean</type>
+ </term>
+ <listitem>
+ <para>
+ Enable compatibility mode with Zend Engine 1 (PHP 4). It affects
+ the cloning, casting (objects with no properties cast to &false; or 0), and <link
+ linkend="language.oop5.object-comparison">comparing of objects</link>.
+ In this mode, objects are passed by value instead of reference by
+ default.
+ </para>
+ <para>
+ See also the section titled
+ <link linkend="migration5">Migrating from PHP 4 to PHP 5</link>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </section>
<section xml:id="ini.sect.resource-limits">
<title>Resource Limits</title>
@@ -3805,9 +3805,9 @@
</tgroup>
</table>
</para>
-
+
&ini.descriptions.title;
-
+
<para>
<variablelist>
<varlistentry xml:id="ini.memory-limit">
@@ -3819,13 +3819,13 @@
<para>
This sets the maximum amount of memory in bytes that a script
is allowed to allocate. This helps prevent poorly written
- scripts for eating up all available memory on a server. Note that
+ scripts for eating up all available memory on a server. Note that
to have no memory limit, set this directive to <literal>-1</literal>.
</para>
<para>
Prior to PHP 5.2.1, in order to use this directive it had to
- be enabled at compile time by using
- <option role="configure">-enable-memory-limit</option> in the
+ be enabled at compile time by using
+ <option role="configure">-enable-memory-limit</option> in the
configure line. This was also required to define the functions
<function>memory_get_usage</function> and
<function>memory_get_peak_usage</function>.
@@ -3908,66 +3908,66 @@
<section xml:id="ini.sect.data-handling">
<title>Data Handling</title>
- <para>
- <table>
- <title>Data Handling Configuration Options</title>
- <tgroup cols="4">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Default</entry>
- <entry>Changeable</entry>
- <entry>Changelog</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>track_vars</entry>
- <entry>"On"</entry>
- <entry>PHP_INI_??</entry>
- <entry></entry>
- </row>
- <row>
- <entry>arg_separator.output</entry>
- <entry>"&"</entry>
- <entry>PHP_INI_ALL</entry>
- <entry>Available since PHP 4.0.5.</entry>
- </row>
- <row>
- <entry>arg_separator.input</entry>
- <entry>"&"</entry>
- <entry>PHP_INI_PERDIR</entry>
- <entry>Available since PHP 4.0.5.</entry>
- </row>
- <row>
- <entry>variables_order</entry>
- <entry>"EGPCS"</entry>
- <entry>PHP_INI_PERDIR</entry>
- <entry>PHP_INI_ALL in PHP <= 5.0.5.</entry>
- </row>
- <row>
- <entry>request_order</entry>
- <entry>""</entry>
- <entry>PHP_INI_SYSTEM|PHP_INI_PERDIR</entry>
- <entry>Available since PHP 5.3.0</entry>
- </row>
- <row>
- <entry>auto_globals_jit</entry>
- <entry>"1"</entry>
- <entry>PHP_INI_PERDIR</entry>
- <entry>Available since PHP 5.0.0.</entry>
- </row>
- <row>
- <entry>register_globals</entry>
- <entry>"0"</entry>
- <entry>PHP_INI_PERDIR</entry>
- <entry>PHP_INI_ALL in PHP <= 4.2.3.</entry>
- </row>
- <row>
- <entry>register_argc_argv</entry>
- <entry>"1"</entry>
- <entry>PHP_INI_PERDIR</entry>
- <entry>PHP_INI_ALL in PHP <= 4.2.3.</entry>
+ <para>
+ <table>
+ <title>Data Handling Configuration Options</title>
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Default</entry>
+ <entry>Changeable</entry>
+ <entry>Changelog</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>track_vars</entry>
+ <entry>"On"</entry>
+ <entry>PHP_INI_??</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>arg_separator.output</entry>
+ <entry>"&"</entry>
+ <entry>PHP_INI_ALL</entry>
+ <entry>Available since PHP 4.0.5.</entry>
+ </row>
+ <row>
+ <entry>arg_separator.input</entry>
+ <entry>"&"</entry>
+ <entry>PHP_INI_PERDIR</entry>
+ <entry>Available since PHP 4.0.5.</entry>
+ </row>
+ <row>
+ <entry>variables_order</entry>
+ <entry>"EGPCS"</entry>
+ <entry>PHP_INI_PERDIR</entry>
+ <entry>PHP_INI_ALL in PHP <= 5.0.5.</entry>
+ </row>
+ <row>
+ <entry>request_order</entry>
+ <entry>""</entry>
+ <entry>PHP_INI_SYSTEM|PHP_INI_PERDIR</entry>
+ <entry>Available since PHP 5.3.0</entry>
+ </row>
+ <row>
+ <entry>auto_globals_jit</entry>
+ <entry>"1"</entry>
+ <entry>PHP_INI_PERDIR</entry>
+ <entry>Available since PHP 5.0.0.</entry>
+ </row>
+ <row>
+ <entry>register_globals</entry>
+ <entry>"0"</entry>
+ <entry>PHP_INI_PERDIR</entry>
+ <entry>PHP_INI_ALL in PHP <= 4.2.3.</entry>
+ </row>
+ <row>
+ <entry>register_argc_argv</entry>
+ <entry>"1"</entry>
+ <entry>PHP_INI_PERDIR</entry>
+ <entry>PHP_INI_ALL in PHP <= 4.2.3.</entry>
</row>
<row>
<entry>register_long_arrays</entry>
@@ -3999,874 +3999,871 @@
<entry>PHP_INI_PERDIR</entry>
<entry>PHP_INI_ALL in PHP <= 4.2.3.</entry>
</row>
- <row>
- <entry>default_mimetype</entry>
- <entry>"text/html"</entry>
- <entry>PHP_INI_ALL</entry>
- <entry></entry>
- </row>
- <row>
- <entry>default_charset</entry>
- <entry>""</entry>
- <entry>PHP_INI_ALL</entry>
- <entry></entry>
- </row>
- <row>
- <entry>always_populate_raw_post_data</entry>
- <entry>"0"</entry>
- <entry>PHP_INI_PERDIR</entry>
- <entry>PHP_INI_ALL in PHP <= 4.2.3. Available since PHP 4.1.0.</entry>
- </row>
- <row>
- <entry>allow_webdav_methods</entry>
- <entry>"0"</entry>
- <entry>PHP_INI_PERDIR</entry>
- <entry></entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </para>
-
- &ini.descriptions.title;
-
- <para>
- <variablelist>
- <varlistentry xml:id="ini.track-vars">
- <term>
- <parameter>track_vars</parameter>
- <type>boolean</type>
- </term>
- <listitem>
- <para>
- If enabled, then Environment, GET, POST, Cookie, and Server
- variables can be found in the global associative arrays
- <varname>$_ENV</varname>,
- <varname>$_GET</varname>,
- <varname>$_POST</varname>,
- <varname>$_COOKIE</varname>, and
- <varname>$_SERVER</varname>.
- </para>
- <para>
- Note that as of PHP 4.0.3, <systemitem
- role="directive">track_vars</systemitem> is always turned on.
- </para>
- </listitem>
- </varlistentry>
+ <row>
+ <entry>default_mimetype</entry>
+ <entry>"text/html"</entry>
+ <entry>PHP_INI_ALL</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>default_charset</entry>
+ <entry>""</entry>
+ <entry>PHP_INI_ALL</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>always_populate_raw_post_data</entry>
+ <entry>"0"</entry>
+ <entry>PHP_INI_PERDIR</entry>
+ <entry>PHP_INI_ALL in PHP <= 4.2.3. Available since PHP 4.1.0.</entry>
+ </row>
+ <row>
+ <entry>allow_webdav_methods</entry>
+ <entry>"0"</entry>
+ <entry>PHP_INI_PERDIR</entry>
+ <entry></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
- <varlistentry xml:id="ini.arg-separator.output">
- <term>
- <parameter>arg_separator.output</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- The separator used in PHP generated URLs to separate arguments.
- </para>
- </listitem>
- </varlistentry>
+ &ini.descriptions.title;
+
+ <para>
+ <variablelist>
+ <varlistentry xml:id="ini.track-vars">
+ <term>
+ <parameter>track_vars</parameter>
+ <type>boolean</type>
+ </term>
+ <listitem>
+ <para>
+ If enabled, then Environment, GET, POST, Cookie, and Server
+ variables can be found in the global associative arrays
+ <varname>$_ENV</varname>,
+ <varname>$_GET</varname>,
+ <varname>$_POST</varname>,
+ <varname>$_COOKIE</varname>, and
+ <varname>$_SERVER</varname>.
+ </para>
+ <para>
+ Note that as of PHP 4.0.3, <systemitem
+ role="directive">track_vars</systemitem> is always turned on.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry xml:id="ini.arg-separator.output">
+ <term>
+ <parameter>arg_separator.output</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ The separator used in PHP generated URLs to separate arguments.
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry xml:id="ini.arg-separator.input">
- <term>
- <parameter>arg_separator.input</parameter>
- <type>string</type>
- </term>
- <listitem>
+ <varlistentry xml:id="ini.arg-separator.input">
+ <term>
+ <parameter>arg_separator.input</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ List of separator(s) used by PHP to parse input URLs into variables.
+ </para>
+ <note>
<para>
- List of separator(s) used by PHP to parse input URLs into variables.
+ Every character in this directive is considered as separator!
</para>
- <note>
- <para>
- Every character in this directive is considered as separator!
- </para>
- </note>
- </listitem>
- </varlistentry>
+ </note>
+ </listitem>
+ </varlistentry>
- <varlistentry xml:id="ini.variables-order">
- <term>
- <parameter>variables_order</parameter>
- <type>string</type>
- </term>
- <listitem>
+ <varlistentry xml:id="ini.variables-order">
+ <term>
+ <parameter>variables_order</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ Sets the order of the EGPCS (<literal>E</literal>nvironment,
+ <literal>G</literal>et, <literal>P</literal>ost,
+ <literal>C</literal>ookie, and <literal>S</literal>erver) variable
+ parsing. For example, if variables_order
+ is set to <literal>"SP"</literal> then PHP will create the
+ &link.superglobals; <varname>$_SERVER</varname> and
+ <varname>$_POST</varname>, but not create
+ <varname>$_ENV</varname>, <varname>$_GET</varname>, and
+ <varname>$_COOKIE</varname>. Setting to "" means no
+ &link.superglobals; will be set.
+ </para>
+ <para>
+ If the deprecated
+ <link linkend="ini.register-globals">register_globals</link>
+ directive is on (removed as of PHP 6.0.0), then variables_order also
+ configures the order the <literal>ENV</literal>,
+ <literal>GET</literal>, <literal>POST</literal>,
+ <literal>COOKIE</literal> and <literal>SERVER</literal> variables
+ are populated in global scope. So for example if variables_order
+ is set to <literal>"EGPCS"</literal>, register_globals is enabled,
+ and both <varname>$_GET['action']</varname> and
+ <varname>$_POST['action']</varname> are set, then
+ <varname>$action</varname> will contain the value of
+ <varname>$_POST['action']</varname> as <literal>P</literal> comes
+ after <literal>G</literal> in our example directive value.
+ </para>
+ <warning>
<para>
- Sets the order of the EGPCS (<literal>E</literal>nvironment,
- <literal>G</literal>et, <literal>P</literal>ost,
- <literal>C</literal>ookie, and <literal>S</literal>erver) variable
- parsing. For example, if variables_order
- is set to <literal>"SP"</literal> then PHP will create the
- &link.superglobals; <varname>$_SERVER</varname> and
- <varname>$_POST</varname>, but not create
- <varname>$_ENV</varname>, <varname>$_GET</varname>, and
- <varname>$_COOKIE</varname>. Setting to "" means no
- &link.superglobals; will be set.
+ In both the CGI and FastCGI SAPIs,
+ <link linkend="reserved.variables.server">$_SERVER</link> is
+ also populated by values from the environment; <literal>S</literal>
+ is always equivelant to <literal>ES</literal> regardless of the
+ placement of <literal>E</literal> elsewhere in this directive.
+ </para>
+ </warning>
+ <note>
+ <para>
+ The content and order of
+ <link linkend="reserved.variables.request">$_REQUEST</link> is also
+ affected by this directive.
</para>
- <para>
- If the deprecated
- <link linkend="ini.register-globals">register_globals</link>
- directive is on (removed as of PHP 6.0.0), then variables_order also
- configures the order the <literal>ENV</literal>,
- <literal>GET</literal>, <literal>POST</literal>,
- <literal>COOKIE</literal> and <literal>SERVER</literal> variables
- are populated in global scope. So for example if variables_order
- is set to <literal>"EGPCS"</literal>, register_globals is enabled,
- and both <varname>$_GET['action']</varname> and
- <varname>$_POST['action']</varname> are set, then
- <varname>$action</varname> will contain the value of
- <varname>$_POST['action']</varname> as <literal>P</literal> comes
- after <literal>G</literal> in our example directive value.
- </para>
- <warning>
- <para>
- In both the CGI and FastCGI SAPIs,
- <link linkend="reserved.variables.server">$_SERVER</link> is
- also populated by values from the environment; <literal>S</literal>
- is always equivelant to <literal>ES</literal> regardless of the
- placement of <literal>E</literal> elsewhere in this directive.
- </para>
- </warning>
- <note>
- <para>
- The content and order of
- <link linkend="reserved.variables.request">$_REQUEST</link> is also
- affected by this directive.
- </para>
- </note>
- </listitem>
- </varlistentry>
+ </note>
+ </listitem>
+ </varlistentry>
- <varlistentry xml:id="ini.request-order">
- <term>
- <parameter>request_order</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- This directive describes the order in which PHP registers GET, POST
- and Cookie variables into the _REQUEST array. Registration is done
- from left to right, newer values override older values.
- </para>
- <para>
- If this directive is not set, variables_order is used for
- <varname>$_REQUEST</varname> contents.
- </para>
- </listitem>
- </varlistentry>
+ <varlistentry xml:id="ini.request-order">
+ <term>
+ <parameter>request_order</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ This directive describes the order in which PHP registers GET, POST
+ and Cookie variables into the _REQUEST array. Registration is done
+ from left to right, newer values override older values.
+ </para>
+ <para>
+ If this directive is not set, variables_order is used for
+ <varname>$_REQUEST</varname> contents.
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry xml:id="ini.auto-globals-jit">
- <term>
- <parameter>auto_globals_jit</parameter>
- <type>boolean</type>
- </term>
- <listitem>
- <para>
- When enabled, the SERVER and ENV variables are created when they're
- first used (Just In Time) instead of when the script starts. If these
- variables are not used within a script, having this directive on will
- result in a performance gain.
- </para>
- <para>
- The PHP directives
- <link linkend="ini.register-globals">register_globals</link>,
- <link linkend="ini.register-long-arrays">register_long_arrays</link>,
- and <link linkend="ini.register-argc-argv">register_argc_argv</link>
- must be disabled for this directive to have any affect. Since PHP
- 5.1.3 it is not necessary to have <link
- linkend="ini.register-argc-argv">register_argc_argv</link> disabled.
- </para>
- </listitem>
- </varlistentry>
+ <varlistentry xml:id="ini.auto-globals-jit">
+ <term>
+ <parameter>auto_globals_jit</parameter>
+ <type>boolean</type>
+ </term>
+ <listitem>
+ <para>
+ When enabled, the SERVER and ENV variables are created when they're
+ first used (Just In Time) instead of when the script starts. If these
+ variables are not used within a script, having this directive on will
+ result in a performance gain.
+ </para>
+ <para>
+ The PHP directives
+ <link linkend="ini.register-globals">register_globals</link>,
+ <link linkend="ini.register-long-arrays">register_long_arrays</link>,
+ and <link linkend="ini.register-argc-argv">register_argc_argv</link>
+ must be disabled for this directive to have any affect. Since PHP
+ 5.1.3 it is not necessary to have <link
+ linkend="ini.register-argc-argv">register_argc_argv</link> disabled.
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry xml:id="ini.register-globals">
- <term>
- <parameter>register_globals</parameter>
- <type>boolean</type>
- </term>
- <listitem>
- <para>
- Whether or not to register the EGPCS (Environment, GET,
- POST, Cookie, Server) variables as global variables.
- </para>
- <para>
- As of <link xlink:href="&url.php.release4.2.0;">PHP 4.2.0</link>,
- this directive defaults to <emphasis>off</emphasis>.
- </para>
- <para>
- Please read the security chapter on
- <link linkend="security.globals">Using register_globals</link>
- for related information.
- </para>
- <para>
- Please note that <systemitem role="directive">register_globals</systemitem>
- cannot be set at runtime (<function>ini_set</function>). Although, you can
- use &htaccess; if your host allows it as described
- above. An example &htaccess; entry:
- <userinput>php_flag register_globals off</userinput>.
- </para>
- <note>
- <para>
- <systemitem role="directive">register_globals</systemitem> is affected
- by the <link linkend="ini.variables-order">variables_order</link>
- directive.
- </para>
- </note>
- &warn.deprecated.removed-6-0-0;
- </listitem>
- </varlistentry>
-
- <varlistentry xml:id="ini.register-argc-argv">
- <term>
- <parameter>register_argc_argv</parameter>
- <type>boolean</type>
- </term>
- <listitem>
- <simpara>
- Tells PHP whether to declare the argv & argc variables
- (that would contain the GET information).
- </simpara>
- <simpara>
- See also <link linkend="features.commandline">command line</link>.
- Also, this directive became available in PHP 4.0.0 and
- was always "on" before that.
- </simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry xml:id="ini.register-long-arrays">
- <term>
- <parameter>register_long_arrays</parameter>
- <type>boolean</type>
- </term>
- <listitem>
- <simpara>
- Tells PHP whether or not to register the deprecated long
- <varname>$HTTP_*_VARS</varname> type
- <link linkend="language.variables.predefined">predefined
- variables</link>. When On (default), long predefined PHP
- variables like <varname>$HTTP_GET_VARS</varname> will be defined.
- If you're not using them, it's recommended to turn them off,
- for performance reasons. Instead, use the superglobal arrays,
- like <varname>$_GET</varname>.
- </simpara>
- <simpara>
- This directive became available in PHP 5.0.0 and was dropped in PHP
- 6.0.0.
- </simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry xml:id="ini.post-max-size">
- <term>
- <parameter>post_max_size</parameter>
- <type>integer</type>
- </term>
- <listitem>
- <simpara>
- Sets max size of post data allowed. This setting also affects
- file upload. To upload large files, this value must be larger
- than <link linkend="ini.upload-max-filesize">upload_max_filesize</link>.
- </simpara>
- <simpara>
- If memory limit is enabled by your configure script, <link
- linkend="ini.memory-limit">memory_limit</link> also affects
- file uploading. Generally speaking,
- <link linkend="ini.memory-limit">memory_limit</link> should be
- larger than <parameter>post_max_size</parameter>.
- </simpara>
-
- &ini.shorthandbytes;
-
- <simpara>
- If the size of post data is greater than post_max_size, the
- <varname>$_POST</varname> and <varname>$_FILES</varname>
- <link linkend="language.variables.superglobals">superglobals</link>
- are empty. This can be tracked in various ways, e.g. by passing the
- <varname>$_GET</varname> variable to the script processing the data,
- i.e. <literal><form action="edit.php?processed=1"></literal>,
- and then checking if <varname>$_GET['processed']</varname> is set.
- </simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry xml:id="ini.gpc-order">
- <term>
- <parameter>gpc_order</parameter>
- <type>string</type>
- </term>
- <listitem>
+ <varlistentry xml:id="ini.register-globals">
+ <term>
+ <parameter>register_globals</parameter>
+ <type>boolean</type>
+ </term>
+ <listitem>
+ <para>
+ Whether or not to register the EGPCS (Environment, GET,
+ POST, Cookie, Server) variables as global variables.
+ </para>
+ <para>
+ As of <link xlink:href="&url.php.release4.2.0;">PHP 4.2.0</link>,
+ this directive defaults to <emphasis>off</emphasis>.
+ </para>
+ <para>
+ Please read the security chapter on
+ <link linkend="security.globals">Using register_globals</link>
+ for related information.
+ </para>
+ <para>
+ Please note that <systemitem role="directive">register_globals</systemitem>
+ cannot be set at runtime (<function>ini_set</function>). Although, you can
+ use &htaccess; if your host allows it as described
+ above. An example &htaccess; entry:
+ <userinput>php_flag register_globals off</userinput>.
+ </para>
+ <note>
<para>
- Set the order of GET/POST/COOKIE variable parsing. The
- default setting of this directive is "GPC". Setting this to
- "GP", for example, will cause PHP to completely ignore cookies
- and to overwrite any GET method variables with POST-method
- variables of the same name.
+ <systemitem role="directive">register_globals</systemitem> is affected
+ by the <link linkend="ini.variables-order">variables_order</link>
+ directive.
</para>
- <note>
- <para>
- This option is not available in PHP 4.
- Use <link linkend="ini.variables-order">variables_order</link>
- instead.
- </para>
- </note>
- </listitem>
- </varlistentry>
+ </note>
+ &warn.deprecated.removed-6-0-0;
+ </listitem>
+ </varlistentry>
- <varlistentry xml:id="ini.auto-prepend-file">
- <term>
- <parameter>auto_prepend_file</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- Specifies the name of a file that is automatically parsed
- before the main file. The file is included as if it was
- called with the <function>require</function> function, so
- <link linkend="ini.include-path">include_path</link> is used.</para>
- <para>
- The special value <literal>none</literal>
- disables auto-prepending.
- </para>
- </listitem>
- </varlistentry>
+ <varlistentry xml:id="ini.register-argc-argv">
+ <term>
+ <parameter>register_argc_argv</parameter>
+ <type>boolean</type>
+ </term>
+ <listitem>
+ <simpara>
+ Tells PHP whether to declare the argv & argc variables
+ (that would contain the GET information).
+ </simpara>
+ <simpara>
+ See also <link linkend="features.commandline">command line</link>.
+ Also, this directive became available in PHP 4.0.0 and
+ was always "on" before that.
+ </simpara>
+ </listitem>
+ </varlistentry>
- <varlistentry xml:id="ini.auto-append-file">
- <term>
- <parameter>auto_append_file</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- Specifies the name of a file that is automatically parsed
- after the main file. The file is included as if it was
- called with the <function>require</function> function, so
- <link linkend="ini.include-path">include_path</link> is used.</para>
- <para>
- The special value <literal>none</literal>
- disables auto-appending.
- <note>
- <simpara>
- If the script is terminated with <function>exit</function>,
- auto-append will <emphasis>not</emphasis> occur.</simpara>
- </note>
- </para>
- </listitem>
- </varlistentry>
+ <varlistentry xml:id="ini.register-long-arrays">
+ <term>
+ <parameter>register_long_arrays</parameter>
+ <type>boolean</type>
+ </term>
+ <listitem>
+ <simpara>
+ Tells PHP whether or not to register the deprecated long
+ <varname>$HTTP_*_VARS</varname> type
+ <link linkend="language.variables.predefined">predefined
+ variables</link>. When On (default), long predefined PHP
+ variables like <varname>$HTTP_GET_VARS</varname> will be defined.
+ If you're not using them, it's recommended to turn them off,
+ for performance reasons. Instead, use the superglobal arrays,
+ like <varname>$_GET</varname>.
+ </simpara>
+ <simpara>
+ This directive became available in PHP 5.0.0 and was dropped in PHP
+ 6.0.0.
+ </simpara>
+ </listitem>
+ </varlistentry>
- <varlistentry xml:id="ini.default-mimetype">
- <term>
- <parameter>default_mimetype</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
+ <varlistentry xml:id="ini.post-max-size">
+ <term>
+ <parameter>post_max_size</parameter>
+ <type>integer</type>
+ </term>
+ <listitem>
+ <simpara>
+ Sets max size of post data allowed. This setting also affects
+ file upload. To upload large files, this value must be larger
+ than <link linkend="ini.upload-max-filesize">upload_max_filesize</link>.
+ </simpara>
+ <simpara>
+ If memory limit is enabled by your configure script, <link
+ linkend="ini.memory-limit">memory_limit</link> also affects
+ file uploading. Generally speaking,
+ <link linkend="ini.memory-limit">memory_limit</link> should be
+ larger than <parameter>post_max_size</parameter>.
+ </simpara>
- <varlistentry xml:id="ini.default-charset">
- <term>
- <parameter>default_charset</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- As of 4.0.0, PHP always outputs a character encoding by default in
- the Content-type: header. To disable sending of the charset, simply
- set it to be empty.
- </para>
- </listitem>
- </varlistentry>
+ &ini.shorthandbytes;
- <varlistentry xml:id="ini.always-populate-raw-post-data">
- <term>
- <parameter>always_populate_raw_post_data</parameter>
- <type>boolean</type>
- </term>
- <listitem>
- <para>
- Always populate the <varname>$HTTP_RAW_POST_DATA</varname> containing
- the raw POST data. Otherwise, the variable is populated only with
- unrecognized MIME type of the data. However, the preferred method for
- accessing the raw POST data is <link
- linkend="wrappers.php">php://input</link>.
- <varname>$HTTP_RAW_POST_DATA</varname> is not available with
- <literal>enctype="multipart/form-data"</literal>.
- </para>
- </listitem>
- </varlistentry>
+ <simpara>
+ If the size of post data is greater than post_max_size, the
+ <varname>$_POST</varname> and <varname>$_FILES</varname>
+ <link linkend="language.variables.superglobals">superglobals</link>
+ are empty. This can be tracked in various ways, e.g. by passing the
+ <varname>$_GET</varname> variable to the script processing the data,
+ i.e. <literal><form action="edit.php?processed=1"></literal>,
+ and then checking if <varname>$_GET['processed']</varname> is set.
+ </simpara>
+ </listitem>
+ </varlistentry>
- <varlistentry xml:id="ini.allow-webdav-methods">
- <term>
- <parameter>allow_webdav_methods</parameter>
- <type>boolean</type>
- </term>
- <listitem>
+ <varlistentry xml:id="ini.gpc-order">
+ <term>
+ <parameter>gpc_order</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ Set the order of GET/POST/COOKIE variable parsing. The
+ default setting of this directive is "GPC". Setting this to
+ "GP", for example, will cause PHP to completely ignore cookies
+ and to overwrite any GET method variables with POST-method
+ variables of the same name.
+ </para>
+ <note>
<para>
- Allow handling of WebDAV http requests within PHP scripts (eg.
- PROPFIND, PROPPATCH, MOVE, COPY, etc.).
- This directive does not exist as of PHP 4.3.2.
- If you want to get the post data of those requests, you have to
- set <link linkend="ini.always-populate-raw-post-data">
- always_populate_raw_post_data</link> as well.
+ This option is not available in PHP 4.
+ Use <link linkend="ini.variables-order">variables_order</link>
+ instead.
</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- <para>
- See also: <link linkend="ini.magic-quotes-gpc">magic_quotes_gpc</link>,
- <link linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link>,
- and
- <link linkend="ini.magic-quotes-sybase">magic_quotes_sybase</link>.
- </para>
- </section>
+ </note>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry xml:id="ini.auto-prepend-file">
+ <term>
+ <parameter>auto_prepend_file</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ Specifies the name of a file that is automatically parsed
+ before the main file. The file is included as if it was
+ called with the <function>require</function> function, so
+ <link linkend="ini.include-path">include_path</link> is used.</para>
+ <para>
+ The special value <literal>none</literal>
+ disables auto-prepending.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry xml:id="ini.auto-append-file">
+ <term>
+ <parameter>auto_append_file</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ Specifies the name of a file that is automatically parsed
+ after the main file. The file is included as if it was
+ called with the <function>require</function> function, so
+ <link linkend="ini.include-path">include_path</link> is used.</para>
+ <para>
+ The special value <literal>none</literal>
+ disables auto-appending.
+ <note>
+ <simpara>
+ If the script is terminated with <function>exit</function>,
+ auto-append will <emphasis>not</emphasis> occur.</simpara>
+ </note>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry xml:id="ini.default-mimetype">
+ <term>
+ <parameter>default_mimetype</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry xml:id="ini.default-charset">
+ <term>
+ <parameter>default_charset</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ As of 4.0.0, PHP always outputs a character encoding by default in
+ the Content-type: header. To disable sending of the charset, simply
+ set it to be empty.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry xml:id="ini.always-populate-raw-post-data">
+ <term>
+ <parameter>always_populate_raw_post_data</parameter>
+ <type>boolean</type>
+ </term>
+ <listitem>
+ <para>
+ Always populate the <varname>$HTTP_RAW_POST_DATA</varname> containing
+ the raw POST data. Otherwise, the variable is populated only with
+ unrecognized MIME type of the data. However, the preferred method for
+ accessing the raw POST data is <link
+ linkend="wrappers.php">php://input</link>.
+ <varname>$HTTP_RAW_POST_DATA</varname> is not available with
+ <literal>enctype="multipart/form-data"</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry xml:id="ini.allow-webdav-methods">
+ <term>
+ <parameter>allow_webdav_methods</parameter>
+ <type>boolean</type>
+ </term>
+ <listitem>
+ <para>
+ Allow handling of WebDAV http requests within PHP scripts (eg.
+ PROPFIND, PROPPATCH, MOVE, COPY, etc.).
+ This directive does not exist as of PHP 4.3.2.
+ If you want to get the post data of those requests, you have to
+ set <link linkend="ini.always-populate-raw-post-data">
+ always_populate_raw_post_data</link> as well.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ <para>
+ See also: <link linkend="ini.magic-quotes-gpc">magic_quotes_gpc</link>,
+ <link linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link>,
+ and
+ <link linkend="ini.magic-quotes-sybase">magic_quotes_sybase</link>.
+ </para>
+ </section>
<section xml:id="ini.sect.path-directory">
<title>Paths and Directories</title>
- <para>
- <table>
- <title>Paths and Directories Configuration Options</title>
- <tgroup cols="4">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Default</entry>
- <entry>Changeable</entry>
- <entry>Changelog</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>include_path</entry>
- <entry>".;/path/to/php/pear"</entry>
- <entry>PHP_INI_ALL</entry>
- <entry></entry>
- </row>
- <row>
- <entry>doc_root</entry>
- <entry>NULL</entry>
- <entry>PHP_INI_SYSTEM</entry>
- <entry></entry>
- </row>
- <row>
- <entry>user_dir</entry>
- <entry>NULL</entry>
- <entry>PHP_INI_SYSTEM</entry>
- <entry></entry>
- </row>
- <row>
- <entry>extension_dir</entry>
- <entry>"/path/to/php"</entry>
- <entry>PHP_INI_SYSTEM</entry>
- <entry></entry>
- </row>
- <row>
- <entry>extension</entry>
- <entry>NULL</entry>
- <entry>&php.ini; only</entry>
- <entry></entry>
- </row>
- <row>
- <entry>cgi.check_shebang_line</entry>
- <entry>"1"</entry>
- <entry>PHP_INI_SYSTEM</entry>
- <entry>Available since PHP 5.2.0.</entry>
- </row>
- <row>
- <entry>cgi.fix_pathinfo</entry>
- <entry>"1"</entry>
- <entry>PHP_INI_SYSTEM</entry>
- <entry>Available since PHP 4.3.0. PHP_INI_ALL prior to PHP 5.2.1.</entry>
- </row>
- <row>
- <entry>cgi.force_redirect</entry>
- <entry>"1"</entry>
- <entry>PHP_INI_SYSTEM</entry>
- <entry>Available since PHP 4.2.0. PHP_INI_ALL prior to PHP 5.2.1.</entry>
- </row>
- <row>
- <entry>cgi.redirect_status_env</entry>
- <entry>NULL</entry>
- <entry>PHP_INI_SYSTEM</entry>
- <entry>Available since PHP 4.2.0. PHP_INI_ALL prior to PHP 5.2.1.</entry>
- </row>
- <row>
- <entry>fastcgi.impersonate</entry>
- <entry>"0"</entry>
- <entry>PHP_INI_SYSTEM</entry>
- <entry>Available since PHP 4.3.0. PHP_INI_ALL prior to PHP 5.2.1.</entry>
- </row>
- <row>
- <entry>cgi.rfc2616_headers</entry>
- <entry>"0"</entry>
- <entry>PHP_INI_ALL</entry>
- <entry>Available since PHP 4.3.0.</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </para>
-
- &ini.descriptions.title;
-
- <para>
- <variablelist>
- <varlistentry xml:id="ini.include-path">
- <term>
- <parameter>include_path</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- Specifies a list of directories where the
- <function>require</function>, <function>include</function>,
- <function>fopen</function>, <function>file</function>,
- <function>readfile</function> and <function>file_get_contents</function>
- functions look for files. The format is like the system's
- <envar>PATH</envar> environment variable: a list of directories
- separated with a colon in Unix or semicolon in Windows.
- </para>
- <para>
- <example>
- <title>Unix include_path</title>
- <programlisting role="php.ini">
+ <para>
+ <table>
+ <title>Paths and Directories Configuration Options</title>
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Default</entry>
+ <entry>Changeable</entry>
+ <entry>Changelog</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>include_path</entry>
+ <entry>".;/path/to/php/pear"</entry>
+ <entry>PHP_INI_ALL</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>doc_root</entry>
+ <entry>NULL</entry>
+ <entry>PHP_INI_SYSTEM</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>user_dir</entry>
+ <entry>NULL</entry>
+ <entry>PHP_INI_SYSTEM</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>extension_dir</entry>
+ <entry>"/path/to/php"</entry>
+ <entry>PHP_INI_SYSTEM</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>extension</entry>
+ <entry>NULL</entry>
+ <entry>&php.ini; only</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>cgi.check_shebang_line</entry>
+ <entry>"1"</entry>
+ <entry>PHP_INI_SYSTEM</entry>
+ <entry>Available since PHP 5.2.0.</entry>
+ </row>
+ <row>
+ <entry>cgi.fix_pathinfo</entry>
+ <entry>"1"</entry>
+ <entry>PHP_INI_SYSTEM</entry>
+ <entry>Available since PHP 4.3.0. PHP_INI_ALL prior to PHP 5.2.1.</entry>
+ </row>
+ <row>
+ <entry>cgi.force_redirect</entry>
+ <entry>"1"</entry>
+ <entry>PHP_INI_SYSTEM</entry>
+ <entry>Available since PHP 4.2.0. PHP_INI_ALL prior to PHP 5.2.1.</entry>
+ </row>
+ <row>
+ <entry>cgi.redirect_status_env</entry>
+ <entry>NULL</entry>
+ <entry>PHP_INI_SYSTEM</entry>
+ <entry>Available since PHP 4.2.0. PHP_INI_ALL prior to PHP 5.2.1.</entry>
+ </row>
+ <row>
+ <entry>fastcgi.impersonate</entry>
+ <entry>"0"</entry>
+ <entry>PHP_INI_SYSTEM</entry>
+ <entry>Available since PHP 4.3.0. PHP_INI_ALL prior to PHP 5.2.1.</entry>
+ </row>
+ <row>
+ <entry>cgi.rfc2616_headers</entry>
+ <entry>"0"</entry>
+ <entry>PHP_INI_ALL</entry>
+ <entry>Available since PHP 4.3.0.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+
+ &ini.descriptions.title;
+
+ <para>
+ <variablelist>
+ <varlistentry xml:id="ini.include-path">
+ <term>
+ <parameter>include_path</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ Specifies a list of directories where the
+ <function>require</function>, <function>include</function>,
+ <function>fopen</function>, <function>file</function>,
+ <function>readfile</function> and <function>file_get_contents</function>
+ functions look for files. The format is like the system's
+ <envar>PATH</envar> environment variable: a list of directories
+ separated with a colon in Unix or semicolon in Windows.
+ </para>
+ <para>
+ <example>
+ <title>Unix include_path</title>
+ <programlisting role="php.ini">
<![CDATA[
include_path=".:/php/includes"
]]>
- </programlisting>
- </example>
- </para>
- <para>
- <example>
- <title>Windows include_path</title>
- <programlisting role="php.ini">
+ </programlisting>
+ </example>
+ </para>
+ <para>
+ <example>
+ <title>Windows include_path</title>
+ <programlisting role="php.ini">
<![CDATA[
include_path=".;c:\php\includes"
]]>
- </programlisting>
- </example>
- </para>
- <para>
- Using a <literal>.</literal> in the include path allows for
- relative includes as it means the current directory.
- </para>
- </listitem>
- </varlistentry>
+ </programlisting>
+ </example>
+ </para>
+ <para>
+ Using a <literal>.</literal> in the include path allows for
+ relative includes as it means the current directory.
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry xml:id="ini.doc-root">
- <term>
- <parameter>doc_root</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- PHP's "root directory" on the server. Only used if
- non-empty. If PHP is configured with &safemode;, no files outside
- this directory are served.
- If PHP was not compiled with FORCE_REDIRECT, you <emphasis>should
- </emphasis> set doc_root if you are running PHP as a CGI under any web
- server (other than IIS). The alternative is to use the
- <link linkend="ini.cgi.force-redirect">
- cgi.force_redirect</link> configuration below.
- </para>
- </listitem>
- </varlistentry>
+ <varlistentry xml:id="ini.doc-root">
+ <term>
+ <parameter>doc_root</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ PHP's "root directory" on the server. Only used if
+ non-empty. If PHP is configured with &safemode;, no files outside
+ this directory are served.
+ If PHP was not compiled with FORCE_REDIRECT, you <emphasis>should
+ </emphasis> set doc_root if you are running PHP as a CGI under any web
+ server (other than IIS). The alternative is to use the
+ <link linkend="ini.cgi.force-redirect">
+ cgi.force_redirect</link> configuration below.
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry xml:id="ini.user-dir">
- <term>
- <parameter>user_dir</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- The base name of the directory used on a user's home directory for PHP
- files, for example <filename class="directory">public_html
- </filename>.
- </para>
- </listitem>
- </varlistentry>
+ <varlistentry xml:id="ini.user-dir">
+ <term>
+ <parameter>user_dir</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ The base name of the directory used on a user's home directory for PHP
+ files, for example <filename class="directory">public_html
+ </filename>.
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry xml:id="ini.extension-dir">
- <term>
- <parameter>extension_dir</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- In what directory PHP should look for dynamically loadable
- extensions. See also: <link linkend="ini.enable-dl">enable_dl</link>,
- and <function>dl</function>.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry xml:id="ini.extension">
- <term>
- <parameter>extension</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- Which dynamically loadable extensions to load when PHP starts
- up.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry xml:id="ini.cgi.check-shebang-line">
- <term>
- <parameter>cgi.check_shebang_line</parameter>
- <type>boolean</type>
- </term>
- <listitem>
- <para>
- Controls whether CGI PHP checks for line starting with #! (shebang)
- at the top of the running script. This line might be needed if the
- script support running both as stand-alone script and via PHP CGI.
- PHP in CGI mode skips this line and ignores its content if this
- directive is turned on.
- </para>
- </listitem>
- </varlistentry>
+ <varlistentry xml:id="ini.extension-dir">
+ <term>
+ <parameter>extension_dir</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ In what directory PHP should look for dynamically loadable
+ extensions. See also: <link linkend="ini.enable-dl">enable_dl</link>,
+ and <function>dl</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="ini.extension">
+ <term>
+ <parameter>extension</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ Which dynamically loadable extensions to load when PHP starts up.
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry xml:id="ini.cgi.fix-pathinfo">
- <term>
- <parameter>cgi.fix_pathinfo</parameter>
- <type>boolean</type>
- </term>
- <listitem>
- <para>
- Provides <emphasis>real</emphasis> PATH_INFO/PATH_TRANSLATED
- support for CGI. PHP's previous behaviour was to set
- PATH_TRANSLATED to SCRIPT_FILENAME, and to not grok what PATH_INFO
- is. For more information on PATH_INFO, see the cgi specs. Setting
- this to 1 will cause PHP CGI to fix it's paths to conform to the
- spec. A setting of zero causes PHP to behave as before. Default
- is zero. You should fix your scripts to use SCRIPT_FILENAME rather
- than PATH_TRANSLATED.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry xml:id="ini.cgi.force-redirect">
- <term>
- <parameter>cgi.force_redirect</parameter>
- <type>boolean</type>
- </term>
- <listitem>
- <para>
- cgi.force_redirect is necessary to provide security running PHP as a
- CGI under most web servers. Left undefined, PHP turns this on by
- default. You can turn it off <emphasis>at your own risk</emphasis>.
- </para>
- <note>
- <para>
- Windows Users: You <emphasis>can</emphasis> safely turn this off for
- IIS, in fact, you <emphasis>must</emphasis>.
- To get OmniHTTPD or Xitami to work you <emphasis>must</emphasis> turn
- it off.
- </para>
- </note>
- </listitem>
- </varlistentry>
+ <varlistentry xml:id="ini.cgi.check-shebang-line">
+ <term>
+ <parameter>cgi.check_shebang_line</parameter>
+ <type>boolean</type>
+ </term>
+ <listitem>
+ <para>
+ Controls whether CGI PHP checks for line starting with #! (shebang)
+ at the top of the running script. This line might be needed if the
+ script support running both as stand-alone script and via PHP CGI.
+ PHP in CGI mode skips this line and ignores its content if this
+ directive is turned on.
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry xml:id="ini.cgi.redirect-status-env">
- <term>
- <parameter>cgi.redirect_status_env</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- If cgi.force_redirect is turned on, and you are not running under
- Apache or Netscape (iPlanet) web servers, you <emphasis>may</emphasis>
- need to set an environment variable name that PHP will look for to
- know it is OK to continue execution.
- </para>
- <note>
- <para>
- Setting this variable <emphasis>may</emphasis> cause security issues,
- <emphasis>know what you are doing first</emphasis>.
- </para>
- </note>
- </listitem>
- </varlistentry>
+ <varlistentry xml:id="ini.cgi.fix-pathinfo">
+ <term>
+ <parameter>cgi.fix_pathinfo</parameter>
+ <type>boolean</type>
+ </term>
+ <listitem>
+ <para>
+ Provides <emphasis>real</emphasis> PATH_INFO/PATH_TRANSLATED
+ support for CGI. PHP's previous behaviour was to set
+ PATH_TRANSLATED to SCRIPT_FILENAME, and to not grok what PATH_INFO
+ is. For more information on PATH_INFO, see the cgi specs. Setting
+ this to 1 will cause PHP CGI to fix it's paths to conform to the
+ spec. A setting of zero causes PHP to behave as before. Default
+ is zero. You should fix your scripts to use SCRIPT_FILENAME rather
+ than PATH_TRANSLATED.
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry xml:id="ini.fastcgi.impersonate">
- <term>
- <parameter>fastcgi.impersonate</parameter>
- <type>string</type>
- </term>
- <listitem>
+ <varlistentry xml:id="ini.cgi.force-redirect">
+ <term>
+ <parameter>cgi.force_redirect</parameter>
+ <type>boolean</type>
+ </term>
+ <listitem>
+ <para>
+ cgi.force_redirect is necessary to provide security running PHP as a
+ CGI under most web servers. Left undefined, PHP turns this on by
+ default. You can turn it off <emphasis>at your own risk</emphasis>.
+ </para>
+ <note>
<para>
- FastCGI under IIS (on WINNT based OS) supports the ability to impersonate
- security tokens of the calling client. This allows IIS to define the
- security context that the request runs under. mod_fastcgi under Apache
- does not currently support this feature (03/17/2002)
- Set to 1 if running under IIS. Default is zero.
+ Windows Users: You <emphasis>can</emphasis> safely turn this off for
+ IIS, in fact, you <emphasis>must</emphasis>.
+ To get OmniHTTPD or Xitami to work you <emphasis>must</emphasis> turn
+ it off.
</para>
- </listitem>
- </varlistentry>
+ </note>
+ </listitem>
+ </varlistentry>
- <varlistentry xml:id="ini.cgi.rfc2616-headers">
- <term>
- <parameter>cgi.rfc2616_headers</parameter>
- <type>int</type>
- </term>
- <listitem>
+ <varlistentry xml:id="ini.cgi.redirect-status-env">
+ <term>
+ <parameter>cgi.redirect_status_env</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ If cgi.force_redirect is turned on, and you are not running under
+ Apache or Netscape (iPlanet) web servers, you <emphasis>may</emphasis>
+ need to set an environment variable name that PHP will look for to
+ know it is OK to continue execution.
+ </para>
+ <note>
<para>
- Tells PHP what type of headers to use when sending HTTP response
- code. If it's set 0, PHP sends a Status: header that is supported
- by Apache and other web servers. When this option is set to 1, PHP
- will send <link xlink:href="&url.rfc;2616">RFC 2616</link> compliant
- headers. Leave it set to 0 unless you know what you're doing.
+ Setting this variable <emphasis>may</emphasis> cause security issues,
+ <emphasis>know what you are doing first</emphasis>.
</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </section>
+ </note>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry xml:id="ini.fastcgi.impersonate">
+ <term>
+ <parameter>fastcgi.impersonate</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ FastCGI under IIS (on WINNT based OS) supports the ability to impersonate
+ security tokens of the calling client. This allows IIS to define the
+ security context that the request runs under. mod_fastcgi under Apache
+ does not currently support this feature (03/17/2002)
+ Set to 1 if running under IIS. Default is zero.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry xml:id="ini.cgi.rfc2616-headers">
+ <term>
+ <parameter>cgi.rfc2616_headers</parameter>
+ <type>int</type>
+ </term>
+ <listitem>
+ <para>
+ Tells PHP what type of headers to use when sending HTTP response
+ code. If it's set 0, PHP sends a Status: header that is supported
+ by Apache and other web servers. When this option is set to 1, PHP
+ will send <link xlink:href="&url.rfc;2616">RFC 2616</link> compliant
+ headers. Leave it set to 0 unless you know what you're doing.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </section>
<section xml:id="ini.sect.file-uploads">
<title>File Uploads</title>
- <para>
- <table>
- <title>File Uploads Configuration Options</title>
- <tgroup cols="4">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Default</entry>
- <entry>Changeable</entry>
- <entry>Changelog</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>file_uploads</entry>
- <entry>"1"</entry>
- <entry>PHP_INI_SYSTEM</entry>
- <entry>PHP_INI_ALL in PHP <= 4.2.3. Available since PHP 4.0.3.</entry>
- </row>
- <row>
- <entry>upload_tmp_dir</entry>
- <entry>NULL</entry>
- <entry>PHP_INI_SYSTEM</entry>
- <entry></entry>
- </row>
- <row>
- <entry>upload_max_filesize</entry>
- <entry>"2M"</entry>
- <entry>PHP_INI_PERDIR</entry>
- <entry>PHP_INI_ALL in PHP <= 4.2.3.</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </para>
-
- &ini.descriptions.title;
-
- <para>
- <variablelist>
- <varlistentry xml:id="ini.file-uploads">
- <term>
- <parameter>file_uploads</parameter>
- <type>boolean</type>
- </term>
- <listitem>
- <para>
- Whether or not to allow HTTP
- <link linkend="features.file-upload">file uploads</link>. See also
- the
- <link linkend="ini.upload-max-filesize">upload_max_filesize</link>,
- <link linkend="ini.upload-tmp-dir">upload_tmp_dir</link>, and
- <link linkend="ini.post-max-size">post_max_size</link> directives.
- </para>
+ <para>
+ <table>
+ <title>File Uploads Configuration Options</title>
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Default</entry>
+ <entry>Changeable</entry>
+ <entry>Changelog</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>file_uploads</entry>
+ <entry>"1"</entry>
+ <entry>PHP_INI_SYSTEM</entry>
+ <entry>PHP_INI_ALL in PHP <= 4.2.3. Available since PHP 4.0.3.</entry>
+ </row>
+ <row>
+ <entry>upload_tmp_dir</entry>
+ <entry>NULL</entry>
+ <entry>PHP_INI_SYSTEM</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>upload_max_filesize</entry>
+ <entry>"2M"</entry>
+ <entry>PHP_INI_PERDIR</entry>
+ <entry>PHP_INI_ALL in PHP <= 4.2.3.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
- &ini.shorthandbytes;
+ &ini.descriptions.title;
- </listitem>
- </varlistentry>
+ <para>
+ <variablelist>
+ <varlistentry xml:id="ini.file-uploads">
+ <term>
+ <parameter>file_uploads</parameter>
+ <type>boolean</type>
+ </term>
+ <listitem>
+ <para>
+ Whether or not to allow HTTP
+ <link linkend="features.file-upload">file uploads</link>. See also the
+ <link linkend="ini.upload-max-filesize">upload_max_filesize</link>,
+ <link linkend="ini.upload-tmp-dir">upload_tmp_dir</link>, and
+ <link linkend="ini.post-max-size">post_max_size</link> directives.
+ </para>
- <varlistentry xml:id="ini.upload-tmp-dir">
- <term>
- <parameter>upload_tmp_dir</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- The temporary directory used for storing files when doing
- file upload. Must be writable by whatever user PHP
- is running as. If not specified PHP will use the system's default.
- </para>
- </listitem>
- </varlistentry>
+ &ini.shorthandbytes;
- <varlistentry xml:id="ini.upload-max-filesize">
- <term>
- <parameter>upload_max_filesize</parameter>
- <type>integer</type>
- </term>
- <listitem>
- <para>
- The maximum size of an uploaded file.
- </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry xml:id="ini.upload-tmp-dir">
+ <term>
+ <parameter>upload_tmp_dir</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ The temporary directory used for storing files when doing
+ file upload. Must be writable by whatever user PHP
+ is running as. If not specified PHP will use the system's default.
+ </para>
+ </listitem>
+ </varlistentry>
- &ini.shorthandbytes;
+ <varlistentry xml:id="ini.upload-max-filesize">
+ <term>
+ <parameter>upload_max_filesize</parameter>
+ <type>integer</type>
+ </term>
+ <listitem>
+ <para>
+ The maximum size of an uploaded file.
+ </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </section>
+ &ini.shorthandbytes;
+
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </section>
<section xml:id="ini.sql-general">
<title>General SQL</title>
- <para>
- <table>
- <title>General SQL Configuration Options</title>
- <tgroup cols="4">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Default</entry>
- <entry>Changeable</entry>
- <entry>Changelog</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>sql.safe_mode</entry>
- <entry>"0"</entry>
- <entry>PHP_INI_SYSTEM</entry>
- <entry></entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </para>
-
- &ini.descriptions.title;
-
- <para>
- <variablelist>
- <varlistentry xml:id="ini.sql.safe-mode">
- <term>
- <parameter>sql.safe_mode</parameter>
- <type>boolean</type>
- </term>
- <listitem>
- <para>
- If turned on, database connect functions that specify default values
- will use those values in place of supplied arguments. For default
- values see connect function documentation for the relevant database.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </section>
+ <para>
+ <table>
+ <title>General SQL Configuration Options</title>
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Default</entry>
+ <entry>Changeable</entry>
+ <entry>Changelog</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>sql.safe_mode</entry>
+ <entry>"0"</entry>
+ <entry>PHP_INI_SYSTEM</entry>
+ <entry></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+
+ &ini.descriptions.title;
+
+ <para>
+ <variablelist>
+ <varlistentry xml:id="ini.sql.safe-mode">
+ <term>
+ <parameter>sql.safe_mode</parameter>
+ <type>boolean</type>
+ </term>
+ <listitem>
+ <para>
+ If turned on, database connect functions that specify default values
+ will use those values in place of supplied arguments. For default
+ values see connect function documentation for the relevant database.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </section>
</section>
</appendix>
--
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic