Class Salient\Curler\Pager\LinkPager

`final`
`implements`	`CurlerPagerInterface`
`uses`	`HasEntitySelector`

Follows "Link" headers with rel="next" in responses from the endpoint

Located at Toolkit/Curler/Pager/LinkPager.php

Methods


					
	public

__construct(
	?int $pageSize = null,
	(Closure(mixed): list<mixed>)|array-key|null $entitySelector = null,
	string $pageSizeKey = 'per_page',
)

Parameters

$entitySelector

Entities are returned from:

$entitySelector($data) if $entitySelector is a closure
Arr::get($data, $entitySelector) if $entitySelector is a string or integer, or
$data if $entitySelector is null


					
	public

getFirstRequest(RequestInterface $request, CurlerInterface $curler, ?array $query = null)

Get a request to retrieve the first page of data from the endpoint

Return $request if no special handling is required.

Return a {@see CurlerPageRequestInterface} to propagate $query changes to {@see CurlerPagerInterface::getPage()} in array form.

Parameters

$query

The query applied to $request.

Implements

Salient\Contract\Curler\CurlerPagerInterface::getFirstRequest()


					
	public

getPage(
	$data,
	RequestInterface $request,
	HttpResponseInterface $response,
	CurlerInterface $curler,
	?CurlerPageInterface $previousPage = null,
	?array $query = null,
): CurlerPageInterface

Convert data returned by the endpoint to a new page object

Parameters

$query

The query applied to $request or returned by {@see CurlerPageRequestInterface::getQuery()}, if applicable.

Implements

Salient\Contract\Curler\CurlerPagerInterface::getPage()

Methods used from Salient\Curler\Pager\HasEntitySelector
`applyEntitySelector()`

Properties used from Salient\Curler\Pager\HasEntitySelector
`$EntitySelector`

Namespaces

Classes

Traits

Class Salient\Curler\Pager\LinkPager

Parameters

Parameters

Implements

Parameters

Implements