Class Doctrine\ORM\Query\ResultSetMappingBuilder

`extends`	`ResultSetMapping`
`uses`	`SQLResultCasing`

A ResultSetMappingBuilder uses the EntityManager to automatically populate entity fields.

Doctrine\ORM\Query\ResultSetMapping
- Doctrine\ORM\Query\ResultSetMappingBuilder uses SQLResultCasing

Methods


					
	public

__construct(EntityManagerInterface $em, self::COLUMN_RENAMING_* $defaultRenameMode = self::COLUMN_RENAMING_NONE)


					
	public

addRootEntityFromClassMetadata(
	class-string $class,
	string $alias,
	array<string, string> $renamedColumns = [],
	self::COLUMN_RENAMING_*|null $renameMode = null,
): void

Adds a root entity and all of its fields to the result set.

Parameters

$alias

The unique alias to use for the root entity.


					
	public

addJoinedEntityFromClassMetadata(
	class-string $class,
	string $alias,
	string $parentAlias,
	string $relation,
	array<string, string> $renamedColumns = [],
	self::COLUMN_RENAMING_*|null $renameMode = null,
): void

Adds a joined entity and all of its fields to the result set.

Parameters

`$alias`	The unique alias to use for the joined entity.
`$parentAlias`	The alias of the entity result that is the parent of this joined result.
`$relation`	The association field that connects the parent entity result with the joined entity result.


					
	protected

addAllClassFields(string $class, string $alias, array<string, string> $columnAliasMap = []): void

Adds all fields of the given class to the result set mapping (columns and meta fields).

Throws

InvalidArgumentException


					
	private

isInheritanceSupported(ClassMetadata $classMetadata): bool


					
	private

getColumnAlias(string $columnName, int $mode, array<string, string> $customRenameColumns): string

Gets column alias for a given column.


					
	private

getColumnAliasMap(
	class-string $className,
	self::COLUMN_RENAMING_* $mode,
	array<string, string> $customRenameColumns,
): string[]

Retrieves a class columns and join columns aliases that are used in the SELECT clause.

This depends on the renaming mode selected by the user.


					
	public

addNamedNativeQueryMapping(ClassMetadataInfo $class, mixed[] $queryMapping): ResultSetMappingBuilder

Adds the mappings of the results of native SQL queries to the result set.

Deprecated

This method is deprecated and will be removed in Doctrine ORM 3.0.


					
	public

addNamedNativeQueryResultClassMapping(ClassMetadataInfo $class, string $resultClassName): $this

Adds the class mapping of the results of native SQL queries to the result set.

Deprecated

This method is deprecated and will be removed in Doctrine ORM 3.0.


					
	public

addNamedNativeQueryResultSetMapping(ClassMetadataInfo $class, string $resultSetMappingName): $this

Adds the result set mapping of the results of native SQL queries to the result set.

Deprecated

This method is deprecated and will be removed in Doctrine ORM 3.0.


					
	public

addNamedNativeQueryEntityResultMapping(ClassMetadataInfo $classMetadata, mixed[] $entityMapping, string $alias): $this

Adds the entity result mapping of the results of native SQL queries to the result set.

Deprecated

This method is deprecated and will be removed in Doctrine ORM 3.0.

Throws

`Doctrine\ORM\Mapping\MappingException`
`InvalidArgumentException`


					
	public

generateSelectClause(array<string, string> $tableAliases = []): string

Generates the Select clause from this ResultSetMappingBuilder.

Works only for all the entity results. The select parts for scalar expressions have to be written manually.


					
	public

__toString(): string

Methods inherited from Doctrine\ORM\Query\ResultSetMapping
`addEntityResult(), setDiscriminatorColumn(), addIndexBy(), addIndexByScalar(), addIndexByColumn(), hasIndexBy(), isFieldResult(), addFieldResult(), addJoinedEntityResult(), addScalarResult(), addEnumResult(), addMetadataParameterMapping(), isScalarResult(), getClassName(), getScalarAlias(), getDeclaringClass(), getRelation(), isRelation(), getEntityAlias(), getParentAlias(), hasParentAlias(), getFieldName(), getAliasMap(), getEntityResultCount(), isMixedResult(), addMetaResult()`

Methods inherited from Doctrine\ORM\Query\ResultSetMapping

addEntityResult(), setDiscriminatorColumn(), addIndexBy(), addIndexByScalar(), addIndexByColumn(), hasIndexBy(), isFieldResult(), addFieldResult(), addJoinedEntityResult(), addScalarResult(), addEnumResult(), addMetadataParameterMapping(), isScalarResult(), getClassName(), getScalarAlias(), getDeclaringClass(), getRelation(), isRelation(), getEntityAlias(), getParentAlias(), hasParentAlias(), getFieldName(), getAliasMap(), getEntityResultCount(), isMixedResult(), addMetaResult()

Methods used from Doctrine\ORM\Internal\SQLResultCasing
`getSQLResultCasing()`

Constants
`public`	`COLUMN_RENAMING_NONE = 1` Picking this rename mode will register entity columns as is, as they are in the database. This can cause clashes when… Picking this rename mode will register entity columns as is, as they are in the database. This can cause clashes when multiple entities are fetched that have columns with the same name.	#
`public`	`COLUMN_RENAMING_CUSTOM = 2` Picking custom renaming allows the user to define the renaming of specific columns with a rename array that contains… Picking custom renaming allows the user to define the renaming of specific columns with a rename array that contains column names as keys and result alias as values.	#
`public`	`COLUMN_RENAMING_INCREMENT = 3` Incremental renaming uses a result set mapping internal counter to add a number to each column result, leading to… Incremental renaming uses a result set mapping internal counter to add a number to each column result, leading to uniqueness. This only works if you use {@see generateSelectClause()} to generate the SELECT clause for you.	#

Properties
`private`	`int`	`$sqlCounter = 0`	#
`private`	`EntityManagerInterface`	`$em`	#
`private`	`int`	`$defaultRenameMode`	#

Properties inherited from Doctrine\ORM\Query\ResultSetMapping
`$isMixed, $isSelect, $aliasMap, $relationMap, $parentAliasMap, $fieldMappings, $scalarMappings, $enumMappings, $typeMappings, $entityMappings, $metaMappings, $columnOwnerMap, $discriminatorColumns, $indexByMap, $declaringClasses, $isIdentifierColumn, $newObjectMappings, $metadataParameterMapping, $discriminatorParameters`

Namespaces

Classes

Interfaces

Exceptions

Class Doctrine\ORM\Query\ResultSetMappingBuilder

Parameters

Parameters

Throws

Deprecated

Deprecated

Deprecated

Deprecated

Throws