PHP Интерфейс Sulu\Component\Rest\ListBuilder\ListRestHelperInterface

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

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

Метод Описание
getFields ( ) : array | null Returns an array with all the fields, which should be contained in the response.
getLimit ( ) : integer Returns the maximum number of elements in a single response.
getOffset ( ) : integer | null Returns the calculated value for the starting position based on the page and limit values.
getPage ( ) : mixed returns the current page.
getSearchFields ( ) : array | null Returns an array with all the fields the search pattern should be executed on.
getSearchPattern ( ) : mixed Returns the pattern of the search.
getSortColumn ( ) : string Returns the desired sort column.
getSortOrder ( ) : string Returns desired sort order.

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

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

If null is returned every field should be contained.
public getFields ( ) : array | null
Результат array | null

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

Returns the maximum number of elements in a single response.
public getLimit ( ) : integer
Результат integer

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

Returns the calculated value for the starting position based on the page and limit values.
public getOffset ( ) : integer | null
Результат integer | null

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

returns the current page.
public getPage ( ) : mixed
Результат mixed

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

Returns an array with all the fields the search pattern should be executed on.
public getSearchFields ( ) : array | null
Результат array | null

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

Returns the pattern of the search.
public getSearchPattern ( ) : mixed
Результат mixed

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

Returns the desired sort column.
public getSortColumn ( ) : string
Результат string

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

Returns desired sort order.
public getSortOrder ( ) : string
Результат string