mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
ref.apache: Implemented the new doc style, new entities, and rewording where appropriate.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@183383 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson
parent
eb55c333f3
commit
c3c8b34adc
14 changed files with 611 additions and 168 deletions
|
|
@ -1,13 +1,14 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<!-- 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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>apache_child_terminate</methodname>
|
||||
<void/>
|
||||
|
|
@ -20,20 +21,30 @@
|
|||
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>
|
||||
¬e.no-windows;
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
See also <function>exit</function>.
|
||||
Returns &true; if PHP is running as an Apache 1 module, the Apache version
|
||||
is non-multithreaded, and the
|
||||
<link linkend="ini.child-terminate">child_terminate</link> PHP directive is
|
||||
enabled (disabled by default). If these conditions are not met, &false; is
|
||||
returned and an error of level <constant>E_WARNING</constant> is generated.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="notes">
|
||||
&reftitle.notes;
|
||||
¬e.no-windows;
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>exit</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,19 +1,57 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>apache_get_modules</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
This function returns an array with the loaded Apache modules.
|
||||
Get a list of loaded Apache modules.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
An <type>array</type> of loaded Apache modules.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="changelog">
|
||||
&reftitle.changelog;
|
||||
<para>
|
||||
<informaltable>
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>&Version;</entry>
|
||||
<entry>&Description;</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>5.0.0</entry>
|
||||
<entry>
|
||||
Became available when using Apache 1, or the PHP Apache 2
|
||||
<emphasis>filter</emphasis> API. Before this time, it was only
|
||||
available when using the Apache 2 <emphasis>handler</emphasis> API.
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>apache_get_modules</function> example</title>
|
||||
|
|
@ -40,13 +78,6 @@ Array
|
|||
</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>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,46 +1,87 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry id="function.apache-get-version">
|
||||
<refnamediv>
|
||||
<refname>apache_get_version</refname>
|
||||
<refpurpose>Fetch Apache version</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<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.
|
||||
Fetch the Apache version.
|
||||
</para>
|
||||
<example>
|
||||
<title><function>apache_get_version</function> example</title>
|
||||
<programlisting role="php">
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the Apache version on success, or &false; on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="changelog">
|
||||
&reftitle.changelog;
|
||||
<para>
|
||||
<informaltable>
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>&Version;</entry>
|
||||
<entry>&Description;</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>4.3.4</entry>
|
||||
<entry>
|
||||
Became available with Apache 1.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>5.0.0</entry>
|
||||
<entry>
|
||||
Became available with the Apache 2 <emphasis>filter</emphasis> API.
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<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>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
See also <function>phpinfo</function>.
|
||||
<simplelist>
|
||||
<member><function>phpinfo</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,47 +1,94 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry id="function.apache-getenv">
|
||||
<refnamediv>
|
||||
<refname>apache_getenv</refname>
|
||||
<refpurpose>Get an Apache subprocess_env variable</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<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.
|
||||
Get an Apache environment variable as specified by
|
||||
<parameter>variable</parameter>.
|
||||
</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">
|
||||
<para>
|
||||
This function requires Apache 2 otherwise it's undefined.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>variable</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The Apache environment variable
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>walk_to_top</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The <parameter>walk_to_top</parameter> parameter.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
The value of the Apache environment variable on success, or &false; on
|
||||
failure
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>functionname</function> example</title>
|
||||
<para>
|
||||
The example above shows how to retrieve the value of the Apache
|
||||
environment variable <varname>SERVER_ADDR</varname>.
|
||||
</para>
|
||||
<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>
|
||||
</programlisting>
|
||||
&example.outputs.similar;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
42.24.42.240
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
See also <function>apache_setenv</function>,
|
||||
<function>getenv</function>&listendand;
|
||||
<link linkend="language.variables.superglobals">Superglobals</link>.
|
||||
<simplelist>
|
||||
<member><function>apache_sentenv</function></member>
|
||||
<member><function>getenv</function></member>
|
||||
<member><link linkend="language.variables.superglobals">Superglobals</link></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,14 @@
|
|||
<?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.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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>object</type><methodname>apache_lookup_uri</methodname>
|
||||
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
|
||||
|
|
@ -15,8 +16,34 @@
|
|||
<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:
|
||||
resource.
|
||||
</para>
|
||||
&apache.req.module;
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>filename</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The filename (URI) that's being requested, or &false; on failure.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
An <type>object</type> of related URI information. The properties of
|
||||
this <type>object</type> are:
|
||||
</para>
|
||||
<para>
|
||||
<simplelist>
|
||||
<member>status</member>
|
||||
<member>the_request</member>
|
||||
|
|
@ -41,6 +68,10 @@
|
|||
<member>request_time</member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>apache_lookup_uri</function> example</title>
|
||||
|
|
@ -84,12 +115,6 @@ 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>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,13 +1,14 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- 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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>apache_note</methodname>
|
||||
<methodparam><type>string</type><parameter>note_name</parameter></methodparam>
|
||||
|
|
@ -16,12 +17,43 @@
|
|||
<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>notes</literal> table.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>note_name</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The name of the note.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>note_value</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The value of the note.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
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>.
|
||||
If the note cannot be retrieved, &false; is returned.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,23 +1,34 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.9 $ -->
|
||||
<!-- $Revision: 1.10 $ -->
|
||||
<!-- 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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<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.
|
||||
Fetches all HTTP requests from the current request.
|
||||
</para>
|
||||
&apache.req.module;
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
An associative array of all the HTTP headers in the current request, or
|
||||
&false; on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>apache_request_headers</function> example</title>
|
||||
|
|
@ -45,6 +56,10 @@ Connection: Keep-Alive
|
|||
</screen>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="notes">
|
||||
&reftitle.notes;
|
||||
<note>
|
||||
<para>
|
||||
Prior to PHP 4.3.0, <function>apache_request_headers</function> was
|
||||
|
|
@ -63,8 +78,14 @@ Connection: Keep-Alive
|
|||
</para>
|
||||
</note>
|
||||
¬e.apache.nsapi-module;
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
See also <function>apache_response_headers</function>.
|
||||
<simplelist>
|
||||
<member><function>apache_response_headers</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<refentry id="function.apache-reset-timeout">
|
||||
<refnamediv>
|
||||
<refname>apache_reset_timeout</refname>
|
||||
<refpurpose>Reset the Apache write timer</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>apache_reset_timeout</methodname>
|
||||
<void/>
|
||||
|
|
@ -14,18 +15,24 @@
|
|||
<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
|
||||
ignore_user_abort(true)</literal> and periodic
|
||||
<function>apache_reset_timeout</function> calls, Apache can theoretically
|
||||
run forever.
|
||||
</para>
|
||||
<para>
|
||||
This function requires Apache 1.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
<note>
|
||||
<simpara>
|
||||
This functions is just available for Apache 1.
|
||||
</simpara>
|
||||
</note>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="notes">
|
||||
&reftitle.notes;
|
||||
¬e.sm.disabled;
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,20 +1,32 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.11 $ -->
|
||||
<!-- $Revision: 1.12 $ -->
|
||||
<!-- 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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>apache_response_headers</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Returns an array of all Apache response headers.
|
||||
Fetch all HTTP response headers.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
An array of all Apache response headers on success, or &false; on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>apache_response_headers</function> example</title>
|
||||
|
|
@ -37,10 +49,20 @@ Array
|
|||
</screen>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="notes">
|
||||
&reftitle.notes;
|
||||
¬e.apache.nsapi-module;
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
See also <function>apache_request_headers</function>, and
|
||||
<function>headers_sent</function>.
|
||||
<simplelist>
|
||||
<member><function>apache_request_headers</function></member>
|
||||
<member><function>headers_sent</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,14 @@
|
|||
<?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.7 -->
|
||||
<refentry id="function.apache-setenv">
|
||||
<refnamediv>
|
||||
<refname>apache_setenv</refname>
|
||||
<refpurpose>Set an Apache subprocess_env variable</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>apache_setenv</methodname>
|
||||
<methodparam><type>string</type><parameter>variable</parameter></methodparam>
|
||||
|
|
@ -21,11 +22,56 @@
|
|||
</para>
|
||||
<note>
|
||||
<para>
|
||||
When setting an Apache environment variable, the corresponding $_SERVER
|
||||
When setting an Apache environment variable, the corresponding
|
||||
<link linkend="reserved.variables.server">$_SERVER</link>
|
||||
variable is not changed.
|
||||
</para>
|
||||
</note>
|
||||
<example>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>variable</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The environment variable that's being set.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>value</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The new <parameter>variable</parameter> value.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>walk_to_top</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The <parameter>walk_to_top</parameter> parameter.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title>Setting an Apache environment variable using <function>apache_setenv</function></title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
|
|
@ -33,16 +79,29 @@
|
|||
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.
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="notes">
|
||||
&reftitle.notes;
|
||||
<note>
|
||||
<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>
|
||||
</note>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
See also <function>apache_getenv</function>.
|
||||
<simplelist>
|
||||
<member><function>apache_getenv</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,14 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- 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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>ascii2ebcdic</methodname>
|
||||
<methodparam><type>string</type><parameter>ascii_str</parameter></methodparam>
|
||||
|
|
@ -19,8 +20,37 @@
|
|||
to its equivalent EBCDIC representation (binary safe), and returns
|
||||
the result.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
See also the reverse function <function>ebcdic2ascii</function>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>ascii_str</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The ASCII string that will be translated.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
The EBCDIC representation of an ASCII string.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>ebcdic2ascii</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,14 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- 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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>ebcdic2ascii</methodname>
|
||||
<methodparam><type>string</type><parameter>ebcdic_str</parameter></methodparam>
|
||||
|
|
@ -19,8 +20,37 @@
|
|||
to its equivalent ASCII representation (binary safe), and returns
|
||||
the result.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
See also the reverse function <function>ascii2ebcdic</function>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>ebcdic_str</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The EBCDIC string that will be translated.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
The ASCII representation of an EBCDIC string.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>ascii2ebcdic</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,36 +1,74 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.9 $ -->
|
||||
<!-- $Revision: 1.10 $ -->
|
||||
<!-- 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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<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.
|
||||
Fetches all HTTP requests from the current request.
|
||||
</para>
|
||||
<para>
|
||||
This function is an alias for <function>apache_request_headers</function>.
|
||||
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>
|
||||
¬e.apache.nsapi-module;
|
||||
&apache.req.module;
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
See also <function>apache_request_headers</function>.
|
||||
An associative array of all the HTTP headers in the current request, or
|
||||
&false; on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="changelog">
|
||||
&reftitle.changelog;
|
||||
<para>
|
||||
<informaltable>
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>&Version;</entry>
|
||||
<entry>&Description;</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>4.3.0</entry>
|
||||
<entry>
|
||||
Became an alias for <function>apache_request_headers</function>.
|
||||
Essentially, it was renamed. This is because this function
|
||||
only works with Apache.
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="notes">
|
||||
&reftitle.notes;
|
||||
¬e.apache.nsapi-module;
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>apache_response_headers</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,14 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.11 $ -->
|
||||
<!-- $Revision: 1.12 $ -->
|
||||
<!-- 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>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>virtual</methodname>
|
||||
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
|
||||
|
|
@ -25,21 +26,69 @@
|
|||
To run the sub-request, all buffers are terminated and flushed to the
|
||||
browser, pending headers are sent too.
|
||||
</para>
|
||||
&apache.req.module;
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>filename</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The file that the virtual command will be performed on.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Performs the virtual command on success, or returns &false; on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="changelog">
|
||||
&reftitle.changelog;
|
||||
<para>
|
||||
<informaltable>
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>&Version;</entry>
|
||||
<entry>&Description;</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>4.0.6</entry>
|
||||
<entry>
|
||||
This function may be used on PHP files. However, it is typically
|
||||
better to use <function>include</function> or
|
||||
<function>require</function> for PHP files.
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="notes">
|
||||
&reftitle.notes;
|
||||
<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.
|
||||
The 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>
|
||||
¬e.apache.nsapi-module;
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
Loading…
Reference in a new issue