cvs: peardoc /en/package/http http-request.xml /en/package/http/http-request TODO response-eval.xml

From:	Martin Jansen	Date:	Mon, 23 Feb 2004 12:15:17 +0000
Subject:	cvs: peardoc /en/package/http http-request.xml /en/package/http/http-request TODO response-eval.xml
Groups:	php.pear.doc
Request:	Send a blank email to pear-doc+get-2707@lists.php.net to get a copy of this message

mj Mon Feb 23 07:15:17 2004 EDT Added files: /peardoc/en/package/http/http-request response-eval.xml Modified files: /peardoc/en/package/http http-request.xml /peardoc/en/package/http/http-request TODO Log: * Adding a section about evaluating the information from a HTTP response. http://cvs.php.net/diff.php/peardoc/en/package/http/http-request.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/package/http/http-request.xml diff -u peardoc/en/package/http/http-request.xml:1.1 peardoc/en/package/http/http-request.xml:1.2 --- peardoc/en/package/http/http-request.xml:1.1 Sat Feb 21 11:46:08 2004 +++ peardoc/en/package/http/http-request.xml Mon Feb 23 07:15:14 2004 @@ -1,4 +1,4 @@ - + <sect1 id="package.http.http-request"> <title>HTTP_Request</title> @@ -14,6 +14,7 @@ &package.http.http-request.file-upload; &package.http.http-request.headers; &package.http.http-request.proxy-auth; + &package.http.http-request.response-eval; </sect1>  <refentry id="package.http.http-request.response-eval"> <refnamediv> <refname>Response Evaluation</refname> <refpurpose> Evaluating the information from a HTTP response </refpurpose> </refnamediv> <refsect1 id="package.http.http-request.response-eval.intro"> <title>Introduction</title> <para> Because HTTP is a protocol based on the <emphasis>Request - Response</emphasis> scheme, every HTTP request is followed by a HTTP response. <classname>HTTP_Request</classname> offers several methods to evaluate the information from these responses. </para> </refsect1> <refsect1 id="package.http.http-request.response-eval.codes"> <title>Response Codes</title> <para> A important part of the HTTP response is the response code. The most well-known response code probably is <literal>404</literal>, which you may have seen in your browser at several occasions. The meaning of <literal>404</literal> is that the requested ressource could not be found. A complete list of status codes can be found in <ulink url="&url.rfc;2616">RFC 2616</ulink>. </para> <example> <title>Checking the response code</title> <programlisting role="php"> require_once "HTTP/Request.php"; $urls = array( "http://www.example.com/", "http://example.com/thisdoesnotexist.html" ); $req =& new HTTP_Request(""); foreach ($urls as $url) { $req->setURL($url); $req->sendRequest(); $code = $req->getResponseCode(); switch ($code) { case 404: echo "Document not found\n"; break; case 200: echo "Everything's ok\n"; break; /* ... */ } } </programlisting> </example> </refsect1> <refsect1 id="package.http.http-request.response-eval.header"> <title>Response Headers</title> <para> Similar to a HTTP request a HTTP response consists of a header and a body. <classname>HTTP_Request</classname> offers a method to access the header of the response. </para> <example> <title>Getting all headers from the response</title> <programlisting role="php"> require_once "HTTP/Request.php"; $req =& new HTTP_Request("http://example.com/"); $req->sendRequest(); foreach ($req->getResponseHeader() as $name => $value) { echo $name . " = " . $value . "\n"; } </programlisting> <para> This will print all headers and the appendant values. </para> </example> <example> <title>Getting a specific header</title> <programlisting role="php"> require_once "HTTP/Request.php"; $req =& new HTTP_Request("http://example.com/"); $req->sendRequest(); echo $req->getResponseHeader("Date"); </programlisting> <para> This will print the value of the <literal>Date:</literal> header. </para> </example> </refsect1> <refsect1 id="package.http.http-request.response-eval.cookies"> <title>Response Cookies</title> <para> Fetching the cookies that are part of the HTTP response is described in the <link linkend="package.http.http-request.cookie">Cookies</link> section. </para> </refsect1> </refentry>