PHP Interface Sulu\Component\Rest\ListBuilder\ListBuilderInterface

Show file Open project: sulu/sulu Interface Usage Examples

Public Methods

Method Description
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

Method Details

addExpression() public method

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

addField() public method

Deprecation: use addSelectField instead
public addField ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface
return Sulu\Component\Rest\ListBuilder\ListBuilderInterface

addGroupBy() public method

Defines GROUP BY.
public addGroupBy ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface
return Sulu\Component\Rest\ListBuilder\ListBuilderInterface

addSearchField() public method

Adds a field descriptor, which will be used for search.
public addSearchField ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface
return Sulu\Component\Rest\ListBuilder\ListBuilderInterface

addSelectField() public method

Adds a field descriptor to the ListBuilder, which is then used to retrieve and return the list.
public addSelectField ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface
return Sulu\Component\Rest\ListBuilder\ListBuilderInterface

between() public method

Defines a between constraint.
public between ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, array $values )
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface
$values array

count() public method

The number of total elements for this list.
public count ( ) : integer
return integer

createAndExpression() public method

Creates an and expression with the given expressions.
public createAndExpression ( array $expressions ) : Sulu\Component\Rest\ListBuilder\Expression\ConjunctionExpressionInterface | null
$expressions array
return Sulu\Component\Rest\ListBuilder\Expression\ConjunctionExpressionInterface | null

createBetweenExpression() public method

Creates a between expression from the given values.
public createBetweenExpression ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, array $values ) : mixed
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface
$values array
return mixed

createInExpression() public method

Creates an in expression from the given values.
public createInExpression ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, array $values ) : mixed
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface
$values array
return mixed

createOrExpression() public method

Creates an or expressions with the given expressions.
public createOrExpression ( array $expressions ) : Sulu\Component\Rest\ListBuilder\Expression\ConjunctionExpressionInterface | null
$expressions array
return Sulu\Component\Rest\ListBuilder\Expression\ConjunctionExpressionInterface | null

createWhereExpression() public method

Creates an where expression from the given values.
public createWhereExpression ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, $value, string $comparator ) : mixed
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface
$value
$comparator string
return mixed

execute() public method

Returns the objects for the built query.
public execute ( ) : mixed
return mixed

getCurrentPage() public method

Returns the current page.
public getCurrentPage ( ) : integer
return integer

getFieldDescriptor() public method

Returns a field descriptor by name.
public getFieldDescriptor ( string $name ) : Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface | null
$name string
return Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface | null

getLimit() public method

Returns the limit of the builder.
public getLimit ( ) : integer
return integer

getSelectField() public method

Gets a field descriptor used by the ListBuilder to retrieve and return the list.
public getSelectField ( string $fieldName ) : Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface
$fieldName string
return Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface

hasField() public method

Deprecation: use hasSelectField instead
public hasField ( $name )

hasSelectField() public method

Checks if field by name has been already added.
public hasSelectField ( $name ) : boolean
$name
return boolean

in() public method

Defines an IN constraint.
public in ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, array $values )
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface
$values array

limit() public method

Defines how many items should be returned.
public limit ( integer $limit ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface
$limit integer
return Sulu\Component\Rest\ListBuilder\ListBuilderInterface

setCurrentPage() public method

Sets the current page for the builder.
public setCurrentPage ( integer $page ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface
$page integer
return Sulu\Component\Rest\ListBuilder\ListBuilderInterface

setFieldDescriptors() public method

Sets an array of field descriptors.
public setFieldDescriptors ( array $fieldDescriptors )
$fieldDescriptors array

setFields() public method

Deprecation: use setSelectFields instead
public setFields ( $fieldDescriptors )

setPermissionCheck() public method

Sets the permission check for the ListBuilder.
public setPermissionCheck ( Sulu\Component\Security\Authentication\UserInterface $user, integer $permission ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface
$user Sulu\Component\Security\Authentication\UserInterface The user for which the permission must be granted
$permission integer A value from the PermissionTypes
return Sulu\Component\Rest\ListBuilder\ListBuilderInterface

setSelectFields() public method

Sets all the field descriptors for the ListBuilder at once.
public setSelectFields ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface[] $fieldDescriptors ) : mixed
$fieldDescriptors Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface[]
return mixed

sort() public method

Adds a field by which the table is sorted.
public sort ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, string $order = self::SORTORDER_ASC ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface
$order string
return Sulu\Component\Rest\ListBuilder\ListBuilderInterface

where() public method

Defines a constraint for the rows to return.
public where ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, string $value, string $comparator = self::WHERE_COMPARATOR_EQUAL ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface The FieldDescriptor which is checked
$value string The value the FieldDescriptor should have
$comparator string The comparator use to compare the values
return Sulu\Component\Rest\ListBuilder\ListBuilderInterface

whereNot() public method

Deprecation: use where instead
public whereNot ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, mixed $value ) : Sulu\Component\Rest\ListBuilder\ListBuilderInterface
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface
$value mixed
return Sulu\Component\Rest\ListBuilder\ListBuilderInterface