From 6d5418df5912f31d5998facca6f95d3669d07650 Mon Sep 17 00:00:00 2001 From: Egon Schmid Date: Wed, 23 Jan 2002 07:32:57 +0000 Subject: [PATCH] Fixed the whitespace fix. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@68433 c90b9560-bf6c-de11-be94-00142212c4b1 --- functions/info.xml | 1364 ++++++++++++++++++++++---------------------- 1 file changed, 687 insertions(+), 677 deletions(-) diff --git a/functions/info.xml b/functions/info.xml index a5f77bbcb1..7c31aeb35d 100644 --- a/functions/info.xml +++ b/functions/info.xml @@ -1,8 +1,8 @@ - + - PHP options & information - PHP options/info + PHP Options&Information + PHP Options/Info @@ -19,14 +19,14 @@ assert will check the given - assertion and take appropriate - action if its result is &false;. + assertion and take appropriate action if + its result is &false;. If the assertion is given as a string it will be evaluated as PHP code by assert. - The advantages of a string assertion - are less overhead when assertion checking is off and messages + The advantages of a string assertion are + less overhead when assertion checking is off and messages containing the assertion expression when an assertion fails. @@ -38,35 +38,36 @@ functions or certain system limits and features. - 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. - The behavior of assert may be configured - by assert_options or by .ini-settings - described in that functions manual page. + The behavior of assert may be configured by + assert_options or by .ini-settings described + in that functions manual page. The assert_options 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. - assert 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! + assert 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! 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) @@ -111,8 +112,7 @@ assert ('mysql_query ("")'); mixed assert_options int what - mixed - value + mixed value @@ -122,49 +122,49 @@ assert ('mysql_query ("")'); current settings. - assert options + Assert Options - option - ini-parameter - default - description + option + ini-parameter + default + description - ASSERT_ACTIVE - assert.active - 1 - enable assert evaluation + ASSERT_ACTIVE + assert.active + 1 + enable assert evaluation - ASSERT_WARNING - assert.warning - 1 - issue a PHP warning for each failed assertion + ASSERT_WARNING + assert.warning + 1 + issue a PHP warning for each failed assertion - ASSERT_BAIL - assert.bail - 0 - terminate execution on failed assertions + ASSERT_BAIL + assert.bail + 0 + terminate execution on failed assertions - ASSERT_QUIET_EVAL - assert.quiet_eval - 0 - - disable error_reporting during assertion expression - evaluation - + ASSERT_QUIET_EVAL + assert.quiet_eval + 0 + + disable error_reporting during assertion expression + evaluation + - ASSERT_CALLBACK - assert_callback - (&null;) - user function to call on failed assertions + ASSERT_CALLBACK + assert_callback + (&null;) + user function to call on failed assertions @@ -179,7 +179,7 @@ assert ('mysql_query ("")'); extension_loaded - find out whether an extension is loaded + Find out whether an extension is loaded Description @@ -208,7 +208,7 @@ assert ('mysql_query ("")'); dl - load a PHP extension at runtime + Loads a PHP extension at runtime Description @@ -220,8 +220,8 @@ assert ('mysql_query ("")'); Loads the PHP extension defined in - library. See also the - Extension Loading Directives + library. See also the Extension Loading Directives @@ -229,7 +229,7 @@ assert ('mysql_query ("")'); getenv - Get the value of an environment variable + Gets the value of an environment variable Description @@ -254,18 +254,17 @@ $ip = getenv ("REMOTE_ADDR"); // get the ip number of the user You can see a list of all the environmental variables by using phpinfo. You can find out what many of them mean by taking a look at the CGI - specification, specifically the page on - environmental variables. + specification, specifically the page on environmental variables. This function does not work in ISAPI mode. - - See also - putenv. - + + See also putenv. + @@ -273,7 +272,7 @@ $ip = getenv ("REMOTE_ADDR"); // get the ip number of the user get_cfg_var - Get the value of a PHP configuration option. + Gets the value of a PHP configuration option @@ -286,8 +285,8 @@ $ip = getenv ("REMOTE_ADDR"); // get the ip number of the user Returns the current value of the PHP configuration variable - specified by varname, or &false; if an error - occurs. + specified by varname, or &false; if an + error occurs. It will not return configuration information set when the PHP was @@ -296,7 +295,7 @@ $ip = getenv ("REMOTE_ADDR"); // get the ip number of the user To check whether the system is using a configuration file, try + linkend="configuration.file">configuration file, 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 @@ $ip = getenv ("REMOTE_ADDR"); // get the ip number of the user get_current_user - Get the name of the owner of the current PHP script. + Gets the name of the owner of the current PHP script @@ -327,10 +326,9 @@ $ip = getenv ("REMOTE_ADDR"); // get the ip number of the user See also getmyuid, - getmygid, - getmypid, - getmyinode, - and getlastmod. + getmygid, getmypid, + getmyinode, and + getlastmod. @@ -340,7 +338,7 @@ $ip = getenv ("REMOTE_ADDR"); // get the ip number of the user get_defined_constants Returns an associative array with the names of all the constants - and their values. + and their values @@ -391,8 +389,7 @@ Array - See also - get_loaded_extensions. + See also get_loaded_extensions. @@ -424,7 +421,7 @@ Array print_r (get_extension_funcs ("xml")); print_r (get_extension_funcs ("gd")); ]]> - + will print a list of the functions in the modules xml and gd respectively. @@ -540,7 +537,7 @@ test4.php See also: include, include_once, require, - require_once and + require_once, and get_required_files. @@ -608,7 +605,7 @@ Array get_magic_quotes_gpc - Get the current active configuration setting of magic quotes gpc. + Gets the current active configuration setting of magic quotes gpc @@ -620,12 +617,12 @@ Array - Returns the current active configuration setting of - magic_quotes_gpc. - (0 for off, 1 for on). + Returns the current active configuration setting of magic_quotes_gpc (0 for + off, 1 for on). - See also get_magic_quotes_runtime, + See also get_magic_quotes_runtime and set_magic_quotes_runtime. @@ -635,8 +632,8 @@ Array get_magic_quotes_runtime - Get the current active configuration setting of - magic_quotes_runtime. + Gets the current active configuration setting of + magic_quotes_runtime @@ -650,12 +647,12 @@ Array - Returns the current active configuration setting of - magic_quotes_runtime. + Returns the current active configuration setting of magic_quotes_runtime (0 for off, 1 for on). - See also get_magic_quotes_gpc, + See also get_magic_quotes_gpc and set_magic_quotes_runtime. @@ -664,7 +661,7 @@ Array getlastmod - Get time of last page modification. + Gets time of last page modification Description @@ -683,15 +680,14 @@ Array See also date, - getmyuid, - getmygid, + getmyuid, getmygid, get_current_user, getmyinode, and getmypid. @@ -702,7 +698,7 @@ echo "Last modified: ".date ("F d Y H:i:s.", getlastmod()); getmyinode - Get the inode of the current script. + Gets the inode of the current script Description @@ -729,7 +725,7 @@ echo "Last modified: ".date ("F d Y H:i:s.", getlastmod()); getmypid - Get PHP's process ID. + Gets PHP's process ID Description @@ -762,7 +758,7 @@ echo "Last modified: ".date ("F d Y H:i:s.", getlastmod()); getmyuid - Get PHP script owner's UID. + Gets PHP script owner's UID Description @@ -810,13 +806,13 @@ echo "Last modified: ".date ("F d Y H:i:s.", getlastmod()); files ended in the extension .php, other extensions would not be returned. The array returned by get_required_files was an associative array - and only listed files included by require and - require_once. + and only listed files included by require + and require_once. See also: require, require_once, include, - include_once and + include_once, and get_included_files. @@ -825,7 +821,7 @@ echo "Last modified: ".date ("F d Y H:i:s.", getlastmod()); getrusage - Get the current resource usages. + Gets the current resource usages Description @@ -863,8 +859,10 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds) - ini_alter - Change the value of a configuration option + ini_alter + + Changes the value of a configuration option + Description @@ -876,9 +874,9 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds) - 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. @@ -888,7 +886,7 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds) See also ini_get, ini_get_all, - ini_restore, + ini_restore, and ini_set @@ -897,7 +895,7 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds) ini_get - Get the value of a configuration option + Gets the value of a configuration option Description @@ -908,14 +906,14 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds) - 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. See also get_cfg_var, ini_get_all, ini_alter, - ini_restore, + ini_restore, and ini_set @@ -924,7 +922,7 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds) ini_get_all - Get all configuration options + Gets all configuration options Description @@ -937,15 +935,15 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds) - Returns all the registered configuration options as an associative array. - If optional extension parameter is set, returns - only options specific for that extension. + Returns all the registered configuration options as an + associative array. If optional extension + parameter is set, returns only options specific for that + extension. - See also ini_alter, - ini_restore, - ini_get, - ini_set + See also: ini_alter, + ini_restore, ini_get, + and ini_set @@ -953,7 +951,7 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds) ini_restore - Restore the value of a configuration option + Restores the value of a configuration option Description @@ -967,10 +965,9 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds) Restores a given configuration option to its original value. - See also ini_alter, - ini_get, - ini_get_all, - ini_set + See also: ini_alter, + ini_get, ini_get_all, + and ini_set @@ -978,7 +975,7 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds) ini_set - Set the value of a configuration option + Sets the value of a configuration option Description @@ -991,9 +988,9 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds) 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. Not all the available options can be changed using @@ -1011,301 +1008,301 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds) - - define_syslog_variables - "0" - PHP_INI_ALL - - - highlight.bg - HL_BG_COLOR - PHP_INI_ALL - - - highlight.comment - HL_COMMENT_COLOR - PHP_INI_ALL - - - highlight.default - HL_DEFAULT_COLOR - PHP_INI_ALL - - - highlight.html - HL_HTML_COLOR - PHP_INI_ALL - - - highlight.keyword - HL_KEYWORD_COLOR - PHP_INI_ALL - - - highlight.string - HL_STRING_COLOR - PHP_INI_ALL - - - allow_call_time_pass_reference - "1" - PHP_INI_SYSTEM|PHP_INI_PERDIR - - - asp_tags - "0" - PHP_INI_SYSTEM|PHP_INI_PERDIR - - - display_errors - "1" - PHP_INI_ALL - - - display_startup_errors - "0" - PHP_INI_ALL - - - enable_dl - "1" - PHP_INI_SYSTEM - - - error_append_string - &null; - PHP_INI_ALL - - - error_prepend_string - &null; - PHP_INI_ALL - - - expose_php - "1" - PHP_INI_SYSTEM - - - html_errors - "1" - PHP_INI_SYSTEM - - - ignore_user_abort - "0" - PHP_INI_ALL - - - implicit_flush - "0" - PHP_INI_PERDIR|PHP_INI_SYSTEM - - - log_errors - "0" - PHP_INI_ALL - - - magic_quotes_gpc - "1" - PHP_INI_PERDIR|PHP_INI_SYSTEM - - - magic_quotes_runtime - "0" - PHP_INI_ALL - - - magic_quotes_sybase - "0" - PHP_INI_PERDIR|PHP_INI_SYSTEM - - - output_buffering - "0" - PHP_INI_PERDIR|PHP_INI_SYSTEM - - - output_handler - &null; - PHP_INI_PERDIR|PHP_INI_SYSTEM - - - register_argc_argv - "1" - PHP_INI_ALL - - - register_globals - "1" - PHP_INI_PERDIR|PHP_INI_SYSTEM - - - safe_mode - "0" - PHP_INI_SYSTEM - - - short_open_tag - "1" - PHP_INI_SYSTEM|PHP_INI_PERDIR - - - sql.safe_mode - "0" - PHP_INI_SYSTEM - - - track_errors - "0" - PHP_INI_ALL - - - y2k_compliance - "0" - PHP_INI_ALL - - - arg_separator - "&" - PHP_INI_ALL - - - auto_append_file - &null; - PHP_INI_ALL - - - auto_prepend_file - &null; - PHP_INI_ALL - - - doc_root - &null; - PHP_INI_SYSTEM - - - default_charset - SAPI_DEFAULT_CHARSET - PHP_INI_ALL - - - default_mimetype - SAPI_DEFAULT_MIMETYPE - PHP_INI_ALL - - - error_log - &null; - PHP_INI_ALL - - - extension_dir - PHP_EXTENSION_DIR - PHP_INI_SYSTEM - - - gpc_order - "GPC" - PHP_INI_ALL - - - include_path - PHP_INCLUDE_PATH - PHP_INI_ALL - - - max_execution_time - "30" - PHP_INI_ALL - - - open_basedir - &null; - PHP_INI_SYSTEM - - - safe_mode_exec_dir - "1" - PHP_INI_SYSTEM - - - upload_max_filesize - "2M" - PHP_INI_ALL - - - file_uploads - "1" - PHP_INI_ALL - - - post_max_size - "8M" - PHP_INI_SYSTEM - - - upload_tmp_dir - &null; - PHP_INI_SYSTEM - - - user_dir - &null; - PHP_INI_SYSTEM - - - variables_order - &null; - PHP_INI_ALL - - - SMTP - "localhost" - PHP_INI_ALL - - - browscap - &null; - PHP_INI_SYSTEM - - - error_reporting - &null; - PHP_INI_ALL - - - memory_limit - "8M" - PHP_INI_ALL - - - precision - "14" - PHP_INI_ALL - - - sendmail_from - &null; - PHP_INI_ALL - - - sendmail_path - DEFAULT_SENDMAIL_PATH - PHP_INI_SYSTEM - - - disable_functions - "" - PHP_INI_SYSTEM - - - allow_url_fopen - "1" - PHP_INI_ALL - + + define_syslog_variables + "0" + PHP_INI_ALL + + + highlight.bg + HL_BG_COLOR + PHP_INI_ALL + + + highlight.comment + HL_COMMENT_COLOR + PHP_INI_ALL + + + highlight.default + HL_DEFAULT_COLOR + PHP_INI_ALL + + + highlight.html + HL_HTML_COLOR + PHP_INI_ALL + + + highlight.keyword + HL_KEYWORD_COLOR + PHP_INI_ALL + + + highlight.string + HL_STRING_COLOR + PHP_INI_ALL + + + allow_call_time_pass_reference + "1" + PHP_INI_SYSTEM|PHP_INI_PERDIR + + + asp_tags + "0" + PHP_INI_SYSTEM|PHP_INI_PERDIR + + + display_errors + "1" + PHP_INI_ALL + + + display_startup_errors + "0" + PHP_INI_ALL + + + enable_dl + "1" + PHP_INI_SYSTEM + + + error_append_string + &null; + PHP_INI_ALL + + + error_prepend_string + &null; + PHP_INI_ALL + + + expose_php + "1" + PHP_INI_SYSTEM + + + html_errors + "1" + PHP_INI_SYSTEM + + + ignore_user_abort + "0" + PHP_INI_ALL + + + implicit_flush + "0" + PHP_INI_PERDIR|PHP_INI_SYSTEM + + + log_errors + "0" + PHP_INI_ALL + + + magic_quotes_gpc + "1" + PHP_INI_PERDIR|PHP_INI_SYSTEM + + + magic_quotes_runtime + "0" + PHP_INI_ALL + + + magic_quotes_sybase + "0" + PHP_INI_PERDIR|PHP_INI_SYSTEM + + + output_buffering + "0" + PHP_INI_PERDIR|PHP_INI_SYSTEM + + + output_handler + &null; + PHP_INI_PERDIR|PHP_INI_SYSTEM + + + register_argc_argv + "1" + PHP_INI_ALL + + + register_globals + "1" + PHP_INI_PERDIR|PHP_INI_SYSTEM + + + safe_mode + "0" + PHP_INI_SYSTEM + + + short_open_tag + "1" + PHP_INI_SYSTEM|PHP_INI_PERDIR + + + sql.safe_mode + "0" + PHP_INI_SYSTEM + + + track_errors + "0" + PHP_INI_ALL + + + y2k_compliance + "0" + PHP_INI_ALL + + + arg_separator + "&" + PHP_INI_ALL + + + auto_append_file + &null; + PHP_INI_ALL + + + auto_prepend_file + &null; + PHP_INI_ALL + + + doc_root + &null; + PHP_INI_SYSTEM + + + default_charset + SAPI_DEFAULT_CHARSET + PHP_INI_ALL + + + default_mimetype + SAPI_DEFAULT_MIMETYPE + PHP_INI_ALL + + + error_log + &null; + PHP_INI_ALL + + + extension_dir + PHP_EXTENSION_DIR + PHP_INI_SYSTEM + + + gpc_order + "GPC" + PHP_INI_ALL + + + include_path + PHP_INCLUDE_PATH + PHP_INI_ALL + + + max_execution_time + "30" + PHP_INI_ALL + + + open_basedir + &null; + PHP_INI_SYSTEM + + + safe_mode_exec_dir + "1" + PHP_INI_SYSTEM + + + upload_max_filesize + "2M" + PHP_INI_ALL + + + file_uploads + "1" + PHP_INI_ALL + + + post_max_size + "8M" + PHP_INI_SYSTEM + + + upload_tmp_dir + &null; + PHP_INI_SYSTEM + + + user_dir + &null; + PHP_INI_SYSTEM + + + variables_order + &null; + PHP_INI_ALL + + + SMTP + "localhost" + PHP_INI_ALL + + + browscap + &null; + PHP_INI_SYSTEM + + + error_reporting + &null; + PHP_INI_ALL + + + memory_limit + "8M" + PHP_INI_ALL + + + precision + "14" + PHP_INI_ALL + + + sendmail_from + &null; + PHP_INI_ALL + + + sendmail_path + DEFAULT_SENDMAIL_PATH + PHP_INI_SYSTEM + + + disable_functions + "" + PHP_INI_SYSTEM + + + allow_url_fopen + "1" + PHP_INI_ALL +
@@ -1330,13 +1327,17 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds) PHP_INI_PERDIR 2 - Entry can be set in .htaccess + + Entry can be set in .htaccess + PHP_INI_SYSTEM 4 - Entry can be set in php.ini or - httpd.conf + + Entry can be set in php.ini or + httpd.conf + PHP_INI_ALL @@ -1348,8 +1349,8 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds) - See also ini_alter, - ini_get, + See also: ini_alter, + ini_get, and ini_restore @@ -1358,7 +1359,7 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds) phpcredits - Prints out the credits for PHP. + Prints out the credits for PHP Description @@ -1372,9 +1373,9 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds) 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: - 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: - +
Pre-defined <function>phpcredits</function> flags - - name - description - + + name + description + - - CREDITS_ALL - - 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. - - - - CREDITS_DOCS - The credits for the documentation team - - - CREDITS_FULLPAGE - - 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. - - - - CREDITS_GENERAL - - General credits: Language design and concept, PHP 4.0 authors - and SAPI module. - - - - CREDITS_GROUP - A list of the core developers - - - CREDITS_MODULES - A list of the extension modules for PHP, and their authors - - - CREDITS_SAPI - A list of the server API modules for PHP, and their authors - + + CREDITS_ALL + + 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. + + + + CREDITS_DOCS + The credits for the documentation team + + + CREDITS_FULLPAGE + + 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. + + + + CREDITS_GENERAL + + General credits: Language design and concept, PHP 4.0 + authors and SAPI module. + + + + CREDITS_GROUP + A list of the core developers + + + CREDITS_MODULES + + A list of the extension modules for PHP, and their authors + + + + CREDITS_SAPI + + A list of the server API modules for PHP, and their authors + +
- See also phpinfo, - phpversion, + See also: phpinfo, + phpversion, and php_logo_guid. @@ -1484,7 +1490,7 @@ phpcredits(CREDITS_GROUP + CREDITS_DOCS + CREDITS_FULLPAGE); phpinfo - Output lots of PHP information. + Outputs lots of PHP information Description @@ -1494,111 +1500,113 @@ phpcredits(CREDITS_GROUP + CREDITS_DOCS + CREDITS_FULLPAGE); int what - - 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. - - - Because every system is setup differently, phpinfo - is commonly used to check configuration - settings and for available - predefined variables - on a given system. Also, phpinfo is a valuable - debugging tool as it contains all EGPCS (Environment, GET, POST, - Cookie, Server) data. - - - The output may be customized by passing one or more of the following - constants bitwise values summed together in the - optional what parameter. One can also combine - the respective constants or bitwise values together with the - or operator. + + 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. + + + Because every system is setup differently, + phpinfo is commonly used to check configuration settings and for + available predefined + variables on a given system. Also, + phpinfo is a valuable debugging tool as it + contains all EGPCS (Environment, GET, POST, Cookie, Server) data. + + + The output may be customized by passing one or more of the + following constants bitwise values summed + together in the optional what parameter. + One can also combine the respective constants or bitwise values + together with the or operator. - - <function>phpinfo</function> options - - - - Name (constant) - Value - Description - - - - - INFO_GENERAL - 1 - - The configuration line, php.ini location, build date, - Web Server, System and more. - - - - INFO_CREDITS - 2 - - PHP 4 Credits. See also phpcredits. - - - - INFO_CONFIGURATION - 4 - - Current Local and Master values for php directives. - See also ini_get. - - - - INFO_MODULES - 8 - - Loaded modules and there respective settings. - - - - INFO_ENVIRONMENT - 16 - - Environment Variable information that's also available - in $_ENV. - - - - INFO_VARIABLES - 32 - - Shows all - predefined variables from EGPCS (Environment, GET, - POST, Cookie, Server). - - - - INFO_LICENSE - 64 - - PHP License information. See also - the license faq. - - - - INFO_ALL - -1 - - Shows all of the above. This is the default value. - - - - -
- - - - <function>phpinfo</function> examples - + + <function>phpinfo</function> options + + + + Name (constant) + Value + Description + + + + + INFO_GENERAL + 1 + + The configuration line, php.ini location, build date, Web + Server, System and more. + + + + INFO_CREDITS + 2 + + PHP 4 Credits. See also phpcredits. + + + + INFO_CONFIGURATION + 4 + + Current Local and Master values for php directives. See + also ini_get. + + + + INFO_MODULES + 8 + + Loaded modules and there respective settings. + + + + INFO_ENVIRONMENT + 16 + + Environment Variable information that's also available in + $_ENV. + + + + INFO_VARIABLES + 32 + + Shows all + predefined variables from EGPCS (Environment, GET, + POST, Cookie, Server). + + + + INFO_LICENSE + 64 + + PHP License information. See also the license faq. + + + + INFO_ALL + -1 + + Shows all of the above. This is the default value. + + + + +
+ + + + <function>phpinfo</function> examples + ]]> - - - - - - - Parts of the information displayed are disabled when the - expose_php configuration setting is set to - off. This includes the PHP and Zend logos, and the - credits. + + + + + + Parts of the information displayed are disabled when the + expose_php configuration setting is set to + off. This includes the PHP and Zend logos, + and the credits. + + + + See also: phpversion, + phpcredits, + php_logo_guid, ini_get, + ini_set, and the section on Predefined + Variables. - - - See also phpversion, - phpcredits, php_logo_guid, - ini_get, ini_set, and the section - on Predefined Variables. - phpversion - Get the current PHP version. + Gets the current PHP version Description @@ -1651,13 +1660,13 @@ phpinfo(INFO_MODULES); - This information is also available in the predefined constant + This information is also available in the predefined constant PHP_VERSION. - <function>phpversion</function> example + <function>phpversion</function> Example See also version_compare, - phpinfo, - phpcredits, - php_logo_guid, + phpinfo, phpcredits, + php_logo_guid, and zend_version. @@ -1681,7 +1689,7 @@ echo 'Current PHP version: ' . phpversion(); php_logo_guid - Get the logo guid + Gets the logo guid Description @@ -1697,9 +1705,9 @@ echo 'Current PHP version: ' . phpversion(); - See also phpinfo. - phpversion, - phpcredits + See also: phpinfo, + phpversion, and + phpcredits. @@ -1720,10 +1728,10 @@ echo 'Current PHP version: ' . phpversion(); - php_sapi_name 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. + php_sapi_name 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. @@ -1732,9 +1740,9 @@ echo 'Current PHP version: ' . phpversion(); @@ -1758,8 +1766,8 @@ else - php_uname returns a string with a description - of the operating system PHP is built on. + php_uname returns a string with a + description of the operating system PHP is built on. @@ -1767,10 +1775,10 @@ else - + @@ -1779,7 +1787,7 @@ if (substr(php_uname(), 0, 7) == "Windows") { putenv - Set the value of an environment variable. + Sets the value of an environment variable Description @@ -1790,31 +1798,34 @@ if (substr(php_uname(), 0, 7) == "Windows") { - Adds setting 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 setting 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. - Setting certain environment variables may be a potential security breach. - The safe_mode_allowed_env_vars 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 PHP_ - (e.g. PHP_FOO=BAR). 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 safe_mode_allowed_env_vars + 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 PHP_ + (e.g. PHP_FOO=BAR). Note: if this directive is + empty, PHP will let the user modify ANY environment variable! The safe_mode_protected_env_vars directive contains a comma-delimited list of environment variables, that - the end user won't be able to change using putenv. - These variables will be protected even if safe_mode_allowed_env_vars - is set to allow to change them. + the end user won't be able to change using + putenv. These variables will be protected + even if safe_mode_allowed_env_vars is set to + allow to change them. - These directives have only effect when safe-mode itself is enabled! + These directives have only effect when safe-mode itself is enabled! @@ -1827,10 +1838,9 @@ putenv ("UNIQID=$uniqid"); - - See also - getenv. - + + See also getenv. + @@ -1838,8 +1848,8 @@ putenv ("UNIQID=$uniqid"); set_magic_quotes_runtime - Set the current active configuration setting of - magic_quotes_runtime. + Sets the current active configuration setting of + magic_quotes_runtime @@ -1854,11 +1864,11 @@ putenv ("UNIQID=$uniqid"); Set the current active configuration setting of magic_quotes_runtime. - (0 for off, 1 for on) + linkend="ini.magic-quotes-runtime">magic_quotes_runtime (0 + for off, 1 for on). - See also get_magic_quotes_gpc, + See also: get_magic_quotes_gpc and get_magic_quotes_runtime. @@ -1867,7 +1877,7 @@ putenv ("UNIQID=$uniqid"); set_time_limit - limit the maximum execution time + Limits the maximum execution time Description @@ -1893,9 +1903,9 @@ putenv ("UNIQID=$uniqid"); total of 45 seconds before timing out. - set_time_limit 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 set_time_limit 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 configuration file. @@ -1917,7 +1927,9 @@ putenv ("UNIQID=$uniqid"); version_compare - Compares two "PHP-standardized" version number strings + + Compares two "PHP-standardized" version number strings + Description @@ -1934,35 +1946,33 @@ putenv ("UNIQID=$uniqid"); - version_compare compares - two "PHP-standardized" version number strings. This - is useful if you would like to write programs working - only on some versions of PHP. + version_compare compares two + "PHP-standardized" version number strings. This is useful if you + would like to write programs working only on some versions of + PHP. - version_compare returns -1 if - the first version is lower than the second, 0 if they - are equal, and +1 if the second is lower. + version_compare returns -1 if the first + version is lower than the second, 0 if they are equal, and +1 if + the second is lower. - If you specify the third optional - operator argument, you - can test for a particular relationship. The possible - operators are: <, + If you specify the third optional operator + argument, you can test for a particular relationship. The + possible operators are: <, lt, <=, le, >, gt, >=, ge, ==, =, eq, !=, <>, - ne respectively. Using - this argument, the function will return 1 if - the relationship is the one specified by the - operator, 0 otherwise. + ne respectively. Using this argument, the + function will return 1 if the relationship is the one specified + by the operator, 0 otherwise. - <function>version_compare</function> example + <function>version_compare</function> Example zend_logo_guid - Get the zend guid + Gets the zend guid Description @@ -2002,7 +2012,7 @@ echo version_compare("4.0.6", "4.0.6", "eq"); zend_version - Get the version of the current Zend engine. + Gets the version of the current Zend engine Description @@ -2016,11 +2026,11 @@ echo version_compare("4.0.6", "4.0.6", "eq"); Returns a string containing the version of the currently running PHP parser. - <function>zend_version</function> example + <function>zend_version</function> Example @@ -2028,12 +2038,12 @@ echo "Zend engine version: ".zend_version(); See also phpinfo, phpcredits, - php_logo_guid + php_logo_guid, and phpversion. - +