ext/intl: breakiterator::setText returns false on failure.

devnexen · devnexen · commit 7623bf0b06e1 · 2023-03-28T13:29:09.000+01:00
Close GH-10820
diff --git a/NEWS b/NEWS
@@ -55,6 +55,7 @@ PHP                                                                        NEWS
     the Spoofchecker's class. (David Carlier)
   . Updated datefmt_set_timezone/IntlDateformatter::setTimezone returns type.
     (David Carlier).
+  . Updated IntlBreakInterator::setText return type. (David Carlier)
 
 - JSON:
   . Added json_validate(). (Juan Morales)
diff --git a/UPGRADING b/UPGRADING
@@ -84,7 +84,9 @@ PHP 8.3 UPGRADE NOTES
 
 - Intl:
   . datefmt_set_timezone (and its alias IntlDateformatter::setTimeZone) 
-    now returns true on sucess, previously null was returned.
+    now returns true on success, previously null was returned.
+  . IntlBreakiterator::setText() now returns false on failure, previously
+    null was returned.
 
 - MBString:
   . mb_strtolower, mb_strtotitle, and mb_convert_case implement conditional
diff --git a/ext/intl/breakiterator/breakiterator.stub.php b/ext/intl/breakiterator/breakiterator.stub.php
@@ -164,7 +164,7 @@ public function preceding(int $offset): int {}
     public function previous(): int {}
 
     /** @tentative-return-type */
-    public function setText(string $text): ?bool {} // TODO return false instead of null in case of failure
+    public function setText(string $text): bool {}
 
     public function getIterator(): Iterator {}
 }
diff --git a/ext/intl/breakiterator/breakiterator_arginfo.h b/ext/intl/breakiterator/breakiterator_arginfo.h
diff --git a/ext/intl/breakiterator/breakiterator_methods.cpp b/ext/intl/breakiterator/breakiterator_methods.cpp
@@ -153,11 +153,11 @@ U_CFUNC PHP_METHOD(IntlBreakIterator, setText)
 	BREAKITER_METHOD_FETCH_OBJECT;
 
 	ut = utext_openUTF8(ut, ZSTR_VAL(text), ZSTR_LEN(text), BREAKITER_ERROR_CODE_P(bio));
-	INTL_METHOD_CHECK_STATUS_OR_NULL(bio, "breakiter_set_text: error opening UText");
+	INTL_METHOD_CHECK_STATUS(bio, "breakiter_set_text: error opening UText");
 
 	bio->biter->setText(ut, BREAKITER_ERROR_CODE(bio));
 	utext_close(ut); /* ICU shallow clones the UText */
-	INTL_METHOD_CHECK_STATUS_OR_NULL(bio, "breakiter_set_text: error calling "
+	INTL_METHOD_CHECK_STATUS(bio, "breakiter_set_text: error calling "
 		"BreakIterator::setText()");
 
 	/* When ICU clones the UText, it does not copy the buffer, so we have to

Original file line number	Diff line number	Diff line change
`@@ -164,7 +164,7 @@ public function preceding(int $offset): int {}`
`164`	`164`	`public function previous(): int {}`
`165`	`165`
`166`	`166`	`/** @tentative-return-type */`
`167`		`- public function setText(string $text): ?bool {} // TODO return false instead of null in case of failure`
	`167`	`+ public function setText(string $text): bool {}`
`168`	`168`
`169`	`169`	`public function getIterator(): Iterator {}`
`170`	`170`	`}`