[php-src] master: ext/spl: Throw TypeError when overloaded SplObjectStorage::getHash() method does not return a string
| From: | Gina Peter Banyard | Date: | Sun, 17 Mar 2024 23:23:08 +0000 |
| Subject: | [php-src] master: ext/spl: Throw TypeError when overloaded SplObjectStorage::getHash() method does not return a string | ||
| Groups: | php.cvs | ||
| Request: | Send a blank email to php-cvs+get-127767@lists.php.net to get a copy of this message | ||
Author: Gina Peter Banyard (Girgias)
Date: 2024-03-17T23:08:58Z
Commit: https://github.com/php/php-src/commit/a648365fc0c7f630b0572c20e689db62dfe6f91d
Raw diff: https://github.com/php/php-src/commit/a648365fc0c7f630b0572c20e689db62dfe6f91d.diff
ext/spl: Throw TypeError when overloaded SplObjectStorage::getHash() method does not return a string
Changed paths:
M ext/spl/spl_observer.c
M ext/spl/tests/SplObjectStorage/SplObjectStorage_getHash.phpt
Diff:
diff --git a/ext/spl/spl_observer.c b/ext/spl/spl_observer.c
index 0d72df557cf7..261d9b19968a 100644
--- a/ext/spl/spl_observer.c
+++ b/ext/spl/spl_observer.c
@@ -87,20 +87,21 @@ static zend_result spl_object_storage_get_hash(zend_hash_key *key, spl_SplObject
zval param;
zval rv;
ZVAL_OBJ(¶m, obj);
- zend_call_method_with_1_params(
- &intern->std, intern->std.ce, &intern->fptr_get_hash, "getHash",
&rv, ¶m);
- if (!Z_ISUNDEF(rv)) {
- if (Z_TYPE(rv) == IS_STRING) {
- key->key = Z_STR(rv);
- return SUCCESS;
- } else {
- zend_throw_exception(spl_ce_RuntimeException, "Hash needs to be a string", 0);
-
+ zend_call_method_with_1_params(&intern->std, intern->std.ce,
&intern->fptr_get_hash, "getHash", &rv, ¶m);
+ if (UNEXPECTED(Z_ISUNDEF(rv))) {
+ /* An exception has occurred */
+ return FAILURE;
+ } else {
+ /* TODO PHP 9: Remove this as this will be enforced from the return type */
+ if (UNEXPECTED(Z_TYPE(rv) != IS_STRING)) {
+ zend_type_error("%s::getHash(): Return value must be of type string, %s returned",
+ ZSTR_VAL(intern->std.ce->name), zend_zval_value_name(&rv));
zval_ptr_dtor(&rv);
return FAILURE;
+ } else {
+ key->key = Z_STR(rv);
+ return SUCCESS;
}
- } else {
- return FAILURE;
}
} else {
key->key = NULL;
diff --git a/ext/spl/tests/SplObjectStorage/SplObjectStorage_getHash.phpt
b/ext/spl/tests/SplObjectStorage/SplObjectStorage_getHash.phpt
index 934243c77e8e..3b39c630bc6a 100644
--- a/ext/spl/tests/SplObjectStorage/SplObjectStorage_getHash.phpt
+++ b/ext/spl/tests/SplObjectStorage/SplObjectStorage_getHash.phpt
@@ -1,27 +1,15 @@
--TEST--
-SplObjectStorage::getHash implementation
+SplObjectStorage::getHash() implementation
--FILE--
<?php
-$s = new SplObjectStorage();
-$o1 = new Stdclass;
-$o2 = new Stdclass;
-$s[$o1] = "some_value\n";
-echo $s->offsetGet($o1);
-class MySplObjectStorage extends SplObjectStorage {
+class MySplObjectStorage1 extends SplObjectStorage {
#[ReturnTypeWillChange]
public function getHash($obj) {
return 2;
}
}
-try {
- $s1 = new MySplObjectStorage;
- $s1[$o1] = "foo";
-} catch(Exception $e) {
- echo "caught 1\n";
-}
-
class MySplObjectStorage2 extends SplObjectStorage {
public function getHash($obj): string {
throw new Exception("foo");
@@ -29,31 +17,47 @@ class MySplObjectStorage2 extends SplObjectStorage {
}
}
-try {
- $s2 = new MySplObjectStorage2;
- $s2[$o2] = "foo";
-} catch(Exception $e) {
- echo "caught 2\n";
-}
-
class MySplObjectStorage3 extends SplObjectStorage {
public function getHash($obj): string {
return "asd";
}
}
-$s3 = new MySplObjectStorage3;
-$s3[$o1] = $o1;
-var_dump($s3[$o1]);
-$s3[$o2] = $o2;
-
-var_dump($s3[$o1] === $s3[$o2]);
+$s = new SplObjectStorage();
+$o1 = new stdClass();
+$o2 = new stdClass();
+
+$instances = [
+ new SplObjectStorage(),
+ new MySplObjectStorage1(),
+ new MySplObjectStorage2(),
+ new MySplObjectStorage3(),
+];
+
+foreach ($instances as $instance) {
+ echo 'Instance as ', $instance::class, PHP_EOL;
+ try {
+ $instance[$o1] = 'foo';
+ var_dump($instance->offsetGet($o1));
+ var_dump($instance[$o1]);
+ $instance[$o2] = $o2;
+ var_dump($instance[$o1] === $instance[$o2]);
+ } catch(Throwable $e) {
+ echo $e::class, ': ', $e->getMessage(), PHP_EOL;
+ }
+}
?>
--EXPECT--
-some_value
-caught 1
-caught 2
-object(stdClass)#2 (0) {
-}
+Instance as SplObjectStorage
+string(3) "foo"
+string(3) "foo"
+bool(false)
+Instance as MySplObjectStorage1
+TypeError: MySplObjectStorage1::getHash(): Return value must be of type string, int returned
+Instance as MySplObjectStorage2
+Exception: foo
+Instance as MySplObjectStorage3
+string(3) "foo"
+string(3) "foo"
bool(true)