[8.x] Allow tap() on Paginator

[crynobone]

Before

$posts = App\Models\Post::search('Laravel')->paginate();

$posts->load('author');

return $posts;

After

return App\Models\Post::search('Laravel')
    ->paginate()
    ->tap(function ($posts) {
        $posts->load('author');
    });

Signed-off-by: Mior Muhammad Zaki [email protected]

[crynobone]

Could be useful to add Illuminate\Support\Traits\Conditionable too

[dabernathy89]

I believe this should be considered a breaking change, since tap would previously be forwarded to the underlying collection of the paginator.

[driesvints]

Ping @crynobone ^

[crynobone]

It would only be breaking change if you doing something like:

$users = User::paginate()->tap(function ($users) { /* ... */ });

$user = User::paginate();

$users->tap(function ($users) { /* ... */ }); // should behave the same

[crynobone]

In most use-case you would generally interact with the collection using:

$users = User::paginate();

$user->setCollection($users->getCollection()->each(/* ... */));

[dabernathy89]

I'm sure it's not common, but regardless, if someone is using tap to access the underlying collection then this is a breaking change for them.