PHP 클래스 Sulu\Component\Rest\ListBuilder\ListRestHelper

These values are calculated from the request paramaters.
상속: implements Sulu\Component\Rest\ListBuilder\ListRestHelperInterface
파일 보기 프로젝트 열기: sulu/sulu 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$requestStack Symfony\Component\HttpFoundation\Request The current request object.

공개 메소드들

메소드 설명
__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.

보호된 메소드들

메소드 설명
getRequest ( ) : Request Returns the current Request.

메소드 상세

__construct() 공개 메소드

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() 공개 메소드

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

getRequest() 보호된 메소드

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

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

프로퍼티 상세

$requestStack 보호되어 있는 프로퍼티

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