PHPC-2128: Create stub file for functions

Author: alcaeus

php_phongo.c

@@ -28,8 +28,7 @@
 #include "src/phongo_client.h"
 #include "src/phongo_error.h"
 #include "src/phongo_ini.h"
-#include "src/BSON/functions.h"
-#include "src/MongoDB/Monitoring/functions.h"
+#include "src/functions_arginfo.h"
 
 ZEND_DECLARE_MODULE_GLOBALS(mongodb)
 #if defined(ZTS) && defined(COMPILE_DL_MONGODB)
@@ -482,42 +481,7 @@ PHP_FUNCTION(MongoDB_disabled___wakeup) /* {{{ */
 } /* }}} */
 /* }}} */
 
-/* {{{ Extension functions, module dependencies, and module entry */
-ZEND_BEGIN_ARG_INFO_EX(ai_bson_fromPHP, 0, 0, 1)
-	ZEND_ARG_INFO(0, value)
-ZEND_END_ARG_INFO();
-
-ZEND_BEGIN_ARG_INFO_EX(ai_bson_toPHP, 0, 0, 1)
-	ZEND_ARG_INFO(0, bson)
-	ZEND_ARG_ARRAY_INFO(0, typemap, 0)
-ZEND_END_ARG_INFO();
-
-ZEND_BEGIN_ARG_INFO_EX(ai_bson_toJSON, 0, 0, 1)
-	ZEND_ARG_INFO(0, bson)
-ZEND_END_ARG_INFO();
-
-ZEND_BEGIN_ARG_INFO_EX(ai_bson_fromJSON, 0, 0, 1)
-	ZEND_ARG_INFO(0, json)
-ZEND_END_ARG_INFO();
-
-ZEND_BEGIN_ARG_INFO_EX(ai_mongodb_driver_monitoring_subscriber, 0, 0, 1)
-	ZEND_ARG_OBJ_INFO(0, subscriber, MongoDB\\Driver\\Monitoring\\Subscriber, 0)
-ZEND_END_ARG_INFO();
-
-static const zend_function_entry mongodb_functions[] = {
-	/* clang-format off */
-	ZEND_NS_NAMED_FE("MongoDB\\BSON", fromPHP, PHP_FN(MongoDB_BSON_fromPHP), ai_bson_fromPHP)
-	ZEND_NS_NAMED_FE("MongoDB\\BSON", toPHP, PHP_FN(MongoDB_BSON_toPHP), ai_bson_toPHP)
-	ZEND_NS_NAMED_FE("MongoDB\\BSON", toJSON, PHP_FN(MongoDB_BSON_toJSON), ai_bson_toJSON)
-	ZEND_NS_NAMED_FE("MongoDB\\BSON", toCanonicalExtendedJSON, PHP_FN(MongoDB_BSON_toCanonicalExtendedJSON), ai_bson_toJSON)
-	ZEND_NS_NAMED_FE("MongoDB\\BSON", toRelaxedExtendedJSON, PHP_FN(MongoDB_BSON_toRelaxedExtendedJSON), ai_bson_toJSON)
-	ZEND_NS_NAMED_FE("MongoDB\\BSON", fromJSON, PHP_FN(MongoDB_BSON_fromJSON), ai_bson_fromJSON)
-	ZEND_NS_NAMED_FE("MongoDB\\Driver\\Monitoring", addSubscriber, PHP_FN(MongoDB_Driver_Monitoring_addSubscriber), ai_mongodb_driver_monitoring_subscriber)
-	ZEND_NS_NAMED_FE("MongoDB\\Driver\\Monitoring", removeSubscriber, PHP_FN(MongoDB_Driver_Monitoring_removeSubscriber), ai_mongodb_driver_monitoring_subscriber)
-	PHP_FE_END
-	/* clang-format on */
-};
-
+/* {{{ Module dependencies and module entry */
 static const zend_module_dep mongodb_deps[] = {
 	/* clang-format off */
 	ZEND_MOD_REQUIRED("date")
@@ -533,7 +497,7 @@ zend_module_entry mongodb_module_entry = {
 	NULL,
 	mongodb_deps,
 	"mongodb",
-	mongodb_functions,
+	ext_functions,
 	PHP_MINIT(mongodb),
 	PHP_MSHUTDOWN(mongodb),
 	PHP_RINIT(mongodb),

src/BSON/functions.c

@@ -30,7 +30,7 @@ typedef enum {
 
 /* {{{ proto string MongoDB\BSON\fromPHP(array|object $value)
    Returns the BSON representation of a PHP value */
-PHP_FUNCTION(MongoDB_BSON_fromPHP)
+PHP_FUNCTION(fromPHP)
 {
 	zval*   data;
 	bson_t* bson;
@@ -48,7 +48,7 @@ PHP_FUNCTION(MongoDB_BSON_fromPHP)
 
 /* {{{ proto array|object MongoDB\BSON\toPHP(string $bson [, array $typemap = array()])
    Returns the PHP representation of a BSON value, optionally converting it into a custom class */
-PHP_FUNCTION(MongoDB_BSON_toPHP)
+PHP_FUNCTION(toPHP)
 {
 	char*                 data;
 	size_t                data_len;
@@ -80,7 +80,7 @@ PHP_FUNCTION(MongoDB_BSON_toPHP)
 
 /* {{{ proto string MongoDB\BSON\fromJSON(string $json)
    Returns the BSON representation of a JSON value */
-PHP_FUNCTION(MongoDB_BSON_fromJSON)
+PHP_FUNCTION(fromJSON)
 {
 	char*        json;
 	size_t       json_len;
@@ -148,21 +148,21 @@ static void phongo_bson_to_json(INTERNAL_FUNCTION_PARAMETERS, php_phongo_json_mo
 
 /* {{{ proto string MongoDB\BSON\toJSON(string $bson)
    Returns the legacy extended JSON representation of a BSON value */
-PHP_FUNCTION(MongoDB_BSON_toJSON)
+PHP_FUNCTION(toJSON)
 {
 	phongo_bson_to_json(INTERNAL_FUNCTION_PARAM_PASSTHRU, PHONGO_JSON_MODE_LEGACY);
 } /* }}} */
 
 /* {{{ proto string MongoDB\BSON\toCanonicalExtendedJSON(string $bson)
    Returns the canonical extended JSON representation of a BSON value */
-PHP_FUNCTION(MongoDB_BSON_toCanonicalExtendedJSON)
+PHP_FUNCTION(toCanonicalExtendedJSON)
 {
 	phongo_bson_to_json(INTERNAL_FUNCTION_PARAM_PASSTHRU, PHONGO_JSON_MODE_CANONICAL);
 } /* }}} */
 
 /* {{{ proto string MongoDB\BSON\toRelaxedExtendedJSON(string $bson)
    Returns the relaxed extended JSON representation of a BSON value */
-PHP_FUNCTION(MongoDB_BSON_toRelaxedExtendedJSON)
+PHP_FUNCTION(toRelaxedExtendedJSON)
 {
 	phongo_bson_to_json(INTERNAL_FUNCTION_PARAM_PASSTHRU, PHONGO_JSON_MODE_RELAXED);
 } /* }}} */

src/BSON/functions.h

@@ -24,7 +24,7 @@ ZEND_EXTERN_MODULE_GLOBALS(mongodb)
 
 /* {{{ proto void MongoDB\Driver\Monitoring\addSubscriber(MongoDB\Driver\Monitoring\Subscriber $subscriber)
    Registers a global event subscriber */
-PHP_FUNCTION(MongoDB_Driver_Monitoring_addSubscriber)
+PHP_FUNCTION(addSubscriber)
 {
 	zval* subscriber;
 
@@ -37,7 +37,7 @@ PHP_FUNCTION(MongoDB_Driver_Monitoring_addSubscriber)
 
 /* {{{ proto void MongoDB\Driver\Monitoring\removeSubscriber(MongoDB\Driver\Monitoring\Subscriber $subscriber)
    Unregisters a global event subscriber */
-PHP_FUNCTION(MongoDB_Driver_Monitoring_removeSubscriber)
+PHP_FUNCTION(removeSubscriber)
 {
 	zval* subscriber;
 

src/MongoDB/Monitoring/functions.c

@@ -0,0 +1,33 @@
+<?php
+
+/** @generate-function-entries */
+
+namespace MongoDB\BSON {
+    function fromJSON(string $json): string {}
+
+#if PHP_VERSION_ID >= 80000
+    function fromPHP(array|object $value): string {}
+#else
+    /** @param array|object $value */
+    function fromPHP($value): string {}
+#endif
+
+    function toCanonicalExtendedJSON(string $bson): string {}
+
+    function toJSON(string $bson): string {}
+
+#if PHP_VERSION_ID >= 80000
+    function toPHP(string $bson, ?array $typemap = null): array|object {}
+#else
+    /** @return array|object */
+    function toPHP(string $bson, ?array $typemap = null) {}
+#endif
+
+    function toRelaxedExtendedJSON(string $bson): string {}
+}
+
+namespace MongoDB\Driver\Monitoring {
+    function addSubscriber(Subscriber $subscriber): void {}
+
+    function removeSubscriber(Subscriber $subscriber): void {}
+}

src/MongoDB/Monitoring/functions.h

@@ -0,0 +1,89 @@
+/* This is a generated file, edit the .stub.php file instead.
+ * Stub hash: 964efb254b4bb8c11a46e51a3005507aabd8d726 */
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_MongoDB_BSON_fromJSON, 0, 1, IS_STRING, 0)
+	ZEND_ARG_TYPE_INFO(0, json, IS_STRING, 0)
+ZEND_END_ARG_INFO()
+
+#if PHP_VERSION_ID >= 80000
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_MongoDB_BSON_fromPHP, 0, 1, IS_STRING, 0)
+	ZEND_ARG_TYPE_MASK(0, value, MAY_BE_ARRAY|MAY_BE_OBJECT, NULL)
+ZEND_END_ARG_INFO()
+#endif
+
+#if !(PHP_VERSION_ID >= 80000)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_MongoDB_BSON_fromPHP, 0, 1, IS_STRING, 0)
+	ZEND_ARG_INFO(0, value)
+ZEND_END_ARG_INFO()
+#endif
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_MongoDB_BSON_toCanonicalExtendedJSON, 0, 1, IS_STRING, 0)
+	ZEND_ARG_TYPE_INFO(0, bson, IS_STRING, 0)
+ZEND_END_ARG_INFO()
+
+#define arginfo_MongoDB_BSON_toJSON arginfo_MongoDB_BSON_toCanonicalExtendedJSON
+
+#if PHP_VERSION_ID >= 80000
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_MongoDB_BSON_toPHP, 0, 1, MAY_BE_ARRAY|MAY_BE_OBJECT)
+	ZEND_ARG_TYPE_INFO(0, bson, IS_STRING, 0)
+	ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, typemap, IS_ARRAY, 1, "null")
+ZEND_END_ARG_INFO()
+#endif
+
+#if !(PHP_VERSION_ID >= 80000)
+ZEND_BEGIN_ARG_INFO_EX(arginfo_MongoDB_BSON_toPHP, 0, 0, 1)
+	ZEND_ARG_TYPE_INFO(0, bson, IS_STRING, 0)
+	ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, typemap, IS_ARRAY, 1, "null")
+ZEND_END_ARG_INFO()
+#endif
+
+#define arginfo_MongoDB_BSON_toRelaxedExtendedJSON arginfo_MongoDB_BSON_toCanonicalExtendedJSON
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_MongoDB_Driver_Monitoring_addSubscriber, 0, 1, IS_VOID, 0)
+	ZEND_ARG_OBJ_INFO(0, subscriber, MongoDB\\Driver\\Monitoring\\Subscriber, 0)
+ZEND_END_ARG_INFO()
+
+#define arginfo_MongoDB_Driver_Monitoring_removeSubscriber arginfo_MongoDB_Driver_Monitoring_addSubscriber
+
+
+ZEND_FUNCTION(fromJSON);
+#if PHP_VERSION_ID >= 80000
+ZEND_FUNCTION(fromPHP);
+#endif
+#if !(PHP_VERSION_ID >= 80000)
+ZEND_FUNCTION(fromPHP);
+#endif
+ZEND_FUNCTION(toCanonicalExtendedJSON);
+ZEND_FUNCTION(toJSON);
+#if PHP_VERSION_ID >= 80000
+ZEND_FUNCTION(toPHP);
+#endif
+#if !(PHP_VERSION_ID >= 80000)
+ZEND_FUNCTION(toPHP);
+#endif
+ZEND_FUNCTION(toRelaxedExtendedJSON);
+ZEND_FUNCTION(addSubscriber);
+ZEND_FUNCTION(removeSubscriber);
+
+
+static const zend_function_entry ext_functions[] = {
+	ZEND_NS_FE("MongoDB\\BSON", fromJSON, arginfo_MongoDB_BSON_fromJSON)
+#if PHP_VERSION_ID >= 80000
+	ZEND_NS_FE("MongoDB\\BSON", fromPHP, arginfo_MongoDB_BSON_fromPHP)
+#endif
+#if !(PHP_VERSION_ID >= 80000)
+	ZEND_NS_FE("MongoDB\\BSON", fromPHP, arginfo_MongoDB_BSON_fromPHP)
+#endif
+	ZEND_NS_FE("MongoDB\\BSON", toCanonicalExtendedJSON, arginfo_MongoDB_BSON_toCanonicalExtendedJSON)
+	ZEND_NS_FE("MongoDB\\BSON", toJSON, arginfo_MongoDB_BSON_toJSON)
+#if PHP_VERSION_ID >= 80000
+	ZEND_NS_FE("MongoDB\\BSON", toPHP, arginfo_MongoDB_BSON_toPHP)
+#endif
+#if !(PHP_VERSION_ID >= 80000)
+	ZEND_NS_FE("MongoDB\\BSON", toPHP, arginfo_MongoDB_BSON_toPHP)
+#endif
+	ZEND_NS_FE("MongoDB\\BSON", toRelaxedExtendedJSON, arginfo_MongoDB_BSON_toRelaxedExtendedJSON)
+	ZEND_NS_FE("MongoDB\\Driver\\Monitoring", addSubscriber, arginfo_MongoDB_Driver_Monitoring_addSubscriber)
+	ZEND_NS_FE("MongoDB\\Driver\\Monitoring", removeSubscriber, arginfo_MongoDB_Driver_Monitoring_removeSubscriber)
+	ZEND_FE_END
+};