Fix Scroll:current() annotation #1749
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thePanz
force-pushed
the
fix-scroll-iterator-current
branch
from
98b0782 to
5a30457
Compare
ruflin
approved these changes
Jan 20, 2020
Calling Scroll->current() on an invalid Iterator should be avoided: the Iterator documentation states that code should first call "valid()" before accessing the "current()" value. Not doing so can lead to unexpected results. Scroll will throw an InvalidException when trying to call "current()" on an invalid state.
thePanz
force-pushed
the
fix-scroll-iterator-current
branch
from
5a30457 to
6236a07
Compare
|
@ruflin Changelog added :) |
ruflin
approved these changes
Jan 20, 2020
|
Ref. #1506 |
|
Didn't know about that PR @Tobion . The whole library should get a cleanup on the Iterator implementations :) |
|
@thePanz I would not say no 😇 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When analyzing a code using the iterator in a
foreach($scroll as $resultSet)with phpstan, the following error is reported:There is quite a debate about the return type of an
Iterator::current(), as it should always return the item in the collection.Invoking the
current()when "out of bounds" of the collection is expected not to happen, as theIterator::valid()should be called first.