Add enchant_dict_remove_from_session() (#17393)

NEWS

@@ -29,6 +29,9 @@ PHP                                                                        NEWS
   . Added Dom\Element::$outerHTML. (nielsdos)
   . Added Dom\Element::insertAdjacentHTML(). (nielsdos)
 
+- Enchant:
+  . Added enchant_dict_remove_from_session(). (nielsdos)
+
 - Intl:
   . Bumped ICU requirement to ICU >= 57.1. (cmb)
   . IntlDateFormatter::setTimeZone()/datefmt_set_timezone() throws an exception

UPGRADING

@@ -166,6 +166,10 @@ PHP 8.5 UPGRADE NOTES
 - DOM:
   . Added Dom\Element::insertAdjacentHTML().
 
+- Enchant:
+  . Added enchant_dict_remove_from_session() to remove a word added to the
+    spellcheck session via enchant_dict_add_to_session().
+
 - PGSQL:
   . pg_close_stmt offers an alternative way to close a prepared
     statement from the DEALLOCATE sql command in that we can reuse

ext/enchant/enchant.c

@@ -707,6 +707,22 @@ PHP_FUNCTION(enchant_dict_add_to_session)
 }
 /* }}} */
 
+PHP_FUNCTION(enchant_dict_remove_from_session)
+{
+	zval *dict;
+	const char *word;
+	size_t wordlen;
+	const 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_from_session(pdict->pdict, word, wordlen);
+}
+
 /* {{{ whether or not 'word' exists in this spelling-session */
 PHP_FUNCTION(enchant_dict_is_added)
 {

ext/enchant/enchant.stub.php

@@ -95,6 +95,8 @@ function enchant_dict_add_to_personal(EnchantDictionary $dictionary, string $wor
 
 function enchant_dict_add_to_session(EnchantDictionary $dictionary, string $word): void {}
 
+function enchant_dict_remove_from_session(EnchantDictionary $dictionary, string $word): void {}
+
 function enchant_dict_is_added(EnchantDictionary $dictionary, string $word): bool {}
 
 /**

ext/enchant/enchant_arginfo.h

@@ -1,5 +1,5 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: bcd5195c8a1eea47d881747a57f1b1342ef0bbd1 */
+ * Stub hash: f4705d8708830247ffb55a7bf73bc6e874e12629 */
 
 ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_enchant_broker_init, 0, 0, EnchantBroker, MAY_BE_FALSE)
 ZEND_END_ARG_INFO()
@@ -79,6 +79,8 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_enchant_dict_add_to_session arginfo_enchant_dict_add
 
+#define arginfo_enchant_dict_remove_from_session arginfo_enchant_dict_add
+
 #define arginfo_enchant_dict_is_added arginfo_enchant_dict_check
 
 #define arginfo_enchant_dict_is_in_session arginfo_enchant_dict_check
@@ -114,6 +116,7 @@ ZEND_FUNCTION(enchant_dict_check);
 ZEND_FUNCTION(enchant_dict_suggest);
 ZEND_FUNCTION(enchant_dict_add);
 ZEND_FUNCTION(enchant_dict_add_to_session);
+ZEND_FUNCTION(enchant_dict_remove_from_session);
 ZEND_FUNCTION(enchant_dict_is_added);
 ZEND_FUNCTION(enchant_dict_store_replacement);
 ZEND_FUNCTION(enchant_dict_get_error);
@@ -138,6 +141,7 @@ static const zend_function_entry ext_functions[] = {
 	ZEND_FE(enchant_dict_add, arginfo_enchant_dict_add)
 	ZEND_RAW_FENTRY("enchant_dict_add_to_personal", zif_enchant_dict_add, arginfo_enchant_dict_add_to_personal, ZEND_ACC_DEPRECATED, NULL, NULL)
 	ZEND_FE(enchant_dict_add_to_session, arginfo_enchant_dict_add_to_session)
+	ZEND_FE(enchant_dict_remove_from_session, arginfo_enchant_dict_remove_from_session)
 	ZEND_FE(enchant_dict_is_added, arginfo_enchant_dict_is_added)
 	ZEND_RAW_FENTRY("enchant_dict_is_in_session", zif_enchant_dict_is_added, arginfo_enchant_dict_is_in_session, ZEND_ACC_DEPRECATED, NULL, NULL)
 	ZEND_FE(enchant_dict_store_replacement, arginfo_enchant_dict_store_replacement)

ext/enchant/tests/dict_remove_from_session.phpt

@@ -0,0 +1,31 @@
+--TEST--
+enchant_dict_remove_from_session() 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_to_session($requestDict, $newWord);
+var_dump(enchant_dict_check($requestDict, $newWord));
+var_dump(enchant_dict_is_added($requestDict, $newWord));
+enchant_dict_remove_from_session($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)

ext/enchant/tests/null_bytes.phpt

@@ -25,6 +25,7 @@ $two_params_dict = [
     "enchant_dict_suggest",
     "enchant_dict_add",
     "enchant_dict_add_to_session",
+    "enchant_dict_remove_from_session",
     "enchant_dict_is_added",
 ];
 
@@ -65,6 +66,7 @@ enchant_dict_check(): Argument #2 ($word) must not contain any null bytes
 enchant_dict_suggest(): Argument #2 ($word) must not contain any null bytes
 enchant_dict_add(): Argument #2 ($word) must not contain any null bytes
 enchant_dict_add_to_session(): Argument #2 ($word) must not contain any null bytes
+enchant_dict_remove_from_session(): Argument #2 ($word) must not contain any null bytes
 enchant_dict_is_added(): Argument #2 ($word) must not contain any null bytes
 enchant_broker_set_ordering(): Argument #2 ($tag) must not contain any null bytes
 enchant_dict_store_replacement(): Argument #2 ($misspelled) must not contain any null bytes