From cda14b5db045b18799f40f577e0e0afc5d6fcf14 Mon Sep 17 00:00:00 2001 From: Michael Wallner Date: Thu, 6 Apr 2006 13:55:55 +0000 Subject: [PATCH] - doc fixes --- docs/functions.html | 15 ++++++++++++--- http_message_object.c | 8 ++++---- 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/docs/functions.html b/docs/functions.html index a18aafa..164af4c 100644 --- a/docs/functions.html +++ b/docs/functions.html @@ -396,6 +396,12 @@ See http_get() for a full list of available options.

Expects the second parameter to be a string containing the data to upload.
See http_get() for a full list of available options.

Returns the HTTP response(s) as string on success, or FALSE on failure.

+

string http_request(int method, string url[, string body[, array options[, array &info]]])

+

Performs a custom HTTP request on the supplied url.

+

Expects the first parameter to be an integer specifying the request method to use.
+Accepts an optional third string parameter containing the raw request body.
+See http_get() for a full list of available options.

+

Returns the HTTP response(s) as string on success, or FALSE on failure.

int http_request_method_register(string method)

Register a custom request method.

Expects a string parameter containing the request method name to register.

@@ -566,7 +572,7 @@ HttpMessage::TYPE_REQUEST or supplied URL was empty.

HttpMessage HttpMessage::getParentMessage()

Get parent Message.

Returns the parent HttpMessage on success, or NULL if there's none.

-

Throws HttpMessageException.

+

Throws HttpRuntimeException.

bool HttpMessage::send()

Send the Message according to its type as Response or Request.
This provides limited functionality compared to HttpRequest and HttpResponse.

@@ -591,9 +597,10 @@ should also contain any parent messages.

Re-constructs the HttpMessage based upon the serialized string.

HttpMessage HttpMessage::detach(void)

Returns a clone of an HttpMessage object detached from any parent messages.

-

void HttpMessage::prepend(HttpMessage message)

+

void HttpMessage::prepend(HttpMessage message[, bool top = true])

Prepends message(s) to the HTTP message.

Expects an HttpMessage object as parameter.

+

Throws HttpInvalidParamException if the message is located within the same message chain.

HttpMessage HttpMessage::reverse()

Reorders the message chain in reverse order.

Returns the most parent HttpMessage object.

@@ -1200,6 +1207,8 @@ http.cache_log is set.

  • http_put_data
  • +
  • http_request +
  • http_request_method_register
  • http_request_method_unregister @@ -1401,7 +1410,7 @@ http.cache_log is set.

  • -

    Generated at: Sun, 19 Mar 2006 19:28:39 +0100

    +

    Generated at: Thu, 06 Apr 2006 15:55:09 +0200

    diff --git a/http_message_object.c b/http_message_object.c index a04438b..8af5805 100644 --- a/http_message_object.c +++ b/http_message_object.c @@ -1133,10 +1133,10 @@ PHP_METHOD(HttpMessage, setHttpVersion) /* {{{ proto HttpMessage HttpMessage::getParentMessage() * * Get parent Message. - * + * * Returns the parent HttpMessage on success, or NULL if there's none. * - * Throws HttpMessageException. + * Throws HttpRuntimeException. */ PHP_METHOD(HttpMessage, getParentMessage) { @@ -1412,13 +1412,13 @@ PHP_METHOD(HttpMessage, detach) } /* }}} */ -/* {{{ proto void HttpMessage::prepend(HttpMessage message) +/* {{{ proto void HttpMessage::prepend(HttpMessage message[, bool top = true]) * * Prepends message(s) to the HTTP message. * * Expects an HttpMessage object as parameter. * - * Throws HttpInvalidParamException if the messages are located within the same message chain. + * Throws HttpInvalidParamException if the message is located within the same message chain. */ PHP_METHOD(HttpMessage, prepend) { -- 2.30.2