Référence de la classe Parameters

Fonctions membres publiques
	__construct (array $input)
	getInclude (array $available=[])
	getOffset ($perPage=null)
	getLimit ($max=null)
	getSort (array $available=[])
	getFields ()
	getFilter ()

Fonctions membres protégées
	getOffsetFromNumber ($perPage)
	getInput ($key, $default=null)
	getPage ($key)

Attributs protégés
	$input

Documentation des constructeurs et destructeur

__construct()

__construct

(

array

$input

)

Paramètres

array

$input

Références Parameters\$input.

Documentation des fonctions membres

getFields()

getFields

(

)

Get the fields requested for inclusion.

Renvoie

array

Références $fields, et Parameters\getInput().

getFilter()

getFilter

(

)

Get a filter item.

Renvoie

mixed

Références Parameters\getInput().

getInclude()

getInclude

(

array

$available = []

)

Get the includes.

Paramètres

array

$available

Exceptions

Références Parameters\getInput(), et null.

getInput()

getInput (   $key,   $default = null  )

protected

Get an input item.

Paramètres

string	$key
null	$default

Renvoie

mixed

Références $default, et $key.

Référencé par Parameters\getFields(), Parameters\getFilter(), Parameters\getInclude(), Parameters\getPage(), et Parameters\getSort().

getLimit()

getLimit

(

$max = null

)

Get the limit.

Paramètres

int | null

$max

Renvoie

int|null

Références $limit, Parameters\getPage(), et null.

getOffset()

getOffset

(

$perPage = null

)

Get number of offset.

Paramètres

int | null

$perPage

Exceptions

Références Joomla\Database\Query\$offset, Parameters\getOffsetFromNumber(), Parameters\getPage(), et null.

getOffsetFromNumber()

getOffsetFromNumber (   $perPage )

protected

Calculate the offset based on the page[number] parameter.

Paramètres

int

$perPage

Exceptions

Références Parameters\getPage().

Référencé par Parameters\getOffset().

getPage()

getPage (   $key )

protected

Get the page.

Paramètres

string

$key

Renvoie

string

Références $key, et Parameters\getInput().

Référencé par Parameters\getLimit(), Parameters\getOffset(), et Parameters\getOffsetFromNumber().

getSort()

getSort

(

array

$available = []

)

Get the sort.

Paramètres

array

$available

Exceptions

Références $field, $fields, Parameters\$input, $sort, Parameters\getInput(), et null.

Documentation des champs

$input

$input

protected

Référencé par Parameters\__construct(), et Parameters\getSort().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• tobscure/json-api/src/Parameters.php