PHP Interface Sulu\Component\Rest\ListBuilder\ListRestHelperInterface

Public Methods

Method	Description
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.

If null is returned every field should be contained.

public getFields ( ) : array \| null
return	array \| null

Returns the maximum number of elements in a single response.

public getLimit ( ) : integer
return	integer

Returns the calculated value for the starting position based on the page and limit values.

public getOffset ( ) : integer \| null
return	integer \| null

returns the current page.

public getPage ( ) : mixed
return	mixed

Returns an array with all the fields the search pattern should be executed on.

public getSearchFields ( ) : array \| null
return	array \| null

Returns the pattern of the search.

public getSearchPattern ( ) : mixed
return	mixed

Returns the desired sort column.

public getSortColumn ( ) : string
return	string

Returns desired sort order.

public getSortOrder ( ) : string
return	string