Add custom gc handlers

danog · danog · commit 263b20c085b2 · 2025-07-24T17:33:32.000+02:00
diff --git a/php_phongo.c b/php_phongo.c
@@ -155,13 +155,6 @@ static zend_class_entry* php_phongo_fetch_internal_class(const char* class_name,
 	return NULL;
 }
 
-static HashTable* php_phongo_std_get_gc(zend_object* object, zval** table, int* n)
-{
-	*table = NULL;
-	*n     = 0;
-	return object->handlers->get_properties(object);
-}
-
 
 PHP_MINIT_FUNCTION(mongodb) /* {{{ */
 {
@@ -198,7 +191,6 @@ PHP_MINIT_FUNCTION(mongodb) /* {{{ */
 	/* Disable cloning by default. Individual classes can opt in if they need to
 	 * support this (e.g. BSON objects). */
 	phongo_std_object_handlers.clone_obj = NULL;
-	phongo_std_object_handlers.get_gc = php_phongo_std_get_gc;
 
 	/* Initialize zend_class_entry dependencies.
 	 *
diff --git a/php_phongo.h b/php_phongo.h
@@ -93,6 +93,16 @@ zend_object_handlers* phongo_get_std_object_handlers(void);
 	} while (0)
 
 #define PHONGO_GET_PROPERTY_HANDLERS(_name, _intern_extractor) \
+	PHONGO_GET_PROPERTY_HANDLERS_NO_GC(_name, _intern_extractor) \
+	\
+	static HashTable* php_phongo_##_name##_get_gc(zend_object* zobj, zval** table, int* n) \
+	{ \
+		*table = NULL; \
+		*n     = 0; \
+		return _intern_extractor(zobj)->php_properties; \
+	}
+
+#define PHONGO_GET_PROPERTY_HANDLERS_NO_GC(_name, _intern_extractor) \
 	static zval* php_phongo_##_name##_read_property(zend_object *zobj, zend_string *member, int type, void **cache_slot, zval *rv) \
 	{ \
 		HashTable *props = _intern_extractor(zobj)->php_properties; \
diff --git a/src/BSON/Binary.c b/src/BSON/Binary.c
@@ -305,6 +305,7 @@ void php_phongo_binary_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_binary.has_property   = php_phongo_binary_has_property;
 	php_phongo_handler_binary.unset_property = php_phongo_binary_unset_property;
 	php_phongo_handler_binary.get_property_ptr_ptr = php_phongo_binary_get_property_ptr_ptr;
+	php_phongo_handler_binary.get_gc = php_phongo_binary_get_gc;
 	php_phongo_handler_binary.free_obj       = php_phongo_binary_free_object;
 	php_phongo_handler_binary.offset         = XtOffsetOf(php_phongo_binary_t, std);
 }
diff --git a/src/BSON/DBPointer.c b/src/BSON/DBPointer.c
@@ -265,6 +265,7 @@ void php_phongo_dbpointer_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_dbpointer.has_property   = php_phongo_dbpointer_has_property;
 	php_phongo_handler_dbpointer.unset_property = php_phongo_dbpointer_unset_property;
 	php_phongo_handler_dbpointer.get_property_ptr_ptr = php_phongo_dbpointer_get_property_ptr_ptr;
+	php_phongo_handler_dbpointer.get_gc = php_phongo_dbpointer_get_gc;
 	php_phongo_handler_dbpointer.free_obj       = php_phongo_dbpointer_free_object;
 	php_phongo_handler_dbpointer.offset         = XtOffsetOf(php_phongo_dbpointer_t, std);
 }
diff --git a/src/BSON/Decimal128.c b/src/BSON/Decimal128.c
@@ -239,6 +239,7 @@ void php_phongo_decimal128_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_decimal128.has_property   = php_phongo_decimal128_has_property;
 	php_phongo_handler_decimal128.unset_property = php_phongo_decimal128_unset_property;
 	php_phongo_handler_decimal128.get_property_ptr_ptr = php_phongo_decimal128_get_property_ptr_ptr;
+	php_phongo_handler_decimal128.get_gc = php_phongo_decimal128_get_gc;
 	php_phongo_handler_decimal128.free_obj       = php_phongo_decimal128_free_object;
 	php_phongo_handler_decimal128.offset         = XtOffsetOf(php_phongo_decimal128_t, std);
 }
diff --git a/src/BSON/Int64.c b/src/BSON/Int64.c
@@ -578,6 +578,7 @@ void php_phongo_int64_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_int64.has_property   = php_phongo_int64_has_property;
 	php_phongo_handler_int64.unset_property = php_phongo_int64_unset_property;
 	php_phongo_handler_int64.get_property_ptr_ptr = php_phongo_int64_get_property_ptr_ptr;
+	php_phongo_handler_int64.get_gc = php_phongo_int64_get_gc;
 	php_phongo_handler_int64.free_obj       = php_phongo_int64_free_object;
 	php_phongo_handler_int64.offset         = XtOffsetOf(php_phongo_int64_t, std);
 	php_phongo_handler_int64.cast_object    = php_phongo_int64_cast_object;
diff --git a/src/BSON/Iterator.c b/src/BSON/Iterator.c
@@ -401,6 +401,7 @@ void php_phongo_iterator_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_iterator.has_property   = php_phongo_iterator_has_property;
 	php_phongo_handler_iterator.unset_property = php_phongo_iterator_unset_property;
 	php_phongo_handler_iterator.get_property_ptr_ptr = php_phongo_iterator_get_property_ptr_ptr;
+	php_phongo_handler_iterator.get_gc = php_phongo_iterator_get_gc;
 	php_phongo_handler_iterator.free_obj       = php_phongo_iterator_free_object;
 	php_phongo_handler_iterator.offset         = XtOffsetOf(php_phongo_iterator_t, std);
 }
diff --git a/src/BSON/Javascript.c b/src/BSON/Javascript.c
@@ -346,6 +346,7 @@ void php_phongo_javascript_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_javascript.has_property   = php_phongo_javascript_has_property;
 	php_phongo_handler_javascript.unset_property = php_phongo_javascript_unset_property;
 	php_phongo_handler_javascript.get_property_ptr_ptr = php_phongo_javascript_get_property_ptr_ptr;
+	php_phongo_handler_javascript.get_gc = php_phongo_javascript_get_gc;
 	php_phongo_handler_javascript.free_obj       = php_phongo_javascript_free_object;
 	php_phongo_handler_javascript.offset         = XtOffsetOf(php_phongo_javascript_t, std);
 }
diff --git a/src/BSON/ObjectId.c b/src/BSON/ObjectId.c
@@ -287,6 +287,7 @@ void php_phongo_objectid_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_objectid.has_property   = php_phongo_objectid_has_property;
 	php_phongo_handler_objectid.unset_property = php_phongo_objectid_unset_property;
 	php_phongo_handler_objectid.get_property_ptr_ptr = php_phongo_objectid_get_property_ptr_ptr;
+	php_phongo_handler_objectid.get_gc = php_phongo_objectid_get_gc;
 	php_phongo_handler_objectid.free_obj       = php_phongo_objectid_free_object;
 	php_phongo_handler_objectid.offset         = XtOffsetOf(php_phongo_objectid_t, std);
 }
diff --git a/src/BSON/PackedArray.c b/src/BSON/PackedArray.c
@@ -588,6 +588,7 @@ void php_phongo_packedarray_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_packedarray.has_property    = php_phongo_packedarray_has_property;
 	php_phongo_handler_packedarray.unset_property  = php_phongo_packedarray_unset_property;
 	php_phongo_handler_packedarray.get_property_ptr_ptr = php_phongo_packedarray_get_property_ptr_ptr;
+	php_phongo_handler_packedarray.get_gc = php_phongo_packedarray_get_gc;
 	php_phongo_handler_packedarray.free_obj        = php_phongo_packedarray_free_object;
 	php_phongo_handler_packedarray.read_dimension  = php_phongo_packedarray_read_dimension;
 	php_phongo_handler_packedarray.write_dimension = php_phongo_packedarray_write_dimension;
diff --git a/src/BSON/Regex.c b/src/BSON/Regex.c
@@ -318,6 +318,7 @@ void php_phongo_regex_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_regex.has_property   = php_phongo_regex_has_property;
 	php_phongo_handler_regex.unset_property = php_phongo_regex_unset_property;
 	php_phongo_handler_regex.get_property_ptr_ptr = php_phongo_regex_get_property_ptr_ptr;
+	php_phongo_handler_regex.get_gc = php_phongo_regex_get_gc;
 	php_phongo_handler_regex.free_obj       = php_phongo_regex_free_object;
 	php_phongo_handler_regex.offset         = XtOffsetOf(php_phongo_regex_t, std);
 }
diff --git a/src/BSON/Symbol.c b/src/BSON/Symbol.c
@@ -232,6 +232,7 @@ void php_phongo_symbol_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_symbol.has_property   = php_phongo_symbol_has_property;
 	php_phongo_handler_symbol.unset_property = php_phongo_symbol_unset_property;
 	php_phongo_handler_symbol.get_property_ptr_ptr = php_phongo_symbol_get_property_ptr_ptr;
+	php_phongo_handler_symbol.get_gc = php_phongo_symbol_get_gc;
 	php_phongo_handler_symbol.free_obj       = php_phongo_symbol_free_object;
 	php_phongo_handler_symbol.offset         = XtOffsetOf(php_phongo_symbol_t, std);
 }
diff --git a/src/BSON/Timestamp.c b/src/BSON/Timestamp.c
@@ -352,6 +352,7 @@ void php_phongo_timestamp_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_timestamp.has_property   = php_phongo_timestamp_has_property;
 	php_phongo_handler_timestamp.unset_property = php_phongo_timestamp_unset_property;
 	php_phongo_handler_timestamp.get_property_ptr_ptr = php_phongo_timestamp_get_property_ptr_ptr;
+	php_phongo_handler_timestamp.get_gc = php_phongo_timestamp_get_gc;
 	php_phongo_handler_timestamp.free_obj       = php_phongo_timestamp_free_object;
 	php_phongo_handler_timestamp.offset         = XtOffsetOf(php_phongo_timestamp_t, std);
 }
diff --git a/src/BSON/UTCDateTime.c b/src/BSON/UTCDateTime.c
@@ -387,6 +387,7 @@ void php_phongo_utcdatetime_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_utcdatetime.has_property   = php_phongo_utcdatetime_has_property;
 	php_phongo_handler_utcdatetime.unset_property = php_phongo_utcdatetime_unset_property;
 	php_phongo_handler_utcdatetime.get_property_ptr_ptr = php_phongo_utcdatetime_get_property_ptr_ptr;
+	php_phongo_handler_utcdatetime.get_gc = php_phongo_utcdatetime_get_gc;
 	php_phongo_handler_utcdatetime.free_obj       = php_phongo_utcdatetime_free_object;
 	php_phongo_handler_utcdatetime.offset         = XtOffsetOf(php_phongo_utcdatetime_t, std);
 }
diff --git a/src/MongoDB/ReadConcern.c b/src/MongoDB/ReadConcern.c
@@ -238,6 +238,7 @@ void php_phongo_readconcern_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_readconcern.has_property   = php_phongo_readconcern_has_property;
 	php_phongo_handler_readconcern.unset_property = php_phongo_readconcern_unset_property;
 	php_phongo_handler_readconcern.get_property_ptr_ptr = php_phongo_readconcern_get_property_ptr_ptr;
+	php_phongo_handler_readconcern.get_gc = php_phongo_readconcern_get_gc;
 	php_phongo_handler_readconcern.free_obj       = php_phongo_readconcern_free_object;
 	php_phongo_handler_readconcern.offset         = XtOffsetOf(php_phongo_readconcern_t, std);
 }
diff --git a/src/MongoDB/ReadPreference.c b/src/MongoDB/ReadPreference.c
@@ -538,6 +538,7 @@ void php_phongo_readpreference_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_readpreference.has_property   = php_phongo_readpreference_has_property;
 	php_phongo_handler_readpreference.unset_property = php_phongo_readpreference_unset_property;
 	php_phongo_handler_readpreference.get_property_ptr_ptr = php_phongo_readpreference_get_property_ptr_ptr;
+	php_phongo_handler_readpreference.get_gc = php_phongo_readpreference_get_gc;
 	php_phongo_handler_readpreference.free_obj       = php_phongo_readpreference_free_object;
 	php_phongo_handler_readpreference.offset         = XtOffsetOf(php_phongo_readpreference_t, std);
 }
diff --git a/src/MongoDB/ServerApi.c b/src/MongoDB/ServerApi.c
@@ -266,6 +266,7 @@ void php_phongo_serverapi_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_serverapi.has_property   = php_phongo_serverapi_has_property;
 	php_phongo_handler_serverapi.unset_property = php_phongo_serverapi_unset_property;
 	php_phongo_handler_serverapi.get_property_ptr_ptr = php_phongo_serverapi_get_property_ptr_ptr;
+	php_phongo_handler_serverapi.get_gc = php_phongo_serverapi_get_gc;
 	php_phongo_handler_serverapi.free_obj       = php_phongo_serverapi_free_object;
 	php_phongo_handler_serverapi.offset         = XtOffsetOf(php_phongo_serverapi_t, std);
 }
diff --git a/src/MongoDB/ServerDescription.c b/src/MongoDB/ServerDescription.c
@@ -289,6 +289,7 @@ void php_phongo_serverdescription_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_serverdescription.has_property   = php_phongo_serverdescription_has_property;
 	php_phongo_handler_serverdescription.unset_property = php_phongo_serverdescription_unset_property;
 	php_phongo_handler_serverdescription.get_property_ptr_ptr = php_phongo_serverdescription_get_property_ptr_ptr;
+	php_phongo_handler_serverdescription.get_gc = php_phongo_serverdescription_get_gc;
 	php_phongo_handler_serverdescription.free_obj       = php_phongo_serverdescription_free_object;
 	php_phongo_handler_serverdescription.offset         = XtOffsetOf(php_phongo_serverdescription_t, std);
 }
diff --git a/src/MongoDB/TopologyDescription.c b/src/MongoDB/TopologyDescription.c
@@ -202,6 +202,7 @@ void php_phongo_topologydescription_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_topologydescription.has_property   = php_phongo_topologydescription_has_property;
 	php_phongo_handler_topologydescription.unset_property = php_phongo_topologydescription_unset_property;
 	php_phongo_handler_topologydescription.get_property_ptr_ptr = php_phongo_topologydescription_get_property_ptr_ptr;
+	php_phongo_handler_topologydescription.get_gc = php_phongo_topologydescription_get_gc;
 	php_phongo_handler_topologydescription.free_obj       = php_phongo_topologydescription_free_object;
 	php_phongo_handler_topologydescription.offset         = XtOffsetOf(php_phongo_topologydescription_t, std);
 }
diff --git a/src/MongoDB/WriteConcern.c b/src/MongoDB/WriteConcern.c
@@ -423,6 +423,7 @@ void php_phongo_writeconcern_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_writeconcern.has_property   = php_phongo_writeconcern_has_property;
 	php_phongo_handler_writeconcern.unset_property = php_phongo_writeconcern_unset_property;
 	php_phongo_handler_writeconcern.get_property_ptr_ptr = php_phongo_writeconcern_get_property_ptr_ptr;
+	php_phongo_handler_writeconcern.get_gc = php_phongo_writeconcern_get_gc;
 	php_phongo_handler_writeconcern.free_obj       = php_phongo_writeconcern_free_object;
 	php_phongo_handler_writeconcern.offset         = XtOffsetOf(php_phongo_writeconcern_t, std);
 }

Original file line number	Diff line number	Diff line change
`@@ -155,13 +155,6 @@ static zend_class_entry* php_phongo_fetch_internal_class(const char* class_name,`
`155`	`155`	`return NULL;`
`156`	`156`	`}`
`157`	`157`
`158`		`-static HashTable* php_phongo_std_get_gc(zend_object* object, zval** table, int* n)`
`159`		`-{`
`160`		`- *table = NULL;`
`161`		`- *n = 0;`
`162`		`- return object->handlers->get_properties(object);`
`163`		`-}`
`164`		`-`
`165`	`158`
`166`	`159`	`PHP_MINIT_FUNCTION(mongodb) /* {{{ */`
`167`	`160`	`{`
`@@ -198,7 +191,6 @@ PHP_MINIT_FUNCTION(mongodb) /* {{{ */`
`198`	`191`	`/* Disable cloning by default. Individual classes can opt in if they need to`
`199`	`192`	`* support this (e.g. BSON objects). */`
`200`	`193`	`phongo_std_object_handlers.clone_obj = NULL;`
`201`		`- phongo_std_object_handlers.get_gc = php_phongo_std_get_gc;`
`202`	`194`
`203`	`195`	`/* Initialize zend_class_entry dependencies.`
`204`	`196`	`*`
Original file line number	Diff line number	Diff line change
`@@ -305,6 +305,7 @@ void php_phongo_binary_init_ce(INIT_FUNC_ARGS)`
`305`	`305`	`php_phongo_handler_binary.has_property = php_phongo_binary_has_property;`
`306`	`306`	`php_phongo_handler_binary.unset_property = php_phongo_binary_unset_property;`
`307`	`307`	`php_phongo_handler_binary.get_property_ptr_ptr = php_phongo_binary_get_property_ptr_ptr;`
	`308`	`+ php_phongo_handler_binary.get_gc = php_phongo_binary_get_gc;`
`308`	`309`	`php_phongo_handler_binary.free_obj = php_phongo_binary_free_object;`
`309`	`310`	`php_phongo_handler_binary.offset = XtOffsetOf(php_phongo_binary_t, std);`
`310`	`311`	`}`
Original file line number	Diff line number	Diff line change
`@@ -265,6 +265,7 @@ void php_phongo_dbpointer_init_ce(INIT_FUNC_ARGS)`
`265`	`265`	`php_phongo_handler_dbpointer.has_property = php_phongo_dbpointer_has_property;`
`266`	`266`	`php_phongo_handler_dbpointer.unset_property = php_phongo_dbpointer_unset_property;`
`267`	`267`	`php_phongo_handler_dbpointer.get_property_ptr_ptr = php_phongo_dbpointer_get_property_ptr_ptr;`
	`268`	`+ php_phongo_handler_dbpointer.get_gc = php_phongo_dbpointer_get_gc;`
`268`	`269`	`php_phongo_handler_dbpointer.free_obj = php_phongo_dbpointer_free_object;`
`269`	`270`	`php_phongo_handler_dbpointer.offset = XtOffsetOf(php_phongo_dbpointer_t, std);`
`270`	`271`	`}`
Original file line number	Diff line number	Diff line change
`@@ -239,6 +239,7 @@ void php_phongo_decimal128_init_ce(INIT_FUNC_ARGS)`
`239`	`239`	`php_phongo_handler_decimal128.has_property = php_phongo_decimal128_has_property;`
`240`	`240`	`php_phongo_handler_decimal128.unset_property = php_phongo_decimal128_unset_property;`
`241`	`241`	`php_phongo_handler_decimal128.get_property_ptr_ptr = php_phongo_decimal128_get_property_ptr_ptr;`
	`242`	`+ php_phongo_handler_decimal128.get_gc = php_phongo_decimal128_get_gc;`
`242`	`243`	`php_phongo_handler_decimal128.free_obj = php_phongo_decimal128_free_object;`
`243`	`244`	`php_phongo_handler_decimal128.offset = XtOffsetOf(php_phongo_decimal128_t, std);`
`244`	`245`	`}`
Original file line number	Diff line number	Diff line change
`@@ -401,6 +401,7 @@ void php_phongo_iterator_init_ce(INIT_FUNC_ARGS)`
`401`	`401`	`php_phongo_handler_iterator.has_property = php_phongo_iterator_has_property;`
`402`	`402`	`php_phongo_handler_iterator.unset_property = php_phongo_iterator_unset_property;`
`403`	`403`	`php_phongo_handler_iterator.get_property_ptr_ptr = php_phongo_iterator_get_property_ptr_ptr;`
	`404`	`+ php_phongo_handler_iterator.get_gc = php_phongo_iterator_get_gc;`
`404`	`405`	`php_phongo_handler_iterator.free_obj = php_phongo_iterator_free_object;`
`405`	`406`	`php_phongo_handler_iterator.offset = XtOffsetOf(php_phongo_iterator_t, std);`
`406`	`407`	`}`
Original file line number	Diff line number	Diff line change
`@@ -346,6 +346,7 @@ void php_phongo_javascript_init_ce(INIT_FUNC_ARGS)`
`346`	`346`	`php_phongo_handler_javascript.has_property = php_phongo_javascript_has_property;`
`347`	`347`	`php_phongo_handler_javascript.unset_property = php_phongo_javascript_unset_property;`
`348`	`348`	`php_phongo_handler_javascript.get_property_ptr_ptr = php_phongo_javascript_get_property_ptr_ptr;`
	`349`	`+ php_phongo_handler_javascript.get_gc = php_phongo_javascript_get_gc;`
`349`	`350`	`php_phongo_handler_javascript.free_obj = php_phongo_javascript_free_object;`
`350`	`351`	`php_phongo_handler_javascript.offset = XtOffsetOf(php_phongo_javascript_t, std);`
`351`	`352`	`}`
Original file line number	Diff line number	Diff line change
`@@ -287,6 +287,7 @@ void php_phongo_objectid_init_ce(INIT_FUNC_ARGS)`
`287`	`287`	`php_phongo_handler_objectid.has_property = php_phongo_objectid_has_property;`
`288`	`288`	`php_phongo_handler_objectid.unset_property = php_phongo_objectid_unset_property;`
`289`	`289`	`php_phongo_handler_objectid.get_property_ptr_ptr = php_phongo_objectid_get_property_ptr_ptr;`
	`290`	`+ php_phongo_handler_objectid.get_gc = php_phongo_objectid_get_gc;`
`290`	`291`	`php_phongo_handler_objectid.free_obj = php_phongo_objectid_free_object;`
`291`	`292`	`php_phongo_handler_objectid.offset = XtOffsetOf(php_phongo_objectid_t, std);`
`292`	`293`	`}`