PHP Trait Tobscure\JsonApi\LinksTrait

显示文件 Open project: tobscure/json-api

Protected Properties

Property	Type	Description
$links	array	The links array.

Public Methods

Method	Description
addLink ( string $key, string $value )	Add a link.
addPaginationLinks ( string $url, array $queryParams, integer $offset, integer $limit, integer \| null $total = null ) : void	Add pagination links (first, prev, next, and last).
getLinks ( ) : array	Get the links.
setLinks ( array $links )	Set the links.

Protected Methods

Method	Description
addPaginationLink ( string $name, string $url, array $queryParams, integer $offset, integer $limit ) : void	Add a pagination link.

Method Details

addLink() public method

Add a link.

public addLink ( string $key, string $value )
$key	string
$value	string

addPaginationLink() protected method

Add a pagination link.

protected addPaginationLink ( string $name, string $url, array $queryParams, integer $offset, integer $limit ) : void
$name	string	The name of the link.
$url	string	The base URL for pagination links.
$queryParams	array	The query params provided in the request.
$offset	integer	The offset to link to.
$limit	integer	The current limit.
return	void

addPaginationLinks() public method

Add pagination links (first, prev, next, and last).

public addPaginationLinks ( string $url, array $queryParams, integer $offset, integer $limit, integer \| null $total = null ) : void
$url	string	The base URL for pagination links.
$queryParams	array	The query params provided in the request.
$offset	integer	The current offset.
$limit	integer	The current limit.
$total	integer \| null	The total number of results, or null if unknown.
return	void

getLinks() public method

Get the links.

public getLinks ( ) : array
return	array

setLinks() public method

Set the links.

public setLinks ( array $links )
$links	array

Property Details

$links protected_oe property

The links array.

protected array $links
return	array