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

OffsetPaginator

abstract class OffsetPaginator extends Paginator

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 $checksumIncludesContinuation

Whether page checksums include the provider's continuation, so a repeated checksum repeats an earlier request.

 from  Paginator
protected bool $pooling

Whether the paginator is currently preparing pooled pages.

 from  Paginator
protected array<int, string> $lastFiveBodyChecksums

The latest response checksums, including continuation where available.

 from  Paginator
protected string $limitName

The result-limit query parameter.
protected string $offsetName

The result-offset query parameter.

Methods

__construct(Connector $connector, Request $request)

Create a paginator.

from  Paginator
Response
current()

Get the response for the current page.

from  Paginator
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()

Process extra state when the paginator rewinds.

from  Paginator
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
string
getPageChecksum(Response $response)

Get the checksum used to detect repeated pages.

from  Paginator
string
getBodyChecksum(Response $response)

Get the checksum of the response body.

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)

Get the total number of independently addressable pages.

from  Paginator
Request
applyPagination(Request $request)

Apply offset pagination to the request.

bool
isLastPage(Response $response)

Determine if the response is the last page.

from  Paginator
array
getPageItems(Response $response, Request $request)

Get the items from one page.

from  Paginator
int
getOffset()

Get the current result offset.

Details

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

Create a paginator.

Parameters

Connector $connector
Request $request

in Paginator at line 126
Response current()

Get the response for the current page.

Return Value

Response

in Paginator at line 179
void next()

Move to the next page.

Return Value

void

in Paginator at line 190
int key()

Get the current iterator key.

Return Value

int

in Paginator at line 198
bool valid()

Determine if another page should be requested.

Return Value

bool

in Paginator at line 210
void rewind()

Reset all iterator state.

Return Value

void

in Paginator at line 225
protected void onRewind()

Process extra state when the paginator rewinds.

Return Value

void

in Paginator at line 234
iterable items()

Iterate over every response item.

Return Value

iterable

in Paginator at line 248
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 262
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 341
int totalResults()

Get the total number of processed results.

Return Value

int

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

Set the maximum number of pages to request.

Parameters

int|null $maxPages

Return Value

Paginator

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

Set the number of results requested per page.

Parameters

int|null $perPageLimit

Return Value

Paginator

in Paginator at line 375
Request request()

Get the cloned request used by this paginator.

Return Value

Request

in Paginator at line 383
int currentPage()

Get the current zero-based page position.

Return Value

int

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

Set the first page number requested after rewind.

Parameters

int $startPage

Return Value

Paginator

in Paginator at line 403
int count()

Count the number of pages yielded by the iterator.

Return Value

int

in Paginator at line 421
protected string getPageChecksum(Response $response)

Get the checksum used to detect repeated pages.

Parameters

Response $response

Return Value

string

in Paginator at line 431
protected string getBodyChecksum(Response $response)

Get the checksum of the response body.

Parameters

Response $response

Return Value

string

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

Resolve response items using the request override when present.

Parameters

Response $response

Return Value

array

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

Yield independently addressable page requests after the first page.

Parameters

int $lastPage

Return Value

iterable

in Paginator at line 474
protected int getTotalPages(Response $response)

Get the total number of independently addressable pages.

Parameters

Response $response

Return Value

int

at line 32
protected Request applyPagination(Request $request)

Apply offset pagination to the request.

Parameters

Request $request

Return Value

Request

in Paginator at line 492
abstract protected bool isLastPage(Response $response)

Determine if the response is the last page.

Parameters

Response $response

Return Value

bool

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

Get the items from one page.

Parameters

Response $response
Request $request

Return Value

array

at line 47
protected int getOffset()

Get the current result offset.

Return Value

int