cvs: phpdoc /en/reference/url/functions get-headers.xml

nlopess Sat May 29 06:39:03 2004 EDT Modified files: /phpdoc/en/reference/url/functions get-headers.xml Log: documentation and examples http://cvs.php.net/diff.php/phpdoc/en/reference/url/functions/get-headers.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/url/functions/get-headers.xml diff -u phpdoc/en/reference/url/functions/get-headers.xml:1.1 phpdoc/en/reference/url/functions/get-headers.xml:1.2 --- phpdoc/en/reference/url/functions/get-headers.xml:1.1 Sun Apr 25 15:21:22 2004 +++ phpdoc/en/reference/url/functions/get-headers.xml Sat May 29 06:39:03 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.get-headers"> <refnamediv> <refname>get_headers</refname> @@ -12,10 +12,65 @@ <methodsynopsis> <type>array</type><methodname>get_headers</methodname> <methodparam><type>string</type><parameter>url</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>format</parameter></methodparam> </methodsynopsis> + <para> + <function>get_headers</function> returns an array with the headers sent + by the server in response to a HTTP request. + </para> + <para> + If the optional <parameter>format</parameter> parameter is true, + <function>get_headers</function> parses the response and sets the array's + keys. + </para> + <para> + <example> + <title><function>get_headers</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +$url = 'http://www.example.com'; - &warn.undocumented.func; +print_r(get_headers($url)); +print_r(get_headers($url, true)); +?> +]]> + </programlisting> + <para> + The above example will output something like: + </para> + <screen> +<![CDATA[ +Array +( + [0] => HTTP/1.1 200 OK + [1] => Date: Sat, 29 May 2004 12:28:13 GMT + [2] => Server: Apache/1.3.27 (Unix) (Red-Hat/Linux) + [3] => Last-Modified: Wed, 08 Jan 2003 23:11:55 GMT + [4] => ETag: "3f80f-1b6-3e1cb03b" + [5] => Accept-Ranges: bytes + [6] => Content-Length: 438 + [7] => Connection: close + [8] => Content-Type: text/html +) + +Array +( + [0] => HTTP/1.1 200 OK + [Date] => Sat, 29 May 2004 12:28:14 GMT + [Server] => Apache/1.3.27 (Unix) (Red-Hat/Linux) + [Last-Modified] => Wed, 08 Jan 2003 23:11:55 GMT + [ETag] => "3f80f-1b6-3e1cb03b" + [Accept-Ranges] => bytes + [Content-Length] => 438 + [Connection] => close + [Content-Type] => text/html +) +]]> + </screen> + </example> + </para> </refsect1> </refentry>