|
| 1 | +<?php |
| 2 | + |
| 3 | +declare(strict_types=1); |
| 4 | + |
| 5 | +namespace LaravelJsonApi\Eloquent\Pagination\Cursor; |
| 6 | + |
| 7 | +use Illuminate\Database\Eloquent\Builder; |
| 8 | +use Illuminate\Database\Eloquent\Relations\Relation; |
| 9 | +use Illuminate\Pagination\Cursor as LaravelCursor; |
| 10 | +use LaravelJsonApi\Contracts\Schema\ID; |
| 11 | +use LaravelJsonApi\Core\Schema\IdParser; |
| 12 | + |
| 13 | +class CursorBuilder |
| 14 | +{ |
| 15 | + private Builder|Relation $query; |
| 16 | + |
| 17 | + private ID $id; |
| 18 | + |
| 19 | + private string $keyName; |
| 20 | + |
| 21 | + private string $direction; |
| 22 | + |
| 23 | + private ?int $defaultPerPage = null; |
| 24 | + |
| 25 | + private bool $withTotal; |
| 26 | + |
| 27 | + private bool $keySort = true; |
| 28 | + |
| 29 | + private CursorParser $parser; |
| 30 | + |
| 31 | + /** |
| 32 | + * CursorBuilder constructor. |
| 33 | + * |
| 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 |
| 38 | + */ |
| 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(); |
| 48 | + $this->parser = new CursorParser(IdParser::make($this->id), $this->keyName); |
| 49 | + } |
| 50 | + |
| 51 | + /** |
| 52 | + * Set the default number of items per-page. |
| 53 | + * |
| 54 | + * If null, the default from the `Model::getPage()` method will be used. |
| 55 | + * |
| 56 | + * @return $this |
| 57 | + */ |
| 58 | + public function withDefaultPerPage(?int $perPage): self |
| 59 | + { |
| 60 | + $this->defaultPerPage = $perPage; |
| 61 | + |
| 62 | + return $this; |
| 63 | + } |
| 64 | + |
| 65 | + |
| 66 | + public function withKeySort(bool $keySort): self |
| 67 | + { |
| 68 | + $this->keySort = $keySort; |
| 69 | + |
| 70 | + return $this; |
| 71 | + } |
| 72 | + |
| 73 | + /** |
| 74 | + * Set the query direction. |
| 75 | + * |
| 76 | + * @return $this |
| 77 | + */ |
| 78 | + public function withDirection(string $direction): self |
| 79 | + { |
| 80 | + if (\in_array($direction, ['asc', 'desc'])) { |
| 81 | + $this->direction = $direction; |
| 82 | + |
| 83 | + return $this; |
| 84 | + } |
| 85 | + |
| 86 | + throw new \InvalidArgumentException('Unexpected query direction.'); |
| 87 | + } |
| 88 | + |
| 89 | + public function withTotal(bool $withTotal): self |
| 90 | + { |
| 91 | + $this->withTotal = $withTotal; |
| 92 | + |
| 93 | + return $this; |
| 94 | + } |
| 95 | + |
| 96 | + /** |
| 97 | + * @param array<string> $columns |
| 98 | + */ |
| 99 | + public function paginate(Cursor $cursor, array $columns = ['*']): CursorPaginator |
| 100 | + { |
| 101 | + $cursor = $cursor->withDefaultLimit($this->getDefaultPerPage()); |
| 102 | + |
| 103 | + $this->applyKeySort(); |
| 104 | + |
| 105 | + $total = $this->getTotal(); |
| 106 | + $laravelPaginator = $this->query->cursorPaginate($cursor->getLimit(), $columns, 'cursor', $this->parser->decode($cursor)); |
| 107 | + $paginator = new CursorPaginator($this->parser, $laravelPaginator, $cursor, $total); |
| 108 | + |
| 109 | + return $paginator->withCurrentPath(); |
| 110 | + } |
| 111 | + |
| 112 | + private function applyKeySort(): void |
| 113 | + { |
| 114 | + if (!$this->keySort) { |
| 115 | + return; |
| 116 | + } |
| 117 | + |
| 118 | + if ( |
| 119 | + empty($this->query->getQuery()->orders) |
| 120 | + || collect($this->query->getQuery()->orders) |
| 121 | + ->whereIn('column', [$this->keyName, $this->query->qualifyColumn($this->keyName)]) |
| 122 | + ->isEmpty() |
| 123 | + ) { |
| 124 | + $this->query->orderBy($this->keyName, $this->direction); |
| 125 | + } |
| 126 | + } |
| 127 | + |
| 128 | + private function getTotal(): ?int |
| 129 | + { |
| 130 | + return $this->withTotal ? $this->query->count() : null; |
| 131 | + } |
| 132 | + |
| 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 | + |
| 157 | + private function getDefaultPerPage(): int |
| 158 | + { |
| 159 | + if (is_int($this->defaultPerPage)) { |
| 160 | + return $this->defaultPerPage; |
| 161 | + } |
| 162 | + |
| 163 | + return $this->query->getModel()->getPerPage(); |
| 164 | + } |
| 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 | + } |
| 173 | +} |
0 commit comments