Skip to content

Update Spl methods with sideEffects #4129

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.

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 5 commits into from
Jul 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions bin/functionMetadata_original.php
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,9 @@
'DateTimeImmutable::getTimestamp' => ['hasSideEffects' => false],
'DateTimeImmutable::getTimezone' => ['hasSideEffects' => false],

'SplDoublyLinkedList::pop' => ['hasSideEffects' => true],
'SplDoublyLinkedList::shift' => ['hasSideEffects' => true],

'SplFileObject::fflush' => ['hasSideEffects' => true],
'SplFileObject::fgetc' => ['hasSideEffects' => true],
'SplFileObject::fgetcsv' => ['hasSideEffects' => true],
Expand All @@ -183,6 +186,24 @@
'SplFileObject::ftruncate' => ['hasSideEffects' => true],
'SplFileObject::fwrite' => ['hasSideEffects' => true],

'SplFixedArray::extract' => ['hasSideEffects' => true],

'SplHead::extract' => ['hasSideEffects' => true],
'SplHead::insert' => ['hasSideEffects' => true],
'SplHead::recoverFromCorruption' => ['hasSideEffects' => true],

'SplObjectStorage::addAll' => ['hasSideEffects' => true],
'SplObjectStorage::attach' => ['hasSideEffects' => true],
'SplObjectStorage::detach' => ['hasSideEffects' => true],
'SplObjectStorage::removeAll' => ['hasSideEffects' => true],
'SplObjectStorage::removeAllExcept' => ['hasSideEffects' => true],

'SplPriorityQueue::extract' => ['hasSideEffects' => true],
'SplPriorityQueue::insert' => ['hasSideEffects' => true],
'SplPriorityQueue::recoverFromCorruption' => ['hasSideEffects' => true],

'SplQueue::dequeue' => ['hasSideEffects' => true],

'XmlReader::next' => ['hasSideEffects' => true],
'XmlReader::read' => ['hasSideEffects' => true],
];
15 changes: 15 additions & 0 deletions resources/functionMetadata.php
Original file line number Diff line number Diff line change
Expand Up @@ -639,6 +639,8 @@
'SimpleXMLIterator::hasChildren' => ['hasSideEffects' => false],
'SimpleXMLIterator::valid' => ['hasSideEffects' => false],
'SoapFault::__construct' => ['hasSideEffects' => false],
'SplDoublyLinkedList::pop' => ['hasSideEffects' => true],
'SplDoublyLinkedList::shift' => ['hasSideEffects' => true],
'SplFileObject::fflush' => ['hasSideEffects' => true],
'SplFileObject::fgetc' => ['hasSideEffects' => true],
'SplFileObject::fgetcsv' => ['hasSideEffects' => true],
Expand All @@ -651,6 +653,19 @@
'SplFileObject::fseek' => ['hasSideEffects' => true],
'SplFileObject::ftruncate' => ['hasSideEffects' => true],
'SplFileObject::fwrite' => ['hasSideEffects' => true],
'SplFixedArray::extract' => ['hasSideEffects' => true],
'SplHead::extract' => ['hasSideEffects' => true],
'SplHead::insert' => ['hasSideEffects' => true],
'SplHead::recoverFromCorruption' => ['hasSideEffects' => true],
'SplObjectStorage::addAll' => ['hasSideEffects' => true],
'SplObjectStorage::attach' => ['hasSideEffects' => true],
'SplObjectStorage::detach' => ['hasSideEffects' => true],
'SplObjectStorage::removeAll' => ['hasSideEffects' => true],
'SplObjectStorage::removeAllExcept' => ['hasSideEffects' => true],
'SplPriorityQueue::extract' => ['hasSideEffects' => true],
'SplPriorityQueue::insert' => ['hasSideEffects' => true],
'SplPriorityQueue::recoverFromCorruption' => ['hasSideEffects' => true],
'SplQueue::dequeue' => ['hasSideEffects' => true],
'Spoofchecker::__construct' => ['hasSideEffects' => false],
'StringBackedEnum::from' => ['hasSideEffects' => false],
'StringBackedEnum::tryFrom' => ['hasSideEffects' => false],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,12 @@ public function testBug9850(): void
$this->analyse([__DIR__ . '/data/bug-9850.php'], []);
}

public function testBug9180(): void
{
$this->treatPhpDocTypesAsCertain = true;
$this->analyse([__DIR__ . '/data/bug-9180.php'], []);
}

public function testBug12716(): void
{
$this->treatPhpDocTypesAsCertain = true;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -996,6 +996,11 @@ public function testBug12946(): void
$this->analyse([__DIR__ . '/data/bug-12946.php'], []);
}

public function testBug10884(): void
{
$this->analyse([__DIR__ . '/data/bug-10884.php'], []);
}

public function testBug13208(): void
{
$this->analyse([__DIR__ . '/data/bug-13208.php'], []);
Expand Down
49 changes: 49 additions & 0 deletions tests/PHPStan/Rules/Comparison/data/bug-10884.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<?php declare(strict_types = 1);

namespace Bug10884;

class Cat {}

/** @var \SplObjectStorage<Cat, null> $map */
$map = new \SplObjectStorage();
$map->attach(new Cat());
$map->attach(new Cat());

class Manager
{
/**
* @param SplObjectStorage<Cat, null> $map
*/
public function doSomething(\SplObjectStorage $map): void
{
/** @var \SplObjectStorage<Cat, null> $other */
$other = new \SplObjectStorage();

if (count($map) === 0) {
return;
}

foreach ($map as $cat) {
if (!$this->someCheck($cat)) {
continue;
}

$other->attach($cat);
}

$map->removeAll($other);

if (count($map) === 0) {
return;
}

// ok!
}

private function someCheck(Cat $cat): bool {
// just some random
return $cat == true;
}
}

(new Manager())->doSomething($map);
15 changes: 15 additions & 0 deletions tests/PHPStan/Rules/Comparison/data/bug-9180.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?php

namespace Bug9180;

$queue = new \SplQueue();

$queue->push(1);

if ($queue->count() > 0) {
for ($i=0;$i<5;$i++) {
while ($queue->count() > 0 && $value = $queue->shift()) {
//do something with $value
}
}
}
Loading