ListOptions
in package
Pagination and metadata mechanism that can be used throughout all list functions.
Tags
Table of Contents
Properties
- $currentCursor : string
- $nextCursor : string
- $perPage : int
- $prevCursor : string
- $total : int
Methods
- __construct() : mixed
- getCurrentCursor() : string
- getNextCursor() : string
- getPerPage() : int
- getPrevCursor() : string
- getTotal() : int
- setCurrentCursor() : void
- setNextCursor() : void
- setPerPage() : void
- setPrevCursor() : void
- setTotal() : void
Properties
$currentCursor
protected
string
$currentCursor
= ''
$nextCursor
protected
string
$nextCursor
= ''
$perPage
protected
int
$perPage
= 50
$prevCursor
protected
string
$prevCursor
= ''
$total
protected
int
$total
= 0
Methods
__construct()
public
__construct([int $perPage = 50 ]) : mixed
Parameters
- $perPage : int = 50
getCurrentCursor()
public
getCurrentCursor() : string
Return values
stringgetNextCursor()
public
getNextCursor() : string
Return values
stringgetPerPage()
public
getPerPage() : int
Return values
intgetPrevCursor()
public
getPrevCursor() : string
Return values
stringgetTotal()
public
getTotal() : int
Return values
intsetCurrentCursor()
public
setCurrentCursor(string $current_cursor) : void
Parameters
- $current_cursor : string
setNextCursor()
public
setNextCursor(string $next_cursor) : void
Parameters
- $next_cursor : string
setPerPage()
public
setPerPage(int $per_page) : void
Parameters
- $per_page : int
setPrevCursor()
public
setPrevCursor(string $prev_cursor) : void
Parameters
- $prev_cursor : string
setTotal()
public
setTotal(int $total) : void
Parameters
- $total : int