File: nsapi-request-headers.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (82 lines) | stat: -rw-r--r-- 2,196 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry id="function.nsapi-request-headers">
 <refnamediv>
  <refname>nsapi_request_headers</refname>
  <refpurpose>Fetch all HTTP request headers</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>nsapi_request_headers</methodname>
   <void/>
  </methodsynopsis>
  <para>
   <function>nsapi_request_headers</function> gets all the HTTP headers in
   the current request. This is only supported when PHP runs as a 
   <productname>NSAPI</productname> module.
  </para>
  <note>
   <para>
    Prior to PHP 4.3.3, <function>getallheaders</function> was only 
    available for the Apache servers.  After PHP 4.3.3,
    <function>getallheaders</function> is an alias for
    <function>nsapi_request_headers</function> if you use the NSAPI module.
   </para>
  </note>
  <note>
   <para>
    You can also get at the value of the common CGI variables by
    reading them from the <literal>$_SERVER</literal> superglobal, which 
    works whether or not you are using PHP as a 
    <productname>NSAPI</productname> module.
   </para>
  </note>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an associative array with all the HTTP headers.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>nsapi_request_headers</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$headers = nsapi_request_headers();

foreach ($headers as $header => $value) {
  echo "$header: $value <br />\n";
}
?>
]]>
    </programlisting>
   </example>
  </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
-->