cvs: phpdoc /en/functions info.xml
| From: | Egon Schmid | Date: | Wed, 23 Jan 2002 07:32:58 +0000 |
| Subject: | cvs: phpdoc /en/functions info.xml | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969341571@lists.php.net to get a copy of this message | ||
eschmid Wed Jan 23 02:32:58 2002 EDT
Modified files:
/phpdoc/en/functions info.xml
Log:
Fixed the whitespace fix.
Index: phpdoc/en/functions/info.xml diff -u phpdoc/en/functions/info.xml:1.88 phpdoc/en/functions/info.xml:1.89 --- phpdoc/en/functions/info.xml:1.88 Tue Jan 22 23:24:26 2002 +++ phpdoc/en/functions/info.xml Wed Jan 23 02:32:57 2002 @@ -1,8 +1,8 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.88 $ --> +<!-- $Revision: 1.89 $ --> <reference id="ref.info"> - <title>PHP options & information</title> - <titleabbrev>PHP options/info</titleabbrev> + <title>PHP Options&Information</title> + <titleabbrev>PHP Options/Info</titleabbrev> <refentry id="function.assert"> <refnamediv> @@ -19,14 +19,14 @@ </funcsynopsis> <para> <function>assert</function> will check the given - <parameter>assertion</parameter> and take appropriate - action if its result is &false;. + <parameter>assertion</parameter> and take appropriate action if + its result is &false;. </para> <para> If the <parameter>assertion</parameter> is given as a string it will be evaluated as PHP code by <function>assert</function>. - The advantages of a string <parameter>assertion</parameter> - are less overhead when assertion checking is off and messages + The advantages of a string <parameter>assertion</parameter> are + less overhead when assertion checking is off and messages containing the <parameter>assertion</parameter> expression when an assertion fails. </para> @@ -38,35 +38,36 @@ functions or certain system limits and features. </para> <para> - Assertions should not be used for normal runtime operations - like input parameter checks. As a rule of thumb your code - should always be able to work correctly if assertion checking - is not activated. + Assertions should not be used for normal runtime operations like + input parameter checks. As a rule of thumb your code should + always be able to work correctly if assertion checking is not + activated. </para> <para> - The behavior of <function>assert</function> may be configured - by <function>assert_options</function> or by .ini-settings - described in that functions manual page. + The behavior of <function>assert</function> may be configured by + <function>assert_options</function> or by .ini-settings described + in that functions manual page. </para> <para> The <function>assert_options</function> function and/or - ASSERT_CALLBACK configuration directive allow a callback - function to be set to handle failed assertions. + ASSERT_CALLBACK configuration directive allow a callback function + to be set to handle failed assertions. </para> <para> - <function>assert</function> callbacks are particularly - useful for building automated test suites because they - allow you to easily capture the code passed to the - assertion, along with information on where the assertion - was made. While this information can be captured via other - methods, using assertions makes it much faster and easier! + <function>assert</function> callbacks are particularly useful for + building automated test suites because they allow you to easily + capture the code passed to the assertion, along with information + on where the assertion was made. While this information can be + captured via other methods, using assertions makes it much faster + and easier! </para> <para> The callback function should accept three arguments. The first - argument will contain the file the assertion failed in. The second - argument will contain the line the assertion failed on and the - third argument will contain the expression that failed (if any - literal - values such as 1 or "two" will not be passed via this argument) + argument will contain the file the assertion failed in. The + second argument will contain the line the assertion failed on and + the third argument will contain the expression that failed (if + any - literal values such as 1 or "two" will not be passed via + this argument) </para> <para> <example> @@ -111,8 +112,7 @@ <funcprototype> <funcdef>mixed <function>assert_options</function></funcdef> <paramdef>int <parameter>what</parameter></paramdef> - <paramdef>mixed - <parameter><optional>value</optional></parameter> + <paramdef>mixed <parameter><optional>value</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> @@ -122,49 +122,49 @@ current settings. </para> <table> - <title>assert options</title> + <title>Assert Options</title> <tgroup cols="4"> <thead> <row> - <entry>option</entry> - <entry>ini-parameter</entry> - <entry>default</entry> - <entry>description</entry> + <entry>option</entry> + <entry>ini-parameter</entry> + <entry>default</entry> + <entry>description</entry> </row> </thead> <tbody> <row> - <entry>ASSERT_ACTIVE</entry> - <entry>assert.active</entry> - <entry>1</entry> - <entry>enable <function>assert</function> evaluation</entry> + <entry>ASSERT_ACTIVE</entry> + <entry>assert.active</entry> + <entry>1</entry> + <entry>enable <function>assert</function> evaluation</entry> </row> <row> - <entry>ASSERT_WARNING</entry> - <entry>assert.warning</entry> - <entry>1</entry> - <entry>issue a PHP warning for each failed assertion</entry> + <entry>ASSERT_WARNING</entry> + <entry>assert.warning</entry> + <entry>1</entry> + <entry>issue a PHP warning for each failed assertion</entry> </row> <row> - <entry>ASSERT_BAIL</entry> - <entry>assert.bail</entry> - <entry>0</entry> - <entry>terminate execution on failed assertions</entry> + <entry>ASSERT_BAIL</entry> + <entry>assert.bail</entry> + <entry>0</entry> + <entry>terminate execution on failed assertions</entry> </row> <row> - <entry>ASSERT_QUIET_EVAL</entry> - <entry>assert.quiet_eval</entry> - <entry>0</entry> - <entry> - disable error_reporting during assertion expression - evaluation - </entry> + <entry>ASSERT_QUIET_EVAL</entry> + <entry>assert.quiet_eval</entry> + <entry>0</entry> + <entry> + disable error_reporting during assertion expression + evaluation + </entry> </row> <row> - <entry>ASSERT_CALLBACK</entry> - <entry>assert_callback</entry> - <entry>(&null;)</entry> - <entry>user function to call on failed assertions</entry> + <entry>ASSERT_CALLBACK</entry> + <entry>assert_callback</entry> + <entry>(&null;)</entry> + <entry>user function to call on failed assertions</entry> </row> </tbody> </tgroup> @@ -179,7 +179,7 @@ <refentry id="function.extension-loaded"> <refnamediv> <refname>extension_loaded</refname> - <refpurpose>find out whether an extension is loaded</refpurpose> + <refpurpose>Find out whether an extension is loaded</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -208,7 +208,7 @@ <refentry id="function.dl"> <refnamediv> <refname>dl</refname> - <refpurpose>load a PHP extension at runtime</refpurpose> + <refpurpose>Loads a PHP extension at runtime</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -220,8 +220,8 @@ </funcsynopsis> <para> Loads the PHP extension defined in - <parameter>library</parameter>. See also the - <link linkend="ini.sect.extension">Extension Loading Directives</link> + <parameter>library</parameter>. See also the <link + linkend="ini.sect.extension">Extension Loading Directives</link> </para> </refsect1> </refentry> @@ -229,7 +229,7 @@ <refentry id="function.getenv"> <refnamediv> <refname>getenv</refname> - <refpurpose>Get the value of an environment variable</refpurpose> + <refpurpose>Gets the value of an environment variable</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -254,18 +254,17 @@ You can see a list of all the environmental variables by using <function>phpinfo</function>. You can find out what many of them mean by taking a look at the <ulink url="&url.cgispecs;">CGI - specification</ulink>, specifically the <ulink url="&url.cgispec;">page on - environmental variables</ulink>. + specification</ulink>, specifically the <ulink + url="&url.cgispec;">page on environmental variables</ulink>. <note> <para> This function does not work in ISAPI mode. </para> </note> </para> - <para> - See also - <function>putenv</function>. - </para> + <para> + See also <function>putenv</function>. + </para> </refsect1> </refentry> @@ -273,7 +272,7 @@ <refnamediv> <refname>get_cfg_var</refname> <refpurpose> - Get the value of a PHP configuration option. + Gets the value of a PHP configuration option </refpurpose> </refnamediv> <refsect1> @@ -286,8 +285,8 @@ </funcsynopsis> <simpara> Returns the current value of the PHP configuration variable - specified by <parameter>varname</parameter>, or &false; if an error - occurs. + specified by <parameter>varname</parameter>, or &false; if an + error occurs. </simpara> <simpara> It will not return configuration information set when the PHP was @@ -296,7 +295,7 @@ </simpara> <simpara> To check whether the system is using a <link - linkend="configuration.file">configuration file</link>, try + linkend="configuration.file">configuration file</link>, try retrieving the value of the cfg_file_path configuration setting. If this is available, a configuration file is being used. @@ -311,7 +310,7 @@ <refnamediv> <refname>get_current_user</refname> <refpurpose> - Get the name of the owner of the current PHP script. + Gets the name of the owner of the current PHP script </refpurpose> </refnamediv> <refsect1> @@ -327,10 +326,9 @@ </simpara> <simpara> See also <function>getmyuid</function>, - <function>getmygid</function>, - <function>getmypid</function>, - <function>getmyinode</function>, - and <function>getlastmod</function>. + <function>getmygid</function>, <function>getmypid</function>, + <function>getmyinode</function>, and + <function>getlastmod</function>. </simpara> </refsect1> </refentry> @@ -340,7 +338,7 @@ <refname>get_defined_constants</refname> <refpurpose> Returns an associative array with the names of all the constants - and their values. + and their values </refpurpose> </refnamediv> <refsect1> @@ -391,8 +389,7 @@ </informalexample> </para> <para> - See also - <function>get_loaded_extensions</function>. + See also <function>get_loaded_extensions</function>. </para> </refsect1> </refentry> @@ -424,7 +421,7 @@ print_r (get_extension_funcs ("xml")); print_r (get_extension_funcs ("gd")); ]]> - </programlisting> + </programlisting> </informalexample> will print a list of the functions in the modules <varname>xml</varname> and <varname>gd</varname> respectively. @@ -540,7 +537,7 @@ <para> See also: <function>include</function>, <function>include_once</function>, <function>require</function>, - <function>require_once</function> and + <function>require_once</function>, and <function>get_required_files</function>. </para> </refsect1> @@ -608,7 +605,7 @@ <refnamediv> <refname>get_magic_quotes_gpc</refname> <refpurpose> - Get the current active configuration setting of magic quotes gpc. + Gets the current active configuration setting of magic quotes gpc </refpurpose> </refnamediv> <refsect1> @@ -620,12 +617,12 @@ </funcprototype> </funcsynopsis> <simpara> - Returns the current active configuration setting of - <link linkend="ini.magic-quotes-gpc">magic_quotes_gpc</link>. - (0 for off, 1 for on). + Returns the current active configuration setting of <link + linkend="ini.magic-quotes-gpc">magic_quotes_gpc</link> (0 for + off, 1 for on). </simpara> <simpara> - See also <function>get_magic_quotes_runtime</function>, + See also <function>get_magic_quotes_runtime</function> and <function>set_magic_quotes_runtime</function>. </simpara> </refsect1> @@ -635,8 +632,8 @@ <refnamediv> <refname>get_magic_quotes_runtime</refname> <refpurpose> - Get the current active configuration setting of - magic_quotes_runtime. + Gets the current active configuration setting of + magic_quotes_runtime </refpurpose> </refnamediv> <refsect1> @@ -650,12 +647,12 @@ </funcprototype> </funcsynopsis> <simpara> - Returns the current active configuration setting of - <link linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link>. + Returns the current active configuration setting of <link + linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link> (0 for off, 1 for on). </simpara> <simpara> - See also <function>get_magic_quotes_gpc</function>, + See also <function>get_magic_quotes_gpc</function> and <function>set_magic_quotes_runtime</function>. </simpara> </refsect1> @@ -664,7 +661,7 @@ <refentry id="function.getlastmod"> <refnamediv> <refname>getlastmod</refname> - <refpurpose>Get time of last page modification.</refpurpose> + <refpurpose>Gets time of last page modification</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -683,15 +680,14 @@ <programlisting role="php"> <![CDATA[ // outputs e.g. 'Last modified: March 04 1998 20:43:59.' -echo "Last modified: ".date ("F d Y H:i:s.", getlastmod()); +echo "Last modified: " . date ("F d Y H:i:s.", getlastmod()); ]]> </programlisting> </example> </para> <para> See also <function>date</function>, - <function>getmyuid</function>, - <function>getmygid</function>, + <function>getmyuid</function>, <function>getmygid</function>, <function>get_current_user</function>, <function>getmyinode</function>, and <function>getmypid</function>. @@ -702,7 +698,7 @@ <refentry id="function.getmyinode"> <refnamediv> <refname>getmyinode</refname> - <refpurpose>Get the inode of the current script.</refpurpose> + <refpurpose>Gets the inode of the current script</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -729,7 +725,7 @@ <refentry id="function.getmypid"> <refnamediv> <refname>getmypid</refname> - <refpurpose>Get PHP's process ID.</refpurpose> + <refpurpose>Gets PHP's process ID</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -762,7 +758,7 @@ <refentry id="function.getmyuid"> <refnamediv> <refname>getmyuid</refname> - <refpurpose>Get PHP script owner's UID.</refpurpose> + <refpurpose>Gets PHP script owner's UID</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -810,13 +806,13 @@ files ended in the extension <literal>.php</literal>, other extensions would not be returned. The array returned by <function>get_required_files</function> was an associative array - and only listed files included by <function>require</function> and - <function>require_once</function>. + and only listed files included by <function>require</function> + and <function>require_once</function>. </para> <para> See also: <function>require</function>, <function>require_once</function>, <function>include</function>, - <function>include_once</function> and + <function>include_once</function>, and <function>get_included_files</function>. </para> </refsect1> @@ -825,7 +821,7 @@ <refentry id="function.getrusage"> <refnamediv> <refname>getrusage</refname> - <refpurpose>Get the current resource usages.</refpurpose> + <refpurpose>Gets the current resource usages</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -863,8 +859,10 @@ <refentry id="function.ini-alter"> <refnamediv> - <refname>ini_alter</refname> - <refpurpose>Change the value of a configuration option</refpurpose> + <refname>ini_alter</refname> + <refpurpose> + Changes the value of a configuration option + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -876,9 +874,9 @@ </funcprototype> </funcsynopsis> <para> - Changes the value of a configuration option, returns - &false; on failure, and the previous value of the - configuration option on success. + Changes the value of a configuration option, returns &false; on + failure, and the previous value of the configuration option on + success. </para> <note> <para> @@ -888,7 +886,7 @@ <para> See also <function>ini_get</function>, <function>ini_get_all</function>, - <function>ini_restore</function>, + <function>ini_restore</function>, and <function>ini_set</function> </para> </refsect1> @@ -897,7 +895,7 @@ <refentry id="function.ini-get"> <refnamediv> <refname>ini_get</refname> - <refpurpose>Get the value of a configuration option</refpurpose> + <refpurpose>Gets the value of a configuration option</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -908,14 +906,14 @@ </funcprototype> </funcsynopsis> <para> - Returns the value of the configuration option on success, - an empty string on failure. + Returns the value of the configuration option on success, an + empty string on failure. </para> <para> See also <function>get_cfg_var</function>, <function>ini_get_all</function>, <function>ini_alter</function>, - <function>ini_restore</function>, + <function>ini_restore</function>, and <function>ini_set</function> </para> </refsect1> @@ -924,7 +922,7 @@ <refentry id="function.ini-get-all"> <refnamediv> <refname>ini_get_all</refname> - <refpurpose>Get all configuration options</refpurpose> + <refpurpose>Gets all configuration options</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -937,15 +935,15 @@ </funcprototype> </funcsynopsis> <para> - Returns all the registered configuration options as an associative array. - If optional <parameter>extension</parameter> parameter is set, returns - only options specific for that extension. + Returns all the registered configuration options as an + associative array. If optional <parameter>extension</parameter> + parameter is set, returns only options specific for that + extension. </para> <para> - See also <function>ini_alter</function>, - <function>ini_restore</function>, - <function>ini_get</function>, - <function>ini_set</function> + See also: <function>ini_alter</function>, + <function>ini_restore</function>, <function>ini_get</function>, + and <function>ini_set</function> </para> </refsect1> </refentry> @@ -953,7 +951,7 @@ <refentry id="function.ini-restore"> <refnamediv> <refname>ini_restore</refname> - <refpurpose>Restore the value of a configuration option</refpurpose> + <refpurpose>Restores the value of a configuration option</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -967,10 +965,9 @@ Restores a given configuration option to its original value. </para> <para> - See also <function>ini_alter</function>, - <function>ini_get</function>, - <function>ini_get_all</function>, - <function>ini_set</function> + See also: <function>ini_alter</function>, + <function>ini_get</function>, <function>ini_get_all</function>, + and <function>ini_set</function> </para> </refsect1> </refentry> @@ -978,7 +975,7 @@ <refentry id="function.ini-set"> <refnamediv> <refname>ini_set</refname> - <refpurpose>Set the value of a configuration option</refpurpose> + <refpurpose>Sets the value of a configuration option</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -991,9 +988,9 @@ </funcsynopsis> <para> Sets the value of the given configuration option. Returns the old - value on success, &false; on failure. The configuration - option will keep this new value during the script's execution, - and will be restored at the script's ending. + value on success, &false; on failure. The configuration option + will keep this new value during the script's execution, and will + be restored at the script's ending. </para> <para> Not all the available options can be changed using @@ -1011,301 +1008,301 @@ </row> </thead> <tbody> - <row> - <entry>define_syslog_variables</entry> - <entry>"0"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>highlight.bg</entry> - <entry>HL_BG_COLOR</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>highlight.comment</entry> - <entry>HL_COMMENT_COLOR</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>highlight.default</entry> - <entry>HL_DEFAULT_COLOR</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>highlight.html</entry> - <entry>HL_HTML_COLOR</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>highlight.keyword</entry> - <entry>HL_KEYWORD_COLOR</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>highlight.string</entry> - <entry>HL_STRING_COLOR</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>allow_call_time_pass_reference</entry> - <entry>"1"</entry> - <entry>PHP_INI_SYSTEM|PHP_INI_PERDIR</entry> - </row> - <row> - <entry>asp_tags</entry> - <entry>"0"</entry> - <entry>PHP_INI_SYSTEM|PHP_INI_PERDIR</entry> - </row> - <row> - <entry>display_errors</entry> - <entry>"1"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>display_startup_errors</entry> - <entry>"0"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>enable_dl</entry> - <entry>"1"</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>error_append_string</entry> - <entry>&null;</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>error_prepend_string</entry> - <entry>&null;</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>expose_php</entry> - <entry>"1"</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>html_errors</entry> - <entry>"1"</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>ignore_user_abort</entry> - <entry>"0"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>implicit_flush</entry> - <entry>"0"</entry> - <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>log_errors</entry> - <entry>"0"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>magic_quotes_gpc</entry> - <entry>"1"</entry> - <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>magic_quotes_runtime</entry> - <entry>"0"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>magic_quotes_sybase</entry> - <entry>"0"</entry> - <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>output_buffering</entry> - <entry>"0"</entry> - <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>output_handler</entry> - <entry>&null;</entry> - <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>register_argc_argv</entry> - <entry>"1"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>register_globals</entry> - <entry>"1"</entry> - <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>safe_mode</entry> - <entry>"0"</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>short_open_tag</entry> - <entry>"1"</entry> - <entry>PHP_INI_SYSTEM|PHP_INI_PERDIR</entry> - </row> - <row> - <entry>sql.safe_mode</entry> - <entry>"0"</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>track_errors</entry> - <entry>"0"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>y2k_compliance</entry> - <entry>"0"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>arg_separator</entry> - <entry>"&"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>auto_append_file</entry> - <entry>&null;</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>auto_prepend_file</entry> - <entry>&null;</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>doc_root</entry> - <entry>&null;</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>default_charset</entry> - <entry>SAPI_DEFAULT_CHARSET</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>default_mimetype</entry> - <entry>SAPI_DEFAULT_MIMETYPE</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>error_log</entry> - <entry>&null;</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>extension_dir</entry> - <entry>PHP_EXTENSION_DIR</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>gpc_order</entry> - <entry>"GPC"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>include_path</entry> - <entry>PHP_INCLUDE_PATH</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>max_execution_time</entry> - <entry>"30"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>open_basedir</entry> - <entry>&null;</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>safe_mode_exec_dir</entry> - <entry>"1"</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>upload_max_filesize</entry> - <entry>"2M"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>file_uploads</entry> - <entry>"1"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>post_max_size</entry> - <entry>"8M"</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>upload_tmp_dir</entry> - <entry>&null;</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>user_dir</entry> - <entry>&null;</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>variables_order</entry> - <entry>&null;</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>SMTP</entry> - <entry>"localhost"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>browscap</entry> - <entry>&null;</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>error_reporting</entry> - <entry>&null;</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>memory_limit</entry> - <entry>"8M"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>precision</entry> - <entry>"14"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>sendmail_from</entry> - <entry>&null;</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>sendmail_path</entry> - <entry>DEFAULT_SENDMAIL_PATH</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>disable_functions</entry> - <entry>""</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>allow_url_fopen</entry> - <entry>"1"</entry> - <entry>PHP_INI_ALL</entry> - </row> + <row> + <entry>define_syslog_variables</entry> + <entry>"0"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>highlight.bg</entry> + <entry>HL_BG_COLOR</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>highlight.comment</entry> + <entry>HL_COMMENT_COLOR</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>highlight.default</entry> + <entry>HL_DEFAULT_COLOR</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>highlight.html</entry> + <entry>HL_HTML_COLOR</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>highlight.keyword</entry> + <entry>HL_KEYWORD_COLOR</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>highlight.string</entry> + <entry>HL_STRING_COLOR</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>allow_call_time_pass_reference</entry> + <entry>"1"</entry> + <entry>PHP_INI_SYSTEM|PHP_INI_PERDIR</entry> + </row> + <row> + <entry>asp_tags</entry> + <entry>"0"</entry> + <entry>PHP_INI_SYSTEM|PHP_INI_PERDIR</entry> + </row> + <row> + <entry>display_errors</entry> + <entry>"1"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>display_startup_errors</entry> + <entry>"0"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>enable_dl</entry> + <entry>"1"</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>error_append_string</entry> + <entry>&null;</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>error_prepend_string</entry> + <entry>&null;</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>expose_php</entry> + <entry>"1"</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>html_errors</entry> + <entry>"1"</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>ignore_user_abort</entry> + <entry>"0"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>implicit_flush</entry> + <entry>"0"</entry> + <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>log_errors</entry> + <entry>"0"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>magic_quotes_gpc</entry> + <entry>"1"</entry> + <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>magic_quotes_runtime</entry> + <entry>"0"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>magic_quotes_sybase</entry> + <entry>"0"</entry> + <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>output_buffering</entry> + <entry>"0"</entry> + <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>output_handler</entry> + <entry>&null;</entry> + <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>register_argc_argv</entry> + <entry>"1"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>register_globals</entry> + <entry>"1"</entry> + <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>safe_mode</entry> + <entry>"0"</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>short_open_tag</entry> + <entry>"1"</entry> + <entry>PHP_INI_SYSTEM|PHP_INI_PERDIR</entry> + </row> + <row> + <entry>sql.safe_mode</entry> + <entry>"0"</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>track_errors</entry> + <entry>"0"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>y2k_compliance</entry> + <entry>"0"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>arg_separator</entry> + <entry>"&"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>auto_append_file</entry> + <entry>&null;</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>auto_prepend_file</entry> + <entry>&null;</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>doc_root</entry> + <entry>&null;</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>default_charset</entry> + <entry>SAPI_DEFAULT_CHARSET</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>default_mimetype</entry> + <entry>SAPI_DEFAULT_MIMETYPE</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>error_log</entry> + <entry>&null;</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>extension_dir</entry> + <entry>PHP_EXTENSION_DIR</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>gpc_order</entry> + <entry>"GPC"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>include_path</entry> + <entry>PHP_INCLUDE_PATH</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>max_execution_time</entry> + <entry>"30"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>open_basedir</entry> + <entry>&null;</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>safe_mode_exec_dir</entry> + <entry>"1"</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>upload_max_filesize</entry> + <entry>"2M"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>file_uploads</entry> + <entry>"1"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>post_max_size</entry> + <entry>"8M"</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>upload_tmp_dir</entry> + <entry>&null;</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>user_dir</entry> + <entry>&null;</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>variables_order</entry> + <entry>&null;</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>SMTP</entry> + <entry>"localhost"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>browscap</entry> + <entry>&null;</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>error_reporting</entry> + <entry>&null;</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>memory_limit</entry> + <entry>"8M"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>precision</entry> + <entry>"14"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>sendmail_from</entry> + <entry>&null;</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>sendmail_path</entry> + <entry>DEFAULT_SENDMAIL_PATH</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>disable_functions</entry> + <entry>""</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>allow_url_fopen</entry> + <entry>"1"</entry> + <entry>PHP_INI_ALL</entry> + </row> </tbody> </tgroup> </table> @@ -1330,13 +1327,17 @@ <row> <entry>PHP_INI_PERDIR</entry> <entry>2</entry> - <entry>Entry can be set in <filename>.htaccess</filename></entry> + <entry> + Entry can be set in <filename>.htaccess</filename> + </entry> </row> <row> <entry>PHP_INI_SYSTEM</entry> <entry>4</entry> - <entry>Entry can be set in <filename>php.ini</filename> or - <filename>httpd.conf</filename></entry> + <entry> + Entry can be set in <filename>php.ini</filename> or + <filename>httpd.conf</filename> + </entry> </row> <row> <entry>PHP_INI_ALL</entry> @@ -1348,8 +1349,8 @@ </table> </para> <para> - See also <function>ini_alter</function>, - <function>ini_get</function>, + See also: <function>ini_alter</function>, + <function>ini_get</function>, and <function>ini_restore</function> </para> </refsect1> @@ -1358,7 +1359,7 @@ <refentry id="function.phpcredits"> <refnamediv> <refname>phpcredits</refname> - <refpurpose>Prints out the credits for PHP.</refpurpose> + <refpurpose>Prints out the credits for PHP</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -1372,9 +1373,9 @@ This function prints out the credits listing the PHP developers, modules, etc. It generates the appropriate HTML codes to insert the information in a page. A parameter indicating what will be - printed (a pre-defined constant flag, see table below) needs - to be passed. For example to print the general credits, you will - use somewhere in your code: + printed (a pre-defined constant flag, see table below) needs to + be passed. For example to print the general credits, you will use + somewhere in your code: <informalexample> <programlisting role="php"> <![CDATA[ @@ -1384,8 +1385,8 @@ ]]> </programlisting> </informalexample> - And if you want to print the core developers and the documentation - group, in a page of its own, you will use: + And if you want to print the core developers and the + documentation group, in a page of its own, you will use: <informalexample> <programlisting role="php"> <![CDATA[ @@ -1419,63 +1420,68 @@ <para> </para> <para> - <table> + <table> <title>Pre-defined <function>phpcredits</function> flags</title> <tgroup cols="2"> <thead> - <row> - <entry>name</entry> - <entry>description</entry> - </row> + <row> + <entry>name</entry> + <entry>description</entry> + </row> </thead> <tbody> - <row> - <entry>CREDITS_ALL</entry> - <entry> - All the credits, equivalent to using: CREDITS_DOCS + CREDITS_GENERAL + - CREDITS_GROUP + CREDITS_MODULES + CREDITS_FULLPAGE. It generates a - complete stand-alone HTML page with the appropriate tags. - </entry> - </row> - <row> - <entry>CREDITS_DOCS</entry> - <entry>The credits for the documentation team</entry> - </row> - <row> - <entry>CREDITS_FULLPAGE</entry> - <entry> - Usually used in combination with the other flags. - Indicates that the a complete stand-alone HTML page - needs to be printed including the information indicated - by the other flags. - </entry> - </row> - <row> - <entry>CREDITS_GENERAL</entry> - <entry> - General credits: Language design and concept, PHP 4.0 authors - and SAPI module. - </entry> - </row> - <row> - <entry>CREDITS_GROUP</entry> - <entry>A list of the core developers</entry> - </row> - <row> - <entry>CREDITS_MODULES</entry> - <entry>A list of the extension modules for PHP, and their authors</entry> - </row> - <row> - <entry>CREDITS_SAPI</entry> - <entry>A list of the server API modules for PHP, and their authors</entry> - </row> + <row> + <entry>CREDITS_ALL</entry> + <entry> + All the credits, equivalent to using: CREDITS_DOCS + + CREDITS_GENERAL + CREDITS_GROUP + CREDITS_MODULES + + CREDITS_FULLPAGE. It generates a complete stand-alone HTML + page with the appropriate tags. + </entry> + </row> + <row> + <entry>CREDITS_DOCS</entry> + <entry>The credits for the documentation team</entry> + </row> + <row> + <entry>CREDITS_FULLPAGE</entry> + <entry> + Usually used in combination with the other flags. Indicates + that the a complete stand-alone HTML page needs to be + printed including the information indicated by the other + flags. + </entry> + </row> + <row> + <entry>CREDITS_GENERAL</entry> + <entry> + General credits: Language design and concept, PHP 4.0 + authors and SAPI module. + </entry> + </row> + <row> + <entry>CREDITS_GROUP</entry> + <entry>A list of the core developers</entry> + </row> + <row> + <entry>CREDITS_MODULES</entry> + <entry> + A list of the extension modules for PHP, and their authors + </entry> + </row> + <row> + <entry>CREDITS_SAPI</entry> + <entry> + A list of the server API modules for PHP, and their authors + </entry> + </row> </tbody> </tgroup> </table> </para> <para> - See also <function>phpinfo</function>, - <function>phpversion</function>, + See also: <function>phpinfo</function>, + <function>phpversion</function>, and <function>php_logo_guid</function>. </para> </refsect1> @@ -1484,7 +1490,7 @@ <refentry id="function.phpinfo"> <refnamediv> <refname>phpinfo</refname> - <refpurpose>Output lots of PHP information.</refpurpose> + <refpurpose>Outputs lots of PHP information</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -1494,111 +1500,113 @@ <paramdef>int <parameter><optional>what</optional></parameter></paramdef> </funcprototype> </funcsynopsis> - <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> + 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. - <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 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 <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"> + <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 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 <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 @@ -1611,31 +1619,32 @@ ?> ]]> - </programlisting> - </example> - </para> - - <note> - <para> - Parts of the information displayed are disabled when the - <literal>expose_php</literal> configuration setting is set to - <literal>off</literal>. This includes the PHP and Zend logos, and the - credits. - </para> - </note> - <para> - See also <function>phpversion</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> + </programlisting> + </example> + </para> + <note> + <para> + Parts of the information displayed are disabled when the + <literal>expose_php</literal> configuration setting is set to + <literal>off</literal>. This includes the PHP and Zend logos, + and the credits. + </para> + </note> + <para> + See also: <function>phpversion</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> <refentry id="function.phpversion"> <refnamediv> <refname>phpversion</refname> - <refpurpose>Get the current PHP version.</refpurpose> + <refpurpose>Gets the current PHP version</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -1651,13 +1660,13 @@ </para> <note> <para> - This information is also available in the predefined constant + This information is also available in the predefined constant <constant>PHP_VERSION</constant>. </para> </note> <para> <example> - <title><function>phpversion</function> example</title> + <title><function>phpversion</function> Example</title> <programlisting role="php"> <![CDATA[ <?php @@ -1670,9 +1679,8 @@ </para> <para> See also <function>version_compare</function>, - <function>phpinfo</function>, - <function>phpcredits</function>, - <function>php_logo_guid</function>, + <function>phpinfo</function>, <function>phpcredits</function>, + <function>php_logo_guid</function>, and <function>zend_version</function>. </para> </refsect1> @@ -1681,7 +1689,7 @@ <refentry id="function.php-logo-guid"> <refnamediv> <refname>php_logo_guid</refname> - <refpurpose>Get the logo guid</refpurpose> + <refpurpose>Gets the logo guid</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -1697,9 +1705,9 @@ </para> </note> <para> - See also <function>phpinfo</function>. - <function>phpversion</function>, - <function>phpcredits</function> + See also: <function>phpinfo</function>, + <function>phpversion</function>, and + <function>phpcredits</function>. </para> </refsect1> </refentry> @@ -1720,10 +1728,10 @@ </funcprototype> </funcsynopsis> <simpara> - <function>php_sapi_name</function> returns a lowercase string which - describes the type of interface between web server and PHP - (Server API, SAPI). In CGI PHP, this string is "cgi", in - mod_php for Apache, this string is "apache" and so on. + <function>php_sapi_name</function> returns a lowercase string + which describes the type of interface between web server and PHP + (Server API, SAPI). In CGI PHP, this string is "cgi", in mod_php + for Apache, this string is "apache" and so on. </simpara> <para> <example> @@ -1732,9 +1740,9 @@ <![CDATA[ $sapi_type = php_sapi_name(); if ($sapi_type == "cgi") - print "You are using CGI PHP\n"; + print "You are using CGI PHP\n"; else - print "You are not using CGI PHP\n"; + print "You are not using CGI PHP\n"; ]]> </programlisting> </example> @@ -1758,8 +1766,8 @@ </funcprototype> </funcsynopsis> <simpara> - <function>php_uname</function> returns a string with a description - of the operating system PHP is built on. + <function>php_uname</function> returns a string with a + description of the operating system PHP is built on. </simpara> <para> <example> @@ -1767,10 +1775,10 @@ <programlisting role="php"> <![CDATA[ if (substr(php_uname(), 0, 7) == "Windows") { - die("Sorry, this script doesn't run on Windows.\n"); + die ("Sorry, this script doesn't run on Windows.\n"); } ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> @@ -1779,7 +1787,7 @@ <refentry id="function.putenv"> <refnamediv> <refname>putenv</refname> - <refpurpose>Set the value of an environment variable.</refpurpose> + <refpurpose>Sets the value of an environment variable</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -1790,31 +1798,34 @@ </funcprototype> </funcsynopsis> <para> - Adds <parameter>setting</parameter> to the server environment. The - environment variable will only exist for the duration of the current - request. At the end of the request the environment is restored to - its original state. + Adds <parameter>setting</parameter> to the server environment. + The environment variable will only exist for the duration of the + current request. At the end of the request the environment is + restored to its original state. </para> <para> - Setting certain environment variables may be a potential security breach. - The <literal>safe_mode_allowed_env_vars</literal> directive contains a - comma-delimited list of prefixes. In Safe Mode, the user may only - alter environment variables whose names begin with the prefixes - supplied by this directive. By default, users will only be able - to set environment variables that begin with <literal>PHP_</literal> - (e.g. <literal>PHP_FOO=BAR</literal>). Note: if this directive is empty, - PHP will let the user modify ANY environment variable! + Setting certain environment variables may be a potential security + breach. The <literal>safe_mode_allowed_env_vars</literal> + directive contains a comma-delimited list of prefixes. In Safe + Mode, the user may only alter environment variables whose names + begin with the prefixes supplied by this directive. By default, + users will only be able to set environment variables that begin + with <literal>PHP_</literal> + (e.g. <literal>PHP_FOO=BAR</literal>). Note: if this directive is + empty, PHP will let the user modify ANY environment variable! </para> <para> The <literal>safe_mode_protected_env_vars</literal> directive contains a comma-delimited list of environment variables, that - the end user won't be able to change using <function>putenv</function>. - These variables will be protected even if <literal>safe_mode_allowed_env_vars</literal> - is set to allow to change them. + the end user won't be able to change using + <function>putenv</function>. These variables will be protected + even if <literal>safe_mode_allowed_env_vars</literal> is set to + allow to change them. </para> <warning> <para> - These directives have only effect when <link linkend="features.safe-mode">safe-mode</link> itself is enabled! + These directives have only effect when <link + linkend="features.safe-mode">safe-mode</link> itself is enabled! </para> </warning> <para> @@ -1827,10 +1838,9 @@ </programlisting> </example> </para> - <para> - See also - <function>getenv</function>. - </para> + <para> + See also <function>getenv</function>. + </para> </refsect1> </refentry> @@ -1838,8 +1848,8 @@ <refnamediv> <refname>set_magic_quotes_runtime</refname> <refpurpose> - Set the current active configuration setting of - magic_quotes_runtime. + Sets the current active configuration setting of + magic_quotes_runtime </refpurpose> </refnamediv> <refsect1> @@ -1854,11 +1864,11 @@ </funcsynopsis> <simpara> Set the current active configuration setting of <link - linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link>. - (0 for off, 1 for on) + linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link> (0 + for off, 1 for on). </simpara> <simpara> - See also <function>get_magic_quotes_gpc</function>, + See also: <function>get_magic_quotes_gpc</function> and <function>get_magic_quotes_runtime</function>. </simpara> </refsect1> @@ -1867,7 +1877,7 @@ <refentry id="function.set-time-limit"> <refnamediv> <refname>set_time_limit</refname> - <refpurpose>limit the maximum execution time</refpurpose> + <refpurpose>Limits the maximum execution time</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -1893,9 +1903,9 @@ total of 45 seconds before timing out. </simpara> <simpara> - <function>set_time_limit</function> has no effect when - PHP is running in safe mode. There is no workaround other than - turning off safe mode or changing the time limit in the <link + <function>set_time_limit</function> has no effect when PHP is + running in safe mode. There is no workaround other than turning + off safe mode or changing the time limit in the <link linkend="ini.max-execution-time">configuration file</link>. </simpara> <note> @@ -1917,7 +1927,9 @@ <refentry id="function.version-compare"> <refnamediv> <refname>version_compare</refname> - <refpurpose>Compares two "PHP-standardized" version number strings</refpurpose> + <refpurpose> + Compares two "PHP-standardized" version number strings + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -1934,35 +1946,33 @@ </funcprototype> </funcsynopsis> <para> - <function>version_compare</function> compares - two "PHP-standardized" version number strings. This - is useful if you would like to write programs working - only on some versions of PHP. + <function>version_compare</function> compares two + "PHP-standardized" version number strings. This is useful if you + would like to write programs working only on some versions of + PHP. </para> <para> - <function>version_compare</function> returns -1 if - the first version is lower than the second, 0 if they - are equal, and +1 if the second is lower. + <function>version_compare</function> returns -1 if the first + version is lower than the second, 0 if they are equal, and +1 if + the second is lower. </para> <para> - If you specify the third optional - <parameter>operator</parameter> argument, you - can test for a particular relationship. The possible - operators are: <literal><</literal>, + If you specify the third optional <parameter>operator</parameter> + argument, you can test for a particular relationship. The + possible operators are: <literal><</literal>, <literal>lt</literal>, <literal><=</literal>, <literal>le</literal>, <literal>></literal>, <literal>gt</literal>, <literal>>=</literal>, <literal>ge</literal>, <literal>==</literal>, <literal>=</literal>, <literal>eq</literal>, <literal>!=</literal>, <literal><></literal>, - <literal>ne</literal> respectively. Using - this argument, the function will return 1 if - the relationship is the one specified by the - operator, 0 otherwise. + <literal>ne</literal> respectively. Using this argument, the + function will return 1 if the relationship is the one specified + by the operator, 0 otherwise. </para> <para> <example> - <title><function>version_compare</function> example</title> + <title><function>version_compare</function> Example</title> <programlisting role="php"> <![CDATA[ // prints -1 @@ -1981,7 +1991,7 @@ <refentry id="function.zend-logo-guid"> <refnamediv> <refname>zend_logo_guid</refname> - <refpurpose>Get the zend guid</refpurpose> + <refpurpose>Gets the zend guid</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -2002,7 +2012,7 @@ <refentry id="function.zend-version"> <refnamediv> <refname>zend_version</refname> - <refpurpose>Get the version of the current Zend engine.</refpurpose> + <refpurpose>Gets the version of the current Zend engine</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -2016,11 +2026,11 @@ Returns a string containing the version of the currently running PHP parser. <example> - <title><function>zend_version</function> example</title> + <title><function>zend_version</function> Example</title> <programlisting role="php"> <![CDATA[ // prints e.g. 'Zend engine version: 1.0.4' -echo "Zend engine version: ".zend_version(); +echo "Zend engine version: " . zend_version(); ]]> </programlisting> </example> @@ -2028,12 +2038,12 @@ <para> See also <function>phpinfo</function>, <function>phpcredits</function>, - <function>php_logo_guid</function> + <function>php_logo_guid</function>, and <function>phpversion</function>. </para> </refsect1> </refentry> - + </reference> <!-- Keep this comment at the end of the file
Index: phpdoc/en/functions/info.xml diff -u phpdoc/en/functions/info.xml:1.88 phpdoc/en/functions/info.xml:1.89 --- phpdoc/en/functions/info.xml:1.88 Tue Jan 22 23:24:26 2002 +++ phpdoc/en/functions/info.xml Wed Jan 23 02:32:57 2002 @@ -1,8 +1,8 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.88 $ --> +<!-- $Revision: 1.89 $ --> <reference id="ref.info"> - <title>PHP options & information</title> - <titleabbrev>PHP options/info</titleabbrev> + <title>PHP Options&Information</title> + <titleabbrev>PHP Options/Info</titleabbrev> <refentry id="function.assert"> <refnamediv> @@ -19,14 +19,14 @@ </funcsynopsis> <para> <function>assert</function> will check the given - <parameter>assertion</parameter> and take appropriate - action if its result is &false;. + <parameter>assertion</parameter> and take appropriate action if + its result is &false;. </para> <para> If the <parameter>assertion</parameter> is given as a string it will be evaluated as PHP code by <function>assert</function>. - The advantages of a string <parameter>assertion</parameter> - are less overhead when assertion checking is off and messages + The advantages of a string <parameter>assertion</parameter> are + less overhead when assertion checking is off and messages containing the <parameter>assertion</parameter> expression when an assertion fails. </para> @@ -38,35 +38,36 @@ functions or certain system limits and features. </para> <para> - Assertions should not be used for normal runtime operations - like input parameter checks. As a rule of thumb your code - should always be able to work correctly if assertion checking - is not activated. + Assertions should not be used for normal runtime operations like + input parameter checks. As a rule of thumb your code should + always be able to work correctly if assertion checking is not + activated. </para> <para> - The behavior of <function>assert</function> may be configured - by <function>assert_options</function> or by .ini-settings - described in that functions manual page. + The behavior of <function>assert</function> may be configured by + <function>assert_options</function> or by .ini-settings described + in that functions manual page. </para> <para> The <function>assert_options</function> function and/or - ASSERT_CALLBACK configuration directive allow a callback - function to be set to handle failed assertions. + ASSERT_CALLBACK configuration directive allow a callback function + to be set to handle failed assertions. </para> <para> - <function>assert</function> callbacks are particularly - useful for building automated test suites because they - allow you to easily capture the code passed to the - assertion, along with information on where the assertion - was made. While this information can be captured via other - methods, using assertions makes it much faster and easier! + <function>assert</function> callbacks are particularly useful for + building automated test suites because they allow you to easily + capture the code passed to the assertion, along with information + on where the assertion was made. While this information can be + captured via other methods, using assertions makes it much faster + and easier! </para> <para> The callback function should accept three arguments. The first - argument will contain the file the assertion failed in. The second - argument will contain the line the assertion failed on and the - third argument will contain the expression that failed (if any - literal - values such as 1 or "two" will not be passed via this argument) + argument will contain the file the assertion failed in. The + second argument will contain the line the assertion failed on and + the third argument will contain the expression that failed (if + any - literal values such as 1 or "two" will not be passed via + this argument) </para> <para> <example> @@ -111,8 +112,7 @@ <funcprototype> <funcdef>mixed <function>assert_options</function></funcdef> <paramdef>int <parameter>what</parameter></paramdef> - <paramdef>mixed - <parameter><optional>value</optional></parameter> + <paramdef>mixed <parameter><optional>value</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> @@ -122,49 +122,49 @@ current settings. </para> <table> - <title>assert options</title> + <title>Assert Options</title> <tgroup cols="4"> <thead> <row> - <entry>option</entry> - <entry>ini-parameter</entry> - <entry>default</entry> - <entry>description</entry> + <entry>option</entry> + <entry>ini-parameter</entry> + <entry>default</entry> + <entry>description</entry> </row> </thead> <tbody> <row> - <entry>ASSERT_ACTIVE</entry> - <entry>assert.active</entry> - <entry>1</entry> - <entry>enable <function>assert</function> evaluation</entry> + <entry>ASSERT_ACTIVE</entry> + <entry>assert.active</entry> + <entry>1</entry> + <entry>enable <function>assert</function> evaluation</entry> </row> <row> - <entry>ASSERT_WARNING</entry> - <entry>assert.warning</entry> - <entry>1</entry> - <entry>issue a PHP warning for each failed assertion</entry> + <entry>ASSERT_WARNING</entry> + <entry>assert.warning</entry> + <entry>1</entry> + <entry>issue a PHP warning for each failed assertion</entry> </row> <row> - <entry>ASSERT_BAIL</entry> - <entry>assert.bail</entry> - <entry>0</entry> - <entry>terminate execution on failed assertions</entry> + <entry>ASSERT_BAIL</entry> + <entry>assert.bail</entry> + <entry>0</entry> + <entry>terminate execution on failed assertions</entry> </row> <row> - <entry>ASSERT_QUIET_EVAL</entry> - <entry>assert.quiet_eval</entry> - <entry>0</entry> - <entry> - disable error_reporting during assertion expression - evaluation - </entry> + <entry>ASSERT_QUIET_EVAL</entry> + <entry>assert.quiet_eval</entry> + <entry>0</entry> + <entry> + disable error_reporting during assertion expression + evaluation + </entry> </row> <row> - <entry>ASSERT_CALLBACK</entry> - <entry>assert_callback</entry> - <entry>(&null;)</entry> - <entry>user function to call on failed assertions</entry> + <entry>ASSERT_CALLBACK</entry> + <entry>assert_callback</entry> + <entry>(&null;)</entry> + <entry>user function to call on failed assertions</entry> </row> </tbody> </tgroup> @@ -179,7 +179,7 @@ <refentry id="function.extension-loaded"> <refnamediv> <refname>extension_loaded</refname> - <refpurpose>find out whether an extension is loaded</refpurpose> + <refpurpose>Find out whether an extension is loaded</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -208,7 +208,7 @@ <refentry id="function.dl"> <refnamediv> <refname>dl</refname> - <refpurpose>load a PHP extension at runtime</refpurpose> + <refpurpose>Loads a PHP extension at runtime</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -220,8 +220,8 @@ </funcsynopsis> <para> Loads the PHP extension defined in - <parameter>library</parameter>. See also the - <link linkend="ini.sect.extension">Extension Loading Directives</link> + <parameter>library</parameter>. See also the <link + linkend="ini.sect.extension">Extension Loading Directives</link> </para> </refsect1> </refentry> @@ -229,7 +229,7 @@ <refentry id="function.getenv"> <refnamediv> <refname>getenv</refname> - <refpurpose>Get the value of an environment variable</refpurpose> + <refpurpose>Gets the value of an environment variable</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -254,18 +254,17 @@ You can see a list of all the environmental variables by using <function>phpinfo</function>. You can find out what many of them mean by taking a look at the <ulink url="&url.cgispecs;">CGI - specification</ulink>, specifically the <ulink url="&url.cgispec;">page on - environmental variables</ulink>. + specification</ulink>, specifically the <ulink + url="&url.cgispec;">page on environmental variables</ulink>. <note> <para> This function does not work in ISAPI mode. </para> </note> </para> - <para> - See also - <function>putenv</function>. - </para> + <para> + See also <function>putenv</function>. + </para> </refsect1> </refentry> @@ -273,7 +272,7 @@ <refnamediv> <refname>get_cfg_var</refname> <refpurpose> - Get the value of a PHP configuration option. + Gets the value of a PHP configuration option </refpurpose> </refnamediv> <refsect1> @@ -286,8 +285,8 @@ </funcsynopsis> <simpara> Returns the current value of the PHP configuration variable - specified by <parameter>varname</parameter>, or &false; if an error - occurs. + specified by <parameter>varname</parameter>, or &false; if an + error occurs. </simpara> <simpara> It will not return configuration information set when the PHP was @@ -296,7 +295,7 @@ </simpara> <simpara> To check whether the system is using a <link - linkend="configuration.file">configuration file</link>, try + linkend="configuration.file">configuration file</link>, try retrieving the value of the cfg_file_path configuration setting. If this is available, a configuration file is being used. @@ -311,7 +310,7 @@ <refnamediv> <refname>get_current_user</refname> <refpurpose> - Get the name of the owner of the current PHP script. + Gets the name of the owner of the current PHP script </refpurpose> </refnamediv> <refsect1> @@ -327,10 +326,9 @@ </simpara> <simpara> See also <function>getmyuid</function>, - <function>getmygid</function>, - <function>getmypid</function>, - <function>getmyinode</function>, - and <function>getlastmod</function>. + <function>getmygid</function>, <function>getmypid</function>, + <function>getmyinode</function>, and + <function>getlastmod</function>. </simpara> </refsect1> </refentry> @@ -340,7 +338,7 @@ <refname>get_defined_constants</refname> <refpurpose> Returns an associative array with the names of all the constants - and their values. + and their values </refpurpose> </refnamediv> <refsect1> @@ -391,8 +389,7 @@ </informalexample> </para> <para> - See also - <function>get_loaded_extensions</function>. + See also <function>get_loaded_extensions</function>. </para> </refsect1> </refentry> @@ -424,7 +421,7 @@ print_r (get_extension_funcs ("xml")); print_r (get_extension_funcs ("gd")); ]]> - </programlisting> + </programlisting> </informalexample> will print a list of the functions in the modules <varname>xml</varname> and <varname>gd</varname> respectively. @@ -540,7 +537,7 @@ <para> See also: <function>include</function>, <function>include_once</function>, <function>require</function>, - <function>require_once</function> and + <function>require_once</function>, and <function>get_required_files</function>. </para> </refsect1> @@ -608,7 +605,7 @@ <refnamediv> <refname>get_magic_quotes_gpc</refname> <refpurpose> - Get the current active configuration setting of magic quotes gpc. + Gets the current active configuration setting of magic quotes gpc </refpurpose> </refnamediv> <refsect1> @@ -620,12 +617,12 @@ </funcprototype> </funcsynopsis> <simpara> - Returns the current active configuration setting of - <link linkend="ini.magic-quotes-gpc">magic_quotes_gpc</link>. - (0 for off, 1 for on). + Returns the current active configuration setting of <link + linkend="ini.magic-quotes-gpc">magic_quotes_gpc</link> (0 for + off, 1 for on). </simpara> <simpara> - See also <function>get_magic_quotes_runtime</function>, + See also <function>get_magic_quotes_runtime</function> and <function>set_magic_quotes_runtime</function>. </simpara> </refsect1> @@ -635,8 +632,8 @@ <refnamediv> <refname>get_magic_quotes_runtime</refname> <refpurpose> - Get the current active configuration setting of - magic_quotes_runtime. + Gets the current active configuration setting of + magic_quotes_runtime </refpurpose> </refnamediv> <refsect1> @@ -650,12 +647,12 @@ </funcprototype> </funcsynopsis> <simpara> - Returns the current active configuration setting of - <link linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link>. + Returns the current active configuration setting of <link + linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link> (0 for off, 1 for on). </simpara> <simpara> - See also <function>get_magic_quotes_gpc</function>, + See also <function>get_magic_quotes_gpc</function> and <function>set_magic_quotes_runtime</function>. </simpara> </refsect1> @@ -664,7 +661,7 @@ <refentry id="function.getlastmod"> <refnamediv> <refname>getlastmod</refname> - <refpurpose>Get time of last page modification.</refpurpose> + <refpurpose>Gets time of last page modification</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -683,15 +680,14 @@ <programlisting role="php"> <![CDATA[ // outputs e.g. 'Last modified: March 04 1998 20:43:59.' -echo "Last modified: ".date ("F d Y H:i:s.", getlastmod()); +echo "Last modified: " . date ("F d Y H:i:s.", getlastmod()); ]]> </programlisting> </example> </para> <para> See also <function>date</function>, - <function>getmyuid</function>, - <function>getmygid</function>, + <function>getmyuid</function>, <function>getmygid</function>, <function>get_current_user</function>, <function>getmyinode</function>, and <function>getmypid</function>. @@ -702,7 +698,7 @@ <refentry id="function.getmyinode"> <refnamediv> <refname>getmyinode</refname> - <refpurpose>Get the inode of the current script.</refpurpose> + <refpurpose>Gets the inode of the current script</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -729,7 +725,7 @@ <refentry id="function.getmypid"> <refnamediv> <refname>getmypid</refname> - <refpurpose>Get PHP's process ID.</refpurpose> + <refpurpose>Gets PHP's process ID</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -762,7 +758,7 @@ <refentry id="function.getmyuid"> <refnamediv> <refname>getmyuid</refname> - <refpurpose>Get PHP script owner's UID.</refpurpose> + <refpurpose>Gets PHP script owner's UID</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -810,13 +806,13 @@ files ended in the extension <literal>.php</literal>, other extensions would not be returned. The array returned by <function>get_required_files</function> was an associative array - and only listed files included by <function>require</function> and - <function>require_once</function>. + and only listed files included by <function>require</function> + and <function>require_once</function>. </para> <para> See also: <function>require</function>, <function>require_once</function>, <function>include</function>, - <function>include_once</function> and + <function>include_once</function>, and <function>get_included_files</function>. </para> </refsect1> @@ -825,7 +821,7 @@ <refentry id="function.getrusage"> <refnamediv> <refname>getrusage</refname> - <refpurpose>Get the current resource usages.</refpurpose> + <refpurpose>Gets the current resource usages</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -863,8 +859,10 @@ <refentry id="function.ini-alter"> <refnamediv> - <refname>ini_alter</refname> - <refpurpose>Change the value of a configuration option</refpurpose> + <refname>ini_alter</refname> + <refpurpose> + Changes the value of a configuration option + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -876,9 +874,9 @@ </funcprototype> </funcsynopsis> <para> - Changes the value of a configuration option, returns - &false; on failure, and the previous value of the - configuration option on success. + Changes the value of a configuration option, returns &false; on + failure, and the previous value of the configuration option on + success. </para> <note> <para> @@ -888,7 +886,7 @@ <para> See also <function>ini_get</function>, <function>ini_get_all</function>, - <function>ini_restore</function>, + <function>ini_restore</function>, and <function>ini_set</function> </para> </refsect1> @@ -897,7 +895,7 @@ <refentry id="function.ini-get"> <refnamediv> <refname>ini_get</refname> - <refpurpose>Get the value of a configuration option</refpurpose> + <refpurpose>Gets the value of a configuration option</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -908,14 +906,14 @@ </funcprototype> </funcsynopsis> <para> - Returns the value of the configuration option on success, - an empty string on failure. + Returns the value of the configuration option on success, an + empty string on failure. </para> <para> See also <function>get_cfg_var</function>, <function>ini_get_all</function>, <function>ini_alter</function>, - <function>ini_restore</function>, + <function>ini_restore</function>, and <function>ini_set</function> </para> </refsect1> @@ -924,7 +922,7 @@ <refentry id="function.ini-get-all"> <refnamediv> <refname>ini_get_all</refname> - <refpurpose>Get all configuration options</refpurpose> + <refpurpose>Gets all configuration options</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -937,15 +935,15 @@ </funcprototype> </funcsynopsis> <para> - Returns all the registered configuration options as an associative array. - If optional <parameter>extension</parameter> parameter is set, returns - only options specific for that extension. + Returns all the registered configuration options as an + associative array. If optional <parameter>extension</parameter> + parameter is set, returns only options specific for that + extension. </para> <para> - See also <function>ini_alter</function>, - <function>ini_restore</function>, - <function>ini_get</function>, - <function>ini_set</function> + See also: <function>ini_alter</function>, + <function>ini_restore</function>, <function>ini_get</function>, + and <function>ini_set</function> </para> </refsect1> </refentry> @@ -953,7 +951,7 @@ <refentry id="function.ini-restore"> <refnamediv> <refname>ini_restore</refname> - <refpurpose>Restore the value of a configuration option</refpurpose> + <refpurpose>Restores the value of a configuration option</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -967,10 +965,9 @@ Restores a given configuration option to its original value. </para> <para> - See also <function>ini_alter</function>, - <function>ini_get</function>, - <function>ini_get_all</function>, - <function>ini_set</function> + See also: <function>ini_alter</function>, + <function>ini_get</function>, <function>ini_get_all</function>, + and <function>ini_set</function> </para> </refsect1> </refentry> @@ -978,7 +975,7 @@ <refentry id="function.ini-set"> <refnamediv> <refname>ini_set</refname> - <refpurpose>Set the value of a configuration option</refpurpose> + <refpurpose>Sets the value of a configuration option</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -991,9 +988,9 @@ </funcsynopsis> <para> Sets the value of the given configuration option. Returns the old - value on success, &false; on failure. The configuration - option will keep this new value during the script's execution, - and will be restored at the script's ending. + value on success, &false; on failure. The configuration option + will keep this new value during the script's execution, and will + be restored at the script's ending. </para> <para> Not all the available options can be changed using @@ -1011,301 +1008,301 @@ </row> </thead> <tbody> - <row> - <entry>define_syslog_variables</entry> - <entry>"0"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>highlight.bg</entry> - <entry>HL_BG_COLOR</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>highlight.comment</entry> - <entry>HL_COMMENT_COLOR</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>highlight.default</entry> - <entry>HL_DEFAULT_COLOR</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>highlight.html</entry> - <entry>HL_HTML_COLOR</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>highlight.keyword</entry> - <entry>HL_KEYWORD_COLOR</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>highlight.string</entry> - <entry>HL_STRING_COLOR</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>allow_call_time_pass_reference</entry> - <entry>"1"</entry> - <entry>PHP_INI_SYSTEM|PHP_INI_PERDIR</entry> - </row> - <row> - <entry>asp_tags</entry> - <entry>"0"</entry> - <entry>PHP_INI_SYSTEM|PHP_INI_PERDIR</entry> - </row> - <row> - <entry>display_errors</entry> - <entry>"1"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>display_startup_errors</entry> - <entry>"0"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>enable_dl</entry> - <entry>"1"</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>error_append_string</entry> - <entry>&null;</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>error_prepend_string</entry> - <entry>&null;</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>expose_php</entry> - <entry>"1"</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>html_errors</entry> - <entry>"1"</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>ignore_user_abort</entry> - <entry>"0"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>implicit_flush</entry> - <entry>"0"</entry> - <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>log_errors</entry> - <entry>"0"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>magic_quotes_gpc</entry> - <entry>"1"</entry> - <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>magic_quotes_runtime</entry> - <entry>"0"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>magic_quotes_sybase</entry> - <entry>"0"</entry> - <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>output_buffering</entry> - <entry>"0"</entry> - <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>output_handler</entry> - <entry>&null;</entry> - <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>register_argc_argv</entry> - <entry>"1"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>register_globals</entry> - <entry>"1"</entry> - <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>safe_mode</entry> - <entry>"0"</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>short_open_tag</entry> - <entry>"1"</entry> - <entry>PHP_INI_SYSTEM|PHP_INI_PERDIR</entry> - </row> - <row> - <entry>sql.safe_mode</entry> - <entry>"0"</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>track_errors</entry> - <entry>"0"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>y2k_compliance</entry> - <entry>"0"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>arg_separator</entry> - <entry>"&"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>auto_append_file</entry> - <entry>&null;</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>auto_prepend_file</entry> - <entry>&null;</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>doc_root</entry> - <entry>&null;</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>default_charset</entry> - <entry>SAPI_DEFAULT_CHARSET</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>default_mimetype</entry> - <entry>SAPI_DEFAULT_MIMETYPE</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>error_log</entry> - <entry>&null;</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>extension_dir</entry> - <entry>PHP_EXTENSION_DIR</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>gpc_order</entry> - <entry>"GPC"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>include_path</entry> - <entry>PHP_INCLUDE_PATH</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>max_execution_time</entry> - <entry>"30"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>open_basedir</entry> - <entry>&null;</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>safe_mode_exec_dir</entry> - <entry>"1"</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>upload_max_filesize</entry> - <entry>"2M"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>file_uploads</entry> - <entry>"1"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>post_max_size</entry> - <entry>"8M"</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>upload_tmp_dir</entry> - <entry>&null;</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>user_dir</entry> - <entry>&null;</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>variables_order</entry> - <entry>&null;</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>SMTP</entry> - <entry>"localhost"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>browscap</entry> - <entry>&null;</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>error_reporting</entry> - <entry>&null;</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>memory_limit</entry> - <entry>"8M"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>precision</entry> - <entry>"14"</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>sendmail_from</entry> - <entry>&null;</entry> - <entry>PHP_INI_ALL</entry> - </row> - <row> - <entry>sendmail_path</entry> - <entry>DEFAULT_SENDMAIL_PATH</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>disable_functions</entry> - <entry>""</entry> - <entry>PHP_INI_SYSTEM</entry> - </row> - <row> - <entry>allow_url_fopen</entry> - <entry>"1"</entry> - <entry>PHP_INI_ALL</entry> - </row> + <row> + <entry>define_syslog_variables</entry> + <entry>"0"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>highlight.bg</entry> + <entry>HL_BG_COLOR</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>highlight.comment</entry> + <entry>HL_COMMENT_COLOR</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>highlight.default</entry> + <entry>HL_DEFAULT_COLOR</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>highlight.html</entry> + <entry>HL_HTML_COLOR</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>highlight.keyword</entry> + <entry>HL_KEYWORD_COLOR</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>highlight.string</entry> + <entry>HL_STRING_COLOR</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>allow_call_time_pass_reference</entry> + <entry>"1"</entry> + <entry>PHP_INI_SYSTEM|PHP_INI_PERDIR</entry> + </row> + <row> + <entry>asp_tags</entry> + <entry>"0"</entry> + <entry>PHP_INI_SYSTEM|PHP_INI_PERDIR</entry> + </row> + <row> + <entry>display_errors</entry> + <entry>"1"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>display_startup_errors</entry> + <entry>"0"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>enable_dl</entry> + <entry>"1"</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>error_append_string</entry> + <entry>&null;</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>error_prepend_string</entry> + <entry>&null;</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>expose_php</entry> + <entry>"1"</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>html_errors</entry> + <entry>"1"</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>ignore_user_abort</entry> + <entry>"0"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>implicit_flush</entry> + <entry>"0"</entry> + <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>log_errors</entry> + <entry>"0"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>magic_quotes_gpc</entry> + <entry>"1"</entry> + <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>magic_quotes_runtime</entry> + <entry>"0"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>magic_quotes_sybase</entry> + <entry>"0"</entry> + <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>output_buffering</entry> + <entry>"0"</entry> + <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>output_handler</entry> + <entry>&null;</entry> + <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>register_argc_argv</entry> + <entry>"1"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>register_globals</entry> + <entry>"1"</entry> + <entry>PHP_INI_PERDIR|PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>safe_mode</entry> + <entry>"0"</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>short_open_tag</entry> + <entry>"1"</entry> + <entry>PHP_INI_SYSTEM|PHP_INI_PERDIR</entry> + </row> + <row> + <entry>sql.safe_mode</entry> + <entry>"0"</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>track_errors</entry> + <entry>"0"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>y2k_compliance</entry> + <entry>"0"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>arg_separator</entry> + <entry>"&"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>auto_append_file</entry> + <entry>&null;</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>auto_prepend_file</entry> + <entry>&null;</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>doc_root</entry> + <entry>&null;</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>default_charset</entry> + <entry>SAPI_DEFAULT_CHARSET</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>default_mimetype</entry> + <entry>SAPI_DEFAULT_MIMETYPE</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>error_log</entry> + <entry>&null;</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>extension_dir</entry> + <entry>PHP_EXTENSION_DIR</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>gpc_order</entry> + <entry>"GPC"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>include_path</entry> + <entry>PHP_INCLUDE_PATH</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>max_execution_time</entry> + <entry>"30"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>open_basedir</entry> + <entry>&null;</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>safe_mode_exec_dir</entry> + <entry>"1"</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>upload_max_filesize</entry> + <entry>"2M"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>file_uploads</entry> + <entry>"1"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>post_max_size</entry> + <entry>"8M"</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>upload_tmp_dir</entry> + <entry>&null;</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>user_dir</entry> + <entry>&null;</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>variables_order</entry> + <entry>&null;</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>SMTP</entry> + <entry>"localhost"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>browscap</entry> + <entry>&null;</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>error_reporting</entry> + <entry>&null;</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>memory_limit</entry> + <entry>"8M"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>precision</entry> + <entry>"14"</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>sendmail_from</entry> + <entry>&null;</entry> + <entry>PHP_INI_ALL</entry> + </row> + <row> + <entry>sendmail_path</entry> + <entry>DEFAULT_SENDMAIL_PATH</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>disable_functions</entry> + <entry>""</entry> + <entry>PHP_INI_SYSTEM</entry> + </row> + <row> + <entry>allow_url_fopen</entry> + <entry>"1"</entry> + <entry>PHP_INI_ALL</entry> + </row> </tbody> </tgroup> </table> @@ -1330,13 +1327,17 @@ <row> <entry>PHP_INI_PERDIR</entry> <entry>2</entry> - <entry>Entry can be set in <filename>.htaccess</filename></entry> + <entry> + Entry can be set in <filename>.htaccess</filename> + </entry> </row> <row> <entry>PHP_INI_SYSTEM</entry> <entry>4</entry> - <entry>Entry can be set in <filename>php.ini</filename> or - <filename>httpd.conf</filename></entry> + <entry> + Entry can be set in <filename>php.ini</filename> or + <filename>httpd.conf</filename> + </entry> </row> <row> <entry>PHP_INI_ALL</entry> @@ -1348,8 +1349,8 @@ </table> </para> <para> - See also <function>ini_alter</function>, - <function>ini_get</function>, + See also: <function>ini_alter</function>, + <function>ini_get</function>, and <function>ini_restore</function> </para> </refsect1> @@ -1358,7 +1359,7 @@ <refentry id="function.phpcredits"> <refnamediv> <refname>phpcredits</refname> - <refpurpose>Prints out the credits for PHP.</refpurpose> + <refpurpose>Prints out the credits for PHP</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -1372,9 +1373,9 @@ This function prints out the credits listing the PHP developers, modules, etc. It generates the appropriate HTML codes to insert the information in a page. A parameter indicating what will be - printed (a pre-defined constant flag, see table below) needs - to be passed. For example to print the general credits, you will - use somewhere in your code: + printed (a pre-defined constant flag, see table below) needs to + be passed. For example to print the general credits, you will use + somewhere in your code: <informalexample> <programlisting role="php"> <![CDATA[ @@ -1384,8 +1385,8 @@ ]]> </programlisting> </informalexample> - And if you want to print the core developers and the documentation - group, in a page of its own, you will use: + And if you want to print the core developers and the + documentation group, in a page of its own, you will use: <informalexample> <programlisting role="php"> <![CDATA[ @@ -1419,63 +1420,68 @@ <para> </para> <para> - <table> + <table> <title>Pre-defined <function>phpcredits</function> flags</title> <tgroup cols="2"> <thead> - <row> - <entry>name</entry> - <entry>description</entry> - </row> + <row> + <entry>name</entry> + <entry>description</entry> + </row> </thead> <tbody> - <row> - <entry>CREDITS_ALL</entry> - <entry> - All the credits, equivalent to using: CREDITS_DOCS + CREDITS_GENERAL + - CREDITS_GROUP + CREDITS_MODULES + CREDITS_FULLPAGE. It generates a - complete stand-alone HTML page with the appropriate tags. - </entry> - </row> - <row> - <entry>CREDITS_DOCS</entry> - <entry>The credits for the documentation team</entry> - </row> - <row> - <entry>CREDITS_FULLPAGE</entry> - <entry> - Usually used in combination with the other flags. - Indicates that the a complete stand-alone HTML page - needs to be printed including the information indicated - by the other flags. - </entry> - </row> - <row> - <entry>CREDITS_GENERAL</entry> - <entry> - General credits: Language design and concept, PHP 4.0 authors - and SAPI module. - </entry> - </row> - <row> - <entry>CREDITS_GROUP</entry> - <entry>A list of the core developers</entry> - </row> - <row> - <entry>CREDITS_MODULES</entry> - <entry>A list of the extension modules for PHP, and their authors</entry> - </row> - <row> - <entry>CREDITS_SAPI</entry> - <entry>A list of the server API modules for PHP, and their authors</entry> - </row> + <row> + <entry>CREDITS_ALL</entry> + <entry> + All the credits, equivalent to using: CREDITS_DOCS + + CREDITS_GENERAL + CREDITS_GROUP + CREDITS_MODULES + + CREDITS_FULLPAGE. It generates a complete stand-alone HTML + page with the appropriate tags. + </entry> + </row> + <row> + <entry>CREDITS_DOCS</entry> + <entry>The credits for the documentation team</entry> + </row> + <row> + <entry>CREDITS_FULLPAGE</entry> + <entry> + Usually used in combination with the other flags. Indicates + that the a complete stand-alone HTML page needs to be + printed including the information indicated by the other + flags. + </entry> + </row> + <row> + <entry>CREDITS_GENERAL</entry> + <entry> + General credits: Language design and concept, PHP 4.0 + authors and SAPI module. + </entry> + </row> + <row> + <entry>CREDITS_GROUP</entry> + <entry>A list of the core developers</entry> + </row> + <row> + <entry>CREDITS_MODULES</entry> + <entry> + A list of the extension modules for PHP, and their authors + </entry> + </row> + <row> + <entry>CREDITS_SAPI</entry> + <entry> + A list of the server API modules for PHP, and their authors + </entry> + </row> </tbody> </tgroup> </table> </para> <para> - See also <function>phpinfo</function>, - <function>phpversion</function>, + See also: <function>phpinfo</function>, + <function>phpversion</function>, and <function>php_logo_guid</function>. </para> </refsect1> @@ -1484,7 +1490,7 @@ <refentry id="function.phpinfo"> <refnamediv> <refname>phpinfo</refname> - <refpurpose>Output lots of PHP information.</refpurpose> + <refpurpose>Outputs lots of PHP information</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -1494,111 +1500,113 @@ <paramdef>int <parameter><optional>what</optional></parameter></paramdef> </funcprototype> </funcsynopsis> - <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> + 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. - <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 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 <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"> + <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 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 <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 @@ -1611,31 +1619,32 @@ ?> ]]> - </programlisting> - </example> - </para> - - <note> - <para> - Parts of the information displayed are disabled when the - <literal>expose_php</literal> configuration setting is set to - <literal>off</literal>. This includes the PHP and Zend logos, and the - credits. - </para> - </note> - <para> - See also <function>phpversion</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> + </programlisting> + </example> + </para> + <note> + <para> + Parts of the information displayed are disabled when the + <literal>expose_php</literal> configuration setting is set to + <literal>off</literal>. This includes the PHP and Zend logos, + and the credits. + </para> + </note> + <para> + See also: <function>phpversion</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> <refentry id="function.phpversion"> <refnamediv> <refname>phpversion</refname> - <refpurpose>Get the current PHP version.</refpurpose> + <refpurpose>Gets the current PHP version</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -1651,13 +1660,13 @@ </para> <note> <para> - This information is also available in the predefined constant + This information is also available in the predefined constant <constant>PHP_VERSION</constant>. </para> </note> <para> <example> - <title><function>phpversion</function> example</title> + <title><function>phpversion</function> Example</title> <programlisting role="php"> <![CDATA[ <?php @@ -1670,9 +1679,8 @@ </para> <para> See also <function>version_compare</function>, - <function>phpinfo</function>, - <function>phpcredits</function>, - <function>php_logo_guid</function>, + <function>phpinfo</function>, <function>phpcredits</function>, + <function>php_logo_guid</function>, and <function>zend_version</function>. </para> </refsect1> @@ -1681,7 +1689,7 @@ <refentry id="function.php-logo-guid"> <refnamediv> <refname>php_logo_guid</refname> - <refpurpose>Get the logo guid</refpurpose> + <refpurpose>Gets the logo guid</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -1697,9 +1705,9 @@ </para> </note> <para> - See also <function>phpinfo</function>. - <function>phpversion</function>, - <function>phpcredits</function> + See also: <function>phpinfo</function>, + <function>phpversion</function>, and + <function>phpcredits</function>. </para> </refsect1> </refentry> @@ -1720,10 +1728,10 @@ </funcprototype> </funcsynopsis> <simpara> - <function>php_sapi_name</function> returns a lowercase string which - describes the type of interface between web server and PHP - (Server API, SAPI). In CGI PHP, this string is "cgi", in - mod_php for Apache, this string is "apache" and so on. + <function>php_sapi_name</function> returns a lowercase string + which describes the type of interface between web server and PHP + (Server API, SAPI). In CGI PHP, this string is "cgi", in mod_php + for Apache, this string is "apache" and so on. </simpara> <para> <example> @@ -1732,9 +1740,9 @@ <![CDATA[ $sapi_type = php_sapi_name(); if ($sapi_type == "cgi") - print "You are using CGI PHP\n"; + print "You are using CGI PHP\n"; else - print "You are not using CGI PHP\n"; + print "You are not using CGI PHP\n"; ]]> </programlisting> </example> @@ -1758,8 +1766,8 @@ </funcprototype> </funcsynopsis> <simpara> - <function>php_uname</function> returns a string with a description - of the operating system PHP is built on. + <function>php_uname</function> returns a string with a + description of the operating system PHP is built on. </simpara> <para> <example> @@ -1767,10 +1775,10 @@ <programlisting role="php"> <![CDATA[ if (substr(php_uname(), 0, 7) == "Windows") { - die("Sorry, this script doesn't run on Windows.\n"); + die ("Sorry, this script doesn't run on Windows.\n"); } ]]> - </programlisting> + </programlisting> </example> </para> </refsect1> @@ -1779,7 +1787,7 @@ <refentry id="function.putenv"> <refnamediv> <refname>putenv</refname> - <refpurpose>Set the value of an environment variable.</refpurpose> + <refpurpose>Sets the value of an environment variable</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -1790,31 +1798,34 @@ </funcprototype> </funcsynopsis> <para> - Adds <parameter>setting</parameter> to the server environment. The - environment variable will only exist for the duration of the current - request. At the end of the request the environment is restored to - its original state. + Adds <parameter>setting</parameter> to the server environment. + The environment variable will only exist for the duration of the + current request. At the end of the request the environment is + restored to its original state. </para> <para> - Setting certain environment variables may be a potential security breach. - The <literal>safe_mode_allowed_env_vars</literal> directive contains a - comma-delimited list of prefixes. In Safe Mode, the user may only - alter environment variables whose names begin with the prefixes - supplied by this directive. By default, users will only be able - to set environment variables that begin with <literal>PHP_</literal> - (e.g. <literal>PHP_FOO=BAR</literal>). Note: if this directive is empty, - PHP will let the user modify ANY environment variable! + Setting certain environment variables may be a potential security + breach. The <literal>safe_mode_allowed_env_vars</literal> + directive contains a comma-delimited list of prefixes. In Safe + Mode, the user may only alter environment variables whose names + begin with the prefixes supplied by this directive. By default, + users will only be able to set environment variables that begin + with <literal>PHP_</literal> + (e.g. <literal>PHP_FOO=BAR</literal>). Note: if this directive is + empty, PHP will let the user modify ANY environment variable! </para> <para> The <literal>safe_mode_protected_env_vars</literal> directive contains a comma-delimited list of environment variables, that - the end user won't be able to change using <function>putenv</function>. - These variables will be protected even if <literal>safe_mode_allowed_env_vars</literal> - is set to allow to change them. + the end user won't be able to change using + <function>putenv</function>. These variables will be protected + even if <literal>safe_mode_allowed_env_vars</literal> is set to + allow to change them. </para> <warning> <para> - These directives have only effect when <link linkend="features.safe-mode">safe-mode</link> itself is enabled! + These directives have only effect when <link + linkend="features.safe-mode">safe-mode</link> itself is enabled! </para> </warning> <para> @@ -1827,10 +1838,9 @@ </programlisting> </example> </para> - <para> - See also - <function>getenv</function>. - </para> + <para> + See also <function>getenv</function>. + </para> </refsect1> </refentry> @@ -1838,8 +1848,8 @@ <refnamediv> <refname>set_magic_quotes_runtime</refname> <refpurpose> - Set the current active configuration setting of - magic_quotes_runtime. + Sets the current active configuration setting of + magic_quotes_runtime </refpurpose> </refnamediv> <refsect1> @@ -1854,11 +1864,11 @@ </funcsynopsis> <simpara> Set the current active configuration setting of <link - linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link>. - (0 for off, 1 for on) + linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link> (0 + for off, 1 for on). </simpara> <simpara> - See also <function>get_magic_quotes_gpc</function>, + See also: <function>get_magic_quotes_gpc</function> and <function>get_magic_quotes_runtime</function>. </simpara> </refsect1> @@ -1867,7 +1877,7 @@ <refentry id="function.set-time-limit"> <refnamediv> <refname>set_time_limit</refname> - <refpurpose>limit the maximum execution time</refpurpose> + <refpurpose>Limits the maximum execution time</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -1893,9 +1903,9 @@ total of 45 seconds before timing out. </simpara> <simpara> - <function>set_time_limit</function> has no effect when - PHP is running in safe mode. There is no workaround other than - turning off safe mode or changing the time limit in the <link + <function>set_time_limit</function> has no effect when PHP is + running in safe mode. There is no workaround other than turning + off safe mode or changing the time limit in the <link linkend="ini.max-execution-time">configuration file</link>. </simpara> <note> @@ -1917,7 +1927,9 @@ <refentry id="function.version-compare"> <refnamediv> <refname>version_compare</refname> - <refpurpose>Compares two "PHP-standardized" version number strings</refpurpose> + <refpurpose> + Compares two "PHP-standardized" version number strings + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -1934,35 +1946,33 @@ </funcprototype> </funcsynopsis> <para> - <function>version_compare</function> compares - two "PHP-standardized" version number strings. This - is useful if you would like to write programs working - only on some versions of PHP. + <function>version_compare</function> compares two + "PHP-standardized" version number strings. This is useful if you + would like to write programs working only on some versions of + PHP. </para> <para> - <function>version_compare</function> returns -1 if - the first version is lower than the second, 0 if they - are equal, and +1 if the second is lower. + <function>version_compare</function> returns -1 if the first + version is lower than the second, 0 if they are equal, and +1 if + the second is lower. </para> <para> - If you specify the third optional - <parameter>operator</parameter> argument, you - can test for a particular relationship. The possible - operators are: <literal><</literal>, + If you specify the third optional <parameter>operator</parameter> + argument, you can test for a particular relationship. The + possible operators are: <literal><</literal>, <literal>lt</literal>, <literal><=</literal>, <literal>le</literal>, <literal>></literal>, <literal>gt</literal>, <literal>>=</literal>, <literal>ge</literal>, <literal>==</literal>, <literal>=</literal>, <literal>eq</literal>, <literal>!=</literal>, <literal><></literal>, - <literal>ne</literal> respectively. Using - this argument, the function will return 1 if - the relationship is the one specified by the - operator, 0 otherwise. + <literal>ne</literal> respectively. Using this argument, the + function will return 1 if the relationship is the one specified + by the operator, 0 otherwise. </para> <para> <example> - <title><function>version_compare</function> example</title> + <title><function>version_compare</function> Example</title> <programlisting role="php"> <![CDATA[ // prints -1 @@ -1981,7 +1991,7 @@ <refentry id="function.zend-logo-guid"> <refnamediv> <refname>zend_logo_guid</refname> - <refpurpose>Get the zend guid</refpurpose> + <refpurpose>Gets the zend guid</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -2002,7 +2012,7 @@ <refentry id="function.zend-version"> <refnamediv> <refname>zend_version</refname> - <refpurpose>Get the version of the current Zend engine.</refpurpose> + <refpurpose>Gets the version of the current Zend engine</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -2016,11 +2026,11 @@ Returns a string containing the version of the currently running PHP parser. <example> - <title><function>zend_version</function> example</title> + <title><function>zend_version</function> Example</title> <programlisting role="php"> <![CDATA[ // prints e.g. 'Zend engine version: 1.0.4' -echo "Zend engine version: ".zend_version(); +echo "Zend engine version: " . zend_version(); ]]> </programlisting> </example> @@ -2028,12 +2038,12 @@ <para> See also <function>phpinfo</function>, <function>phpcredits</function>, - <function>php_logo_guid</function> + <function>php_logo_guid</function>, and <function>phpversion</function>. </para> </refsect1> </refentry> - + </reference> <!-- Keep this comment at the end of the file