PHP Класс Sulu\Component\Rest\ListBuilder\Doctrine\DoctrineListBuilder

Наследование: extends Sulu\Component\Rest\ListBuilder\AbstractListBuilder
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$expressionFields array Array of unique field descriptors from expressions.
$expressions Sulu\Component\Rest\ListBuilder\Expression\Doctrine\AbstractDoctrineExpression[]
$queryBuilder Doctrine\ORM\QueryBuilder
$searchFields Sulu\Component\Rest\ListBuilder\Doctrine\FieldDescriptor\DoctrineFieldDescriptorInterface[]
$selectFields Sulu\Component\Rest\ListBuilder\Doctrine\FieldDescriptor\DoctrineFieldDescriptorInterface[]

Открытые методы

Метод Описание
__construct ( EntityManager $em, $entityName, Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher, array $permissions )
count ( )
createAndExpression ( array $expressions )
createBetweenExpression ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, array $values )
createInExpression ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, array $values )
createOrExpression ( array $expressions )
createWhereExpression ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, $value, $comparator )
distinct ( boolean $flag = true ) Eliminates duplicated rows.
execute ( )
setIdField ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $idField ) Set id-field of the "root" entity.

Защищенные методы

Метод Описание
assignGroupBy ( Doctrine\ORM\QueryBuilder $queryBuilder ) Sets group by fields to querybuilder.
assignJoins ( Doctrine\ORM\QueryBuilder $queryBuilder, array $joins = null ) Adds joins to querybuilder.
assignSortFields ( Doctrine\ORM\QueryBuilder $queryBuilder ) Assigns ORDER BY clauses to querybuilder.
createQueryBuilder ( array | null $joins = null ) : Doctrine\ORM\QueryBuilder Creates Querybuilder.
createSubQueryBuilder ( null | string $select = null ) : Doctrine\ORM\QueryBuilder Creates a query-builder for sub-selecting ID's.
findIdsByGivenCriteria ( ) : array Function that finds all IDs of entities that match the search criteria.
getAllFieldNames ( AbstractDoctrineExpression[] $expressions ) : array Returns all fieldnames used in the expressions.
getAllFields ( boolean $onlyReturnFilterFields = false ) : Sulu\Component\Rest\ListBuilder\Doctrine\FieldDescriptor\DoctrineFieldDescriptorInterface[] Returns all FieldDescriptors that were passed to list builder.
getEntityNamesOfFieldDescriptors ( array $filterFields ) : string[] Returns array of field-descriptor aliases.
getJoins ( ) : DoctrineJoinDescriptor[] Returns all the joins required for the query.
getNecessaryJoins ( string[] $necessaryEntityNames ) : Sulu\Component\Rest\ListBuilder\Doctrine\FieldDescriptor\DoctrineFieldDescriptorInterface[] Function returns all necessary joins for filtering result.
getUniqueExpressionFieldDescriptors ( array $expressions ) : array Returns an array of unique expression field descriptors.
hasSelectStatement ( Doctrine\ORM\QueryBuilder $queryBuilder, $statement )

Описание методов

__construct() публичный Метод

public __construct ( EntityManager $em, $entityName, Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher, array $permissions )
$em Doctrine\ORM\EntityManager
$eventDispatcher Symfony\Component\EventDispatcher\EventDispatcherInterface
$permissions array

assignGroupBy() защищенный Метод

Sets group by fields to querybuilder.
protected assignGroupBy ( Doctrine\ORM\QueryBuilder $queryBuilder )
$queryBuilder Doctrine\ORM\QueryBuilder

assignJoins() защищенный Метод

Adds joins to querybuilder.
protected assignJoins ( Doctrine\ORM\QueryBuilder $queryBuilder, array $joins = null )
$queryBuilder Doctrine\ORM\QueryBuilder
$joins array

assignSortFields() защищенный Метод

Assigns ORDER BY clauses to querybuilder.
protected assignSortFields ( Doctrine\ORM\QueryBuilder $queryBuilder )
$queryBuilder Doctrine\ORM\QueryBuilder

count() публичный Метод

public count ( )

createAndExpression() публичный Метод

public createAndExpression ( array $expressions )
$expressions array

createBetweenExpression() публичный Метод

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

createInExpression() публичный Метод

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

createOrExpression() публичный Метод

public createOrExpression ( array $expressions )
$expressions array

createQueryBuilder() защищенный Метод

Creates Querybuilder.
protected createQueryBuilder ( array | null $joins = null ) : Doctrine\ORM\QueryBuilder
$joins array | null Define which joins should be made
Результат Doctrine\ORM\QueryBuilder

createSubQueryBuilder() защищенный Метод

Creates a query-builder for sub-selecting ID's.
protected createSubQueryBuilder ( null | string $select = null ) : Doctrine\ORM\QueryBuilder
$select null | string
Результат Doctrine\ORM\QueryBuilder

createWhereExpression() публичный Метод

public createWhereExpression ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $fieldDescriptor, $value, $comparator )
$fieldDescriptor Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface

distinct() публичный Метод

Eliminates duplicated rows.
public distinct ( boolean $flag = true )
$flag boolean

execute() публичный Метод

public execute ( )

findIdsByGivenCriteria() защищенный Метод

Function that finds all IDs of entities that match the search criteria.
protected findIdsByGivenCriteria ( ) : array
Результат array

getAllFieldNames() защищенный Метод

Returns all fieldnames used in the expressions.
protected getAllFieldNames ( AbstractDoctrineExpression[] $expressions ) : array
$expressions Sulu\Component\Rest\ListBuilder\Expression\Doctrine\AbstractDoctrineExpression[]
Результат array

getAllFields() защищенный Метод

Returns all FieldDescriptors that were passed to list builder.
protected getAllFields ( boolean $onlyReturnFilterFields = false ) : Sulu\Component\Rest\ListBuilder\Doctrine\FieldDescriptor\DoctrineFieldDescriptorInterface[]
$onlyReturnFilterFields boolean Define if only filtering FieldDescriptors should be returned
Результат Sulu\Component\Rest\ListBuilder\Doctrine\FieldDescriptor\DoctrineFieldDescriptorInterface[]

getEntityNamesOfFieldDescriptors() защищенный Метод

Returns array of field-descriptor aliases.
protected getEntityNamesOfFieldDescriptors ( array $filterFields ) : string[]
$filterFields array
Результат string[]

getJoins() защищенный Метод

Returns all the joins required for the query.
protected getJoins ( ) : DoctrineJoinDescriptor[]
Результат Sulu\Component\Rest\ListBuilder\Doctrine\FieldDescriptor\DoctrineJoinDescriptor[]

getNecessaryJoins() защищенный Метод

Function returns all necessary joins for filtering result.
protected getNecessaryJoins ( string[] $necessaryEntityNames ) : Sulu\Component\Rest\ListBuilder\Doctrine\FieldDescriptor\DoctrineFieldDescriptorInterface[]
$necessaryEntityNames string[]
Результат Sulu\Component\Rest\ListBuilder\Doctrine\FieldDescriptor\DoctrineFieldDescriptorInterface[]

getUniqueExpressionFieldDescriptors() защищенный Метод

Returns an array of unique expression field descriptors.
protected getUniqueExpressionFieldDescriptors ( array $expressions ) : array
$expressions array
Результат array

hasSelectStatement() защищенный Метод

protected hasSelectStatement ( Doctrine\ORM\QueryBuilder $queryBuilder, $statement )
$queryBuilder Doctrine\ORM\QueryBuilder

setIdField() публичный Метод

Set id-field of the "root" entity.
public setIdField ( Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface $idField )
$idField Sulu\Component\Rest\ListBuilder\FieldDescriptorInterface

Описание свойств

$expressionFields защищенное свойство

Array of unique field descriptors from expressions.
protected array $expressionFields
Результат array

$expressions защищенное свойство

protected AbstractDoctrineExpression[],Sulu\Component\Rest\ListBuilder\Expression\Doctrine $expressions
Результат Sulu\Component\Rest\ListBuilder\Expression\Doctrine\AbstractDoctrineExpression[]

$queryBuilder защищенное свойство

protected QueryBuilder,Doctrine\ORM $queryBuilder
Результат Doctrine\ORM\QueryBuilder

$searchFields защищенное свойство

protected DoctrineFieldDescriptorInterface[],Sulu\Component\Rest\ListBuilder\Doctrine\FieldDescriptor $searchFields
Результат Sulu\Component\Rest\ListBuilder\Doctrine\FieldDescriptor\DoctrineFieldDescriptorInterface[]

$selectFields защищенное свойство

protected DoctrineFieldDescriptorInterface[],Sulu\Component\Rest\ListBuilder\Doctrine\FieldDescriptor $selectFields
Результат Sulu\Component\Rest\ListBuilder\Doctrine\FieldDescriptor\DoctrineFieldDescriptorInterface[]