diff --git a/reference/apache/functions/apache-child-terminate.xml b/reference/apache/functions/apache-child-terminate.xml index 9528e30a8e..327f4be0cb 100644 --- a/reference/apache/functions/apache-child-terminate.xml +++ b/reference/apache/functions/apache-child-terminate.xml @@ -1,13 +1,14 @@ - + apache_child_terminate Terminate apache process after this request - - Description + + + &reftitle.description; boolapache_child_terminate @@ -20,20 +21,30 @@ 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; + + + + &reftitle.returnvalues; - See also exit. + Returns &true; if PHP is running as an Apache 1 module, the Apache version + is non-multithreaded, and the + child_terminate PHP directive is + enabled (disabled by default). If these conditions are not met, &false; is + returned and an error of level E_WARNING is generated. + + + + + &reftitle.notes; + ¬e.no-windows; + + + + &reftitle.seealso; + + + exit + diff --git a/reference/apache/functions/apache-get-modules.xml b/reference/apache/functions/apache-get-modules.xml index bed184bcc3..b15f79d056 100755 --- a/reference/apache/functions/apache-get-modules.xml +++ b/reference/apache/functions/apache-get-modules.xml @@ -1,19 +1,57 @@ - - + + apache_get_modules Get a list of loaded Apache modules - - Description + + + &reftitle.description; arrayapache_get_modules - This function returns an array with the loaded Apache modules. + Get a list of loaded Apache modules. + + + + &reftitle.returnvalues; + + An array of loaded Apache modules. + + + + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 5.0.0 + + Became available when using Apache 1, or the PHP Apache 2 + filter API. Before this time, it was only + available when using the Apache 2 handler API. + + + + + + + + + + &reftitle.examples; <function>apache_get_modules</function> example @@ -40,13 +78,6 @@ Array - - - This function is available only in Apache 2 handler. - As of PHP 5, it is available also in Apache 2 filter - and Apache 1. - - diff --git a/reference/apache/functions/apache-get-version.xml b/reference/apache/functions/apache-get-version.xml index ed7572ab4d..e89996a892 100644 --- a/reference/apache/functions/apache-get-version.xml +++ b/reference/apache/functions/apache-get-version.xml @@ -1,46 +1,87 @@ - - + + apache_get_version Fetch Apache version - - Description + + + &reftitle.description; stringapache_get_version - apache_get_version returns the version of Apache as - string, or &false; on failure. + Fetch the Apache version. - - <function>apache_get_version</function> example - + + + + &reftitle.returnvalues; + + Returns the Apache version on success, or &false; on failure. + + + + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 4.3.4 + + Became available with Apache 1. + + + + 5.0.0 + + Became available with the Apache 2 filter API. + + + + + + + + + + &reftitle.examples; + + + <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. - - + + + + + + + &reftitle.seealso; - See also phpinfo. + + phpinfo + diff --git a/reference/apache/functions/apache-getenv.xml b/reference/apache/functions/apache-getenv.xml index 774d06e36c..08e0d68a96 100755 --- a/reference/apache/functions/apache-getenv.xml +++ b/reference/apache/functions/apache-getenv.xml @@ -1,47 +1,94 @@ - - + + apache_getenv Get an Apache subprocess_env variable - - Description + + + &reftitle.description; stringapache_getenv stringvariable boolwalk_to_top - apache_getenv returns the value of the Apache - environment variable specified by variable, or - &false; on failure. + Get an Apache environment variable as specified by + variable. - - - apache_getenv is only defined when using - Apache 2. - - - - <function>apache_getenv</function> example - + + This function requires Apache 2 otherwise it's undefined. + + + + + &reftitle.parameters; + + + + variable + + + The Apache environment variable + + + + + walk_to_top + + + The walk_to_top parameter. + + + + + + + + + &reftitle.returnvalues; + + The value of the Apache environment variable on success, or &false; on + failure + + + + + &reftitle.examples; + + + <function>functionname</function> example + + The example above shows how to retrieve the value of the Apache + environment variable SERVER_ADDR. + + ]]> - - - The example above shows how to retrieve the value of the Apache - environment variable "SERVER_ADDR". - - + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; - See also apache_setenv, - getenv&listendand; - Superglobals. + + apache_sentenv + getenv + Superglobals + diff --git a/reference/apache/functions/apache-lookup-uri.xml b/reference/apache/functions/apache-lookup-uri.xml index 44119ef482..852e1d7b54 100644 --- a/reference/apache/functions/apache-lookup-uri.xml +++ b/reference/apache/functions/apache-lookup-uri.xml @@ -1,13 +1,14 @@ - + apache_lookup_uri Perform a partial request for the specified URI and return all info about it - - Description + + + &reftitle.description; objectapache_lookup_uri stringfilename @@ -15,8 +16,34 @@ 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: + resource. + + &apache.req.module; + + + + &reftitle.parameters; + + + + filename + + + The filename (URI) that's being requested, or &false; on failure. + + + + + + + + + &reftitle.returnvalues; + + An object of related URI information. The properties of + this object are: + + status the_request @@ -41,6 +68,10 @@ request_time + + + + &reftitle.examples; <function>apache_lookup_uri</function> example @@ -84,12 +115,6 @@ file exists! - - - apache_lookup_uri only works when PHP - is installed as an Apache module. - - diff --git a/reference/apache/functions/apache-note.xml b/reference/apache/functions/apache-note.xml index aad46ba560..94a2bebf94 100644 --- a/reference/apache/functions/apache-note.xml +++ b/reference/apache/functions/apache-note.xml @@ -1,13 +1,14 @@ - + apache_note Get and set apache request notes - - Description + + + &reftitle.description; stringapache_note stringnote_name @@ -16,12 +17,43 @@ 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 + notes table. + + + + + &reftitle.parameters; + + + + note_name + + + The name of the note. + + + + + note_value + + + The value of the note. + + + + + + + + + &reftitle.returnvalues; + + 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. + If the note cannot be retrieved, &false; is returned. diff --git a/reference/apache/functions/apache-request-headers.xml b/reference/apache/functions/apache-request-headers.xml index 3e9e873539..2224d3def3 100644 --- a/reference/apache/functions/apache-request-headers.xml +++ b/reference/apache/functions/apache-request-headers.xml @@ -1,23 +1,34 @@ - + apache_request_headers Fetch all HTTP request headers - - Description + + + &reftitle.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. + Fetches all HTTP requests from the current request. + &apache.req.module; + + + + &reftitle.returnvalues; + + An associative array of all the HTTP headers in the current request, or + &false; on failure. + + + + + &reftitle.examples; <function>apache_request_headers</function> example @@ -45,6 +56,10 @@ Connection: Keep-Alive + + + + &reftitle.notes; Prior to PHP 4.3.0, apache_request_headers was @@ -63,8 +78,14 @@ Connection: Keep-Alive ¬e.apache.nsapi-module; + + + + &reftitle.seealso; - See also apache_response_headers. + + apache_response_headers + diff --git a/reference/apache/functions/apache-reset-timeout.xml b/reference/apache/functions/apache-reset-timeout.xml index 213f29d555..f276cda731 100755 --- a/reference/apache/functions/apache-reset-timeout.xml +++ b/reference/apache/functions/apache-reset-timeout.xml @@ -1,12 +1,13 @@ - - + + apache_reset_timeout Reset the Apache write timer - - Description + + + &reftitle.description; boolapache_reset_timeout @@ -14,18 +15,24 @@ apache_reset_timeout resets the Apache write timer, which defaults to 300 seconds. With set_time_limit(0); - ignore_user_abort(true) and periodic + ignore_user_abort(true) and periodic apache_reset_timeout calls, Apache can theoretically run forever. + + This function requires Apache 1. + + + + + &reftitle.returnvalues; &return.success; - - - This functions is just available for Apache 1. - - + + + + &reftitle.notes; ¬e.sm.disabled; diff --git a/reference/apache/functions/apache-response-headers.xml b/reference/apache/functions/apache-response-headers.xml index b58e4fdb2c..418816d8d1 100644 --- a/reference/apache/functions/apache-response-headers.xml +++ b/reference/apache/functions/apache-response-headers.xml @@ -1,20 +1,32 @@ - + apache_response_headers Fetch all HTTP response headers - - Description + + + &reftitle.description; arrayapache_response_headers - Returns an array of all Apache response headers. + Fetch all HTTP response headers. + + + + &reftitle.returnvalues; + + An array of all Apache response headers on success, or &false; on failure. + + + + + &reftitle.examples; <function>apache_response_headers</function> example @@ -37,10 +49,20 @@ Array + + + + &reftitle.notes; ¬e.apache.nsapi-module; + + + + &reftitle.seealso; - See also apache_request_headers, and - headers_sent. + + apache_request_headers + headers_sent + diff --git a/reference/apache/functions/apache-setenv.xml b/reference/apache/functions/apache-setenv.xml index fc2fc61376..f526afee62 100644 --- a/reference/apache/functions/apache-setenv.xml +++ b/reference/apache/functions/apache-setenv.xml @@ -1,13 +1,14 @@ - + apache_setenv Set an Apache subprocess_env variable - - Description + + + &reftitle.description; intapache_setenv stringvariable @@ -21,11 +22,56 @@ - When setting an Apache environment variable, the corresponding $_SERVER + When setting an Apache environment variable, the corresponding + $_SERVER variable is not changed. - + + + + &reftitle.parameters; + + + + variable + + + The environment variable that's being set. + + + + + value + + + The new variable value. + + + + + walk_to_top + + + The walk_to_top parameter. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.examples; + + 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. + + + + + + &reftitle.notes; + + + 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. + + + + + + &reftitle.seealso; - See also apache_getenv. + + apache_getenv + diff --git a/reference/apache/functions/ascii2ebcdic.xml b/reference/apache/functions/ascii2ebcdic.xml index 228445d44b..a35e4f8e73 100644 --- a/reference/apache/functions/ascii2ebcdic.xml +++ b/reference/apache/functions/ascii2ebcdic.xml @@ -1,13 +1,14 @@ - + ascii2ebcdic Translate string from ASCII to EBCDIC - - Description + + + &reftitle.description; intascii2ebcdic stringascii_str @@ -19,8 +20,37 @@ to its equivalent EBCDIC representation (binary safe), and returns the result. + + + + &reftitle.parameters; - See also the reverse function ebcdic2ascii + + + ascii_str + + + The ASCII string that will be translated. + + + + + + + + + &reftitle.returnvalues; + + The EBCDIC representation of an ASCII string. + + + + + &reftitle.seealso; + + + ebcdic2ascii + diff --git a/reference/apache/functions/ebcdic2ascii.xml b/reference/apache/functions/ebcdic2ascii.xml index d09a70228e..d08e45876b 100644 --- a/reference/apache/functions/ebcdic2ascii.xml +++ b/reference/apache/functions/ebcdic2ascii.xml @@ -1,13 +1,14 @@ - + ebcdic2ascii Translate string from EBCDIC to ASCII - - Description + + + &reftitle.description; intebcdic2ascii stringebcdic_str @@ -19,8 +20,37 @@ to its equivalent ASCII representation (binary safe), and returns the result. + + + + &reftitle.parameters; - See also the reverse function ascii2ebcdic + + + ebcdic_str + + + The EBCDIC string that will be translated. + + + + + + + + + &reftitle.returnvalues; + + The ASCII representation of an EBCDIC string. + + + + + &reftitle.seealso; + + + ascii2ebcdic + diff --git a/reference/apache/functions/getallheaders.xml b/reference/apache/functions/getallheaders.xml index 7b2a5483b4..aafbe63348 100644 --- a/reference/apache/functions/getallheaders.xml +++ b/reference/apache/functions/getallheaders.xml @@ -1,36 +1,74 @@ - + getallheaders Fetch all HTTP request headers - - Description + + + &reftitle.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. + Fetches all HTTP requests from the current request. + + + This function is an alias for apache_request_headers. 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; + &apache.req.module; + + + + &reftitle.returnvalues; - See also apache_request_headers. + An associative array of all the HTTP headers in the current request, or + &false; on failure. + + + + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 4.3.0 + + Became an alias for apache_request_headers. + Essentially, it was renamed. This is because this function + only works with Apache. + + + + + + + + + + &reftitle.notes; + ¬e.apache.nsapi-module; + + + + &reftitle.seealso; + + + apache_response_headers + diff --git a/reference/apache/functions/virtual.xml b/reference/apache/functions/virtual.xml index 0e4e69b241..ef03add659 100644 --- a/reference/apache/functions/virtual.xml +++ b/reference/apache/functions/virtual.xml @@ -1,13 +1,14 @@ - + virtual Perform an Apache sub-request - - Description + + + &reftitle.description; intvirtual stringfilename @@ -25,21 +26,69 @@ To run the sub-request, all buffers are terminated and flushed to the browser, pending headers are sent too. + &apache.req.module; + + + + &reftitle.parameters; + + + + filename + + + The file that the virtual command will be performed on. + + + + + + + + + &reftitle.returnvalues; + + Performs the virtual command on success, or returns &false; on failure. + + + + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 4.0.6 + + This function may be used on PHP files. However, it is typically + better to use include or + require for PHP files. + + + + + + + + + + &reftitle.notes; - 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. + The 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;