[php-src] Issue #13992: Objects implementing ArrayAccess cannot discern appended values or setting a value with a NULL offset.
| From: | wrossmann | Date: | Wed, 17 Apr 2024 21:22:12 +0000 |
| Subject: | [php-src] Issue #13992: Objects implementing ArrayAccess cannot discern appended values or setting a value with a NULL offset. | ||
| Groups: | php.bugs | ||
| Request: | Send a blank email to php-bugs+get-246782@lists.php.net to get a copy of this message | ||
Issue: https://github.com/php/php-src/issues/13992
Author: wrossmann
### Description
While arrays treat
$arr[] = 1 and $arr[NULL] = 1 as different operations,
with the latter key being juggled to "",
ArrayAccess::offsetSet() can only be passed NULL as the key in both cases,
leaving the implementer to choose to either append the value to the array or set the
"NULL" index.
The following code: https://3v4l.org/KIt91
```php
<?php
class AATest implements ArrayAccess {
protected $array = [];
// ArrayAccess interface
public function offsetExists(mixed $offset): bool {
return key_exists($offset, $this->array);
}
public function offsetGet(mixed $offset): mixed {
return $this->array[$offset];
}
public function offsetSet(mixed $offset, mixed $value): void {
if( is_null($offset) ) {
$this->array[] = $value;
} else {
$this->array[$offset] = $value;
}
}
public function offsetUnset(mixed $offset): void {
unset($this->array[$offset]);
}
// debug
public function dbgGetArray() {
return $this->array;
}
}
$object = new AATest();
$object[] = 'a';
$object[NULL] = 'b';
$object[] = 'c';
var_dump($object->dbgGetArray());
$array = [];
$array[] = 'a';
$array[NULL] = 'b';
$array[] = 'c';
var_dump($array);
```
Resulted in this output:
```
array(3) {
[0]=>
string(1) "a"
[1]=>
string(1) "b"
[2]=>
string(1) "c"
}
array(3) {
[0]=>
string(1) "a"
[""]=>
string(1) "b"
[1]=>
string(1) "c"
}
```
But I expected this output instead:
```
array(3) {
[0]=>
string(1) "a"
[""]=>
string(1) "b"
[1]=>
string(1) "c"
}
array(3) {
[0]=>
string(1) "a"
[""]=>
string(1) "b"
[1]=>
string(1) "c"
}
```
With a few tweaks you can make 3v4l show that this has been the case all the way back to 5.0.0: https://3v4l.org/OC9qQ
I believe that in order to address this discrepancy there should be another method added to
ArrayAccess specifically to handle an append, eg: ArrayAccess::appendValue(mixed $value):
void, which would be invoked in the case of $obj[] = 1.
Of course, this would be a BC break, but the prior functionality would be easily restored via
defining:
```php
public function appendValue(mixed $value): void {
$this->offsetSet(NULL, $value);
}
```
Alternately, NULL could simply be disallowed as a valid array offset entirely. Another
BC break, but fixable with $array[$maybeNull ?: ""].
### PHP Version
PHP >= 5.0.0
### Operating System
_No response_