X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-http;a=blobdiff_plain;f=http_message_object.c;h=0510829f74d791b02345ba51798a9fdd2adf25ad;hp=88ab7d498e9c7485c52f9766d2720ddc0788d9ff;hb=266dd631dcb4e0652522ad4884ee8a40b88532ec;hpb=07d9534adbf7c25a7f8c35e14b23c9aa6cba1233

diff --git a/http_message_object.c b/http_message_object.c
index 88ab7d4..0510829 100644
--- a/http_message_object.c
+++ b/http_message_object.c
@@ -1,16 +1,13 @@
 /*
-   +----------------------------------------------------------------------+
-   | PECL :: http                                                         |
-   +----------------------------------------------------------------------+
-   | This source file is subject to version 3.0 of the PHP license, that  |
-   | is bundled with this package in the file LICENSE, and is available   |
-   | through the world-wide-web at http://www.php.net/license/3_0.txt.    |
-   | If you did not receive a copy of the PHP license and are unable to   |
-   | obtain it through the world-wide-web, please send a note to          |
-   | license@php.net so we can mail you a copy immediately.               |
-   +----------------------------------------------------------------------+
-   | Copyright (c) 2004-2005 Michael Wallner <mike@php.net>               |
-   +----------------------------------------------------------------------+
+    +--------------------------------------------------------------------+
+    | PECL :: http                                                       |
+    +--------------------------------------------------------------------+
+    | Redistribution and use in source and binary forms, with or without |
+    | modification, are permitted provided that the conditions mentioned |
+    | in the accompanying LICENSE file are met.                          |
+    +--------------------------------------------------------------------+
+    | Copyright (c) 2004-2005, Michael Wallner <mike@php.net>            |
+    +--------------------------------------------------------------------+
 */
 
 /* $Id$ */
@@ -30,7 +27,7 @@
 #include "php_http_exception_object.h"
 
 #include "phpstr/phpstr.h"
-#include  "missing.h"
+#include "missing.h"
 
 ZEND_EXTERN_MODULE_GLOBALS(http);
 
@@ -100,8 +97,6 @@ static zval *_http_message_object_read_prop(zval *object, zval *member, int type
 static void _http_message_object_write_prop(zval *object, zval *member, zval *value TSRMLS_DC);
 #define http_message_object_get_props _http_message_object_get_props
 static HashTable *_http_message_object_get_props(zval *object TSRMLS_DC);
-#define http_message_object_clone_obj _http_message_object_clone_obj
-static inline zend_object_value _http_message_object_clone_obj(zval *object TSRMLS_DC);
 
 zend_class_entry *http_message_object_ce;
 zend_function_entry http_message_object_fe[] = {
@@ -133,7 +128,7 @@ zend_function_entry http_message_object_fe[] = {
 };
 static zend_object_handlers http_message_object_handlers;
 
-void _http_message_object_init(INIT_FUNC_ARGS)
+PHP_MINIT_FUNCTION(http_message_object)
 {
 	HTTP_REGISTER_CLASS_EX(HttpMessage, http_message_object, NULL, 0);
 
@@ -141,34 +136,39 @@ void _http_message_object_init(INIT_FUNC_ARGS)
 	HTTP_LONG_CONSTANT("HTTP_MSG_REQUEST", HTTP_MSG_REQUEST);
 	HTTP_LONG_CONSTANT("HTTP_MSG_RESPONSE", HTTP_MSG_RESPONSE);
 
-	http_message_object_handlers.clone_obj = http_message_object_clone_obj;
+	http_message_object_handlers.clone_obj = _http_message_object_clone_obj;
 	http_message_object_handlers.read_property = http_message_object_read_prop;
 	http_message_object_handlers.write_property = http_message_object_write_prop;
 	http_message_object_handlers.get_properties = http_message_object_get_props;
 	http_message_object_handlers.get_property_ptr_ptr = NULL;
+	
+	return SUCCESS;
 }
 
 zend_object_value _http_message_object_new(zend_class_entry *ce TSRMLS_DC)
 {
-	return http_message_object_new_ex(ce, NULL);
+	return http_message_object_new_ex(ce, NULL, NULL);
 }
 
-zend_object_value _http_message_object_new_ex(zend_class_entry *ce, http_message *msg TSRMLS_DC)
+zend_object_value _http_message_object_new_ex(zend_class_entry *ce, http_message *msg, http_message_object **ptr TSRMLS_DC)
 {
 	zend_object_value ov;
 	http_message_object *o;
 
 	o = ecalloc(1, sizeof(http_message_object));
 	o->zo.ce = ce;
-	o->message = NULL;
-	o->parent.handle = 0;
-	o->parent.handlers = NULL;
+	
+	if (ptr) {
+		*ptr = o;
+	}
 
 	if (msg) {
 		o->message = msg;
 		if (msg->parent) {
-			o->parent = http_message_object_from_msg(msg->parent);
+			o->parent = http_message_object_new_ex(ce, msg->parent, NULL);
 		}
+	} else {
+		o->message = http_message_init(NULL);
 	}
 
 	ALLOC_HASHTABLE(OBJ_PROP(o));
@@ -180,9 +180,10 @@ zend_object_value _http_message_object_new_ex(zend_class_entry *ce, http_message
 	return ov;
 }
 
-zend_object_value _http_message_object_clone(zval *this_ptr TSRMLS_DC)
+zend_object_value _http_message_object_clone_obj(zval *this_ptr TSRMLS_DC)
 {
-	return http_message_object_clone_obj(this_ptr TSRMLS_CC);
+	getObject(http_message_object, obj);
+	return http_message_object_new_ex(Z_OBJCE_P(this_ptr), http_message_dup(obj->message), NULL);
 }
 
 static inline void _http_message_object_declare_default_properties(TSRMLS_D)
@@ -220,62 +221,60 @@ void _http_message_object_free(zend_object *object TSRMLS_DC)
 	efree(o);
 }
 
-static inline zend_object_value _http_message_object_clone_obj(zval *this_ptr TSRMLS_DC)
-{
-	getObject(http_message_object, obj);
-	return http_message_object_from_msg(http_message_dup(obj->message));
-}
-
 static zval *_http_message_object_read_prop(zval *object, zval *member, int type TSRMLS_DC)
 {
 	getObjectEx(http_message_object, obj, object);
 	http_message *msg = obj->message;
 	zval *return_value;
+#ifdef WONKY
+	ulong h = zend_get_hash_value(Z_STRVAL_P(member), Z_STRLEN_P(member)+1);
+#else
 	zend_property_info *pinfo = zend_get_property_info(obj->zo.ce, member, 1 TSRMLS_CC);
 	
 	if (!pinfo || ACC_PROP_PUBLIC(pinfo->flags)) {
 		return zend_get_std_object_handlers()->read_property(object, member, type TSRMLS_CC);
 	}
+#endif
 
-	return_value = &EG(uninitialized_zval);
+	if (type == BP_VAR_W) {
+		zend_error(E_ERROR, "Cannot access HttpMessage properties by reference or array key/index");
+		return NULL;
+	}
+	
+	ALLOC_ZVAL(return_value);
 	return_value->refcount = 0;
 	return_value->is_ref = 0;
 
-#if 0
-	fprintf(stderr, "Read HttpMessage::$%s\n", Z_STRVAL_P(member));
-#endif
-
+#ifdef WONKY
+	switch (h)
+#else
 	switch (pinfo->h)
+#endif
 	{
 		case HTTP_MSG_PROPHASH_TYPE:
+		case HTTP_MSG_CHILD_PROPHASH_TYPE:
 			RETVAL_LONG(msg->type);
 		break;
 
 		case HTTP_MSG_PROPHASH_HTTP_VERSION:
+		case HTTP_MSG_CHILD_PROPHASH_HTTP_VERSION:
 			RETVAL_DOUBLE(msg->http.version);
 		break;
 
 		case HTTP_MSG_PROPHASH_BODY:
+		case HTTP_MSG_CHILD_PROPHASH_BODY:
 			phpstr_fix(PHPSTR(msg));
 			RETVAL_PHPSTR(PHPSTR(msg), 0, 1);
 		break;
 
 		case HTTP_MSG_PROPHASH_HEADERS:
-			/* This is needed for situations like
-			 * $this->headers['foo'] = 'bar';
-			 */
-			if (type == BP_VAR_W) {
-				return_value->refcount = 1;
-				return_value->is_ref = 1;
-				Z_TYPE_P(return_value) = IS_ARRAY;
-				Z_ARRVAL_P(return_value) = &msg->hdrs;
-			} else {
-				array_init(return_value);
-				zend_hash_copy(Z_ARRVAL_P(return_value), &msg->hdrs, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
-			}
+		case HTTP_MSG_CHILD_PROPHASH_HEADERS:
+			array_init(return_value);
+			zend_hash_copy(Z_ARRVAL_P(return_value), &msg->hdrs, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
 		break;
 
 		case HTTP_MSG_PROPHASH_PARENT_MESSAGE:
+		case HTTP_MSG_CHILD_PROPHASH_PARENT_MESSAGE:
 			if (msg->parent) {
 				RETVAL_OBJVAL(obj->parent);
 			} else {
@@ -284,6 +283,7 @@ static zval *_http_message_object_read_prop(zval *object, zval *member, int type
 		break;
 
 		case HTTP_MSG_PROPHASH_REQUEST_METHOD:
+		case HTTP_MSG_CHILD_PROPHASH_REQUEST_METHOD:
 			if (HTTP_MSG_TYPE(REQUEST, msg) && msg->http.info.request.method) {
 				RETVAL_STRING(msg->http.info.request.method, 1);
 			} else {
@@ -292,6 +292,7 @@ static zval *_http_message_object_read_prop(zval *object, zval *member, int type
 		break;
 
 		case HTTP_MSG_PROPHASH_REQUEST_URI:
+		case HTTP_MSG_CHILD_PROPHASH_REQUEST_URI:
 			if (HTTP_MSG_TYPE(REQUEST, msg) && msg->http.info.request.URI) {
 				RETVAL_STRING(msg->http.info.request.URI, 1);
 			} else {
@@ -300,6 +301,7 @@ static zval *_http_message_object_read_prop(zval *object, zval *member, int type
 		break;
 
 		case HTTP_MSG_PROPHASH_RESPONSE_CODE:
+		case HTTP_MSG_CHILD_PROPHASH_RESPONSE_CODE:
 			if (HTTP_MSG_TYPE(RESPONSE, msg)) {
 				RETVAL_LONG(msg->http.info.response.code);
 			} else {
@@ -308,6 +310,7 @@ static zval *_http_message_object_read_prop(zval *object, zval *member, int type
 		break;
 		
 		case HTTP_MSG_PROPHASH_RESPONSE_STATUS:
+		case HTTP_MSG_CHILD_PROPHASH_RESPONSE_STATUS:
 			if (HTTP_MSG_TYPE(RESPONSE, msg) && msg->http.info.response.status) {
 				RETVAL_STRING(msg->http.info.response.status, 1);
 			} else {
@@ -316,7 +319,11 @@ static zval *_http_message_object_read_prop(zval *object, zval *member, int type
 		break;
 		
 		default:
+#ifdef WONKY
+			return zend_get_std_object_handlers()->read_property(object, member, type TSRMLS_CC);
+#else
 			RETVAL_NULL();
+#endif
 		break;
 	}
 
@@ -327,52 +334,64 @@ static void _http_message_object_write_prop(zval *object, zval *member, zval *va
 {
 	getObjectEx(http_message_object, obj, object);
 	http_message *msg = obj->message;
+#ifdef WONKY
+	ulong h = zend_get_hash_value(Z_STRVAL_P(member), Z_STRLEN_P(member) + 1);
+#else
 	zend_property_info *pinfo = zend_get_property_info(obj->zo.ce, member, 1 TSRMLS_CC);
 	
 	if (!pinfo || ACC_PROP_PUBLIC(pinfo->flags)) {
 		zend_get_std_object_handlers()->write_property(object, member, value TSRMLS_CC);
 		return;
 	}
-
-#if 0
-	fprintf(stderr, "Write HttpMessage::$%s\n", Z_STRVAL_P(member));
 #endif
 
+#ifdef WONKY
+	switch (h)
+#else
 	switch (pinfo->h)
+#endif
 	{
 		case HTTP_MSG_PROPHASH_TYPE:
+		case HTTP_MSG_CHILD_PROPHASH_TYPE:
 			convert_to_long_ex(&value);
 			http_message_set_type(msg, Z_LVAL_P(value));
 		break;
 
 		case HTTP_MSG_PROPHASH_HTTP_VERSION:
+		case HTTP_MSG_CHILD_PROPHASH_HTTP_VERSION:
 			convert_to_double_ex(&value);
 			msg->http.version = Z_DVAL_P(value);
 		break;
 
 		case HTTP_MSG_PROPHASH_BODY:
+		case HTTP_MSG_CHILD_PROPHASH_BODY:
 			convert_to_string_ex(&value);
 			phpstr_dtor(PHPSTR(msg));
 			phpstr_from_string_ex(PHPSTR(msg), Z_STRVAL_P(value), Z_STRLEN_P(value));
 		break;
 
 		case HTTP_MSG_PROPHASH_HEADERS:
+		case HTTP_MSG_CHILD_PROPHASH_HEADERS:
 			convert_to_array_ex(&value);
 			zend_hash_clean(&msg->hdrs);
 			zend_hash_copy(&msg->hdrs, Z_ARRVAL_P(value), (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
 		break;
 
 		case HTTP_MSG_PROPHASH_PARENT_MESSAGE:
-			if (msg->parent) {
-				zval tmp;
-				tmp.value.obj = obj->parent;
-				zend_objects_store_del_ref(&tmp TSRMLS_CC);
+		case HTTP_MSG_CHILD_PROPHASH_PARENT_MESSAGE:
+			if (Z_TYPE_P(value) == IS_OBJECT && instanceof_function(Z_OBJCE_P(value), http_message_object_ce TSRMLS_CC)) {
+				if (msg->parent) {
+					zval tmp;
+					tmp.value.obj = obj->parent;
+					Z_OBJ_DELREF(tmp);
+				}
+				Z_OBJ_ADDREF_P(value);
+				obj->parent = value->value.obj;
 			}
-			zend_objects_store_add_ref(value TSRMLS_CC);
-			obj->parent = value->value.obj;
 		break;
 
 		case HTTP_MSG_PROPHASH_REQUEST_METHOD:
+		case HTTP_MSG_CHILD_PROPHASH_REQUEST_METHOD:
 			if (HTTP_MSG_TYPE(REQUEST, msg)) {
 				convert_to_string_ex(&value);
 				STR_SET(msg->http.info.request.method, estrndup(Z_STRVAL_P(value), Z_STRLEN_P(value)));
@@ -380,6 +399,7 @@ static void _http_message_object_write_prop(zval *object, zval *member, zval *va
 		break;
 
 		case HTTP_MSG_PROPHASH_REQUEST_URI:
+		case HTTP_MSG_CHILD_PROPHASH_REQUEST_URI:
 			if (HTTP_MSG_TYPE(REQUEST, msg)) {
 				convert_to_string_ex(&value);
 				STR_SET(msg->http.info.request.URI, estrndup(Z_STRVAL_P(value), Z_STRLEN_P(value)));
@@ -387,6 +407,7 @@ static void _http_message_object_write_prop(zval *object, zval *member, zval *va
 		break;
 
 		case HTTP_MSG_PROPHASH_RESPONSE_CODE:
+		case HTTP_MSG_CHILD_PROPHASH_RESPONSE_CODE:
 			if (HTTP_MSG_TYPE(RESPONSE, msg)) {
 				convert_to_long_ex(&value);
 				msg->http.info.response.code = Z_LVAL_P(value);
@@ -394,11 +415,18 @@ static void _http_message_object_write_prop(zval *object, zval *member, zval *va
 		break;
 		
 		case HTTP_MSG_PROPHASH_RESPONSE_STATUS:
+		case HTTP_MSG_CHILD_PROPHASH_RESPONSE_STATUS:
 			if (HTTP_MSG_TYPE(RESPONSE, msg)) {
 				convert_to_string_ex(&value);
 				STR_SET(msg->http.info.response.status, estrndup(Z_STRVAL_P(value), Z_STRLEN_P(value)));
 			}
-			
+		break;
+		
+		default:
+#ifdef WONKY
+			zend_get_std_object_handlers()->write_property(object, member, value TSRMLS_CC);
+#endif
+		break;
 	}
 }
 
@@ -472,6 +500,13 @@ static HashTable *_http_message_object_get_props(zval *object TSRMLS_DC)
 /* {{{ 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)
 {
@@ -483,7 +518,7 @@ PHP_METHOD(HttpMessage, __construct)
 	if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &message, &length) && message && length) {
 		if (obj->message = http_message_parse(message, length)) {
 			if (obj->message->parent) {
-				obj->parent = http_message_object_from_msg(obj->message->parent);
+				obj->parent = http_message_object_new_ex(Z_OBJCE_P(getThis()), obj->message->parent, NULL);
 			}
 		}
 	} else if (!obj->message) {
@@ -495,7 +530,14 @@ 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)
 {
@@ -503,22 +545,24 @@ 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_new_ex(http_message_object_ce, msg, NULL);
+		}
 	}
-
-	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)
 {
@@ -535,6 +579,8 @@ 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)
 {
@@ -552,6 +598,8 @@ PHP_METHOD(HttpMessage, setBody)
 /* {{{ proto array HttpMessage::getHeaders()
  *
  * Get Message Headers.
+ * 
+ * Returns an associative array containing the messages HTTP headers.
  */
 PHP_METHOD(HttpMessage, getHeaders)
 {
@@ -571,6 +619,9 @@ 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)
 {
@@ -590,6 +641,12 @@ 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)
 {
@@ -610,9 +667,11 @@ 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)
 {
@@ -625,9 +684,11 @@ 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)
 {
@@ -641,9 +702,12 @@ 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)
 {
@@ -651,32 +715,27 @@ PHP_METHOD(HttpMessage, getResponseCode)
 
 	IF_RETVAL_USED {
 		getObject(http_message_object, obj);
-
-		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();
-		}
-
+		HTTP_CHECK_MESSAGE_TYPE_RESPONSE(obj->message, 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)
 {
 	long code;
 	getObject(http_message_object, obj);
 
-	if (!HTTP_MSG_TYPE(RESPONSE, obj->message)) {
-		http_error(HE_WARNING, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_RESPONSE");
-		RETURN_FALSE;
-	}
+	HTTP_CHECK_MESSAGE_TYPE_RESPONSE(obj->message, RETURN_FALSE);
 
 	if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &code)) {
 		RETURN_FALSE;
@@ -694,7 +753,9 @@ 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)
 {
@@ -702,12 +763,7 @@ PHP_METHOD(HttpMessage, getRequestMethod)
 
 	IF_RETVAL_USED {
 		getObject(http_message_object, obj);
-
-		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();
-		}
-
+		HTTP_CHECK_MESSAGE_TYPE_REQUEST(obj->message, RETURN_FALSE);
 		RETURN_STRING(obj->message->http.info.request.method, 1);
 	}
 }
@@ -716,7 +772,11 @@ PHP_METHOD(HttpMessage, getRequestMethod)
 /* {{{ 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)
 {
@@ -724,10 +784,7 @@ PHP_METHOD(HttpMessage, setRequestMethod)
 	int method_len;
 	getObject(http_message_object, obj);
 
-	if (!HTTP_MSG_TYPE(REQUEST, obj->message)) {
-		http_error(HE_WARNING, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_REQUEST");
-		RETURN_FALSE;
-	}
+	HTTP_CHECK_MESSAGE_TYPE_REQUEST(obj->message, RETURN_FALSE);
 
 	if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &method, &method_len)) {
 		RETURN_FALSE;
@@ -749,6 +806,9 @@ 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)
 {
@@ -756,12 +816,7 @@ PHP_METHOD(HttpMessage, getRequestUri)
 
 	IF_RETVAL_USED {
 		getObject(http_message_object, obj);
-
-		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();
-		}
-
+		HTTP_CHECK_MESSAGE_TYPE_REQUEST(obj->message, RETURN_FALSE);
 		RETURN_STRING(obj->message->http.info.request.URI, 1);
 	}
 }
@@ -770,8 +825,11 @@ PHP_METHOD(HttpMessage, getRequestUri)
 /* {{{ 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)
 {
@@ -779,13 +837,10 @@ PHP_METHOD(HttpMessage, setRequestUri)
 	int URIlen;
 	getObject(http_message_object, obj);
 
-	if (!HTTP_MSG_TYPE(REQUEST, obj->message)) {
-		http_error(HE_WARNING, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_REQUEST");
-		RETURN_FALSE;
-	}
 	if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &URI, &URIlen)) {
 		RETURN_FALSE;
 	}
+	HTTP_CHECK_MESSAGE_TYPE_REQUEST(obj->message, RETURN_FALSE);
 	if (URIlen < 1) {
 		http_error(HE_WARNING, HTTP_E_INVALID_PARAM, "Cannot set HttpMessage::requestUri to an empty string");
 		RETURN_FALSE;
@@ -799,6 +854,8 @@ 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)
 {
@@ -817,7 +874,10 @@ 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)
 {
@@ -844,6 +904,8 @@ 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)
 {
@@ -864,6 +926,9 @@ 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)
 {
@@ -878,6 +943,11 @@ 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)
 {