From 5003afe9bfe209c87d78565e9558a5f412cc72f3 Mon Sep 17 00:00:00 2001
From: Nuno Lopes <nlopess@php.net>
Date: Sat, 29 May 2004 10:39:03 +0000
Subject: [PATCH] documentation and examples
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@159992 c90b9560-bf6c-de11-be94-00142212c4b1
---
reference/url/functions/get-headers.xml | 59 ++++++++++++++++++++++++-
1 file changed, 57 insertions(+), 2 deletions(-)
diff --git a/reference/url/functions/get-headers.xml b/reference/url/functions/get-headers.xml
index 138c5e2432..669d499678 100644
--- a/reference/url/functions/get-headers.xml
+++ b/reference/url/functions/get-headers.xml
@@ -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>