ApiCollectionMetaData
in package
implements
ApiCollectionMetaData
Class ApiCollectionMetaData
Interfaces, Classes and Traits
- ApiCollectionMetaData
- Interface ApiCollectionMetaData
Table of Contents
- $links : array<string|int, string>
- $page : int
- $perPage : int
- $totalItems : int
- addPaginationLinks() : $this
- create() : ApiCollectionMetaData
- jsonSerialize() : mixed
- setLink() : ApiMetaData
- setPage() : $this
- setPerPage() : $this
- setTotalItems() : $this
- __construct() : mixed
- ApiCollectionMetaData constructor.
Properties
$links
private
array<string|int, string>
$links
$page
private
int
$page
$perPage
private
int
$perPage
$totalItems
private
int
$totalItems
Methods
addPaginationLinks()
public
addPaginationLinks(string $url, array<string|int, mixed> $queryParams) : $this
Parameters
- $url : string
- $queryParams : array<string|int, mixed>
Return values
$this —create()
public
static create(int $page, int $perPage, int $totalItems[, array<string|int, mixed> $links = [] ]) : ApiCollectionMetaData
Parameters
- $page : int
- $perPage : int
- $totalItems : int
- $links : array<string|int, mixed> = []
Return values
ApiCollectionMetaData —jsonSerialize()
public
jsonSerialize() : mixed
Tags
Return values
mixed —setLink()
public
setLink(string $name, string $link) : ApiMetaData
Parameters
- $name : string
- $link : string
Tags
Return values
ApiMetaData —setPage()
public
setPage(int $page) : $this
Parameters
- $page : int
Tags
Return values
$this —setPerPage()
public
setPerPage(int $perPage) : $this
Parameters
- $perPage : int
Tags
Return values
$this —setTotalItems()
public
setTotalItems(int $totalItems) : $this
Parameters
- $totalItems : int
Tags
Return values
$this —__construct()
ApiCollectionMetaData constructor.
private
__construct(int $page, int $perPage, int $totalItems, array<string|int, mixed> $links) : mixed
Parameters
- $page : int
- $perPage : int
- $totalItems : int
- $links : array<string|int, mixed>