PHP Class Sulu\Component\Rest\ListBuilder\ListRestHelper

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

Protected Properties

Свойство Type Description
$requestStack Symfony\Component\HttpFoundation\Request The current request object.

Méthodes publiques

Méthode 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.

Méthodes protégées

Méthode Description
getRequest ( ) : Request Returns the current Request.

Method Details

__construct() public méthode

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 méthode

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

getLimit() public méthode

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

getOffset() public méthode

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

getPage() public méthode

returns the current page.
public getPage ( ) : mixed
Résultat mixed

getRequest() protected méthode

Returns the current Request.
protected getRequest ( ) : Request
Résultat Symfony\Component\HttpFoundation\Request

getSearchFields() public méthode

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

getSearchPattern() public méthode

Returns the pattern of the search.
public getSearchPattern ( ) : mixed
Résultat mixed

getSortColumn() public méthode

Returns the desired sort column.
public getSortColumn ( ) : string
Résultat string

getSortOrder() public méthode

Returns desired sort order.
public getSortOrder ( ) : string
Résultat string

Property Details

$requestStack protected_oe property

The current request object.
protected Request,Symfony\Component\HttpFoundation $requestStack
Résultat Symfony\Component\HttpFoundation\Request