Skip to content

Fixed unsetting from loosely equal keys OrderedHashMap #24566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 16, 2017
Merged

Fixed unsetting from loosely equal keys OrderedHashMap #24566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions src/Symfony/Component/Form/Tests/Util/OrderedHashMapTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,15 @@ public function testInsertNullKeys()
$this->assertSame(array(0 => 1, 'foo' => 2, 1 => 3), iterator_to_array($map));
}

public function testInsertLooselyEqualKeys()
{
$map = new OrderedHashMap();
$map['1 as a string'] = '1 as a string';
$map[1] = 1;

$this->assertSame(array('1 as a string' => '1 as a string', 1 => 1), iterator_to_array($map));
}

/**
* Updates should not change the position of an element, otherwise we could
* turn foreach loops into endless loops if they change the current
Expand Down Expand Up @@ -111,6 +120,17 @@ public function testUnset()
$this->assertSame(array('second' => 2), iterator_to_array($map));
}

public function testUnsetFromLooselyEqualKeysHashMap()
{
$map = new OrderedHashMap();
$map['1 as a string'] = '1 as a string';
$map[1] = 1;

unset($map[1]);

$this->assertSame(array('1 as a string' => '1 as a string'), iterator_to_array($map));
}

public function testUnsetNonExistingSucceeds()
{
$map = new OrderedHashMap();
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Component/Form/Util/OrderedHashMap.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ public function offsetSet($key, $value)
: 1 + (int) max($this->orderedKeys);
}

$this->orderedKeys[] = $key;
$this->orderedKeys[] = (string) $key;
}

$this->elements[$key] = $value;
Expand All @@ -144,7 +144,7 @@ public function offsetSet($key, $value)
*/
public function offsetUnset($key)
{
if (false !== ($position = array_search($key, $this->orderedKeys))) {
if (false !== ($position = array_search((string) $key, $this->orderedKeys))) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't it have been enough to pass true as the third argument here?

Copy link
Contributor Author

@maryo maryo Nov 13, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xabbuh https://3v4l.org/vBboa
When unsetting a numeric string offset like unset($map['1']), $key equals to integer 1. So it's needed to treat these numeric strings the same way as integers. Hence the cast. And since $this->orderedKeys are all strings (the new cast in offsetSet), passing true would result in the same.

array_splice($this->orderedKeys, $position, 1);
unset($this->elements[$key]);

Expand Down
8 changes: 7 additions & 1 deletion src/Symfony/Component/Form/Util/OrderedHashMapIterator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,13 @@ public function next()
*/
public function key()
{
return $this->key;
if (null === $this->key) {
return null;
}

$array = array($this->key => null);

return key($array);
}

/**
Expand Down