#include "php_http_exception_object.h"
#include "phpstr/phpstr.h"
-#include "missing.h"
+#include "missing.h"
ZEND_EXTERN_MODULE_GLOBALS(http);
/* {{{ proto void HttpMessage::__construct([string message])
*
* Instantiate a new HttpMessage object.
+ *
+ * Accepts an optional string parameter containing a single or several
+ * consecutive HTTP messages. The constructed object will actually
+ * represent the *last* message of the passed string. If there were
+ * prior messages, those can be accessed by HttpMessage::getParentMessage().
+ *
+ * Throws HttpMalformedHeaderException.
*/
PHP_METHOD(HttpMessage, __construct)
{
/* {{{ proto static HttpMessage HttpMessage::fromString(string raw_message)
*
- * Create an HttpMessage object from a string.
+ * Create an HttpMessage object from a string. Kind of a static constructor.
+ *
+ * Expects a string parameter containing a sinlge or several consecutive
+ * HTTP messages.
+ *
+ * Returns an HttpMessage object on success or NULL on failure.
+ *
+ * Throws HttpMalformedHeadersException.
*/
PHP_METHOD(HttpMessage, fromString)
{
int length = 0;
http_message *msg = NULL;
- if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &string, &length)) {
- RETURN_NULL();
- }
-
- if (!(msg = http_message_parse(string, length))) {
- RETURN_NULL();
+ RETVAL_NULL();
+
+ SET_EH_THROW_HTTP();
+ if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &string, &length)) {
+ if (msg = http_message_parse(string, length)) {
+ Z_TYPE_P(return_value) = IS_OBJECT;
+ return_value->value.obj = http_message_object_from_msg(msg);
+ }
}
-
- Z_TYPE_P(return_value) = IS_OBJECT;
- return_value->value.obj = http_message_object_from_msg(msg);
+ SET_EH_NORMAL();
}
/* }}} */
/* {{{ proto string HttpMessage::getBody()
*
- * Get the body of the parsed Message.
+ * Get the body of the parsed HttpMessage.
+ *
+ * Returns the message body as string.
*/
PHP_METHOD(HttpMessage, getBody)
{
*
* Set the body of the HttpMessage.
* NOTE: Don't forget to update any headers accordingly.
+ *
+ * Expects a string parameter containing the new body of the message.
*/
PHP_METHOD(HttpMessage, setBody)
{
/* {{{ proto array HttpMessage::getHeaders()
*
* Get Message Headers.
+ *
+ * Returns an associative array containing the messages HTTP headers.
*/
PHP_METHOD(HttpMessage, getHeaders)
{
/* {{{ proto void HttpMessage::setHeaders(array headers)
*
* Sets new headers.
+ *
+ * Expects an associative array as parameter containing the new HTTP headers,
+ * which will replace *all* previous HTTP headers of the message.
*/
PHP_METHOD(HttpMessage, setHeaders)
{
/* {{{ proto void HttpMessage::addHeaders(array headers[, bool append = false])
*
* Add headers. If append is true, headers with the same name will be separated, else overwritten.
+ *
+ * Expects an associative array as parameter containing the additional HTTP headers
+ * to add to the messages existing headers. If the optional bool parameter is true,
+ * and a header with the same name of one to add exists already, this respective
+ * header will be converted to an array containing both header values, otherwise
+ * it will be overwritten with the new header value.
*/
PHP_METHOD(HttpMessage, addHeaders)
{
}
/* }}} */
-/* {{{ proto long HttpMessage::getType()
+/* {{{ proto int HttpMessage::getType()
*
* Get Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE)
+ *
+ * Returns the HttpMessage::TYPE.
*/
PHP_METHOD(HttpMessage, getType)
{
}
/* }}} */
-/* {{{ proto void HttpMessage::setType(long type)
+/* {{{ proto void HttpMessage::setType(int type)
*
* Set Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE)
+ *
+ * Exptects an int parameter, the HttpMessage::TYPE.
*/
PHP_METHOD(HttpMessage, setType)
{
}
/* }}} */
-/* {{{ proto long HttpMessage::getResponseCode()
+/* {{{ proto int HttpMessage::getResponseCode()
*
* Get the Response Code of the Message.
+ *
+ * Returns the HTTP response code if the message is of type
+ * HttpMessage::TYPE_RESPONSE, else FALSE.
*/
PHP_METHOD(HttpMessage, getResponseCode)
{
if (!HTTP_MSG_TYPE(RESPONSE, obj->message)) {
http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_RESPONSE");
- RETURN_NULL();
+ RETURN_FALSE;
}
RETURN_LONG(obj->message->http.info.response.code);
}
/* }}} */
-/* {{{ proto bool HttpMessage::setResponseCode(long code)
+/* {{{ proto bool HttpMessage::setResponseCode(int code)
*
* Set the response code of an HTTP Response Message.
- * Returns false if the Message is not of type HTTP_MSG_RESPONSE,
- * or if the response code is out of range (100-510).
+ *
+ * Expects an int parameter with the HTTP response code.
+ *
+ * Returns TRUE on success, or FALSE if the message is not of type
+ * HttpMessage::TYPE_RESPONSE or the response code is out of range (100-510).
*/
PHP_METHOD(HttpMessage, setResponseCode)
{
/* {{{ proto string HttpMessage::getRequestMethod()
*
* Get the Request Method of the Message.
- * Returns false if the Message is not of type HTTP_MSG_REQUEST.
+ *
+ * Returns the request method name on success, or FALSE if the message is
+ * not of type HttpMessage::TYPE_REQUEST.
*/
PHP_METHOD(HttpMessage, getRequestMethod)
{
if (!HTTP_MSG_TYPE(REQUEST, obj->message)) {
http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_REQUEST");
- RETURN_NULL();
+ RETURN_FALSE;
}
RETURN_STRING(obj->message->http.info.request.method, 1);
/* {{{ proto bool HttpMessage::setRequestMethod(string method)
*
* Set the Request Method of the HTTP Message.
- * Returns false if the Message is not of type HTTP_MSG_REQUEST.
+ *
+ * Expects a string parameter containing the request method name.
+ *
+ * Returns TRUE on success, or FALSE if the message is not of type
+ * HttpMessage::TYPE_REQUEST or an invalid request method was supplied.
*/
PHP_METHOD(HttpMessage, setRequestMethod)
{
/* {{{ proto string HttpMessage::getRequestUri()
*
* Get the Request URI of the Message.
+ *
+ * Returns the request uri as string on success, or FALSE if the message
+ * is not of type HttpMessage::TYPE_REQUEST.
*/
PHP_METHOD(HttpMessage, getRequestUri)
{
if (!HTTP_MSG_TYPE(REQUEST, obj->message)) {
http_error(HE_WARNING, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_REQUEST");
- RETURN_NULL();
+ RETURN_FALSE;
}
RETURN_STRING(obj->message->http.info.request.URI, 1);
/* {{{ proto bool HttpMessage::setRequestUri(string URI)
*
* Set the Request URI of the HTTP Message.
- * Returns false if the Message is not of type HTTP_MSG_REQUEST,
- * or if paramtere URI was empty.
+ *
+ * Expects a string parameters containing the request uri.
+ *
+ * Returns TRUE on success, or FALSE if the message is not of type
+ * HttpMessage::TYPE_REQUEST or supplied URI was empty.
*/
PHP_METHOD(HttpMessage, setRequestUri)
{
/* {{{ proto string HttpMessage::getHttpVersion()
*
* Get the HTTP Protocol Version of the Message.
+ *
+ * Returns the HTTP protocol version as string.
*/
PHP_METHOD(HttpMessage, getHttpVersion)
{
/* {{{ proto bool HttpMessage::setHttpVersion(string version)
*
* Set the HTTP Protocol version of the Message.
- * Returns false if version is invalid (1.0 and 1.1).
+ *
+ * Expects a string parameter containing the HTTP protocol version.
+ *
+ * Returns TRUE on success, or FALSE if supplied version is out of range (1.0/1.1).
*/
PHP_METHOD(HttpMessage, setHttpVersion)
{
/* {{{ proto HttpMessage HttpMessage::getParentMessage()
*
* Get parent Message.
+ *
+ * Returns the parent HttpMessage on success, or NULL if there's none.
*/
PHP_METHOD(HttpMessage, getParentMessage)
{
/* {{{ proto bool HttpMessage::send()
*
* Send the Message according to its type as Response or Request.
+ * This provides limited functionality compared to HttpRequest and HttpResponse.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpMessage, send)
{
/* {{{ proto string HttpMessage::toString([bool include_parent = false])
*
* Get the string representation of the Message.
+ *
+ * Accepts a bool parameter which specifies whether the returned string
+ * should also contain any parent messages.
+ *
+ * Returns the full message as string.
*/
PHP_METHOD(HttpMessage, toString)
{
/* ### USERLAND ### */
-/* {{{ proto void HttpRequest::__construct([string url[, long request_method = HTTP_GET]])
+/* {{{ proto void HttpRequest::__construct([string url[, int request_method = HTTP_METH_GET]])
*
- * Instantiate a new HttpRequest object which can be used to issue HEAD, GET
- * and POST (including posting files) HTTP requests.
+ * Instantiate a new HttpRequest object.
+ *
+ * Accepts a string as optional parameter containing the target request url.
+ * Additianally accepts an optional int parameter specifying the request method
+ * to use.
+ *
+ * Throws HttpException.
*/
PHP_METHOD(HttpRequest, __construct)
{
/* {{{ proto bool HttpRequest::setOptions([array options])
*
* Set the request options to use. See http_get() for a full list of available options.
+ *
+ * Accepts an array as optional parameters, wich values will overwrite the
+ * currently set request options. If the parameter is empty or mitted,
+ * the optoions of the HttpRequest object will be reset.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpRequest, setOptions)
{
/* {{{ proto array HttpRequest::getOptions()
*
* Get currently set options.
+ *
+ * Returns an associative array containing currently set options.
*/
PHP_METHOD(HttpRequest, getOptions)
{
/* {{{ proto bool HttpRequest::setSslOptions([array options])
*
* Set SSL options.
+ *
+ * Accepts an associative array as parameter containing any SSL specific options.
+ * If the parameter is empty or omitted, the SSL options will be reset.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpRequest, setSslOptions)
{
/* {{{ proto bool HttpRequest::addSslOptions(array options)
*
* Set additional SSL options.
+ *
+ * Expects an associative array as parameter containing additional SSL specific options.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpRequest, addSslOptions)
{
/* {{{ proto array HttpRequest::getSslOtpions()
*
* Get previously set SSL options.
+ *
+ * Returns an associative array containing any previously set SSL options.
*/
PHP_METHOD(HttpRequest, getSslOptions)
{
/* {{{ proto bool HttpRequest::addHeaders(array headers)
*
* Add request header name/value pairs.
+ *
+ * Expects an ssociative array as parameter containing additional header
+ * name/value pairs.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpRequest, addHeaders)
{
/* {{{ proto bool HttpRequest::setHeaders([array headers])
*
* Set request header name/value pairs.
+ *
+ * Accepts an associative array as parameter containing header name/value pairs.
+ * If the parameter is empty or omitted, all previously set headers will be unset.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpRequest, setHeaders)
{
/* {{{ proto array HttpRequest::getHeaders()
*
* Get previously set request headers.
+ *
+ * Returns an associative array containing all currently set headers.
*/
PHP_METHOD(HttpRequest, getHeaders)
{
/* {{{ proto bool HttpRequest::setCookies([array cookies])
*
* Set cookies.
+ *
+ * Accepts an associative array as parameter containing cookie name/value pairs.
+ * If the parameter is empty or omitted, all previously set cookies will be unset.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpRequest, setCookies)
{
/* {{{ proto bool HttpRequest::addCookies(array cookies)
*
* Add cookies.
+ *
+ * Expects an associative array as parameter containing any cookie name/value
+ * pairs to add.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpRequest, addCookies)
{
/* {{{ proto array HttpRequest::getCookies()
*
* Get previously set cookies.
+ *
+ * Returns an associative array containing any previously set cookies.
*/
PHP_METHOD(HttpRequest, getCookies)
{
/* {{{ proto bool HttpRequest::setUrl(string url)
*
* Set the request URL.
+ *
+ * Expects a string as parameter specifying the request url.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpRequest, setUrl)
{
/* {{{ proto string HttpRequest::getUrl()
*
* Get the previously set request URL.
+ *
+ * Returns the currently set request url as string.
*/
PHP_METHOD(HttpRequest, getUrl)
{
}
/* }}} */
-/* {{{ proto bool HttpRequest::setMethod(long request_method)
+/* {{{ proto bool HttpRequest::setMethod(int request_method)
*
- * Set the request methods; one of the <tt>HTTP_HEAD</tt>, <tt>HTTP_GET</tt> or
- * <tt>HTTP_POST</tt> constants.
+ * Set the request method.
+ *
+ * Expects an int as parameter specifying the request method to use.
+ * In PHP 5.1+ HttpRequest::METH, otherwise the HTTP_METH constants can be used.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpRequest, setMethod)
{
}
/* }}} */
-/* {{{ proto long HttpRequest::getMethod()
+/* {{{ proto int HttpRequest::getMethod()
*
* Get the previously set request method.
+ *
+ * Returns the currently set request method.
*/
PHP_METHOD(HttpRequest, getMethod)
{
/* {{{ proto bool HttpRequest::setContentType(string content_type)
*
* Set the content type the post request should have.
- * Use this only if you know what you're doing.
+ *
+ * Expects a string as parameters containing the content type of the request
+ * (primary/secondary).
+ *
+ * Returns TRUE on success, or FALSE if the content type does not seem to
+ * contain a primary and a secondary part.
*/
PHP_METHOD(HttpRequest, setContentType)
{
/* {{{ proto string HttpRequest::getContentType()
*
* Get the previously content type.
+ *
+ * Returns the previously set content type as string.
*/
PHP_METHOD(HttpRequest, getContentType)
{
/* {{{ proto bool HttpRequest::setQueryData([mixed query_data])
*
- * Set the URL query parameters to use.
- * Overwrites previously set query parameters.
+ * Set the URL query parameters to use, overwriting previously set query parameters.
* Affects any request types.
+ *
+ * Accepts a string or associative array parameter containing the pre-encoded
+ * query string or to be encoded query fields. If the parameter is empty or
+ * omitted, the query data will be unset.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpRequest, setQueryData)
{
/* {{{ proto string HttpRequest::getQueryData()
*
* Get the current query data in form of an urlencoded query string.
+ *
+ * Returns a string containing the urlencoded query.
*/
PHP_METHOD(HttpRequest, getQueryData)
{
/* {{{ proto bool HttpRequest::addQueryData(array query_params)
*
- * Add parameters to the query parameter list.
+ * Add parameters to the query parameter list, leaving previously set unchanged.
* Affects any request type.
+ *
+ * Expects an associative array as parameter containing the query fields to add.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpRequest, addQueryData)
{
/* {{{ proto bool HttpRequest::addPostFields(array post_data)
*
- * Adds POST data entries.
- * Affects only POST requests.
+ * Adds POST data entries, leaving previously set unchanged, unless a
+ * post entry with the same name already exists.
+ * Affects only POST and custom requests.
+ *
+ * Expects an associative array as parameter containing the post fields.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpRequest, addPostFields)
{
/* {{{ proto bool HttpRequest::setPostFields([array post_data])
*
- * Set the POST data entries.
- * Overwrites previously set POST data.
- * Affects only POST requests.
+ * Set the POST data entries, overwriting previously set POST data.
+ * Affects only POST and custom requests.
+ *
+ * Accepts an associative array as parameter containing the post fields.
+ * If the parameter is empty or omitted, the post data will be unset.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpRequest, setPostFields)
{
/* {{{ proto array HttpRequest::getPostFields()
*
* Get previously set POST data.
+ *
+ * Returns the currently set post fields as associative array.
*/
PHP_METHOD(HttpRequest, getPostFields)
{
/* {{{ proto bool HttpRequest::setRawPostData([string raw_post_data])
*
- * Set raw post data to send. Don't forget to specify a content type.
- * Affects only POST requests.
+ * Set raw post data to send, overwriting previously set raw post data. Don't
+ * forget to specify a content type. Affects only POST and custom requests.
+ * Only either post fields or raw post data can be used for each request.
+ * Raw post data has higher precedence and will be used even if post fields
+ * are set.
+ *
+ * Accepts a string as parameter containing the *raw* post data.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpRequest, setRawPostData)
{
/* {{{ proto bool HttpRequest::addRawPostData(string raw_post_data)
*
- * Add raw post data.
- * Affects only POST requests.
+ * Add raw post data, leaving previously set raw post data unchanged.
+ * Affects only POST and custom requests.
+ *
+ * Expects a string as parameter containing the raw post data to concatenate.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpRequest, addRawPostData)
{
/* {{{ proto string HttpRequest::getRawPostData()
*
* Get previously set raw post data.
+ *
+ * Returns a string containing the currently set raw post data.
*/
PHP_METHOD(HttpRequest, getRawPostData)
{
/* {{{ proto bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])
*
- * Add a file to the POST request.
- * Affects only POST requests.
+ * Add a file to the POST request, leaving prefiously set files unchanged.
+ * Affects only POST and custom requests. Cannot be used with raw post data.
+ *
+ * Expects a string parameter containing the form element name, and a string
+ * paremeter containing the path to the file which should be uploaded.
+ * Additionally accepts an optional string parameter which chould contain
+ * the content type of the file.
+ *
+ * Returns TRUE on success, or FALSE if the content type seems not to contain a
+ * primary and a secondary content type part.
*/
PHP_METHOD(HttpRequest, addPostFile)
{
/* {{{ proto bool HttpRequest::setPostFiles([array post_files])
*
- * Set files to post.
- * Overwrites previously set post files.
- * Affects only POST requests.
+ * Set files to post, overwriting previously set post files.
+ * Affects only POST and requests. Cannot be used with raw post data.
+ *
+ * Accepts an array containing the files to post. Each entry should be an
+ * associative array with "name", "file" and "type" keys. If the parameter
+ * is empty or omitted the post files will be unset.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpRequest, setPostFiles)
{
/* {{{ proto array HttpRequest::getPostFiles()
*
* Get all previously added POST files.
+ *
+ * Returns an array containing currently set post files.
*/
PHP_METHOD(HttpRequest, getPostFiles)
{
/* {{{ proto bool HttpRequest::setPutFile([string file])
*
- * Set file to put.
- * Affects only PUT requests.
+ * Set file to put. Affects only PUT requests.
+ *
+ * Accepts a string as parameter referencing the path to file.
+ * If the parameter is empty or omitted the put file will be unset.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpRequest, setPutFile)
{
/* {{{ proto string HttpRequest::getPutFile()
*
* Get previously set put file.
+ *
+ * Returns a string containing the path to the currently set put file.
*/
PHP_METHOD(HttpRequest, getPutFile)
{
/* {{{ proto array HttpRequest::getResponseData()
*
* Get all response data after the request has been sent.
+ *
+ * Returns an associative array with the key "headers" containing an associative
+ * array holding all response headers, as well as the ley "body" containing a
+ * string with the response body.
+ *
+ * If redirects were allowed and several responses were received, the data
+ * references the last received response.
*/
PHP_METHOD(HttpRequest, getResponseData)
{
/* {{{ proto mixed HttpRequest::getResponseHeader([string name])
*
* Get response header(s) after the request has been sent.
+ *
+ * Accepts an string as optional parameter specifying a certain header to read.
+ * If the parameter is empty or omitted all response headers will be returned.
+ *
+ * Returns either a string with the value of the header matching name if requested,
+ * FALSE on failure, or an associative array containing all reponse headers.
+ *
+ * If redirects were allowed and several responses were received, the data
+ * references the last received response.
*/
PHP_METHOD(HttpRequest, getResponseHeader)
{
/* {{{ proto array HttpRequest::getResponseCookie([string name])
*
* Get response cookie(s) after the request has been sent.
+ *
+ * Accepts a string as optional parameter specifying the name of the cookie to read.
+ * If the parameter is empty or omitted, an associative array with all received
+ * cookies will be returned.
+ *
+ * Returns either an associative array with the cookie's name, value and any
+ * additional params of the cookie matching name if requested, FALSE on failure,
+ * or an array containing all received cookies as arrays.
+ *
+ * If redirects were allowed and several responses were received, the data
+ * references the last received response.
*/
PHP_METHOD(HttpRequest, getResponseCookie)
{
/* {{{ proto string HttpRequest::getResponseBody()
*
* Get the response body after the request has been sent.
+ *
+ * Returns a string containing the response body.
+ *
+ * If redirects were allowed and several responses were received, the data
+ * references the last received response.
*/
PHP_METHOD(HttpRequest, getResponseBody)
{
/* {{{ proto int HttpRequest::getResponseCode()
*
* Get the response code after the request has been sent.
+ *
+ * Returns an int representing the response code.
+ *
+ * If redirects were allowed and several responses were received, the data
+ * references the last received response.
*/
PHP_METHOD(HttpRequest, getResponseCode)
{
}
/* }}} */
-/* {{{ proto array HttpRequest::getResponseInfo([string name])
+/* {{{ proto mixed HttpRequest::getResponseInfo([string name])
*
* Get response info after the request has been sent.
* See http_get() for a full list of returned info.
+ *
+ * Accepts a string as optional parameter specifying the info to read.
+ * If the parameter is empty or omitted, an associative array containing
+ * all available info will be returned.
+ *
+ * Returns either a scalar containing the value of the info matching name if
+ * requested, FALSE on failure, or an associative array containing all
+ * available info.
+ *
+ * If redirects were allowed and several responses were received, the data
+ * references the last received response.
*/
PHP_METHOD(HttpRequest, getResponseInfo)
{
/* {{{ proto HttpMessage HttpRequest::getResponseMessage()
*
- * Get the full response as HttpMessage object.
+ * Get the full response as HttpMessage object after the request has been sent.
+ *
+ * Returns an HttpMessage object of the response.
+ *
+ * If redirects were allowed and several responses were received, the data
+ * references the last received response. Use HttpMessage::getParentMessage()
+ * to access the data of previously received responses whithin this request
+ * cycle.
+ *
+ * Throws HttpException.
*/
PHP_METHOD(HttpRequest, getResponseMessage)
{
/* {{{ proto HttpMessage HttpRequest::getRequestMessage()
*
* Get sent HTTP message.
+ *
+ * Returns an HttpMessage object representing the sent request.
+ *
+ * If redirects were allowed and several responses were received, the data
+ * references the last received response. Use HttpMessage::getParentMessage()
+ * to access the data of previously sent requests whithin this request
+ * cycle.
*/
PHP_METHOD(HttpRequest, getRequestMessage)
{
/* {{{ proto HttpMessage HttpRequest::getHistory()
*
* Get all sent requests and received responses as an HttpMessage object.
+ *
+ * If you don't want to record history at all, set the instance variable
+ * HttpRequest::$recoedHistory to FALSE.
+ *
+ * Returns an HttpMessage object representing the complete request/response
+ * history.
+ *
+ * The object references the last received response, use HttpMessage::getParentMessage()
+ * to access the data of previously sent requests and received responses.
+ *
+ * Throws HttpMalformedHeaderException.
*/
PHP_METHOD(HttpRequest, getHistory)
{
/* {{{ proto HttpMessage HttpRequest::send()
*
* Send the HTTP request.
+ *
+ * Returns the received response as HttpMessage object.
+ *
+ * Throws HttpRuntimeException, HttpRequestException,
+ * HttpMalformedHeaderException, HttpEncodingException.
*
* GET example:
* <pre>
projects / m6w6 / ext-http / commitdiff
