php-doc-en/reference/apache/functions/apache-request-headers.xml

112 lines
2.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $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 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>apache_request_headers</methodname>
<void/>
</methodsynopsis>
<para>
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>
<programlisting role="php">
<![CDATA[
<?php
$headers = apache_request_headers();
foreach ($headers as $header => $value) {
echo "$header: $value <br />\n";
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Accept: */*
Accept-Language: en-us
Accept-Encoding: gzip, deflate
User-Agent: Mozilla/4.0
Host: www.example.com
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
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;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>apache_response_headers</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->