Skip to content

Commit fcd5add

Browse files
lindyhopchrislindyhopchris
committedAug 7, 2024·
refactor: tidy up cursor pagination implementation
·
v4.5.0v4.2.0
1 parent d46b030 commit fcd5add

File tree

8 files changed

+529
-311
lines changed

8 files changed

+529
-311
lines changed
 

‎CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file. This projec
55

66
## Unreleased
77

8+
### Added
9+
10+
- [#37](https://github.com/laravel-json-api/eloquent/pull/37) Add Eloquent cursor pagination implementation.
11+
812
## [4.1.0] - 2024-06-26
913

1014
### Added

‎src/Pagination/Cursor/Cursor.php

+18-41
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,10 @@
11
<?php
22
/*
3-
* Copyright 2023 Cloud Creativity Limited
3+
* Copyright 2024 Cloud Creativity Limited
44
*
5-
* Licensed under the Apache License, Version 2.0 (the "License");
6-
* you may not use this file except in compliance with the License.
7-
* You may obtain a copy of the License at
8-
*
9-
* http://www.apache.org/licenses/LICENSE-2.0
10-
*
11-
* Unless required by applicable law or agreed to in writing, software
12-
* distributed under the License is distributed on an "AS IS" BASIS,
13-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14-
* See the License for the specific language governing permissions and
15-
* limitations under the License.
5+
* Use of this source code is governed by an MIT-style
6+
* license that can be found in the LICENSE file or at
7+
* https://opensource.org/licenses/MIT.
168
*/
179

1810
declare(strict_types=1);
@@ -21,40 +13,23 @@
2113

2214
use InvalidArgumentException;
2315

24-
class Cursor
16+
final readonly class Cursor
2517
{
26-
27-
/**
28-
* @var string|null
29-
*/
30-
private ?string $before;
31-
32-
/**
33-
* @var string|null
34-
*/
35-
private ?string $after;
36-
37-
/**
38-
* @var int|null
39-
*/
40-
private ?int $limit;
41-
42-
/**
18+
/**
4319
* Cursor constructor.
4420
*
4521
* @param string|null $before
4622
* @param string|null $after
4723
* @param int|null $limit
4824
*/
49-
public function __construct(string $before = null, string $after = null, int $limit = null)
50-
{
51-
if (is_int($limit) && 1 > $limit) {
25+
public function __construct(
26+
private ?string $before = null,
27+
private ?string $after = null,
28+
private ?int $limit = null
29+
) {
30+
if (is_int($this->limit) && 1 > $this->limit) {
5231
throw new InvalidArgumentException('Expecting a limit that is 1 or greater.');
5332
}
54-
55-
$this->before = $before ?: null;
56-
$this->after = $after ?: null;
57-
$this->limit = $limit;
5833
}
5934

6035
/**
@@ -97,10 +72,12 @@ public function getAfter(): ?string
9772
*/
9873
public function withDefaultLimit(int $limit): self
9974
{
100-
if (is_null($this->limit)) {
101-
$copy = clone $this;
102-
$copy->limit = $limit;
103-
return $copy;
75+
if ($this->limit === null) {
76+
return new self(
77+
before: $this->before,
78+
after: $this->after,
79+
limit: $limit,
80+
);
10481
}
10582

10683
return $this;

‎src/Pagination/Cursor/CursorBuilder.php

+61-56
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,66 @@
11
<?php
2+
/*
3+
* Copyright 2024 Cloud Creativity Limited
4+
*
5+
* Use of this source code is governed by an MIT-style
6+
* license that can be found in the LICENSE file or at
7+
* https://opensource.org/licenses/MIT.
8+
*/
29

310
declare(strict_types=1);
411

512
namespace LaravelJsonApi\Eloquent\Pagination\Cursor;
613

714
use Illuminate\Database\Eloquent\Builder;
815
use Illuminate\Database\Eloquent\Relations\Relation;
9-
use Illuminate\Pagination\Cursor as LaravelCursor;
1016
use LaravelJsonApi\Contracts\Schema\ID;
1117
use LaravelJsonApi\Core\Schema\IdParser;
1218

13-
class CursorBuilder
19+
final class CursorBuilder
1420
{
15-
private Builder|Relation $query;
16-
17-
private ID $id;
18-
19-
private string $keyName;
21+
/**
22+
* @var string
23+
*/
24+
private readonly string $keyName;
2025

26+
/**
27+
* @var string
28+
*/
2129
private string $direction;
2230

31+
/**
32+
* @var int|null
33+
*/
2334
private ?int $defaultPerPage = null;
2435

36+
/**
37+
* @var bool
38+
*/
2539
private bool $withTotal;
2640

41+
/**
42+
* @var bool
43+
*/
2744
private bool $keySort = true;
2845

29-
private CursorParser $parser;
46+
/**
47+
* @var CursorParser
48+
*/
49+
private readonly CursorParser $parser;
3050

3151
/**
3252
* CursorBuilder constructor.
3353
*
34-
* @param Builder|Relation $query
35-
* the column to use for the cursor
36-
* @param string|null $key
37-
* the key column that the before/after cursors related to
54+
* @param Builder|Relation $query the column to use for the cursor
55+
* @param ID $id
56+
* @param string|null $key the key column that the before/after cursors related to
3857
*/
39-
public function __construct($query, ID $id, string $key = null)
40-
{
41-
if (!$query instanceof Builder && !$query instanceof Relation) {
42-
throw new \InvalidArgumentException('Expecting an Eloquent query builder or relation.');
43-
}
44-
45-
$this->query = $query;
46-
$this->id = $id;
47-
$this->keyName = $key ?: $this->guessKey();
58+
public function __construct(
59+
private readonly Builder|Relation $query,
60+
private readonly ID $id,
61+
?string $key = null
62+
) {
63+
$this->keyName = $key ?: $this->id->key();
4864
$this->parser = new CursorParser(IdParser::make($this->id), $this->keyName);
4965
}
5066

@@ -62,8 +78,11 @@ public function withDefaultPerPage(?int $perPage): self
6278
return $this;
6379
}
6480

65-
66-
public function withKeySort(bool $keySort): self
81+
/**
82+
* @param bool $keySort
83+
* @return $this
84+
*/
85+
public function withKeySort(bool $keySort = true): self
6786
{
6887
$this->keySort = $keySort;
6988

@@ -86,6 +105,10 @@ public function withDirection(string $direction): self
86105
throw new \InvalidArgumentException('Unexpected query direction.');
87106
}
88107

108+
/**
109+
* @param bool $withTotal
110+
* @return $this
111+
*/
89112
public function withTotal(bool $withTotal): self
90113
{
91114
$this->withTotal = $withTotal;
@@ -103,12 +126,20 @@ public function paginate(Cursor $cursor, array $columns = ['*']): CursorPaginato
103126
$this->applyKeySort();
104127

105128
$total = $this->getTotal();
106-
$laravelPaginator = $this->query->cursorPaginate($cursor->getLimit(), $columns, 'cursor', $this->parser->decode($cursor));
129+
$laravelPaginator = $this->query->cursorPaginate(
130+
$cursor->getLimit(),
131+
$columns,
132+
'cursor',
133+
$this->parser->decode($cursor),
134+
);
107135
$paginator = new CursorPaginator($this->parser, $laravelPaginator, $cursor, $total);
108136

109137
return $paginator->withCurrentPath();
110138
}
111139

140+
/**
141+
* @return void
142+
*/
112143
private function applyKeySort(): void
113144
{
114145
if (!$this->keySort) {
@@ -125,35 +156,17 @@ private function applyKeySort(): void
125156
}
126157
}
127158

159+
/**
160+
* @return int|null
161+
*/
128162
private function getTotal(): ?int
129163
{
130164
return $this->withTotal ? $this->query->count() : null;
131165
}
132166

133-
private function convertCursor(Cursor $cursor): ?LaravelCursor
134-
{
135-
$encodedCursor = $cursor->isBefore() ? $cursor->getBefore() : $cursor->getAfter();
136-
if (!is_string($encodedCursor)) {
137-
return null;
138-
}
139-
140-
$parameters = json_decode(base64_decode(str_replace(['-', '_'], ['+', '/'], $encodedCursor)), true);
141-
142-
if (json_last_error() !== JSON_ERROR_NONE) {
143-
return null;
144-
}
145-
146-
$pointsToNextItems = $parameters['_pointsToNextItems'];
147-
unset($parameters['_pointsToNextItems']);
148-
if (isset($parameters[$this->keyName])) {
149-
$parameters[$this->keyName] = IdParser::make($this->id)->decode(
150-
(string) $parameters[$this->keyName],
151-
);
152-
}
153-
154-
return new LaravelCursor($parameters, $pointsToNextItems);
155-
}
156-
167+
/**
168+
* @return int
169+
*/
157170
private function getDefaultPerPage(): int
158171
{
159172
if (is_int($this->defaultPerPage)) {
@@ -162,12 +175,4 @@ private function getDefaultPerPage(): int
162175

163176
return $this->query->getModel()->getPerPage();
164177
}
165-
166-
/**
167-
* Guess the key to use for the cursor.
168-
*/
169-
private function guessKey(): string
170-
{
171-
return $this->id?->key() ?? $this->query->getModel()->getKeyName();
172-
}
173178
}

‎src/Pagination/Cursor/CursorPage.php

+42-20
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,51 @@
11
<?php
22
/*
3-
* Copyright 2023 Cloud Creativity Limited
3+
* Copyright 2024 Cloud Creativity Limited
44
*
5-
* Licensed under the Apache License, Version 2.0 (the "License");
6-
* you may not use this file except in compliance with the License.
7-
* You may obtain a copy of the License at
8-
*
9-
* http://www.apache.org/licenses/LICENSE-2.0
10-
*
11-
* Unless required by applicable law or agreed to in writing, software
12-
* distributed under the License is distributed on an "AS IS" BASIS,
13-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14-
* See the License for the specific language governing permissions and
15-
* limitations under the License.
5+
* Use of this source code is governed by an MIT-style
6+
* license that can be found in the LICENSE file or at
7+
* https://opensource.org/licenses/MIT.
168
*/
179

1810
declare(strict_types=1);
1911

2012
namespace LaravelJsonApi\Eloquent\Pagination\Cursor;
2113

14+
use InvalidArgumentException;
2215
use LaravelJsonApi\Core\Document\Link;
2316
use LaravelJsonApi\Core\Pagination\AbstractPage;
2417

2518
class CursorPage extends AbstractPage
2619
{
27-
private CursorPaginator $paginator;
28-
20+
/**
21+
* @var string
22+
*/
2923
private string $before;
3024

25+
/**
26+
* @var string
27+
*/
3128
private string $after;
3229

30+
/**
31+
* @var string
32+
*/
3333
private string $limit;
3434

3535
/**
3636
* CursorPage constructor.
37+
*
38+
* @param CursorPaginator $paginator
3739
*/
38-
public function __construct(CursorPaginator $paginator)
40+
public function __construct(private readonly CursorPaginator $paginator)
3941
{
40-
$this->paginator = $paginator;
4142
}
4243

4344
/**
4445
* Fluent constructor.
46+
*
47+
* @param CursorPaginator $paginator
48+
* @return self
4549
*/
4650
public static function make(CursorPaginator $paginator): self
4751
{
@@ -56,7 +60,7 @@ public static function make(CursorPaginator $paginator): self
5660
public function withAfterParam(string $key): self
5761
{
5862
if (empty($key)) {
59-
throw new \InvalidArgumentException('Expecting a non-empty string.');
63+
throw new InvalidArgumentException('Expecting a non-empty string.');
6064
}
6165

6266
$this->after = $key;
@@ -72,7 +76,7 @@ public function withAfterParam(string $key): self
7276
public function withBeforeParam(string $key): self
7377
{
7478
if (empty($key)) {
75-
throw new \InvalidArgumentException('Expecting a non-empty string.');
79+
throw new InvalidArgumentException('Expecting a non-empty string.');
7680
}
7781

7882
$this->before = $key;
@@ -88,21 +92,27 @@ public function withBeforeParam(string $key): self
8892
public function withLimitParam(string $key): self
8993
{
9094
if (empty($key)) {
91-
throw new \InvalidArgumentException('Expecting a non-empty string.');
95+
throw new InvalidArgumentException('Expecting a non-empty string.');
9296
}
9397

9498
$this->limit = $key;
9599

96100
return $this;
97101
}
98102

103+
/**
104+
* @return Link|null
105+
*/
99106
public function first(): ?Link
100107
{
101108
return new Link('first', $this->url([
102109
$this->limit => $this->paginator->getPerPage(),
103110
]));
104111
}
105112

113+
/**
114+
* @return Link|null
115+
*/
106116
public function prev(): ?Link
107117
{
108118
if ($this->paginator->isNotEmpty() && $this->paginator->hasPrev()) {
@@ -115,6 +125,9 @@ public function prev(): ?Link
115125
return null;
116126
}
117127

128+
/**
129+
* @return Link|null
130+
*/
118131
public function next(): ?Link
119132
{
120133
if ($this->paginator->isNotEmpty() && $this->paginator->hasNext()) {
@@ -127,6 +140,9 @@ public function next(): ?Link
127140
return null;
128141
}
129142

143+
/**
144+
* @return Link|null
145+
*/
130146
public function last(): ?Link
131147
{
132148
return null;
@@ -140,18 +156,24 @@ public function url(array $page): string
140156
return $this->paginator->path() . '?' . $this->stringifyQuery($page);
141157
}
142158

159+
/**
160+
* @return \Traversable
161+
*/
143162
public function getIterator(): \Traversable
144163
{
145164
yield from $this->paginator;
146165
}
147166

167+
/**
168+
* @return int
169+
*/
148170
public function count(): int
149171
{
150172
return $this->paginator->count();
151173
}
152174

153175
/**
154-
* @return array<string,mixed>
176+
* @return array<string, mixed>
155177
*/
156178
protected function metaForPage(): array
157179
{

‎src/Pagination/Cursor/CursorPaginator.php

+83-7
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,62 @@
11
<?php
2+
/*
3+
* Copyright 2024 Cloud Creativity Limited
4+
*
5+
* Use of this source code is governed by an MIT-style
6+
* license that can be found in the LICENSE file or at
7+
* https://opensource.org/licenses/MIT.
8+
*/
29

310
declare(strict_types=1);
411

512
namespace LaravelJsonApi\Eloquent\Pagination\Cursor;
613

14+
use Countable;
715
use Illuminate\Contracts\Pagination\CursorPaginator as LaravelCursorPaginator;
816
use Illuminate\Database\Eloquent\Collection;
917
use Illuminate\Pagination\Paginator;
18+
use IteratorAggregate;
1019

11-
class CursorPaginator implements \IteratorAggregate, \Countable
20+
final class CursorPaginator implements IteratorAggregate, Countable
1221
{
13-
private Collection $items;
22+
/**
23+
* @var Collection
24+
*/
25+
private readonly Collection $items;
1426

27+
/**
28+
* @var string|null
29+
*/
1530
private ?string $path;
1631

1732
/**
1833
* CursorPaginator constructor.
34+
*
35+
* @param CursorParser $parser
36+
* @param LaravelCursorPaginator $laravelPaginator
37+
* @param Cursor $cursor
38+
* @param int|null $total
1939
*/
20-
public function __construct(private readonly CursorParser $parser, private readonly LaravelCursorPaginator $laravelPaginator, private readonly Cursor $cursor, private readonly int|null $total = null)
21-
{
40+
public function __construct(
41+
private readonly CursorParser $parser,
42+
private readonly LaravelCursorPaginator $laravelPaginator,
43+
private readonly Cursor $cursor,
44+
private readonly ?int $total = null
45+
) {
2246
$this->items = Collection::make($this->laravelPaginator->items());
2347
}
2448

49+
/**
50+
* @return Collection
51+
*/
2552
public function getItems(): Collection
2653
{
27-
return $this->items;
54+
return clone $this->items;
2855
}
2956

57+
/**
58+
* @return string|null
59+
*/
3060
public function firstItem(): ?string
3161
{
3262

@@ -37,6 +67,9 @@ public function firstItem(): ?string
3767
return $this->parser->encode($this->laravelPaginator->getCursorForItem($this->items->first(), false));
3868
}
3969

70+
/**
71+
* @return string|null
72+
*/
4073
public function lastItem(): ?string
4174
{
4275
if ($this->laravelPaginator->isEmpty()) {
@@ -46,73 +79,116 @@ public function lastItem(): ?string
4679
return $this->parser->encode($this->laravelPaginator->getCursorForItem($this->items->last()));
4780
}
4881

82+
/**
83+
* @return bool
84+
*/
4985
public function hasMorePages(): bool
5086
{
5187
return ($this->cursor->isBefore() && !$this->laravelPaginator->onFirstPage()) || $this->laravelPaginator->hasMorePages();
5288
}
5389

54-
public function hasNext()
90+
/**
91+
* @return bool
92+
*/
93+
public function hasNext(): bool
5594
{
5695
return ((!$this->cursor->isAfter() && !$this->cursor->isBefore()) || $this->cursor->isAfter()) && $this->hasMorePages();
5796
}
5897

59-
public function hasPrev()
98+
/**
99+
* @return bool
100+
*/
101+
public function hasPrev(): bool
60102
{
61103
return ($this->cursor->isBefore() && $this->hasMorePages()) || $this->cursor->isAfter();
62104
}
63105

106+
/**
107+
* @return bool
108+
*/
64109
public function hasNoMorePages(): bool
65110
{
66111
return !$this->hasMorePages();
67112
}
68113

114+
/**
115+
* @return int
116+
*/
69117
public function getPerPage(): int
70118
{
71119
return $this->laravelPaginator->perPage();
72120
}
73121

122+
/**
123+
* @return string|null
124+
*/
74125
public function getFrom(): ?string
75126
{
76127
return $this->firstItem();
77128
}
78129

130+
/**
131+
* @return string|null
132+
*/
79133
public function getTo(): ?string
80134
{
81135
return $this->lastItem();
82136
}
83137

138+
/**
139+
* @return int|null
140+
*/
84141
public function getTotal(): ?int
85142
{
86143
return $this->total;
87144
}
88145

146+
/**
147+
* @return \Traversable
148+
*/
89149
public function getIterator(): \Traversable
90150
{
91151
yield from $this->items;
92152
}
93153

154+
/**
155+
* @return int
156+
*/
94157
public function count(): int
95158
{
96159
return $this->items->count();
97160
}
98161

162+
/**
163+
* @return bool
164+
*/
99165
public function isEmpty(): bool
100166
{
101167
return $this->items->isEmpty();
102168
}
103169

170+
/**
171+
* @return bool
172+
*/
104173
public function isNotEmpty(): bool
105174
{
106175
return !$this->isEmpty();
107176
}
108177

178+
/**
179+
* @return $this
180+
*/
109181
public function withCurrentPath(): self
110182
{
111183
$this->path = Paginator::resolveCurrentPath();
112184

113185
return $this;
114186
}
115187

188+
/**
189+
* @param string $path
190+
* @return $this
191+
*/
116192
public function withPath(string $path): self
117193
{
118194
$this->path = $path;

‎src/Pagination/Cursor/CursorParser.php

+26-3
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,39 @@
11
<?php
2+
/*
3+
* Copyright 2024 Cloud Creativity Limited
4+
*
5+
* Use of this source code is governed by an MIT-style
6+
* license that can be found in the LICENSE file or at
7+
* https://opensource.org/licenses/MIT.
8+
*/
9+
10+
declare(strict_types=1);
211

312
namespace LaravelJsonApi\Eloquent\Pagination\Cursor;
413

514
use Illuminate\Pagination\Cursor as LaravelCursor;
615
use LaravelJsonApi\Core\Schema\IdParser;
716

8-
class CursorParser
17+
final readonly class CursorParser
918
{
19+
/**
20+
* CursorParser constructor.
21+
*
22+
* @param IdParser $idParser
23+
* @param string $keyName
24+
*/
1025
public function __construct(private IdParser $idParser, private string $keyName)
1126
{
12-
1327
}
1428

29+
/**
30+
* @param LaravelCursor $cursor
31+
* @return string
32+
*/
1533
public function encode(LaravelCursor $cursor): string
1634
{
17-
$key = $cursor->parameter($this->keyName);
35+
$key = $cursor->parameter($this->keyName);
36+
1837
if (!$key) {
1938
return $cursor->encode();
2039
}
@@ -28,6 +47,10 @@ public function encode(LaravelCursor $cursor): string
2847
return $newCursor->encode();
2948
}
3049

50+
/**
51+
* @param Cursor $cursor
52+
* @return LaravelCursor|null
53+
*/
3154
public function decode(Cursor $cursor): ?LaravelCursor
3255
{
3356
$encodedCursor = $cursor->isBefore() ? $cursor->getBefore() : $cursor->getAfter();

‎src/Pagination/CursorPagination.php

+67-6
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,84 @@
11
<?php
2+
/*
3+
* Copyright 2024 Cloud Creativity Limited
4+
*
5+
* Use of this source code is governed by an MIT-style
6+
* license that can be found in the LICENSE file or at
7+
* https://opensource.org/licenses/MIT.
8+
*/
29

310
declare(strict_types=1);
411

512
namespace LaravelJsonApi\Eloquent\Pagination;
613

7-
use LaravelJsonApi\Eloquent\Pagination\Cursor\CursorBuilder;
8-
use LaravelJsonApi\Eloquent\Pagination\Cursor\CursorPage;
914
use Illuminate\Database\Eloquent\Builder;
1015
use Illuminate\Database\Eloquent\Relations\Relation;
1116
use LaravelJsonApi\Contracts\Pagination\Page;
1217
use LaravelJsonApi\Contracts\Schema\ID;
1318
use LaravelJsonApi\Core\Pagination\Concerns\HasPageMeta;
14-
use LaravelJsonApi\Eloquent\Pagination\Cursor\Cursor;
1519
use LaravelJsonApi\Eloquent\Contracts\Paginator;
20+
use LaravelJsonApi\Eloquent\Pagination\Cursor\Cursor;
21+
use LaravelJsonApi\Eloquent\Pagination\Cursor\CursorBuilder;
22+
use LaravelJsonApi\Eloquent\Pagination\Cursor\CursorPage;
1623

17-
class CursorPagination implements Paginator
24+
final class CursorPagination implements Paginator
1825
{
1926
use HasPageMeta;
2027

28+
/**
29+
* @var string
30+
*/
2131
private string $before;
2232

33+
/**
34+
* @var string
35+
*/
2336
private string $after;
2437

38+
/**
39+
* @var string
40+
*/
2541
private string $limit;
2642

43+
/**
44+
* @var string
45+
*/
2746
private string $direction;
2847

48+
/**
49+
* @var string|null
50+
*/
2951
private ?string $primaryKey = null;
3052

31-
/** @var string|array<string>|null */
53+
/**
54+
* @var string|array<string>|null
55+
*/
3256
private string|array|null $columns = null;
3357

58+
/**
59+
* @var int|null
60+
*/
3461
private ?int $defaultPerPage = null;
3562

63+
/**
64+
* @var bool
65+
*/
3666
private bool $withTotal;
3767

68+
/**
69+
* @var bool
70+
*/
3871
private bool $withTotalOnFirstPage;
3972

73+
/**
74+
* @var bool
75+
*/
4076
private bool $keySort = true;
4177

4278
/**
4379
* CursorPagination constructor.
80+
*
81+
* @param ID $id
4482
*/
4583
public function __construct(private readonly ID $id)
4684
{
@@ -55,6 +93,9 @@ public function __construct(private readonly ID $id)
5593

5694
/**
5795
* Fluent constructor.
96+
*
97+
* @param ID $id
98+
* @return self
5899
*/
59100
public static function make(ID $id): self
60101
{
@@ -135,20 +176,32 @@ public function withDefaultPerPage(?int $perPage): self
135176
return $this;
136177
}
137178

179+
/**
180+
* @param bool $withTotal
181+
* @return $this
182+
*/
138183
public function withTotal(bool $withTotal = true): self
139184
{
140185
$this->withTotal = $withTotal;
141186

142187
return $this;
143188
}
144189

190+
/**
191+
* @param bool $withTotal
192+
* @return $this
193+
*/
145194
public function withTotalOnFirstPage(bool $withTotal = true): self
146195
{
147196
$this->withTotalOnFirstPage = $withTotal;
148197

149198
return $this;
150199
}
151200

201+
/**
202+
* @param string $column
203+
* @return $this
204+
*/
152205
public function withKeyName(string $column): self
153206
{
154207
$this->primaryKey = $column;
@@ -167,13 +220,20 @@ public function withColumns($columns): self
167220
return $this;
168221
}
169222

223+
/**
224+
* @param bool $keySort
225+
* @return $this
226+
*/
170227
public function withKeySort(bool $keySort = true): self
171228
{
172229
$this->keySort = $keySort;
173230

174231
return $this;
175232
}
176233

234+
/**
235+
* @return $this
236+
*/
177237
public function withoutKeySort(): self
178238
{
179239
return $this->withKeySort(false);
@@ -231,7 +291,8 @@ private function query(Builder|Relation $query): CursorBuilder
231291

232292
/**
233293
* Extract the cursor from the provided paging parameters.
234-
* @param array<string,mixed> $page
294+
*
295+
* @param array<string, mixed> $page
235296
*/
236297
private function cursor(array $page): Cursor
237298
{

‎tests/lib/Acceptance/Pagination/CursorPaginationTest.php

+228-178
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)
Please sign in to comment.