Class Salient\Curler\Pager\ODataPager

`final`
`implements`	`CurlerPagerInterface`

Follows OData "nextLink" annotations in responses from the endpoint

Located at Toolkit/Curler/Pager/ODataPager.php

Methods


					
	public

__construct(?int $maxPageSize = null)


					
	public

getFirstRequest(RequestInterface $request, CurlerInterface $curler, ?array $query = null): 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.

Implements

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


					
	public

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

Convert data returned by the endpoint to a new page object

Parameters

`$previousEntities`	The number of entities returned from the endpoint via previous pages.
`$query`	The query applied to `$request` or returned by {@see CurlerPageRequestInterface::getQuery()}, if applicable.

Implements

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

Constants inherited from Salient\Contract\Http\HasHttpHeader
`HEADER_ACCEPT, HEADER_ACCEPT_ENCODING, HEADER_AUTHORIZATION, HEADER_CONNECTION, HEADER_CONTENT_DISPOSITION, HEADER_CONTENT_LENGTH, HEADER_CONTENT_TYPE, HEADER_DATE, HEADER_HOST, HEADER_LINK, HEADER_LOCATION, HEADER_ODATA_VERSION, HEADER_PREFER, HEADER_PROXY_AUTHORIZATION, HEADER_RETRY_AFTER, HEADER_SERVER, HEADER_TRANSFER_ENCODING, HEADER_USER_AGENT`

Namespaces

Classes

Traits

Class Salient\Curler\Pager\ODataPager

Parameters

Implements

Parameters

Implements