PHP Class Tobscure\JsonApi\Parameters

Afficher le fichier Open project: tobscure/json-api Class Usage Examples

Protected Properties

Свойство Type Description
$input array

Méthodes publiques

Méthode Description
__construct ( array $input )
getFields ( ) : array Get the fields requested for inclusion.
getFilter ( ) : mixed Get a filter item.
getInclude ( array $available = [] ) : array Get the includes.
getLimit ( integer | null $max = null ) : integer | null Get the limit.
getOffset ( integer | null $perPage = null ) : integer Get number of offset.
getSort ( array $available = [] ) : array Get the sort.

Méthodes protégées

Méthode Description
getInput ( string $key, null $default = null ) : mixed Get an input item.
getOffsetFromNumber ( integer $perPage ) : integer Calculate the offset based on the page[number] parameter.
getPage ( string $key ) : string Get the page.

Method Details

__construct() public méthode

public __construct ( array $input )
$input array

getFields() public méthode

Get the fields requested for inclusion.
public getFields ( ) : array
Résultat array

getFilter() public méthode

Get a filter item.
public getFilter ( ) : mixed
Résultat mixed

getInclude() public méthode

Get the includes.
public getInclude ( array $available = [] ) : array
$available array
Résultat array

getInput() protected méthode

Get an input item.
protected getInput ( string $key, null $default = null ) : mixed
$key string
$default null
Résultat mixed

getLimit() public méthode

Get the limit.
public getLimit ( integer | null $max = null ) : integer | null
$max integer | null
Résultat integer | null

getOffset() public méthode

Get number of offset.
public getOffset ( integer | null $perPage = null ) : integer
$perPage integer | null
Résultat integer

getOffsetFromNumber() protected méthode

Calculate the offset based on the page[number] parameter.
protected getOffsetFromNumber ( integer $perPage ) : integer
$perPage integer
Résultat integer

getPage() protected méthode

Get the page.
protected getPage ( string $key ) : string
$key string
Résultat string

getSort() public méthode

Get the sort.
public getSort ( array $available = [] ) : array
$available array
Résultat array

Property Details

$input protected_oe property

protected array $input
Résultat array