sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

WS, preparation for the new doc style

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@183374 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2005-04-01 22:55:18 +00:00
parent 4a84ac0542
commit eb55c333f3
14 changed files with 510 additions and 521 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

74
reference/apache/functions/apache-child-terminate.xml
View file

@ -1,42 +1,42 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/apache.xml, last change in rev 1.20 -->
<refentry id="function.apache-child-terminate">
<refnamediv>
<refname>apache_child_terminate</refname>
<refpurpose>Terminate apache process after this request</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>apache_child_terminate</methodname>
<void/>
</methodsynopsis>
<para>
<function>apache_child_terminate</function> 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.
</para>
<note>
<simpara>
The availability of this feature is controlled by the &php.ini; directive
<option>child_terminate</option>, which is set to <literal>off</literal>
by default.
</simpara>
<simpara>
This function is only available in non-multithreaded versions of Apache
1, with PHP running as Apache module.
</simpara>
</note>
&note.no-windows;
<para>
See also <function>exit</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.apache-child-terminate">
<refnamediv>
<refname>apache_child_terminate</refname>
<refpurpose>Terminate apache process after this request</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>apache_child_terminate</methodname>
<void/>
</methodsynopsis>
<para>
<function>apache_child_terminate</function> 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.
</para>
<note>
<simpara>
The availability of this feature is controlled by the &php.ini; directive
<option>child_terminate</option>, which is set to <literal>off</literal>
by default.
</simpara>
<simpara>
This function is only available in non-multithreaded versions of Apache
1, with PHP running as Apache module.
</simpara>
</note>
&note.no-windows;
<para>
See also <function>exit</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

70
reference/apache/functions/apache-get-modules.xml
View file

@ -1,33 +1,31 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<refentry id="function.apache-get-modules">
<refnamediv>
<refname>apache_get_modules</refname>
<refpurpose>
Get a list of loaded Apache modules
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>apache_get_modules</methodname>
<void/>
</methodsynopsis>
<para>
This function returns an array with the loaded Apache modules.
</para>
<para>
<example>
<title><function>apache_get_modules</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.5 $ -->
<refentry id="function.apache-get-modules">
<refnamediv>
<refname>apache_get_modules</refname>
<refpurpose>Get a list of loaded Apache modules</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>apache_get_modules</methodname>
<void/>
</methodsynopsis>
<para>
This function returns an array with the loaded Apache modules.
</para>
<para>
<example>
<title><function>apache_get_modules</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
print_r(apache_get_modules());
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
@ -39,18 +37,18 @@ Array
[5] => mod_rewrite
)
]]>
</screen>
</example>
</para>
<note>
<para>
This function is available only in Apache 2 <emphasis>handler</emphasis>.
As of PHP 5, it is available also in Apache 2 <emphasis>filter</emphasis>
and Apache 1.
</para>
</note>
</refsect1>
</refentry>
</screen>
</example>
</para>
<note>
<para>
This function is available only in Apache 2 <emphasis>handler</emphasis>.
As of PHP 5, it is available also in Apache 2 <emphasis>filter</emphasis>
and Apache 1.
</para>
</note>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

74
reference/apache/functions/apache-get-version.xml
View file

@ -1,51 +1,49 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<refentry id="function.apache-get-version">
<refnamediv>
<refname>apache_get_version</refname>
<refpurpose>
Fetch Apache version
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>apache_get_version</methodname>
<void/>
</methodsynopsis>
<para>
<function>apache_get_version</function> returns the version of Apache as
string, or &false; on failure.
</para>
<example>
<title><function>apache_get_version</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.6 $ -->
<refentry id="function.apache-get-version">
<refnamediv>
<refname>apache_get_version</refname>
<refpurpose>Fetch Apache version</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>apache_get_version</methodname>
<void/>
</methodsynopsis>
<para>
<function>apache_get_version</function> returns the version of Apache as
string, or &false; on failure.
</para>
<example>
<title><function>apache_get_version</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$version = apache_get_version();
echo "$version\n";
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Apache/1.3.29 (Unix) PHP/4.3.4
]]>
</screen>
</example>
<note>
<para>
This function is available only in Apache 2 <emphasis>handler</emphasis>.
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 <emphasis>filter</emphasis>.
</para>
</note>
<para>
See also <function>phpinfo</function>.
</para>
</refsect1>
</refentry>
</screen>
</example>
<note>
<para>
This function is available only in Apache 2 <emphasis>handler</emphasis>.
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 <emphasis>filter</emphasis>.
</para>
</note>
<para>
See also <function>phpinfo</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

80
reference/apache/functions/apache-getenv.xml
View file

@ -1,50 +1,50 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<refentry id="function.apache-getenv">
<refnamediv>
<refname>apache_getenv</refname>
<refpurpose>Get an Apache subprocess_env variable</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>apache_getenv</methodname>
<methodparam><type>string</type><parameter>variable</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>walk_to_top</parameter></methodparam>
</methodsynopsis>
<para>
<function>apache_getenv</function> returns the value of the Apache
environment variable specified by <parameter>variable</parameter>, or
&false; on failure.
</para>
<note>
<para>
<function>apache_getenv</function> is only defined when using
Apache 2.
</para>
</note>
<example>
<title><function>apache_getenv</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.5 $ -->
<refentry id="function.apache-getenv">
<refnamediv>
<refname>apache_getenv</refname>
<refpurpose>Get an Apache subprocess_env variable</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>apache_getenv</methodname>
<methodparam><type>string</type><parameter>variable</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>walk_to_top</parameter></methodparam>
</methodsynopsis>
<para>
<function>apache_getenv</function> returns the value of the Apache
environment variable specified by <parameter>variable</parameter>, or
&false; on failure.
</para>
<note>
<para>
<function>apache_getenv</function> is only defined when using
Apache 2.
</para>
</note>
<example>
<title><function>apache_getenv</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$ret = apache_getenv("SERVER_ADDR");
echo $ret;
?>
]]>
</programlisting>
<para>
The example above shows how to retrieve the value of the Apache
environment variable "SERVER_ADDR".
</para>
</example>
<para>
See also <function>apache_setenv</function>,
<function>getenv</function>&listendand;
<link linkend="language.variables.superglobals">Superglobals</link>.
</para>
</refsect1>
</refentry>
</programlisting>
<para>
The example above shows how to retrieve the value of the Apache
environment variable "SERVER_ADDR".
</para>
</example>
<para>
See also <function>apache_setenv</function>,
<function>getenv</function>&listendand;
<link linkend="language.variables.superglobals">Superglobals</link>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

121
reference/apache/functions/apache-lookup-uri.xml
View file

@ -1,53 +1,50 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/apache.xml, last change in rev 1.2 -->
<refentry id="function.apache-lookup-uri">
<refnamediv>
<refname>apache_lookup_uri</refname>
<refpurpose>
Perform a partial request for the specified URI and return all
info about it
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>object</type><methodname>apache_lookup_uri</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
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:
<simplelist>
<member>status</member>
<member>the_request</member>
<member>status_line</member>
<member>method</member>
<member>content_type</member>
<member>handler</member>
<member>uri</member>
<member>filename</member>
<member>path_info</member>
<member>args</member>
<member>boundary</member>
<member>no_cache</member>
<member>no_local_copy</member>
<member>allowed</member>
<member>send_bodyct</member>
<member>bytes_sent</member>
<member>byterange</member>
<member>clength</member>
<member>unparsed_uri</member>
<member>mtime</member>
<member>request_time</member>
</simplelist>
</para>
<para>
<example>
<title><function>apache_lookup_uri</function> example</title>
<programlisting role="php">
<refentry id="function.apache-lookup-uri">
<refnamediv>
<refname>apache_lookup_uri</refname>
<refpurpose>Perform a partial request for the specified URI and return all info about it</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>object</type><methodname>apache_lookup_uri</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
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:
<simplelist>
<member>status</member>
<member>the_request</member>
<member>status_line</member>
<member>method</member>
<member>content_type</member>
<member>handler</member>
<member>uri</member>
<member>filename</member>
<member>path_info</member>
<member>args</member>
<member>boundary</member>
<member>no_cache</member>
<member>no_local_copy</member>
<member>allowed</member>
<member>send_bodyct</member>
<member>bytes_sent</member>
<member>byterange</member>
<member>clength</member>
<member>unparsed_uri</member>
<member>mtime</member>
<member>request_time</member>
</simplelist>
</para>
<para>
<example>
<title><function>apache_lookup_uri</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$info = apache_lookup_uri('index.php?var=value');
@ -58,9 +55,9 @@ if (file_exists($info->filename)) {
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
stdClass Object
(
@ -84,17 +81,17 @@ stdClass Object
)
file exists!
]]>
</screen>
</example>
</para>
<note>
<simpara>
<function>apache_lookup_uri</function> only works when PHP
is installed as an Apache module.
</simpara>
</note>
</refsect1>
</refentry>
</screen>
</example>
</para>
<note>
<simpara>
<function>apache_lookup_uri</function> only works when PHP
is installed as an Apache module.
</simpara>
</note>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

50
reference/apache/functions/apache-note.xml
View file

@ -1,30 +1,30 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/apache.xml, last change in rev 1.2 -->
<refentry id="function.apache-note">
<refnamediv>
<refname>apache_note</refname>
<refpurpose>Get and set apache request notes</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>apache_note</methodname>
<methodparam><type>string</type><parameter>note_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>note_value</parameter></methodparam>
</methodsynopsis>
<para>
<function>apache_note</function> is an Apache-specific function
which gets and sets values in a request's
<literal>notes</literal> table. If called with one argument, it
returns the current value of note
<literal>note_name</literal>. If called with two arguments, it
sets the value of note <literal>note_name</literal> to
<literal>note_value</literal> and returns the previous value of
note <literal>note_name</literal>.
</para>
</refsect1>
</refentry>
<refentry id="function.apache-note">
<refnamediv>
<refname>apache_note</refname>
<refpurpose>Get and set apache request notes</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>apache_note</methodname>
<methodparam><type>string</type><parameter>note_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>note_value</parameter></methodparam>
</methodsynopsis>
<para>
<function>apache_note</function> is an Apache-specific function
which gets and sets values in a request's
<literal>notes</literal> table. If called with one argument, it
returns the current value of note
<literal>note_name</literal>. If called with two arguments, it
sets the value of note <literal>note_name</literal> to
<literal>note_value</literal> and returns the previous value of
note <literal>note_name</literal>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

102
reference/apache/functions/apache-request-headers.xml
View file

@ -1,27 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/apache.xml, last change in rev 1.2 -->
<refentry id="function.apache-request-headers">
<refnamediv>
<refname>apache_request_headers</refname>
<refpurpose>Fetch all HTTP request headers</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>apache_request_headers</methodname>
<void/>
</methodsynopsis>
<para>
<function>apache_request_headers</function> returns an associative
array of all the HTTP headers in the current request. This is only
supported when PHP runs as an <productname>Apache</productname>
module.
</para>
<para>
<example>
<title><function>apache_request_headers</function> example</title>
<programlisting role="php">
<refentry id="function.apache-request-headers">
<refnamediv>
<refname>apache_request_headers</refname>
<refpurpose>Fetch all HTTP request headers</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>apache_request_headers</methodname>
<void/>
</methodsynopsis>
<para>
<function>apache_request_headers</function> returns an associative
array of all the HTTP headers in the current request. This is only
supported when PHP runs as an <productname>Apache</productname>
module.
</para>
<para>
<example>
<title><function>apache_request_headers</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$headers = apache_request_headers();
@ -31,9 +31,9 @@ foreach ($headers as $header => $value) {
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Accept: */*
Accept-Language: en-us
@ -42,32 +42,32 @@ User-Agent: Mozilla/4.0
Host: www.example.com
Connection: Keep-Alive
]]>
</screen>
</example>
</para>
<note>
<para>
Prior to PHP 4.3.0, <function>apache_request_headers</function> was
called <function>getallheaders</function>. After PHP 4.3.0,
<function>getallheaders</function> is an alias for
<function>apache_request_headers</function>.
</para>
</note>
<note>
<para>
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 <productname>Apache</productname> module. Use
<function>phpinfo</function> to see a list of all of the available
<link linkend="language.variables.predefined">environment variables</link>.
</para>
</note>
&note.apache.nsapi-module;
<para>
See also <function>apache_response_headers</function>.
</para>
</refsect1>
</refentry>
</screen>
</example>
</para>
<note>
<para>
Prior to PHP 4.3.0, <function>apache_request_headers</function> was
called <function>getallheaders</function>. After PHP 4.3.0,
<function>getallheaders</function> is an alias for
<function>apache_request_headers</function>.
</para>
</note>
<note>
<para>
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 <productname>Apache</productname> module. Use
<function>phpinfo</function> to see a list of all of the available
<link linkend="language.variables.predefined">environment variables</link>.
</para>
</note>
&note.apache.nsapi-module;
<para>
See also <function>apache_response_headers</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

62
reference/apache/functions/apache-reset-timeout.xml
View file

@ -1,36 +1,34 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.apache-reset-timeout">
<refnamediv>
<refname>apache_reset_timeout</refname>
<refpurpose>
Reset the Apache write timer
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>apache_reset_timeout</methodname>
<void/>
</methodsynopsis>
<para>
<function>apache_reset_timeout</function> resets the Apache write timer,
which defaults to 300 seconds. With <literal>set_time_limit(0);
ignore_user_abort(true)</literal> and periodic
<function>apache_reset_timeout</function> calls, Apache can theoretically
run forever.
</para>
<para>
&return.success;
</para>
<note>
<simpara>
This functions is just available for Apache 1.
</simpara>
</note>
&note.sm.disabled;
</refsect1>
</refentry>
<!-- $Revision: 1.2 $ -->
<refentry id="function.apache-reset-timeout">
<refnamediv>
<refname>apache_reset_timeout</refname>
<refpurpose>Reset the Apache write timer</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>apache_reset_timeout</methodname>
<void/>
</methodsynopsis>
<para>
<function>apache_reset_timeout</function> resets the Apache write timer,
which defaults to 300 seconds. With <literal>set_time_limit(0);
ignore_user_abort(true)</literal> and periodic
<function>apache_reset_timeout</function> calls, Apache can theoretically
run forever.
</para>
<para>
&return.success;
</para>
<note>
<simpara>
This functions is just available for Apache 1.
</simpara>
</note>
&note.sm.disabled;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

66
reference/apache/functions/apache-response-headers.xml
View file

@ -1,34 +1,32 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- $Revision: 1.11 $ -->
<!-- splitted from ./en/functions/apache.xml, last change in rev 1.2 -->
<refentry id="function.apache-response-headers">
<refnamediv>
<refname>apache_response_headers</refname>
<refpurpose>
Fetch all HTTP response headers
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>apache_response_headers</methodname>
<void/>
</methodsynopsis>
<para>
Returns an array of all Apache response headers.
</para>
<para>
<example>
<title><function>apache_response_headers</function> example</title>
<programlisting role="php">
<refentry id="function.apache-response-headers">
<refnamediv>
<refname>apache_response_headers</refname>
<refpurpose>Fetch all HTTP response headers</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>apache_response_headers</methodname>
<void/>
</methodsynopsis>
<para>
Returns an array of all Apache response headers.
</para>
<para>
<example>
<title><function>apache_response_headers</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
print_r(apache_response_headers());
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
@ -36,16 +34,16 @@ Array
[X-Powered-By] => PHP/4.3.8
)
]]>
</screen>
</example>
</para>
&note.apache.nsapi-module;
<para>
See also <function>apache_request_headers</function>, and
<function>headers_sent</function>.
</para>
</refsect1>
</refentry>
</screen>
</example>
</para>
&note.apache.nsapi-module;
<para>
See also <function>apache_request_headers</function>, and
<function>headers_sent</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

82
reference/apache/functions/apache-setenv.xml
View file

@ -1,51 +1,51 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/apache.xml, last change in rev 1.7 -->
<refentry id="function.apache-setenv">
<refnamediv>
<refname>apache_setenv</refname>
<refpurpose>Set an Apache subprocess_env variable</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>apache_setenv</methodname>
<methodparam><type>string</type><parameter>variable</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>walk_to_top</parameter></methodparam>
</methodsynopsis>
<para>
<function>apache_setenv</function> sets the value of the Apache
environment variable specified by
<parameter>variable</parameter>.
</para>
<note>
<para>
When setting an Apache environment variable, the corresponding $_SERVER
variable is not changed.
</para>
</note>
<example>
<title>Setting an Apache environment variable using <function>apache_setenv</function></title>
<programlisting role="php">
<refentry id="function.apache-setenv">
<refnamediv>
<refname>apache_setenv</refname>
<refpurpose>Set an Apache subprocess_env variable</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>apache_setenv</methodname>
<methodparam><type>string</type><parameter>variable</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>walk_to_top</parameter></methodparam>
</methodsynopsis>
<para>
<function>apache_setenv</function> sets the value of the Apache
environment variable specified by
<parameter>variable</parameter>.
</para>
<note>
<para>
When setting an Apache environment variable, the corresponding $_SERVER
variable is not changed.
</para>
</note>
<example>
<title>Setting an Apache environment variable using <function>apache_setenv</function></title>
<programlisting role="php">
<![CDATA[
<?php
apache_setenv("EXAMPLE_VAR", "Example Value");
?>
]]>
</programlisting>
</example>
<para>
<function>apache_setenv</function> can be paired up with
<function>apache_getenv</function> across separate pages or for setting
variables to pass to Server Side Includes (.shtml) that have been
included in PHP scripts.
</para>
<para>
See also <function>apache_getenv</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
<para>
<function>apache_setenv</function> can be paired up with
<function>apache_getenv</function> across separate pages or for setting
variables to pass to Server Side Includes (.shtml) that have been
included in PHP scripts.
</para>
<para>
See also <function>apache_getenv</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

48
reference/apache/functions/ascii2ebcdic.xml
View file

@ -1,29 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/apache.xml, last change in rev 1.10 -->
<refentry id="function.ascii2ebcdic">
<refnamediv>
<refname>ascii2ebcdic</refname>
<refpurpose>Translate string from ASCII to EBCDIC</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ascii2ebcdic</methodname>
<methodparam><type>string</type><parameter>ascii_str</parameter></methodparam>
</methodsynopsis>
<para>
<function>ascii2ebcdic</function> is an Apache-specific function which
is available only on EBCDIC based operating systems (OS/390, BS2000).
It translates the ASCII encoded string <parameter>ascii_str</parameter>
to its equivalent EBCDIC representation (binary safe), and returns
the result.
</para>
<para>
See also the reverse function <function>ebcdic2ascii</function>
</para>
</refsect1>
</refentry>
<refentry id="function.ascii2ebcdic">
<refnamediv>
<refname>ascii2ebcdic</refname>
<refpurpose>Translate string from ASCII to EBCDIC</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ascii2ebcdic</methodname>
<methodparam><type>string</type><parameter>ascii_str</parameter></methodparam>
</methodsynopsis>
<para>
<function>ascii2ebcdic</function> is an Apache-specific function which
is available only on EBCDIC based operating systems (OS/390, BS2000).
It translates the ASCII encoded string <parameter>ascii_str</parameter>
to its equivalent EBCDIC representation (binary safe), and returns
the result.
</para>
<para>
See also the reverse function <function>ebcdic2ascii</function>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

48
reference/apache/functions/ebcdic2ascii.xml
View file

@ -1,29 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/apache.xml, last change in rev 1.10 -->
<refentry id="function.ebcdic2ascii">
<refnamediv>
<refname>ebcdic2ascii</refname>
<refpurpose>Translate string from EBCDIC to ASCII</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ebcdic2ascii</methodname>
<methodparam><type>string</type><parameter>ebcdic_str</parameter></methodparam>
</methodsynopsis>
<para>
<function>ebcdic2ascii</function> is an Apache-specific function which
is available only on EBCDIC based operating systems (OS/390, BS2000).
It translates the EBCDIC encoded string <parameter>ebcdic_str</parameter>
to its equivalent ASCII representation (binary safe), and returns
the result.
</para>
<para>
See also the reverse function <function>ascii2ebcdic</function>
</para>
</refsect1>
</refentry>
<refentry id="function.ebcdic2ascii">
<refnamediv>
<refname>ebcdic2ascii</refname>
<refpurpose>Translate string from EBCDIC to ASCII</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ebcdic2ascii</methodname>
<methodparam><type>string</type><parameter>ebcdic_str</parameter></methodparam>
</methodsynopsis>
<para>
<function>ebcdic2ascii</function> is an Apache-specific function which
is available only on EBCDIC based operating systems (OS/390, BS2000).
It translates the EBCDIC encoded string <parameter>ebcdic_str</parameter>
to its equivalent ASCII representation (binary safe), and returns
the result.
</para>
<para>
See also the reverse function <function>ascii2ebcdic</function>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

68
reference/apache/functions/getallheaders.xml
View file

@ -1,39 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/apache.xml, last change in rev 1.2 -->
<refentry id="function.getallheaders">
<refnamediv>
<refname>getallheaders</refname>
<refpurpose>Fetch all HTTP request headers</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>getallheaders</methodname>
<void/>
</methodsynopsis>
<para>
<function>getallheaders</function> is an alias for
<function>apache_request_headers</function>. It will return an
associative array of all the HTTP headers in the current request.
Please read the <function>apache_request_headers</function>
documentation for more information on how this function works.
</para>
<note>
<para>
In PHP 4.3.0, <function>getallheaders</function> became an
alias for <function>apache_request_headers</function>.
Essentially, it was renamed. This is because this function
only works when PHP is compiled as an
<productname>Apache</productname> Module.
</para>
</note>
&note.apache.nsapi-module;
<para>
See also <function>apache_request_headers</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.getallheaders">
<refnamediv>
<refname>getallheaders</refname>
<refpurpose>Fetch all HTTP request headers</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>getallheaders</methodname>
<void/>
</methodsynopsis>
<para>
<function>getallheaders</function> is an alias for
<function>apache_request_headers</function>. It will return an
associative array of all the HTTP headers in the current request.
Please read the <function>apache_request_headers</function>
documentation for more information on how this function works.
</para>
<note>
<para>
In PHP 4.3.0, <function>getallheaders</function> became an
alias for <function>apache_request_headers</function>.
Essentially, it was renamed. This is because this function
only works when PHP is compiled as an
<productname>Apache</productname> Module.
</para>
</note>
&note.apache.nsapi-module;
<para>
See also <function>apache_request_headers</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

86
reference/apache/functions/virtual.xml
View file

@ -1,48 +1,48 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- $Revision: 1.11 $ -->
<!-- splitted from ./en/functions/apache.xml, last change in rev 1.20 -->
<refentry id="function.virtual">
<refnamediv>
<refname>virtual</refname>
<refpurpose>Perform an Apache sub-request</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>virtual</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
<function>virtual</function> is an Apache-specific function which
is equivalent to &lt;!--#include virtual...--&gt; 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.
</para>
<para>
To run the sub-request, all buffers are terminated and flushed to the
browser, pending headers are sent too.
</para>
<warning>
<para>
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 <varname>$_GET</varname> is copied from
the parent script and only <varname>$_SERVER['QUERY_STRING']</varname> 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.
</para>
</warning>
<para>
As of PHP 4.0.6, you can use <function>virtual</function> on PHP files.
However, it is typically better to use <function>include</function> or
<function>require</function> if you need to include another PHP file.
</para>
&note.apache.nsapi-module;
</refsect1>
</refentry>
<refentry id="function.virtual">
<refnamediv>
<refname>virtual</refname>
<refpurpose>Perform an Apache sub-request</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>virtual</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
<function>virtual</function> is an Apache-specific function which
is equivalent to &lt;!--#include virtual...--&gt; 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.
</para>
<para>
To run the sub-request, all buffers are terminated and flushed to the
browser, pending headers are sent too.
</para>
<warning>
<para>
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 <varname>$_GET</varname> is copied from
the parent script and only <varname>$_SERVER['QUERY_STRING']</varname> 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.
</para>
</warning>
<para>
As of PHP 4.0.6, you can use <function>virtual</function> on PHP files.
However, it is typically better to use <function>include</function> or
<function>require</function> if you need to include another PHP file.
</para>
&note.apache.nsapi-module;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: