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

상속: implements Sulu\Component\Rest\ListBuilder\ListBuilderInterface
파일 보기 프로젝트 열기: sulu/sulu

보호된 프로퍼티들

프로퍼티 타입 설명
$expressions Sulu\Component\Rest\ListBuilder\Expression\ExpressionInterface[]
$fieldDescriptors Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface[] All field descriptors for the current context.
$groupByFields array group by fields.
$limit integer The limit for this query.
$page integer The page the resulting query will be returning.
$permission string
$search string The value for which the searchfields will be searched.
$searchFields Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface[] The field descriptors for the field, which will be used for the search.
$selectFields Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface[] The field descriptors for the current list.
$sortFields Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface[] The field descriptor for the field to sort.
$sortOrders string[] Defines the sort order of the string.
$user Sulu\Component\Security\Authentication\UserInterface

공개 메소드들

메소드 설명
addExpression ( Sulu\Component\Rest\ListBuilder\Expression\ExpressionInterface $expression )
addField ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor )
addGroupBy ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor )
addSearchField ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor )
addSelectField ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor )
between ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, array $values )
getCurrentPage ( )
getFieldDescriptor ( $fieldName )
getLimit ( )
getSelectField ( $fieldName )
hasField ( $name )
hasSelectField ( $name )
in ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, array $values )
limit ( $limit )
search ( $search )
setCurrentPage ( $page )
setFieldDescriptors ( array $fieldDescriptors )
setFields ( $fieldDescriptors )
setPermissionCheck ( Sulu\Component\Security\Authentication\UserInterface $user, $permission )
setSelectFields ( $fieldDescriptors )
sort ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, $order = self::SORTORDER_ASC )
where ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, $value, $comparator = self::WHERE_COMPARATOR_EQUAL )
whereNot ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, $value )

보호된 메소드들

메소드 설명
addFieldDescriptor ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor ) Adds a field descriptor.
retrieveIndexOfFieldDescriptor ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, array $fieldDescriptors ) : boolean | integer | string Returns index of given FieldDescriptor in given array of descriptors.

메소드 상세

addExpression() 공개 메소드

public addExpression ( Sulu\Component\Rest\ListBuilder\Expression\ExpressionInterface $expression )
$expression Sulu\Component\Rest\ListBuilder\Expression\ExpressionInterface

addField() 공개 메소드

사용 중단: use addSelectField instead
public addField ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor )
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface

addFieldDescriptor() 보호된 메소드

Adds a field descriptor.
protected addFieldDescriptor ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor )
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface

addGroupBy() 공개 메소드

public addGroupBy ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor )
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface

addSearchField() 공개 메소드

public addSearchField ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor )
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface

addSelectField() 공개 메소드

public addSelectField ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor )
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface

between() 공개 메소드

public between ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, array $values )
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface
$values array

getCurrentPage() 공개 메소드

public getCurrentPage ( )

getFieldDescriptor() 공개 메소드

public getFieldDescriptor ( $fieldName )

getLimit() 공개 메소드

public getLimit ( )

getSelectField() 공개 메소드

public getSelectField ( $fieldName )

hasField() 공개 메소드

사용 중단: use hasSelectField instead
public hasField ( $name )

hasSelectField() 공개 메소드

public hasSelectField ( $name )

in() 공개 메소드

public in ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, array $values )
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface
$values array

limit() 공개 메소드

public limit ( $limit )

retrieveIndexOfFieldDescriptor() 보호된 메소드

If no match is found, false will be returned.
protected retrieveIndexOfFieldDescriptor ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, array $fieldDescriptors ) : boolean | integer | string
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface
$fieldDescriptors array
리턴 boolean | integer | string

setCurrentPage() 공개 메소드

public setCurrentPage ( $page )

setFieldDescriptors() 공개 메소드

public setFieldDescriptors ( array $fieldDescriptors )
$fieldDescriptors array

setFields() 공개 메소드

사용 중단: use setSelectFields instead
public setFields ( $fieldDescriptors )

setPermissionCheck() 공개 메소드

public setPermissionCheck ( Sulu\Component\Security\Authentication\UserInterface $user, $permission )
$user Sulu\Component\Security\Authentication\UserInterface

setSelectFields() 공개 메소드

public setSelectFields ( $fieldDescriptors )

sort() 공개 메소드

public sort ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, $order = self::SORTORDER_ASC )
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface

where() 공개 메소드

public where ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, $value, $comparator = self::WHERE_COMPARATOR_EQUAL )
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface

whereNot() 공개 메소드

사용 중단: use where instead {@inheritdoc}
public whereNot ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, $value )
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface

프로퍼티 상세

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

protected ExpressionInterface[],Sulu\Component\Rest\ListBuilder\Expression $expressions
리턴 Sulu\Component\Rest\ListBuilder\Expression\ExpressionInterface[]

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

All field descriptors for the current context.
protected FieldDescriptorInterface[],Sulu\Component\Rest\ListBuilder $fieldDescriptors
리턴 Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface[]

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

group by fields.
protected array $groupByFields
리턴 array

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

The limit for this query.
protected int $limit
리턴 integer

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

The page the resulting query will be returning.
protected int $page
리턴 integer

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

protected string $permission
리턴 string

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

The field descriptors for the field, which will be used for the search.
protected FieldDescriptorInterface[],Sulu\Component\Rest\ListBuilder $searchFields
리턴 Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface[]

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

The field descriptors for the current list.
protected FieldDescriptorInterface[],Sulu\Component\Rest\ListBuilder $selectFields
리턴 Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface[]

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

The field descriptor for the field to sort.
protected FieldDescriptorInterface[],Sulu\Component\Rest\ListBuilder $sortFields
리턴 Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface[]

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

Defines the sort order of the string.
protected string[] $sortOrders
리턴 string[]

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

protected UserInterface,Sulu\Component\Security\Authentication $user
리턴 Sulu\Component\Security\Authentication\UserInterface