Skip to content
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

Jump to bottom

Deprecate getResults in favor of getCurrentPageResults #6760

Merged
merged 4 commits into from
Jan 12, 2021
Merged

Deprecate getResults in favor of getCurrentPageResults #6760

merged 4 commits into from
Jan 12, 2021

Conversation

VincentLanglet
Copy link
Member

Subject

I am targeting this branch, because BC.

I just discover that

count($pager->getResults()) !== $pager->countResults()

And I think it's misleading.

getResults is returning the results of the current page, so I think it's better to rename this function.

I also close #6620

Changelog

### Added
- Added `PagerInterface::getCurrentPageResults()`

### Deprecated
- Added `PagerInterface::getResults()`

phansys
phansys requested changes Jan 11, 2021
View reviewed changes
src/Datagrid/PagerInterface.php Outdated Show resolved Hide resolved
@SonataCI
Copy link
Collaborator

Could you please rebase your PR and fix merge conflicts?

@VincentLanglet VincentLanglet requested review from phansys and a team January 11, 2021 11:33
dmaicher
dmaicher previously approved these changes Jan 11, 2021
View reviewed changes
phansys
phansys previously approved these changes Jan 11, 2021
View reviewed changes
@VincentLanglet VincentLanglet requested a review from a team January 11, 2021 14:53
@VincentLanglet VincentLanglet requested review from franmomu and a team January 11, 2021 18:24
@VincentLanglet VincentLanglet merged commit f9fa149 into sonata-project:3.x Jan 12, 2021
franmomu
franmomu reviewed Jan 13, 2021
View reviewed changes
src/Datagrid/Pager.php
@@ -940,7 +940,23 @@ protected function initializeIterator()
), E_USER_DEPRECATED);
}

$this->results = $this->getResults();
if (method_exists($this, 'getCurrentPageResults')) {
Copy link
Member

Choose a reason for hiding this comment

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

NEXT_MAJOR comment is missing here

@VincentLanglet VincentLanglet deleted the getCurrentPageResults branch March 27, 2021 22:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@franmomu franmomu franmomu left review comments

@phansys phansys phansys approved these changes

@OskarStark OskarStark OskarStark approved these changes

@dmaicher dmaicher dmaicher left review comments

Assignees
No one assigned
Labels
minor
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Return iterable instead of array in PagerInterface::getResults
6 participants
@VincentLanglet @SonataCI @franmomu @dmaicher @OskarStark @phansys