Mocking Paginator #5236

New Issue

Closed

opened 2026-01-22 15:02:12 +01:00 by admin · 12 comments

admin commented 2026-01-22 15:02:12 +01:00

Owner

Copy Link

Originally created by @matiux on GitHub (Aug 31, 2016).

Hi,
I need to test a service that accepts a Doctrine\ORM\Tools\Pagination\Paginator object.
I wouldn't use the real repository in the test class. Rather I'd like to mock Paginator with some result so that I can pass it to my service.

I'm looking for the examples in the source code but I still not find them.

Can someone supply some examples to mock Paginator?

Thanks

Originally created by @matiux on GitHub (Aug 31, 2016). Hi, I need to test a service that accepts a `Doctrine\ORM\Tools\Pagination\Paginator` object. I wouldn't use the real repository in the test class. Rather I'd like to mock Paginator with some result so that I can pass it to my service. I'm looking for the examples in the source code but I still not find them. Can someone supply some examples to mock Paginator? Thanks

admin closed this issue 2026-01-22 15:02:13 +01:00

admin commented 2026-01-22 15:02:14 +01:00

Author

Owner

Copy Link

@Ocramius commented on GitHub (Aug 31, 2016):

A Paginator is just an iterator: you can type-hint against that, usually.

On 31 Aug 2016 1:19 p.m., "Matteo" notifications@github.com wrote:

Hi,
I need to test a service that accepts a Doctrine\ORM\Tools\Pagination
Paginator object.
I wouldn't use the real repository in the test class. Rather I'd like to
mock Paginator with some result so that I can pass it to my service.

I'm looking for the examples in the source code but I still not find them.

Can someone supply some examples to mock Paginator?

Thanks

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
https://github.com/doctrine/doctrine2/issues/5999, or mute the thread
https://github.com/notifications/unsubscribe-auth/AAJakNIX3APfF5qq79NVrlFWJ96qdbVfks5qlWNPgaJpZM4JxgBy
.

@Ocramius commented on GitHub (Aug 31, 2016): A Paginator is just an iterator: you can type-hint against that, usually. On 31 Aug 2016 1:19 p.m., "Matteo" notifications@github.com wrote: > Hi, > I need to test a service that accepts a Doctrine\ORM\Tools\Pagination\ > Paginator object. > I wouldn't use the real repository in the test class. Rather I'd like to > mock Paginator with some result so that I can pass it to my service. > > I'm looking for the examples in the source code but I still not find them. > > Can someone supply some examples to mock Paginator? > > Thanks > > — > You are receiving this because you are subscribed to this thread. > Reply to this email directly, view it on GitHub > https://github.com/doctrine/doctrine2/issues/5999, or mute the thread > https://github.com/notifications/unsubscribe-auth/AAJakNIX3APfF5qq79NVrlFWJ96qdbVfks5qlWNPgaJpZM4JxgBy > .

admin commented 2026-01-22 15:02:14 +01:00

Author

Owner

Copy Link

@matiux commented on GitHub (Aug 31, 2016):

Thanks @Ocramius,
what do you mean with "type-hint against that" ?

@matiux commented on GitHub (Aug 31, 2016): Thanks @Ocramius, what do you mean with "type-hint against that" ?

admin commented 2026-01-22 15:02:14 +01:00

Author

Owner

Copy Link

@lcobucci commented on GitHub (Aug 31, 2016):

Paginator implements IteratorAggregate (that extends Traversable). So you can use Traversable as type-hint and pass any iterator you want (instead of mocking Paginator class).

@lcobucci commented on GitHub (Aug 31, 2016): `Paginator` implements `IteratorAggregate` (that extends `Traversable`). So you can use `Traversable` as type-hint and pass any iterator you want (instead of mocking `Paginator` class).

admin commented 2026-01-22 15:02:15 +01:00

Author

Owner

Copy Link

@matiux commented on GitHub (Aug 31, 2016):

Thanks,
I'm was also able to create a mock:

$config = m::mock(Configuration::class);
$config->shouldReceive('getDefaultQueryHints')->andReturn([]);
$config->shouldReceive('isSecondLevelCacheEnabled')->andReturn(false);

$em = m::mock(EntityManager::class);
$em->shouldReceive('getConfiguration')->andReturn($config);

$query = m::mock(new Query($em));
$query->shouldReceive('getFirstResult')->andReturn(1);

$paginator = m::namedMock('Paginator', 'Doctrine\ORM\Tools\Pagination\Paginator');
$paginator->shouldReceive('count')->atMost(1)->andReturn(count($results));
$paginator->shouldReceive('getQuery')->atMost(1)->andReturn($query);
$paginator->shouldReceive('getIterator')->atMost(1)->andReturn(new \ArrayIterator($results));

adding the methods that I need

@matiux commented on GitHub (Aug 31, 2016): Thanks, I'm was also able to create a mock: ``` $config = m::mock(Configuration::class); $config->shouldReceive('getDefaultQueryHints')->andReturn([]); $config->shouldReceive('isSecondLevelCacheEnabled')->andReturn(false); $em = m::mock(EntityManager::class); $em->shouldReceive('getConfiguration')->andReturn($config); $query = m::mock(new Query($em)); $query->shouldReceive('getFirstResult')->andReturn(1); $paginator = m::namedMock('Paginator', 'Doctrine\ORM\Tools\Pagination\Paginator'); $paginator->shouldReceive('count')->atMost(1)->andReturn(count($results)); $paginator->shouldReceive('getQuery')->atMost(1)->andReturn($query); $paginator->shouldReceive('getIterator')->atMost(1)->andReturn(new \ArrayIterator($results)); ``` adding the methods that I need

admin commented 2026-01-22 15:02:16 +01:00

Author

Owner

Copy Link

@Ocramius commented on GitHub (Sep 1, 2016):

That is all waaaaaay too specific mocking of implementation details. Refrain from doing that: it is just making your tests fragile, hard to read and an overall no-value-added.

See what @lcobucci said instead.

Closing here: thought it was on the mailing list, but it's on the tracker, and the tracker is for issues ;-)

@Ocramius commented on GitHub (Sep 1, 2016): That is all waaaaaay too specific mocking of implementation details. Refrain from doing that: it is just making your tests fragile, hard to read and an overall no-value-added. See what @lcobucci said instead. Closing here: thought it was on the mailing list, but it's on the tracker, and the tracker is for issues ;-)

admin commented 2026-01-22 15:02:16 +01:00

Author

Owner

Copy Link

@matiux commented on GitHub (Sep 1, 2016):

I have a doubt. Using Traversable object, how can I have, for example getFirstResult() method? My service (that accepts Paginator object), needs to access to Query in Paginator to get the first result

Thanks

@matiux commented on GitHub (Sep 1, 2016): I have a doubt. Using Traversable object, how can I have, for example `getFirstResult()` method? My service (that accepts `Paginator` object), needs to access to `Query` in `Paginator` to get the first result Thanks

admin commented 2026-01-22 15:02:17 +01:00

Author

Owner

Copy Link

@Ocramius commented on GitHub (Sep 1, 2016):

You'd inject the query and the paginator separately then. Getting the query from the paginator is usually a bad idea...

@Ocramius commented on GitHub (Sep 1, 2016): You'd inject the query and the paginator separately then. Getting the query from the paginator is usually a bad idea...

admin commented 2026-01-22 15:02:18 +01:00

Author

Owner

Copy Link

@matiux commented on GitHub (Sep 1, 2016):

Paginator is based on the query. You can simply get the query with $paginator->getQuery(). Passing Paginator and Query separately is a redundant way. My 2 cents.

public function foo(Paginator $p, Query $q) {
}

public function foo(Paginator $p) {

$q = $p->getQuery();
}

I don't think that the second approach it's wrong :)

@matiux commented on GitHub (Sep 1, 2016): Paginator is based on the query. You can simply get the query with `$paginator->getQuery()`. Passing Paginator and Query separately is a redundant way. My 2 cents. ``` public function foo(Paginator $p, Query $q) { } public function foo(Paginator $p) { $q = $p->getQuery(); } ``` I don't think that the second approach it's wrong :)

admin commented 2026-01-22 15:02:18 +01:00

Author

Owner

Copy Link

@Ocramius commented on GitHub (Sep 1, 2016):

The second approach is wrong because you are assuming that the query that
you retrieve is the same one you gave in. No guarantee on this comes from
that API.

Marco Pivetta

http://twitter.com/Ocramius

http://ocramius.github.com/

On Thu, Sep 1, 2016 at 11:06 AM, Matteo notifications@github.com wrote:

Paginator is based on the query. You can simply get the query with
$paginator->getQuery(). Passing Paginator and Query separately is a
redundant way. My 2 cents.

public function foo(Paginator $p, Query $q) {
}

public function foo(Paginator $p) {

$q = $p->getQuery();
}

I don't think that the second approach it's wrong :)

—
You are receiving this because you modified the open/close state.
Reply to this email directly, view it on GitHub
https://github.com/doctrine/doctrine2/issues/5999#issuecomment-244020635,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAJakDRM08NXK2_Pb-FSX53apVq94KPmks5qlpWggaJpZM4JxgBy
.

@Ocramius commented on GitHub (Sep 1, 2016): The second approach is wrong because you are assuming that the query that you retrieve is the same one you gave in. No guarantee on this comes from that API. Marco Pivetta http://twitter.com/Ocramius http://ocramius.github.com/ On Thu, Sep 1, 2016 at 11:06 AM, Matteo notifications@github.com wrote: > Paginator is based on the query. You can simply get the query with > $paginator->getQuery(). Passing Paginator and Query separately is a > redundant way. My 2 cents. > > public function foo(Paginator $p, Query $q) { > } > > public function foo(Paginator $p) { > > $q = $p->getQuery(); > } > > I don't think that the second approach it's wrong :) > > — > You are receiving this because you modified the open/close state. > Reply to this email directly, view it on GitHub > https://github.com/doctrine/doctrine2/issues/5999#issuecomment-244020635, > or mute the thread > https://github.com/notifications/unsubscribe-auth/AAJakDRM08NXK2_Pb-FSX53apVq94KPmks5qlpWggaJpZM4JxgBy > .

admin commented 2026-01-22 15:02:18 +01:00

Author

Owner

Copy Link

@matiux commented on GitHub (Sep 1, 2016):

According to this logic, from the repository I need to return not only Doctrine\ORM\Tools\Pagination\Paginator but also Doctrine\ORM\Query

@matiux commented on GitHub (Sep 1, 2016): According to this logic, from the repository I need to return not only `Doctrine\ORM\Tools\Pagination\Paginator` but also `Doctrine\ORM\Query`

admin commented 2026-01-22 15:02:18 +01:00

Author

Owner

Copy Link

@Ocramius commented on GitHub (Sep 1, 2016):

Or just the iterator. If you want the first result only, you can traverse
the operator only to its first element. Throwing a query object around is
mostly trouble.

On 1 Sep 2016 11:13, "Matteo" notifications@github.com wrote:

According to this logic, from the repository I need to return non only
Doctrine\ORM\Tools\Pagination\Paginator but also Doctrine\ORM\Query

—
You are receiving this because you modified the open/close state.
Reply to this email directly, view it on GitHub
https://github.com/doctrine/doctrine2/issues/5999#issuecomment-244022257,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAJakKpm4VOJSc1tj7BoLonBgnQwXqIyks5qlpc1gaJpZM4JxgBy
.

@Ocramius commented on GitHub (Sep 1, 2016): Or just the iterator. If you want the first result only, you can traverse the operator only to its first element. Throwing a query object around is mostly trouble. On 1 Sep 2016 11:13, "Matteo" notifications@github.com wrote: > According to this logic, from the repository I need to return non only > Doctrine\ORM\Tools\Pagination\Paginator but also Doctrine\ORM\Query > > — > You are receiving this because you modified the open/close state. > Reply to this email directly, view it on GitHub > https://github.com/doctrine/doctrine2/issues/5999#issuecomment-244022257, > or mute the thread > https://github.com/notifications/unsubscribe-auth/AAJakKpm4VOJSc1tj7BoLonBgnQwXqIyks5qlpc1gaJpZM4JxgBy > .

admin commented 2026-01-22 15:02:20 +01:00

Author

Owner

Copy Link

@matiux commented on GitHub (Sep 1, 2016):

There is a mistake. getFirstResult() doesn't return the first item of the collection. It returns the offset of the query.

... LIMIT 40 OFFSET 81

It is the parameter that you can set in the query doctrine with $queryBuilder->setFirstResult($offset);

This paramater there isn't in the Paginator object

@matiux commented on GitHub (Sep 1, 2016): There is a mistake. `getFirstResult()` doesn't return the first item of the collection. It returns the offset of the query. ... LIMIT 40 OFFSET **81** It is the parameter that you can set in the query doctrine with `$queryBuilder->setFirstResult($offset);` This paramater there isn't in the `Paginator` object

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

3.6.x

2.20.x

dependabot/github_actions/2.20.x/doctrine/dot-github/dot-github/workflows/composer-lint.yml-14.0.0

3.7.x

4.0.x

2.21.x

old-prototype-3.x

3.6.2

3.6.1

3.6.0

2.20.9

3.5.8

3.5.7

3.5.6

3.5.5

2.20.8

3.5.4

3.5.3

2.20.7

3.5.2

2.20.6

3.5.1

3.5.0

3.4.4

3.4.3

3.4.2

2.20.5

3.4.1

3.4.0

3.3.4

2.20.4

3.3.3

2.20.3

3.3.2

2.20.2

3.3.1

2.20.1

3.3.0

3.2.3

2.20.0

2.19.8

3.2.2

2.19.7

3.2.1

2.19.6

3.2.0

3.1.4

3.1.3

2.19.5

3.1.2

2.19.4

3.1.1

2.19.3

2.19.2

2.19.1

3.1.0

2.19.0

3.0.3

2.18.3

3.0.2

2.18.2

3.0.1

2.18.1

3.0.0

2.18.0

2.17.5

3.0.0-RC1

2.17.4

2.17.3

2.17.2

2.17.1

3.0.0-beta2

2.17.0

2.16.3

3.0.0-beta1

2.16.2

2.16.1

2.16.0

2.15.5

2.15.4

2.15.3

2.15.2

2.15.1

2.15.0

2.14.3

2.14.2

2.14.1

2.14.0

2.13.5

2.13.4

2.13.3

2.13.2

2.13.1

2.13.0

2.12.4

2.12.3

2.12.2

2.12.1

2.12.0

2.11.3

2.11.2

2.11.1

2.11.0

2.10.5

2.10.4

2.10.3

2.10.2

2.10.1

2.10.0

2.9.6

2.9.5

2.9.4

2.9.3

2.9.2

2.9.1

2.9.0

2.8.5

2.8.4

2.8.3

2.8.2

2.8.1

2.8.0

2.7.5

2.7.4

v2.7.3

v2.7.2

v2.7.1

v2.7.0

v2.6.6

v2.6.5

v2.6.4

v2.6.3

v2.6.2

v2.6.1

v2.6.0

v2.5.14

v2.5.13

v2.5.12

v2.5.11

v2.5.10

v2.5.9

v2.5.8

v2.5.7

v2.5.6

v2.5.5

v2.5.4

v2.5.3

v2.5.2

v2.4.8

v2.5.1

v2.5.0

v2.5.0-RC2

v2.5.0-RC1

v2.5.0-beta1

v2.5.0-alpha2

v2.5.0-alpha1

v2.4.7

v2.4.6

v2.4.5

v2.4.4

v2.4.3

v2.3.6

v2.4.2

2.3.5

v2.4.1

v2.4.0

2.4.0-RC2

2.4.0-RC1

2.4.0-BETA2

2.3.4

2.3.3

2.4.0-BETA1

2.3.2

2.3.1

2.3.0

2.3.0-RC4

2.3.0-RC3

2.3.0-RC2

2.2.3

2.3.0-RC1

2.3.0-BETA1

2.1.7

2.2.2

2.2.1

2.1.6

2.2.0

2.2.0-RC1

2.2.0-BETA2

2.2.0-BETA1

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.0.7

2.1.0

2.1.0RC3

2.1.0RC2

2.1.0RC1

2.0.6

2.1.0BETA1

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

2.0.0RC2

2.0.0RC1

2.0.0-BETA4

2.0.0-BETA3

2.0.0-BETA2

2.0.0-BETA1

Labels

Clear labels

BC Break

Bug

Can't Fix

Deprecation

Documentation

DQL

Duplicate

Failing Test

Hacktoberfest

Improvement

Improvement

Incomplete

Invalid

Missing Tests

New Feature

PR Created

pull-request

Mirrored from GitHub Pull Request

Question

Regression

Status: Waiting feedback

Waiting feedback

WIP

Won't Fix

No Label

Milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

admin

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: doctrine/archived-orm#5236