Extract utility function to check return types of bsonSerialize()

Author: alcaeus

src/phongo_bson_encode.c

@@ -90,6 +90,49 @@ static int php_phongo_is_array_or_document(zval* val)
 	return IS_ARRAY;
 }
 
+/* Checks the return type of a bsonSerialize() method. Returns true on
+ * success; otherwise, throws an exception and returns false.
+ *
+ * TODO: obsolete once PHP 8.0+ is required and tentative return type is enforced.
+ */
+static inline bool phongo_check_bson_serialize_return_type(zval* retval, zend_class_entry* ce)
+{
+	if (instanceof_function(ce, php_phongo_persistable_ce)) {
+		// Instances of Persistable must return an array, stdClass, or MongoDB\BSON\Document
+		if (
+			Z_TYPE_P(retval) != IS_ARRAY && !(Z_TYPE_P(retval) == IS_OBJECT && (instanceof_function(Z_OBJCE_P(retval), zend_standard_class_def) || instanceof_function(Z_OBJCE_P(retval), php_phongo_document_ce)))) {
+			phongo_throw_exception(PHONGO_ERROR_UNEXPECTED_VALUE,
+								   "Expected %s::%s() to return an array, stdClass, or %s, %s given",
+								   ZSTR_VAL(ce->name),
+								   BSON_SERIALIZE_FUNC_NAME,
+								   ZSTR_VAL(php_phongo_document_ce->name),
+								   PHONGO_ZVAL_CLASS_OR_TYPE_NAME(*retval));
+			return false;
+		}
+
+		return true;
+	}
+
+	if (instanceof_function(ce, php_phongo_serializable_ce)) {
+		// Instances of Serializable must return an array, stdClass, MongoDB\BSON\Document, or MongoDB\BSON\PackedArray
+		if (
+			Z_TYPE_P(retval) != IS_ARRAY && !(Z_TYPE_P(retval) == IS_OBJECT && (instanceof_function(Z_OBJCE_P(retval), zend_standard_class_def) || instanceof_function(Z_OBJCE_P(retval), php_phongo_document_ce) || instanceof_function(Z_OBJCE_P(retval), php_phongo_packedarray_ce)))) {
+			phongo_throw_exception(PHONGO_ERROR_UNEXPECTED_VALUE,
+								   "Expected %s::%s() to return an array, stdClass, %s, or %s, %s given",
+								   ZSTR_VAL(ce->name),
+								   BSON_SERIALIZE_FUNC_NAME,
+								   ZSTR_VAL(php_phongo_document_ce->name),
+								   ZSTR_VAL(php_phongo_packedarray_ce->name),
+								   PHONGO_ZVAL_CLASS_OR_TYPE_NAME(*retval));
+			return false;
+		}
+
+		return true;
+	}
+
+	return false;
+}
+
 /* Appends the array or object argument to the BSON document.
  *
  * For instances of MongoDB\BSON\Document, raw BSON data is appended as document.
@@ -134,31 +177,9 @@ static void php_phongo_bson_append_object(bson_t* bson, php_phongo_field_path* f
 				return;
 			}
 
-			// TODO PHP_VERSION_ID < 80000: obsolete once the tentative return type of bsonSerialize() is enforced
-			if (instanceof_function(Z_OBJCE_P(object), php_phongo_persistable_ce)) {
-				if (
-					Z_TYPE(obj_data) != IS_ARRAY && !(Z_TYPE(obj_data) == IS_OBJECT && (instanceof_function(Z_OBJCE(obj_data), zend_standard_class_def) || instanceof_function(Z_OBJCE(obj_data), php_phongo_document_ce)))) {
-					phongo_throw_exception(PHONGO_ERROR_UNEXPECTED_VALUE,
-										   "Expected %s::%s() to return an array, stdClass, or %s, %s given",
-										   ZSTR_VAL(Z_OBJCE_P(object)->name),
-										   BSON_SERIALIZE_FUNC_NAME,
-										   ZSTR_VAL(php_phongo_document_ce->name),
-										   PHONGO_ZVAL_CLASS_OR_TYPE_NAME(obj_data));
-					zval_ptr_dtor(&obj_data);
-
-					return;
-				}
-			} else if (
-				Z_TYPE(obj_data) != IS_ARRAY && !(Z_TYPE(obj_data) == IS_OBJECT && (instanceof_function(Z_OBJCE(obj_data), zend_standard_class_def) || instanceof_function(Z_OBJCE(obj_data), php_phongo_document_ce) || instanceof_function(Z_OBJCE(obj_data), php_phongo_packedarray_ce)))) {
-				phongo_throw_exception(PHONGO_ERROR_UNEXPECTED_VALUE,
-									   "Expected %s::%s() to return an array, stdClass, %s, or %s, %s given",
-									   ZSTR_VAL(Z_OBJCE_P(object)->name),
-									   BSON_SERIALIZE_FUNC_NAME,
-									   ZSTR_VAL(php_phongo_document_ce->name),
-									   ZSTR_VAL(php_phongo_packedarray_ce->name),
-									   PHONGO_ZVAL_CLASS_OR_TYPE_NAME(obj_data));
+			if (!phongo_check_bson_serialize_return_type(&obj_data, Z_OBJCE_P(object))) {
+				// Exception already thrown
 				zval_ptr_dtor(&obj_data);
-
 				return;
 			}
 
@@ -474,19 +495,12 @@ static void php_phongo_zval_to_bson_internal(zval* data, php_phongo_field_path*
 					return;
 				}
 
-				if (instanceof_function(Z_OBJCE_P(data), php_phongo_persistable_ce)) {
-					if (Z_TYPE(obj_data) == IS_OBJECT && instanceof_function(Z_OBJCE(obj_data), php_phongo_packedarray_ce)) {
-						phongo_throw_exception(
-							PHONGO_ERROR_UNEXPECTED_VALUE,
-							"Expected %s::%s() to return an array, stdClass, or %s, %s given",
-							ZSTR_VAL(Z_OBJCE_P(data)->name),
-							BSON_SERIALIZE_FUNC_NAME,
-							ZSTR_VAL(php_phongo_document_ce->name),
-							PHONGO_ZVAL_CLASS_OR_TYPE_NAME(obj_data));
-
-						goto cleanup;
-					}
+				if (!phongo_check_bson_serialize_return_type(&obj_data, Z_OBJCE_P(data))) {
+					// Exception already thrown
+					goto cleanup;
+				}
 
+				if (instanceof_function(Z_OBJCE_P(data), php_phongo_persistable_ce)) {
 					bson_append_binary(bson, PHONGO_ODM_FIELD_NAME, -1, 0x80, (const uint8_t*) Z_OBJCE_P(data)->name->val, Z_OBJCE_P(data)->name->len);
 					/* Ensure that we ignore an existing key with the same name
 					 * if one exists in the bsonSerialize() return value. */
@@ -500,19 +514,6 @@ static void php_phongo_zval_to_bson_internal(zval* data, php_phongo_field_path*
 					goto done;
 				}
 
-				if (Z_TYPE(obj_data) != IS_ARRAY && !(Z_TYPE(obj_data) == IS_OBJECT && instanceof_function(Z_OBJCE(obj_data), zend_standard_class_def))) {
-					phongo_throw_exception(
-						PHONGO_ERROR_UNEXPECTED_VALUE,
-						"Expected %s::%s() to return an array, stdClass, %s, or %s, %s given",
-						ZSTR_VAL(Z_OBJCE_P(data)->name),
-						BSON_SERIALIZE_FUNC_NAME,
-						ZSTR_VAL(php_phongo_document_ce->name),
-						ZSTR_VAL(php_phongo_packedarray_ce->name),
-						PHONGO_ZVAL_CLASS_OR_TYPE_NAME(obj_data));
-
-					goto cleanup;
-				}
-
 				ht_data = HASH_OF(&obj_data);
 
 				break;