• 홈
• Sulu
• Component
• Rest
• ListBuilder
• ListBuilderInterface

PHP 인터페이스 Sulu\Component\Rest\ListBuilder\ListBuilderInterface

파일 보기 프로젝트 열기: sulu/sulu 0 사용 예제들

공개 메소드들

메소드	설명
addExpression ( Sulu\Component\Rest\ListBuilder\Expression\ExpressionInterface $expression )	Adds an expression.
addField ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface
addGroupBy ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface	Defines GROUP BY.
addSearchField ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface	Adds a field descriptor, which will be used for search.
addSelectField ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface	Adds a field descriptor to the ListBuilder, which is then used to retrieve and return the list.
between ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, array $values )	Defines a between constraint.
count ( ) : integer	The number of total elements for this list.
createAndExpression ( array $expressions ) : Sulu\Component\Rest\ListBuilder\Expression\ConjunctionExpressionInterface | null	Creates an and expression with the given expressions.
createBetweenExpression ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, array $values ) : mixed	Creates a between expression from the given values.
createInExpression ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, array $values ) : mixed	Creates an in expression from the given values.
createOrExpression ( array $expressions ) : Sulu\Component\Rest\ListBuilder\Expression\ConjunctionExpressionInterface | null	Creates an or expressions with the given expressions.
createWhereExpression ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, $value, string $comparator ) : mixed	Creates an where expression from the given values.
execute ( ) : mixed	Returns the objects for the built query.
getCurrentPage ( ) : integer	Returns the current page.
getFieldDescriptor ( string $name ) : Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface | null	Returns a field descriptor by name.
getLimit ( ) : integer	Returns the limit of the builder.
getSelectField ( string $fieldName ) : Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface	Gets a field descriptor used by the ListBuilder to retrieve and return the list.
hasField ( $name )
hasSelectField ( $name ) : boolean	Checks if field by name has been already added.
in ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, array $values )	Defines an IN constraint.
limit ( integer $limit ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface	Defines how many items should be returned.
search ( string $search ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface	Sets the search value for the search fields.
setCurrentPage ( integer $page ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface	Sets the current page for the builder.
setFieldDescriptors ( array $fieldDescriptors )	Sets an array of field descriptors.
setFields ( $fieldDescriptors )
setPermissionCheck ( Sulu\Component\Security\Authentication\UserInterface $user, integer $permission ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface	Sets the permission check for the ListBuilder.
setSelectFields ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface[] $fieldDescriptors ) : mixed	Sets all the field descriptors for the ListBuilder at once.
sort ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, string $order = self::SORTORDER_ASC ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface	Adds a field by which the table is sorted.
where ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, string $value, string $comparator = self::WHERE_COMPARATOR_EQUAL ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface	Defines a constraint for the rows to return.
whereNot ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, mixed $value ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface

메소드 상세