Interface Salient\Contract\Curler\CurlerPagerInterface

Salient\Contract\Curler\CurlerPagerInterface
- Salient\Curler\Pager\ODataPager implements CurlerPagerInterface
- Salient\Curler\Pager\QueryPager implements CurlerPagerInterface uses HasEntitySelector
- Salient\Curler\Pager\LinkPager implements CurlerPagerInterface uses HasEntitySelector

Located at Toolkit/Contract/Curler/CurlerPagerInterface.php

Methods


					
	public

getFirstRequest(
	RequestInterface $request,
	CurlerInterface $curler,
	mixed[]|null $query = null,
): CurlerPageRequestInterface|RequestInterface

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.

Implemented by


					
	public

getPage<TPage is CurlerPageInterface|null>(
	mixed $data,
	RequestInterface $request,
	HttpResponseInterface $response,
	CurlerInterface $curler,
	TPage $previousPage = null,
	mixed[]|null $query = null,
): (TPage is null ? CurlerPageInterface : TPage)

Convert data returned by the endpoint to a new page object

Parameters

$query

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

Namespaces

Interfaces

Interface Salient\Contract\Curler\CurlerPagerInterface

Parameters

Implemented by

Parameters

Implemented by