[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/vendor/tobscure/json-api/src/ -> LinksTrait.php (summary)

The links array.

File Size: 135 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 5 functions

  getLinks()
  setLinks()
  addLink()
  addPaginationLinks()
  addPaginationLink()

Functions
Functions that are not part of a class:

getLinks()   X-Ref
Get the links.

return: array

setLinks(array $links)   X-Ref
Set the links.

param: array $links
return: $this

addLink($key, $value)   X-Ref
Add a link.

param: string $key
param: string $value
return: $this

addPaginationLinks($url, array $queryParams, $offset, $limit, $total = null)   X-Ref
Add pagination links (first, prev, next, and last).

param: string $url The base URL for pagination links.
param: array $queryParams The query params provided in the request.
param: int $offset The current offset.
param: int $limit The current limit.
param: int|null $total The total number of results, or null if unknown.
return: void

addPaginationLink($name, $url, array $queryParams, $offset, $limit)   X-Ref
Add a pagination link.

param: string $name The name of the link.
param: string $url The base URL for pagination links.
param: array $queryParams The query params provided in the request.
param: int $offset The offset to link to.
param: int $limit The current limit.
return: void



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer