Auth0-PHP

PaginatedRequest
in package

Class PaginatedRequest.

Table of Contents

$from  : string|null
$includeTotals  : bool|null
$page  : int|null
$perPage  : int|null
$take  : int|null
Number of results per page for checkpoint pagination.
__construct()  : mixed
PaginatedRequest constructor.
build()  : array<string|int, int|string>
Return an array representing the paginated request.
getFrom()  : string|null
Retrieve the `from` for the checkpoint-paginated request.
getIncludeTotals()  : bool|null
Retrieve the `include_totals` for the paginated request.
getPage()  : int|null
Retrieve the `page` for the paginated request.
getPerPage()  : int|null
Retrieve the `per_page` for the paginated request.
getTake()  : int|null
Retrieve the `take` for the checkpoint-paginated request.
setFrom()  : self
Set the `from` for the checkpoint-paginated request.
setIncludeTotals()  : self
Set the `include_totals` for the paginated request.
setPage()  : self
Set the `page` for the paginated request.
setPerPage()  : self
Set the `per_page` for the paginated request.
setTake()  : self
Set the `take` for the paginated request.

Properties

$take

Number of results per page for checkpoint pagination.

private int|null $take = null

Methods

__construct()

PaginatedRequest constructor.

public __construct([int|null $page = null ][, int|null $perPage = null ][, bool|null $includeTotals = null ][, string|null $from = null ]) : mixed
Parameters
$page : int|null = null

Page index of the results to return. First page is 0.

$perPage : int|null = null

Number of results per page. Paging is disabled if parameter not set.

$includeTotals : bool|null = null

return results inside an object that contains the total result count (true) or as a direct array of results (false, default)

$from : string|null = null
Return values
mixed —

build()

Return an array representing the paginated request.

public build() : array<string|int, int|string>
Return values
array<string|int, int|string> —

getFrom()

Retrieve the `from` for the checkpoint-paginated request.

public getFrom() : string|null
Return values
string|null —

getIncludeTotals()

Retrieve the `include_totals` for the paginated request.

public getIncludeTotals() : bool|null
Return values
bool|null —

getPage()

Retrieve the `page` for the paginated request.

public getPage() : int|null
Return values
int|null —

getPerPage()

Retrieve the `per_page` for the paginated request.

public getPerPage() : int|null
Return values
int|null —

getTake()

Retrieve the `take` for the checkpoint-paginated request.

public getTake() : int|null
Return values
int|null —

setFrom()

Set the `from` for the checkpoint-paginated request.

public setFrom(string $from) : self
Parameters
$from : string

value of from parameter for the checkpoint-paginated request

Return values
self —

setIncludeTotals()

Set the `include_totals` for the paginated request.

public setIncludeTotals(bool|null $includeTotals) : self
Parameters
$includeTotals : bool|null

value of include_totals parameter for the paginated request

Return values
self —

setPage()

Set the `page` for the paginated request.

public setPage(int $page) : self
Parameters
$page : int

value of page parameter for the paginated request

Return values
self —

setPerPage()

Set the `per_page` for the paginated request.

public setPerPage(int $perPage) : self
Parameters
$perPage : int

value of per_page parameter for the paginated request

Return values
self —

setTake()

Set the `take` for the paginated request.

public setTake(int $take) : self
Parameters
$take : int

value of take parameter for the checkpoint-paginated request

Return values
self —

Search results