PHP Class Sulu\Component\Rest\ListBuilder\ListRestHelper

These values are calculated from the request paramaters.
Inheritance: implements Sulu\Component\Rest\ListBuilder\ListRestHelperInterface
Mostrar archivo Open project: sulu/sulu Class Usage Examples

Protected Properties

Property Type Description
$requestStack Symfony\Component\HttpFoundation\Request The current request object.

Public Methods

Method Description
__construct ( Symfony\Component\HttpFoundation\RequestStack $requestStack ) The constructor takes the request stack as an argument, which is injected by the service container.
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.

Protected Methods

Method Description
getRequest ( ) : Request Returns the current Request.

Method Details

__construct() public method

The constructor takes the request stack as an argument, which is injected by the service container.
public __construct ( Symfony\Component\HttpFoundation\RequestStack $requestStack )
$requestStack Symfony\Component\HttpFoundation\RequestStack

getFields() public method

If null is returned every field should be contained.
public getFields ( ) : array | null
return array | null

getLimit() public method

Returns the maximum number of elements in a single response.
public getLimit ( ) : integer
return integer

getOffset() public method

Returns the calculated value for the starting position based on the page and limit values.
public getOffset ( ) : integer | null
return integer | null

getPage() public method

returns the current page.
public getPage ( ) : mixed
return mixed

getRequest() protected method

Returns the current Request.
protected getRequest ( ) : Request
return Symfony\Component\HttpFoundation\Request

getSearchFields() public method

Returns an array with all the fields the search pattern should be executed on.
public getSearchFields ( ) : array | null
return array | null

getSearchPattern() public method

Returns the pattern of the search.
public getSearchPattern ( ) : mixed
return mixed

getSortColumn() public method

Returns the desired sort column.
public getSortColumn ( ) : string
return string

getSortOrder() public method

Returns desired sort order.
public getSortOrder ( ) : string
return string

Property Details

$requestStack protected_oe property

The current request object.
protected Request,Symfony\Component\HttpFoundation $requestStack
return Symfony\Component\HttpFoundation\Request