PHP Класс Tobscure\JsonApi\Parameters

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$input array

Открытые методы

Метод Описание
__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.

Защищенные методы

Метод Описание
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.

Описание методов

__construct() публичный Метод

public __construct ( array $input )
$input array

getFields() публичный Метод

Get the fields requested for inclusion.
public getFields ( ) : array
Результат array

getFilter() публичный Метод

Get a filter item.
public getFilter ( ) : mixed
Результат mixed

getInclude() публичный Метод

Get the includes.
public getInclude ( array $available = [] ) : array
$available array
Результат array

getInput() защищенный Метод

Get an input item.
protected getInput ( string $key, null $default = null ) : mixed
$key string
$default null
Результат mixed

getLimit() публичный Метод

Get the limit.
public getLimit ( integer | null $max = null ) : integer | null
$max integer | null
Результат integer | null

getOffset() публичный Метод

Get number of offset.
public getOffset ( integer | null $perPage = null ) : integer
$perPage integer | null
Результат integer

getOffsetFromNumber() защищенный Метод

Calculate the offset based on the page[number] parameter.
protected getOffsetFromNumber ( integer $perPage ) : integer
$perPage integer
Результат integer

getPage() защищенный Метод

Get the page.
protected getPage ( string $key ) : string
$key string
Результат string

getSort() публичный Метод

Get the sort.
public getSort ( array $available = [] ) : array
$available array
Результат array

Описание свойств

$input защищенное свойство

protected array $input
Результат array