CVS update: phpdoc/functions

Date: Sunday June 27, 1999 @ 21:22 Author: jim Update of /repository/phpdoc/functions In directory php:/tmp/cvs-serv15132 Modified Files: apache.sgml Log Message: Add note to getallheaders() about accessing CGI variables from environment. Index: phpdoc/functions/apache.sgml diff -u phpdoc/functions/apache.sgml:1.2 phpdoc/functions/apache.sgml:1.3 --- phpdoc/functions/apache.sgml:1.2 Sat Jun 19 23:04:55 1999 +++ phpdoc/functions/apache.sgml Sun Jun 27 21:22:31 1999 @@ -14,32 +14,34 @@ <paramdef>string <parameter>filename</parameter></paramdef> </funcsynopsis> <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> + 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> </refsect1> </refentry> @@ -81,8 +83,16 @@ <para> This function returns an associative array of all the HTTP headers in the current request. + <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 Apache module. Use <function>phpinfo</function> to see a + list of all of the environment variables defined this way. + </para> + </note> <example> - <title>GetAllHeaders() Example</title> + <title>getallheaders() Example</title> <programlisting> $headers = getallheaders(); while (list($header, $value) = each($headers)) { @@ -93,7 +103,7 @@ current request. <note> <simpara> - <function>GetAllHeaders</function> is currently only supported + <function>getallheaders</function> is currently only supported when PHP runs as an <productname>Apache</productname> module. </simpara> </note> @@ -112,20 +122,18 @@ <paramdef>string <parameter>filename</parameter></paramdef> </funcsynopsis> <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. - For PHP files, you should use <function>include</function> or - <function>require</function>. + <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. For PHP files, you should use + <function>include</function> or <function>require</function>. </refsect1> </refentry> - - - </reference> + </reference> <!-- Keep this comment at the end of the file Local variables: