Add enchant_dict_remove() (php#17507)

Author: ndossche

NEWS

@@ -35,6 +35,7 @@ PHP                                                                        NEWS
 
 - Enchant:
   . Added enchant_dict_remove_from_session(). (nielsdos)
+  . Added enchant_dict_remove(). (nielsdos)
 
 - GD:
   . Fixed bug #68629 (Transparent artifacts when using imagerotate). (pierre,

UPGRADING

@@ -205,6 +205,8 @@ PHP 8.5 UPGRADE NOTES
 - Enchant:
   . Added enchant_dict_remove_from_session() to remove a word added to the
     spellcheck session via enchant_dict_add_to_session().
+  . Added enchant_dict_remove() to put a word on the exclusion list and
+    remove it from the session dictionary.
 
 - PGSQL:
   . pg_close_stmt offers an alternative way to close a prepared

ext/enchant/enchant.c

@@ -689,6 +689,22 @@ PHP_FUNCTION(enchant_dict_add)
 }
 /* }}} */
 
+PHP_FUNCTION(enchant_dict_remove)
+{
+	zval *dict;
+	char *word;
+	size_t wordlen;
+	enchant_dict *pdict;
+
+	if (zend_parse_parameters(ZEND_NUM_ARGS(), "Op", &dict, enchant_dict_ce, &word, &wordlen) == FAILURE) {
+		RETURN_THROWS();
+	}
+
+	PHP_ENCHANT_GET_DICT;
+
+	enchant_dict_remove(pdict->pdict, word, wordlen);
+}
+
 /* {{{ add 'word' to this spell-checking session */
 PHP_FUNCTION(enchant_dict_add_to_session)
 {

ext/enchant/enchant.stub.php

@@ -87,6 +87,8 @@ function enchant_dict_suggest(EnchantDictionary $dictionary, string $word): arra
 
 function enchant_dict_add(EnchantDictionary $dictionary, string $word): void {}
 
+function enchant_dict_remove(EnchantDictionary $dictionary, string $word): void {}
+
 /**
 * @alias enchant_dict_add
 */

ext/enchant/enchant_arginfo.h

@@ -0,0 +1,30 @@
+--TEST--
+enchant_dict_remove() function
+--EXTENSIONS--
+enchant
+--SKIPIF--
+<?php
+if (!is_array(enchant_broker_list_dicts(enchant_broker_init()))) die("skip no dictionary installed on this machine");
+?>
+--FILE--
+<?php
+$broker = enchant_broker_init();
+$dicts = enchant_broker_list_dicts($broker);
+$newWord = 'myImaginaryWord';
+
+$requestDict = enchant_broker_request_dict($broker, $dicts[0]['lang_tag']);
+
+var_dump(enchant_dict_check($requestDict, $newWord));
+enchant_dict_add($requestDict, $newWord);
+var_dump(enchant_dict_check($requestDict, $newWord));
+var_dump(enchant_dict_is_added($requestDict, $newWord));
+enchant_dict_remove($requestDict, $newWord);
+var_dump(enchant_dict_check($requestDict, $newWord));
+var_dump(enchant_dict_is_added($requestDict, $newWord));
+?>
+--EXPECT--
+bool(false)
+bool(true)
+bool(true)
+bool(false)
+bool(false)