1. class
  2. Hypervel
  3. \
  4. Saloon
  5. \
  6. Pagination
  7. \
  8. LinkPaginator

LinkPaginator

abstract class LinkPaginator extends PagedPaginator

Properties

protected int $pageNumber

The page number applied to the next request.

 from  Paginator
protected int $currentPage

The zero-based iterator position.

 from  Paginator
protected int $startPage

The first page number requested after rewind.

 from  Paginator
protected int|null $maxPages

The optional maximum number of pages to request.

 from  Paginator
protected int|null $perPageLimit

The optional result limit per page.

 from  Paginator
protected null|Response<mixed> $currentResponse

The current response.

 from  Paginator
protected bool $currentPageLoaded

Whether the current page has been fetched and mapped.

 from  Paginator
protected TItem> $currentPageItems

The items mapped from the final current response.

 from  Paginator
protected int $totalResults

The total number of mapped results processed.

 from  Paginator
protected bool $detectInfiniteLoop

Whether repeated response bodies should stop iteration.

 from  Paginator
protected bool $pooling

Whether the paginator is currently preparing pooled pages.

 from  Paginator
protected array<int, string> $lastFiveBodyChecksums

The latest response body checksums.

 from  Paginator
protected string $pageName

The page-number query parameter.

 from  PagedPaginator
protected string $perPageName

The per-page limit query parameter.

 from  PagedPaginator
protected UriInterface|null $nextUri

The next page's resolved URI.
protected int|null $lastPage

The last independently addressable page for pooled requests.

Methods

__construct(Connector $connector, Request $request)

Create a paginator.

from  Paginator
Response
current()

Get the current response and resolve its pagination links.

void
next()

Move to the next page.

from  Paginator
int
key()

Get the current iterator key.

from  Paginator
bool
valid()

Determine if another page should be requested.

from  Paginator
void
rewind()

Reset all iterator state.

from  Paginator
void
onRewind()

Clear continuation state when iteration restarts.

iterable
items()

Iterate over every response item.

from  Paginator
LazyCollection
collect(bool $throughItems = true)

Create a lazy collection from page responses or response items.

from  Paginator
array
pool(int $concurrency = 5, callable|null $responseHandler = null, callable|null $exceptionHandler = null)

Send every page through a bounded coroutine pool.

from  Paginator
int
totalResults()

Get the total number of processed results.

from  Paginator
Paginator
maxPages(int|null $maxPages)

Set the maximum number of pages to request.

from  Paginator
Paginator
perPageLimit(int|null $perPageLimit)

Set the number of results requested per page.

from  Paginator
Request
request()

Get the cloned request used by this paginator.

from  Paginator
int
currentPage()

Get the current zero-based page position.

from  Paginator
Paginator
startPage(int $startPage)

Set the first page number requested after rewind.

from  Paginator
int
count()

Count the number of pages yielded by the iterator.

from  Paginator
array
pageItems(Response $response)

Resolve response items using the request override when present.

from  Paginator
iterable
remainingRequests(int $lastPage)

Yield independently addressable page requests after the first page.

from  Paginator
int
getTotalPages(Response $response)

Resolve the last independently addressable page.

Request
applyPagination(Request $request)

Apply numbered pagination or the provider's continuation URL.

bool
isLastPage(Response $response)

Determine whether the response has no continuation link.

array
getPageItems(Response $response, Request $request)

Get the items from one page.

from  Paginator
Request
applyNextLink(Request $request)

Apply the continuation URL and replace any explicit raw query.

int|null
pageFromUri(UriInterface $uri)

Read an optional page number without flattening repeated names.

UriInterface
resolveLink(string $target, UriInterface $currentUri)

Resolve a continuation target against the current request.

array
getLinks(Response $response, UriInterface $currentUri)

Get pagination links resolved through resolveLink against the current URI.

Details

in Paginator at line 100
__construct(Connector $connector, Request $request)

Create a paginator.

Parameters

Connector $connector
Request $request

at line 36
Response current()

Get the current response and resolve its pagination links.

Return Value

Response

in Paginator at line 162
void next()

Move to the next page.

Return Value

void

in Paginator at line 173
int key()

Get the current iterator key.

Return Value

int

in Paginator at line 181
bool valid()

Determine if another page should be requested.

Return Value

bool

in Paginator at line 193
void rewind()

Reset all iterator state.

Return Value

void

at line 112
protected void onRewind()

Clear continuation state when iteration restarts.

Return Value

void

in Paginator at line 217
iterable items()

Iterate over every response item.

Return Value

iterable

in Paginator at line 231
LazyCollection collect(bool $throughItems = true)

Create a lazy collection from page responses or response items.

Parameters

bool $throughItems

Return Value

LazyCollection

in Paginator at line 245
array pool(int $concurrency = 5, callable|null $responseHandler = null, callable|null $exceptionHandler = null)

Send every page through a bounded coroutine pool.

Parameters

int $concurrency
callable|null $responseHandler
callable|null $exceptionHandler

Return Value

array

in Paginator at line 322
int totalResults()

Get the total number of processed results.

Return Value

int

in Paginator at line 332
Paginator maxPages(int|null $maxPages)

Set the maximum number of pages to request.

Parameters

int|null $maxPages

Return Value

Paginator

in Paginator at line 344
Paginator perPageLimit(int|null $perPageLimit)

Set the number of results requested per page.

Parameters

int|null $perPageLimit

Return Value

Paginator

in Paginator at line 356
Request request()

Get the cloned request used by this paginator.

Return Value

Request

in Paginator at line 364
int currentPage()

Get the current zero-based page position.

Return Value

int

in Paginator at line 374
Paginator startPage(int $startPage)

Set the first page number requested after rewind.

Parameters

int $startPage

Return Value

Paginator

in Paginator at line 384
int count()

Count the number of pages yielded by the iterator.

Return Value

int

in Paginator at line 403
protected array pageItems(Response $response)

Resolve response items using the request override when present.

Parameters

Response $response

Return Value

array

in Paginator at line 420
protected iterable remainingRequests(int $lastPage)

Yield independently addressable page requests after the first page.

Parameters

int $lastPage

Return Value

iterable

at line 102
protected int getTotalPages(Response $response)

Resolve the last independently addressable page.

Parameters

Response $response

Return Value

int

at line 64
protected Request applyPagination(Request $request)

Apply numbered pagination or the provider's continuation URL.

Parameters

Request $request

Return Value

Request

at line 92
protected bool isLastPage(Response $response)

Determine whether the response has no continuation link.

Parameters

Response $response

Return Value

bool

in Paginator at line 462
abstract protected array getPageItems(Response $response, Request $request)

Get the items from one page.

Parameters

Response $response
Request $request

Return Value

array

Apply the continuation URL and replace any explicit raw query.

Parameters

Request $request

Return Value

Request

at line 121
protected int|null pageFromUri(UriInterface $uri)

Read an optional page number without flattening repeated names.

Parameters

UriInterface $uri

Return Value

int|null

Resolve a continuation target against the current request.

Parameters

string $target
UriInterface $currentUri

Return Value

UriInterface

Get pagination links resolved through resolveLink against the current URI.

Parameters

Response $response
UriInterface $currentUri

Return Value

array