From eb55c333f3a667ccf2b79c9620b8c00109703c3c Mon Sep 17 00:00:00 2001 From: Philip Olson Date: Fri, 1 Apr 2005 22:55:18 +0000 Subject: [PATCH] WS, preparation for the new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@183374 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../functions/apache-child-terminate.xml | 74 +++++------ .../apache/functions/apache-get-modules.xml | 70 +++++----- .../apache/functions/apache-get-version.xml | 74 ++++++----- reference/apache/functions/apache-getenv.xml | 80 ++++++------ .../apache/functions/apache-lookup-uri.xml | 121 +++++++++--------- reference/apache/functions/apache-note.xml | 50 ++++---- .../functions/apache-request-headers.xml | 102 +++++++-------- .../apache/functions/apache-reset-timeout.xml | 62 +++++---- .../functions/apache-response-headers.xml | 66 +++++----- reference/apache/functions/apache-setenv.xml | 82 ++++++------ reference/apache/functions/ascii2ebcdic.xml | 48 +++---- reference/apache/functions/ebcdic2ascii.xml | 48 +++---- reference/apache/functions/getallheaders.xml | 68 +++++----- reference/apache/functions/virtual.xml | 86 ++++++------- 14 files changed, 510 insertions(+), 521 deletions(-) diff --git a/reference/apache/functions/apache-child-terminate.xml b/reference/apache/functions/apache-child-terminate.xml index 6297edd4e3..9528e30a8e 100644 --- a/reference/apache/functions/apache-child-terminate.xml +++ b/reference/apache/functions/apache-child-terminate.xml @@ -1,42 +1,42 @@ - + - - - apache_child_terminate - Terminate apache process after this request - - - Description - - boolapache_child_terminate - - - - apache_child_terminate will register the - Apache process executing the current PHP request for termination - once execution of PHP code it is completed. It may be used to - terminate a process after a script with high memory consumption has - been run as memory will usually only be freed internally but not - given back to the operating system. - - - - The availability of this feature is controlled by the &php.ini; directive - , which is set to off - by default. - - - This function is only available in non-multithreaded versions of Apache - 1, with PHP running as Apache module. - - - ¬e.no-windows; - - See also exit. - - - + + + apache_child_terminate + Terminate apache process after this request + + + Description + + boolapache_child_terminate + + + + apache_child_terminate will register the + Apache process executing the current PHP request for termination + once execution of PHP code it is completed. It may be used to + terminate a process after a script with high memory consumption has + been run as memory will usually only be freed internally but not + given back to the operating system. + + + + The availability of this feature is controlled by the &php.ini; directive + , which is set to off + by default. + + + This function is only available in non-multithreaded versions of Apache + 1, with PHP running as Apache module. + + + ¬e.no-windows; + + See also exit. + + + - - - apache_get_modules - - Get a list of loaded Apache modules - - - - Description - - arrayapache_get_modules - - - - This function returns an array with the loaded Apache modules. - - - - <function>apache_get_modules</function> example - + + + + apache_get_modules + Get a list of loaded Apache modules + + + Description + + arrayapache_get_modules + + + + This function returns an array with the loaded Apache modules. + + + + <function>apache_get_modules</function> example + ]]> - - &example.outputs.similar; - + + &example.outputs.similar; + mod_rewrite ) ]]> - - - - - - This function is available only in Apache 2 handler. - As of PHP 5, it is available also in Apache 2 filter - and Apache 1. - - - - + + + + + + This function is available only in Apache 2 handler. + As of PHP 5, it is available also in Apache 2 filter + and Apache 1. + + + + - - - apache_get_version - - Fetch Apache version - - - - Description - - stringapache_get_version - - - - apache_get_version returns the version of Apache as - string, or &false; on failure. - - - <function>apache_get_version</function> example - + + + + apache_get_version + Fetch Apache version + + + Description + + stringapache_get_version + + + + apache_get_version returns the version of Apache as + string, or &false; on failure. + + + <function>apache_get_version</function> example + ]]> - - &example.outputs.similar; - + + &example.outputs.similar; + - - - - - This function is available only in Apache 2 handler. - As of PHP 4.3.4, it is available also in Apache 1 and as of PHP 5, it is - available also in Apache 2 filter. - - - - See also phpinfo. - - - + + + + + This function is available only in Apache 2 handler. + As of PHP 4.3.4, it is available also in Apache 1 and as of PHP 5, it is + available also in Apache 2 filter. + + + + See also phpinfo. + + + - - - apache_getenv - Get an Apache subprocess_env variable - - - Description - - stringapache_getenv - stringvariable - boolwalk_to_top - - - apache_getenv returns the value of the Apache - environment variable specified by variable, or - &false; on failure. - - - - apache_getenv is only defined when using - Apache 2. - - - - <function>apache_getenv</function> example - + + + + apache_getenv + Get an Apache subprocess_env variable + + + Description + + stringapache_getenv + stringvariable + boolwalk_to_top + + + apache_getenv returns the value of the Apache + environment variable specified by variable, or + &false; on failure. + + + + apache_getenv is only defined when using + Apache 2. + + + + <function>apache_getenv</function> example + ]]> - - - The example above shows how to retrieve the value of the Apache - environment variable "SERVER_ADDR". - - - - See also apache_setenv, - getenv&listendand; - Superglobals. - - - + + + The example above shows how to retrieve the value of the Apache + environment variable "SERVER_ADDR". + + + + See also apache_setenv, + getenv&listendand; + Superglobals. + + + + - - - apache_lookup_uri - - Perform a partial request for the specified URI and return all - info about it - - - - Description - - objectapache_lookup_uri - stringfilename - - - This performs a partial request for a URI. It goes just far - enough to obtain all the important information about the given - resource and returns this information in a class. The properties - of the returned class are: - - status - the_request - status_line - method - content_type - handler - uri - filename - path_info - args - boundary - no_cache - no_local_copy - allowed - send_bodyct - bytes_sent - byterange - clength - unparsed_uri - mtime - request_time - - - - - <function>apache_lookup_uri</function> example - + + + apache_lookup_uri + Perform a partial request for the specified URI and return all info about it + + + Description + + objectapache_lookup_uri + stringfilename + + + This performs a partial request for a URI. It goes just far + enough to obtain all the important information about the given + resource and returns this information in a class. The properties + of the returned class are: + + status + the_request + status_line + method + content_type + handler + uri + filename + path_info + args + boundary + no_cache + no_local_copy + allowed + send_bodyct + bytes_sent + byterange + clength + unparsed_uri + mtime + request_time + + + + + <function>apache_lookup_uri</function> example + filename)) { } ?> ]]> - - &example.outputs.similar; - + + &example.outputs.similar; + - - - - - - apache_lookup_uri only works when PHP - is installed as an Apache module. - - - - + + + + + + apache_lookup_uri only works when PHP + is installed as an Apache module. + + + + + - - - apache_note - Get and set apache request notes - - - Description - - stringapache_note - stringnote_name - stringnote_value - - - apache_note is an Apache-specific function - which gets and sets values in a request's - notes table. If called with one argument, it - returns the current value of note - note_name. If called with two arguments, it - sets the value of note note_name to - note_value and returns the previous value of - note note_name. - - - + + + apache_note + Get and set apache request notes + + + Description + + stringapache_note + stringnote_name + stringnote_value + + + apache_note is an Apache-specific function + which gets and sets values in a request's + notes table. If called with one argument, it + returns the current value of note + note_name. If called with two arguments, it + sets the value of note note_name to + note_value and returns the previous value of + note note_name. + + + + - - - apache_request_headers - Fetch all HTTP request headers - - - Description - - arrayapache_request_headers - - - - apache_request_headers returns an associative - array of all the HTTP headers in the current request. This is only - supported when PHP runs as an Apache - module. - - - - <function>apache_request_headers</function> example - + + + apache_request_headers + Fetch all HTTP request headers + + + Description + + arrayapache_request_headers + + + + apache_request_headers returns an associative + array of all the HTTP headers in the current request. This is only + supported when PHP runs as an Apache + module. + + + + <function>apache_request_headers</function> example + $value) { } ?> ]]> - - &example.outputs.similar; - + + &example.outputs.similar; + - - - - - - Prior to PHP 4.3.0, apache_request_headers was - called getallheaders. After PHP 4.3.0, - getallheaders is an alias for - apache_request_headers. - - - - - You can also get at the value of the common CGI variables by - reading them from the environment, which works whether or not - you are using PHP as an Apache module. Use - phpinfo to see a list of all of the available - environment variables. - - - ¬e.apache.nsapi-module; - - See also apache_response_headers. - - - + + + + + + Prior to PHP 4.3.0, apache_request_headers was + called getallheaders. After PHP 4.3.0, + getallheaders is an alias for + apache_request_headers. + + + + + You can also get at the value of the common CGI variables by + reading them from the environment, which works whether or not + you are using PHP as an Apache module. Use + phpinfo to see a list of all of the available + environment variables. + + + ¬e.apache.nsapi-module; + + See also apache_response_headers. + + + - - - apache_reset_timeout - - Reset the Apache write timer - - - - Description - - boolapache_reset_timeout - - - - apache_reset_timeout resets the Apache write timer, - which defaults to 300 seconds. With set_time_limit(0); - ignore_user_abort(true) and periodic - apache_reset_timeout calls, Apache can theoretically - run forever. - - - &return.success; - - - - This functions is just available for Apache 1. - - - ¬e.sm.disabled; - - + + + + apache_reset_timeout + Reset the Apache write timer + + + Description + + boolapache_reset_timeout + + + + apache_reset_timeout resets the Apache write timer, + which defaults to 300 seconds. With set_time_limit(0); + ignore_user_abort(true) and periodic + apache_reset_timeout calls, Apache can theoretically + run forever. + + + &return.success; + + + + This functions is just available for Apache 1. + + + ¬e.sm.disabled; + + + - - - apache_response_headers - - Fetch all HTTP response headers - - - - Description - - arrayapache_response_headers - - - - Returns an array of all Apache response headers. - - - - <function>apache_response_headers</function> example - + + + apache_response_headers + Fetch all HTTP response headers + + + Description + + arrayapache_response_headers + + + + Returns an array of all Apache response headers. + + + + <function>apache_response_headers</function> example + ]]> - - &example.outputs.similar; - + + &example.outputs.similar; + PHP/4.3.8 ) ]]> - - - - ¬e.apache.nsapi-module; - - See also apache_request_headers, and - headers_sent. - - - + + + + ¬e.apache.nsapi-module; + + See also apache_request_headers, and + headers_sent. + + + + - - - apache_setenv - Set an Apache subprocess_env variable - - - Description - - intapache_setenv - stringvariable - stringvalue - boolwalk_to_top - - - apache_setenv sets the value of the Apache - environment variable specified by - variable. - - - - When setting an Apache environment variable, the corresponding $_SERVER - variable is not changed. - - - - Setting an Apache environment variable using <function>apache_setenv</function> - + + + apache_setenv + Set an Apache subprocess_env variable + + + Description + + intapache_setenv + stringvariable + stringvalue + boolwalk_to_top + + + apache_setenv sets the value of the Apache + environment variable specified by + variable. + + + + When setting an Apache environment variable, the corresponding $_SERVER + variable is not changed. + + + + Setting an Apache environment variable using <function>apache_setenv</function> + ]]> - - - - apache_setenv can be paired up with - apache_getenv across separate pages or for setting - variables to pass to Server Side Includes (.shtml) that have been - included in PHP scripts. - - - See also apache_getenv. - - - + + + + apache_setenv can be paired up with + apache_getenv across separate pages or for setting + variables to pass to Server Side Includes (.shtml) that have been + included in PHP scripts. + + + See also apache_getenv. + + + + - - - ascii2ebcdic - Translate string from ASCII to EBCDIC - - - Description - - intascii2ebcdic - stringascii_str - - - ascii2ebcdic is an Apache-specific function which - is available only on EBCDIC based operating systems (OS/390, BS2000). - It translates the ASCII encoded string ascii_str - to its equivalent EBCDIC representation (binary safe), and returns - the result. - - - See also the reverse function ebcdic2ascii - - - + + + ascii2ebcdic + Translate string from ASCII to EBCDIC + + + Description + + intascii2ebcdic + stringascii_str + + + ascii2ebcdic is an Apache-specific function which + is available only on EBCDIC based operating systems (OS/390, BS2000). + It translates the ASCII encoded string ascii_str + to its equivalent EBCDIC representation (binary safe), and returns + the result. + + + See also the reverse function ebcdic2ascii + + + + - - - ebcdic2ascii - Translate string from EBCDIC to ASCII - - - Description - - intebcdic2ascii - stringebcdic_str - - - ebcdic2ascii is an Apache-specific function which - is available only on EBCDIC based operating systems (OS/390, BS2000). - It translates the EBCDIC encoded string ebcdic_str - to its equivalent ASCII representation (binary safe), and returns - the result. - - - See also the reverse function ascii2ebcdic - - - + + + ebcdic2ascii + Translate string from EBCDIC to ASCII + + + Description + + intebcdic2ascii + stringebcdic_str + + + ebcdic2ascii is an Apache-specific function which + is available only on EBCDIC based operating systems (OS/390, BS2000). + It translates the EBCDIC encoded string ebcdic_str + to its equivalent ASCII representation (binary safe), and returns + the result. + + + See also the reverse function ascii2ebcdic + + + + - - - getallheaders - Fetch all HTTP request headers - - - Description - - arraygetallheaders - - - - getallheaders is an alias for - apache_request_headers. It will return an - associative array of all the HTTP headers in the current request. - Please read the apache_request_headers - documentation for more information on how this function works. - - - - In PHP 4.3.0, getallheaders became an - alias for apache_request_headers. - Essentially, it was renamed. This is because this function - only works when PHP is compiled as an - Apache Module. - - - ¬e.apache.nsapi-module; - - See also apache_request_headers. - - - + + + getallheaders + Fetch all HTTP request headers + + + Description + + arraygetallheaders + + + + getallheaders is an alias for + apache_request_headers. It will return an + associative array of all the HTTP headers in the current request. + Please read the apache_request_headers + documentation for more information on how this function works. + + + + In PHP 4.3.0, getallheaders became an + alias for apache_request_headers. + Essentially, it was renamed. This is because this function + only works when PHP is compiled as an + Apache Module. + + + ¬e.apache.nsapi-module; + + See also apache_request_headers. + + + + - - - virtual - Perform an Apache sub-request - - - Description - - intvirtual - stringfilename - - - virtual is an Apache-specific function which - is equivalent to <!--#include virtual...--> in mod_include. - It performs an Apache sub-request. It is useful for including - CGI scripts or .shtml files, or anything else that you would - parse through Apache. Note that for a CGI script, the script - must generate valid CGI headers. At the minimum that means it - must generate a Content-type header. - - - To run the sub-request, all buffers are terminated and flushed to the - browser, pending headers are sent too. - - - - This function works only when PHP is compiled as an Apache module, - since it uses the Apache API for doing sub requests. Query string can be - passed to the included file but $_GET is copied from - the parent script and only $_SERVER['QUERY_STRING'] is - filled with the passed query string. The query string may only be passed - when using Apache 2. The requested file will not be listed in the Apache access log. - - - - As of PHP 4.0.6, you can use virtual on PHP files. - However, it is typically better to use include or - require if you need to include another PHP file. - - ¬e.apache.nsapi-module; - - + + + virtual + Perform an Apache sub-request + + + Description + + intvirtual + stringfilename + + + virtual is an Apache-specific function which + is equivalent to <!--#include virtual...--> in mod_include. + It performs an Apache sub-request. It is useful for including + CGI scripts or .shtml files, or anything else that you would + parse through Apache. Note that for a CGI script, the script + must generate valid CGI headers. At the minimum that means it + must generate a Content-type header. + + + To run the sub-request, all buffers are terminated and flushed to the + browser, pending headers are sent too. + + + + This function works only when PHP is compiled as an Apache module, + since it uses the Apache API for doing sub requests. Query string can be + passed to the included file but $_GET is copied from + the parent script and only $_SERVER['QUERY_STRING'] is + filled with the passed query string. The query string may only be passed + when using Apache 2. The requested file will not be listed in the Apache access log. + + + + As of PHP 4.0.6, you can use virtual on PHP files. + However, it is typically better to use include or + require if you need to include another PHP file. + + ¬e.apache.nsapi-module; + +