- enchant_broker_list_dicts() and enchant_broker_describe() return null` if no broker is available - raise exception on Invalid object

Author: remicollet

ext/enchant/enchant.c

@@ -275,15 +275,15 @@ PHP_MINFO_FUNCTION(enchant)
 #define PHP_ENCHANT_GET_BROKER	\
 	pbroker = Z_ENCHANT_BROKER_P(broker); \
 	if (!pbroker || !pbroker->pbroker) {	\
-		php_error_docref(NULL, E_WARNING, "Invalid EnchantBroker object");	\
-		RETURN_FALSE;	\
+		zend_value_error("Invalid or uninitialized EnchantBroker object"); \
+		RETURN_THROWS(); \
 	}
 
 #define PHP_ENCHANT_GET_DICT	\
 	pdict = Z_ENCHANT_DICT_P(dict); \
 	if (!pdict || !pdict->pdict) {	\
-		php_error_docref(NULL, E_WARNING, "Invalid EnchantDict object");	\
-		RETURN_FALSE;	\
+		zend_value_error("Invalid or uninitialized EnchantBroker object"); \
+		RETURN_THROWS(); \
 	}
 
 /* {{{ proto resource enchant_broker_init()
@@ -545,7 +545,7 @@ PHP_METHOD(EnchantDict, __construct)
 		dict->pdict =pdict;
 		ZVAL_COPY(&dict->zbroker, broker);
 	} else {
-		zend_throw_exception(spl_ce_RuntimeException, "Can't create a new EnchantBroker", 0);
+		zend_throw_exception(spl_ce_RuntimeException, "Can't create a new EnchantDict", 0);
 	}
 }
 /* }}} */

ext/enchant/enchant.stub.php

@@ -11,7 +11,7 @@ public function __construct() {}
 	public function getError(): string|false {}
 
 	/** @alias enchant_broker_list_dicts */
-	public function listDicts(): array {}
+	public function listDicts(): ?array {}
 
 	/** @alias enchant_broker_request_dict */
 	public function requestDict(string $tag): EnchantDict|false {}
@@ -26,7 +26,7 @@ public function isDict(string $tag): bool {}
 	public function setOrdering(string $tag, string $ordering): bool {}
 
 	/** @alias enchant_broker_describe */
-	public function describe($broker): array {}
+	public function describe(): ?array {}
 }
 
 final class EnchantDict
@@ -80,7 +80,7 @@ function enchant_broker_set_dict_path(EnchantBroker $broker, int $name, string $
 */
 function enchant_broker_get_dict_path(EnchantBroker $broker, int $name): string|false {}
 
-function enchant_broker_list_dicts(EnchantBroker $broker): array {}
+function enchant_broker_list_dicts(EnchantBroker $broker): ?array {}
 
 function enchant_broker_request_dict(EnchantBroker $broker, string $tag): EnchantDict|false {}
 
@@ -95,7 +95,7 @@ function enchant_broker_dict_exists(EnchantBroker $broker, string $tag): bool {}
 
 function enchant_broker_set_ordering(EnchantBroker $broker, string $tag, string $ordering): bool {}
 
-function enchant_broker_describe(EnchantBroker $broker): array {}
+function enchant_broker_describe(EnchantBroker $broker): ?array {}
 
 function enchant_dict_quick_check(EnchantDict $dict, string $word, &$suggestions = UNKNOWN): bool {}
 

ext/enchant/enchant_arginfo.h

@@ -22,7 +22,7 @@ ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_enchant_broker_get_dict_path, 0,
 	ZEND_ARG_TYPE_INFO(0, name, IS_LONG, 0)
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_enchant_broker_list_dicts, 0, 1, IS_ARRAY, 0)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_enchant_broker_list_dicts, 0, 1, IS_ARRAY, 1)
 	ZEND_ARG_OBJ_INFO(0, broker, EnchantBroker, 0)
 ZEND_END_ARG_INFO()
 
@@ -102,7 +102,7 @@ ZEND_END_ARG_INFO()
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_class_EnchantBroker_getError, 0, 0, MAY_BE_STRING|MAY_BE_FALSE)
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_EnchantBroker_listDicts, 0, 0, IS_ARRAY, 0)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_EnchantBroker_listDicts, 0, 0, IS_ARRAY, 1)
 ZEND_END_ARG_INFO()
 
 ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_class_EnchantBroker_requestDict, 0, 1, EnchantDict, MAY_BE_FALSE)
@@ -122,9 +122,7 @@ ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_EnchantBroker_setOrdering,
 	ZEND_ARG_TYPE_INFO(0, ordering, IS_STRING, 0)
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_EnchantBroker_describe, 0, 1, IS_ARRAY, 0)
-	ZEND_ARG_INFO(0, broker)
-ZEND_END_ARG_INFO()
+#define arginfo_class_EnchantBroker_describe arginfo_class_EnchantBroker_listDicts
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_EnchantDict___construct, 0, 0, 2)
 	ZEND_ARG_OBJ_INFO(0, broker, EnchantBroker, 0)
@@ -159,7 +157,8 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_class_EnchantDict_getError arginfo_class_EnchantBroker_getError
 
-#define arginfo_class_EnchantDict_describe arginfo_class_EnchantBroker_listDicts
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_EnchantDict_describe, 0, 0, IS_ARRAY, 0)
+ZEND_END_ARG_INFO()
 
 
 ZEND_FUNCTION(enchant_broker_init);