cvs: phpdoc /en/reference/nsapi/functions nsapi-request-headers.xml nsapi-response-headers.xml nsapi-virtual.xml

didou Sat Jan 29 19:46:44 2005 EDT Modified files: /phpdoc/en/reference/nsapi/functions nsapi-request-headers.xml nsapi-response-headers.xml nsapi-virtual.xml Log: Migrate docs to the new structue, fix protos and remove useless PHP version information http://cvs.php.net/diff.php/phpdoc/en/reference/nsapi/functions/nsapi-request-headers.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/nsapi/functions/nsapi-request-headers.xml diff -u phpdoc/en/reference/nsapi/functions/nsapi-request-headers.xml:1.2 phpdoc/en/reference/nsapi/functions/nsapi-request-headers.xml:1.3 --- phpdoc/en/reference/nsapi/functions/nsapi-request-headers.xml:1.2 Tue Jul 15 04:00:48 2003 +++ phpdoc/en/reference/nsapi/functions/nsapi-request-headers.xml Sat Jan 29 19:46:43 2005 @@ -1,22 +1,46 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.nsapi-request-headers"> <refnamediv> <refname>nsapi_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>nsapi_request_headers</methodname> <void/> </methodsynopsis> <para> - <function>nsapi_request_headers</function> returns an associative - array of all the HTTP headers in the current request. This is only - supported when PHP runs as a <productname>NSAPI</productname> - module. + <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> @@ -33,20 +57,6 @@ </programlisting> </example> </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> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/nsapi/functions/nsapi-response-headers.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/nsapi/functions/nsapi-response-headers.xml diff -u phpdoc/en/reference/nsapi/functions/nsapi-response-headers.xml:1.3 phpdoc/en/reference/nsapi/functions/nsapi-response-headers.xml:1.4 --- phpdoc/en/reference/nsapi/functions/nsapi-response-headers.xml:1.3 Fri Mar 5 21:40:22 2004 +++ phpdoc/en/reference/nsapi/functions/nsapi-response-headers.xml Sat Jan 29 19:46:43 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.nsapi-response-headers"> <refnamediv> <refname>nsapi_response_headers</refname> @@ -7,19 +7,29 @@ Fetch all HTTP response headers </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>nsapi_response_headers</methodname> <void/> </methodsynopsis> <para> - Returns an array of all NSAPI response headers. This functionality - is only available in PHP 4.3.3 and greater. + Gets all the NSAPI response headers. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an associative array with all the NSAPI response headers. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>nsapi_request_headers</function> and - <function>headers_sent</function>. + <simplelist> + <member><function>nsapi_request_headers</function></member> + <member><function>headers_sent</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/nsapi/functions/nsapi-virtual.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/nsapi/functions/nsapi-virtual.xml diff -u phpdoc/en/reference/nsapi/functions/nsapi-virtual.xml:1.8 phpdoc/en/reference/nsapi/functions/nsapi-virtual.xml:1.9 --- phpdoc/en/reference/nsapi/functions/nsapi-virtual.xml:1.8 Mon Aug 9 12:53:14 2004 +++ phpdoc/en/reference/nsapi/functions/nsapi-virtual.xml Sat Jan 29 19:46:43 2005 @@ -1,14 +1,14 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.nsapi-virtual"> <refnamediv> <refname>nsapi_virtual</refname> <refpurpose>Perform an NSAPI sub-request</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>nsapi_virtual</methodname> + <type>bool</type><methodname>nsapi_virtual</methodname> <methodparam><type>string</type><parameter>uri</parameter></methodparam> </methodsynopsis> <para> @@ -33,13 +33,36 @@ webservers. Use <function>phpinfo</function> to determine if it is available. In the Unix environment it should always work, in windows it depends on the name of a <filename>ns-httpdXX.dll</filename> file. - Read the note about subrequests in the NSAPI section - (<link linkend='install.unix.sun.notes'>UNIX</link>, - <link linkend='install.windows.sun.notes'>Windows</link>) - if you experience this problem. + </para> + <para> + Read the note about subrequests in the NSAPI section (<link + linkend='install.unix.sun.notes'>UNIX</link>, <link + linkend='install.windows.sun.notes'>Windows</link>) if you experience + this problem. </para> </note> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>uri</parameter></term> + <listitem> + <para> + The URI of the script. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file