PHPC-154: WriteError can have info field

Author: bjori

php_phongo.c

@@ -309,6 +309,22 @@ zend_bool phongo_writeerror_init(zval *return_value, bson_t *bson TSRMLS_DC) /*
 	if (bson_iter_init_find(&iter, bson, "errmsg") && BSON_ITER_HOLDS_UTF8(&iter)) {
 		writeerror->message = bson_iter_dup_utf8(&iter, NULL);
 	}
+	if (bson_iter_init_find(&iter, bson, "errInfo")) {
+		bson_t                 info;
+		php_phongo_bson_state  state = PHONGO_BSON_STATE_INITIALIZER;
+
+		MAKE_STD_ZVAL(writeerror->info);
+		state.zchild = writeerror->info;
+
+		bson_init(&info);
+		bson_append_iter(&info, NULL, 0, &iter);
+
+		if (!bson_to_zval(bson_get_data(&info), info.len, &state)) {
+			zval_ptr_dtor(&writeerror->info);
+			writeerror->info = NULL;
+			return false;
+		}
+	}
 	if (bson_iter_init_find(&iter, bson, "index") && BSON_ITER_HOLDS_INT32(&iter)) {
 		writeerror->index = bson_iter_int32(&iter);
 	}

php_phongo_classes.h

@@ -128,6 +128,7 @@ typedef struct {
 	zend_object              std;
 	int                      code;
 	char                    *message;
+	zval                    *info;
 	uint32_t                 index;
 } php_phongo_writeerror_t;
 

src/MongoDB/WriteError.c

@@ -109,6 +109,29 @@ PHP_METHOD(WriteError, getMessage)
 	RETURN_STRING(intern->message, 1);
 }
 /* }}} */
+/* {{{ proto mixed WriteError::getInfo()
+   Returns additional metadata for the error */
+PHP_METHOD(WriteError, getInfo)
+{
+	php_phongo_writeerror_t *intern;
+	zend_error_handling             error_handling;
+
+
+	zend_replace_error_handling(EH_THROW, phongo_exception_from_phongo_domain(PHONGO_ERROR_INVALID_ARGUMENT), &error_handling TSRMLS_CC);
+	intern = (php_phongo_writeerror_t *)zend_object_store_get_object(getThis() TSRMLS_CC);
+
+	if (zend_parse_parameters_none() == FAILURE) {
+		zend_restore_error_handling(&error_handling TSRMLS_CC);
+		return;
+	}
+	zend_restore_error_handling(&error_handling TSRMLS_CC);
+
+
+	if (intern->info) {
+		RETURN_ZVAL(intern->info, 1, 0);
+	}
+}
+/* }}} */
 
 /**
  * Value object for a write error (e.g. duplicate key).
@@ -121,6 +144,9 @@ ZEND_END_ARG_INFO();
 ZEND_BEGIN_ARG_INFO_EX(ai_WriteError_getIndex, 0, 0, 0)
 ZEND_END_ARG_INFO();
 
+ZEND_BEGIN_ARG_INFO_EX(ai_WriteError_getInfo, 0, 0, 0)
+ZEND_END_ARG_INFO();
+
 ZEND_BEGIN_ARG_INFO_EX(ai_WriteError_getMessage, 0, 0, 0)
 ZEND_END_ARG_INFO();
 
@@ -129,6 +155,7 @@ static zend_function_entry php_phongo_writeerror_me[] = {
 	PHP_ME(WriteError, getCode, ai_WriteError_getCode, ZEND_ACC_PUBLIC|ZEND_ACC_FINAL)
 	PHP_ME(WriteError, getIndex, ai_WriteError_getIndex, ZEND_ACC_PUBLIC|ZEND_ACC_FINAL)
 	PHP_ME(WriteError, getMessage, ai_WriteError_getMessage, ZEND_ACC_PUBLIC|ZEND_ACC_FINAL)
+	PHP_ME(WriteError, getInfo, ai_WriteError_getInfo, ZEND_ACC_PUBLIC|ZEND_ACC_FINAL)
 	PHP_FE_END
 };
 
@@ -177,6 +204,12 @@ HashTable *php_phongo_writeerror_get_debug_info(zval *object, int *is_temp TSRML
 	add_assoc_string_ex(&retval, ZEND_STRS("message"), intern->message, 1);
 	add_assoc_long_ex(&retval, ZEND_STRS("code"), intern->code);
 	add_assoc_long_ex(&retval, ZEND_STRS("index"), intern->index);
+	if (intern->info) {
+		Z_ADDREF_P(intern->info);
+		add_assoc_zval_ex(&retval, ZEND_STRS("info"), intern->info);
+	} else {
+		add_assoc_null_ex(&retval, ZEND_STRS("info"));
+	}
 
 	return Z_ARRVAL(retval);
 } /* }}} */

tests/standalone/manager-executeWriteBatch-002.phpt

@@ -50,6 +50,8 @@ object(MongoDB\Driver\WriteError)#%d (%d) {
   int(11000)
   ["index"]=>
   int(1)
+  ["info"]=>
+  NULL
 }
 writeError[1].message: %s
 writeError[1].code: 11000

tests/standalone/manager-executeWriteBatch-003.phpt

@@ -50,6 +50,8 @@ object(MongoDB\Driver\WriteError)#%d (%d) {
   int(11000)
   ["index"]=>
   int(1)
+  ["info"]=>
+  NULL
 }
 writeError[1].message: %s
 writeError[1].code: 11000
@@ -60,6 +62,8 @@ object(MongoDB\Driver\WriteError)#%d (%d) {
   int(11000)
   ["index"]=>
   int(3)
+  ["info"]=>
+  NULL
 }
 writeError[3].message: %s
 writeError[3].code: 11000