Référence de l'espace de nommage Tobscure\JsonApi

Espaces de nommage
	Exception

Structures de données
class	AbstractSerializer
class	Collection
class	Document
interface	ElementInterface
class	ErrorHandler
class	Parameters
class	Relationship
class	Resource
interface	SerializerInterface
class	Util

Fonctions
	getLinks ()
	setLinks (array $links)
	addLink ($key, $value)
	addPaginationLinks ($url, array $queryParams, $offset, $limit, $total=null)
	addPaginationLink ($name, $url, array $queryParams, $offset, $limit)
	getMeta ()
	setMeta (array $meta)
	addMeta ($key, $value)

Variables
trait	LinksTrait
trait	MetaTrait

Documentation des fonctions

addLink()

Tobscure\JsonApi\addLink	(		$key,
			$value
	)

Add a link.

Paramètres

string	$key
string	$value

Renvoie

$this

Références $key, $this, et $value.

Référencé par Tobscure\JsonApi\addPaginationLink(), ContentSerializer\category(), ContactSerializer\category(), NewsfeedSerializer\category(), ContentSerializer\createdBy(), NewsfeedSerializer\createdBy(), ContactSerializer\createdBy(), ContentSerializer\languageAssociations(), ContactSerializer\languageAssociations(), NewsfeedSerializer\languageAssociations(), ContentSerializer\modifiedBy(), NewsfeedSerializer\modifiedBy(), ContactSerializer\modifiedBy(), et ContactSerializer\userId().

addMeta()

Tobscure\JsonApi\addMeta	(		$key,
			$value
	)

Add meta data.

Paramètres

string	$key
string	$value

Renvoie

$this

Références $key, $this, et $value.

addPaginationLink()

Tobscure\JsonApi\addPaginationLink (   $name,   $url, array  $queryParams,   $offset,   $limit  )

protected

Add a pagination link.

Paramètres

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

Renvoie

void

Références $limit, $name, Joomla\Database\Query\$offset, $url, et Tobscure\JsonApi\addLink().

Référencé par Tobscure\JsonApi\addPaginationLinks().

addPaginationLinks()

Tobscure\JsonApi\addPaginationLinks	(		$url,
		array	$queryParams,
			$offset,
			$limit,
			$total = null
	)

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

Paramètres

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

Renvoie

void

Références $limit, Joomla\Database\Query\$offset, $total, $url, Tobscure\JsonApi\addPaginationLink(), et null.

getLinks()

Tobscure\JsonApi\getLinks

(

)

Get the links.

Renvoie

array

getMeta()

Tobscure\JsonApi\getMeta

(

)

Get the meta.

Renvoie

array

setLinks()

Tobscure\JsonApi\setLinks

(

array

$links

)

Set the links.

Paramètres

array

$links

Renvoie

$this

Références $this.

setMeta()

Tobscure\JsonApi\setMeta

(

array

$meta

)

Set the meta data array.

Paramètres

array

$meta

Renvoie

$this

Références $this.

Documentation des variables

LinksTrait

trait LinksTrait

Valeur initiale :

{
    
    protected $links

MetaTrait

trait MetaTrait

Valeur initiale :

{
    
    protected $meta