Class Doctrine\ORM\Query\ResultSetMapping

A ResultSetMapping describes how a result set of an SQL query maps to a Doctrine result.

IMPORTANT NOTE: The properties of this class are only public for fast internal READ access and to (drastically) reduce the size of serialized instances for more effective caching due to better (un-)serialization performance.

Users should use the public methods.

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

Methods


					
	public

addEntityResult(class-string $class, string $alias, string|null $resultAlias = null): $this

Adds an entity result to this ResultSetMapping.

Parameters

`$alias`	The alias for the class. The alias must be unique among all entity results or joined entity results within this ResultSetMapping.
`$resultAlias`	The result alias with which the entity result should be placed in the result structure.


					
	public

setDiscriminatorColumn(string $alias, string $discrColumn): $this

Sets a discriminator column for an entity result or joined entity result. The discriminator column will be used to…

Sets a discriminator column for an entity result or joined entity result. The discriminator column will be used to determine the concrete class name to instantiate.

Parameters

`$alias`	The alias of the entity result or joined entity result the discriminator column should be used for.
`$discrColumn`	The name of the discriminator column in the SQL result set.


					
	public

addIndexBy(string $alias, string $fieldName): $this

Sets a field to use for indexing an entity result or joined entity result.

Parameters

`$alias`	The alias of an entity result or joined entity result.
`$fieldName`	The name of the field to use for indexing.


					
	public

addIndexByScalar(string $resultColumnName): $this

Sets to index by a scalar result column name.


					
	public

addIndexByColumn(string $alias, string $resultColumnName): $this

Sets a column to use for indexing an entity or joined entity result by the given alias name.


					
	public

hasIndexBy(string $alias): bool

Checks whether an entity result or joined entity result with a given alias has a field set for indexing.


					
	public

isFieldResult(string $columnName): bool

Checks whether the column with the given name is mapped as a field result as part of an entity result or joined entity…

Checks whether the column with the given name is mapped as a field result as part of an entity result or joined entity result.

Parameters

$columnName

The name of the column in the SQL result set.


					
	public

addFieldResult(string $alias, string $columnName, string $fieldName, class-string|null $declaringClass = null): $this

Adds a field to the result that belongs to an entity or joined entity.

Parameters

`$alias`	The alias of the root entity or joined entity to which the field belongs.
`$columnName`	The name of the column in the SQL result set.
`$fieldName`	The name of the field on the declaring class.


					
	public

addJoinedEntityResult(class-string $class, string $alias, string $parentAlias, string $relation): $this

Adds a joined entity result.

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.


					
	public

addScalarResult(string $columnName, string|int $alias, string $type = 'string'): $this

Adds a scalar result mapping.

Parameters

`$columnName`	The name of the column in the SQL result set.
`$alias`	The result alias with which the scalar result should be placed in the result structure.
`$type`	The column type


					
	public

addEnumResult(string $columnName, string $enumType): $this

Adds a scalar result mapping.

Parameters

`$columnName`	The name of the column in the SQL result set.
`$enumType`	The enum type


					
	public

addMetadataParameterMapping(string|int $parameter, string $attribute): void

Adds a metadata parameter mappings.

Parameters

`$parameter`	The parameter name in the SQL result set.
`$attribute`	The metadata attribute.


					
	public

isScalarResult(string $columnName): bool

Checks whether a column with a given name is mapped as a scalar result.

Parameters

$columnName

The name of the column in the SQL result set.


					
	public

getClassName(string $alias): class-string

Gets the name of the class of an entity result or joined entity result, identified by the given unique alias.


					
	public

getScalarAlias(string $columnName): string|int

Gets the field alias for a column that is mapped as a scalar value.

Parameters

$columnName

The name of the column in the SQL result set.


					
	public

getDeclaringClass(string $columnName): class-string

Gets the name of the class that owns a field mapping for the specified column.


					
	public

getRelation(string $alias): string


					
	public

isRelation(string $alias): bool


					
	public

getEntityAlias(string $columnName): string

Gets the alias of the class that owns a field mapping for the specified column.


					
	public

getParentAlias(string $alias): string

Gets the parent alias of the given alias.


					
	public

hasParentAlias(string $alias): bool

Checks whether the given alias has a parent alias.


					
	public

getFieldName(string $columnName): string

Gets the field name for a column name.


					
	public

getAliasMap()


					
	public

getEntityResultCount(): int

Gets the number of different entities that appear in the mapped result.


					
	public

isMixedResult(): bool

Checks whether this ResultSetMapping defines a mixed result.

Mixed results can only occur in object and array (graph) hydration. In such a case a mixed result means that scalar values are mixed with objects/array in the result.


					
	public

addMetaResult(
	string $alias,
	string $columnName,
	string $fieldName,
	bool $isIdentifierColumn = false,
	string|null $type = null,
): $this

Adds a meta column (foreign key or discriminator column) to the result set.

Parameters

`$alias`	The result alias with which the meta result should be placed in the result structure.
`$columnName`	The name of the column in the SQL result set.
`$fieldName`	The name of the field on the declaring class.
`$type`	The column type

Properties
`public`	`bool`	`$isMixed = false`	#
`public`	`bool`	`$isSelect = true`	#
`public`		`$aliasMap = []` Maps alias names to class names. Maps alias names to class names.	#
`public`		`$relationMap = []` Maps alias names to related association field names. Maps alias names to related association field names.	#
`public`		`$parentAliasMap = []` Maps alias names to parent alias names. Maps alias names to parent alias names.	#
`public`		`$fieldMappings = []` Maps column names in the result set to field names for each class. Maps column names in the result set to field names for each class.	#
`public`		`$scalarMappings = []` Maps column names in the result set to the alias/field name to use in the mapped result. Maps column names in the result set to the alias/field name to use in the mapped result.	#
`public`		`$enumMappings = []` Maps scalar columns to enums Maps scalar columns to enums	#
`public`		`$typeMappings = []` Maps column names in the result set to the alias/field type to use in the mapped result. Maps column names in the result set to the alias/field type to use in the mapped result.	#
`public`		`$entityMappings = []` Maps entities in the result set to the alias name to use in the mapped result. Maps entities in the result set to the alias name to use in the mapped result.	#
`public`		`$metaMappings = []` Maps column names of meta columns (foreign keys, discriminator columns, ...) to field names. Maps column names of meta columns (foreign keys, discriminator columns, ...) to field names.	#
`public`		`$columnOwnerMap = []` Maps column names in the result set to the alias they belong to. Maps column names in the result set to the alias they belong to.	#
`public`		`$discriminatorColumns = []` List of columns in the result set that are used as discriminator columns. List of columns in the result set that are used as discriminator columns.	#
`public`		`$indexByMap = []` Maps alias names to field names that should be used for indexing. Maps alias names to field names that should be used for indexing.	#
`public`		`$declaringClasses = []` Map from column names to class names that declare the field the column is mapped to. Map from column names to class names that declare the field the column is mapped to.	#
`public`		`$isIdentifierColumn = []` This is necessary to hydrate derivate foreign keys correctly. This is necessary to hydrate derivate foreign keys correctly.	#
`public`		`$newObjectMappings = []` Maps column names in the result set to field names for each new object expression. Maps column names in the result set to field names for each new object expression.	#
`public`		`$metadataParameterMapping = []` Maps metadata parameter names to the metadata attribute. Maps metadata parameter names to the metadata attribute.	#
`public`		`$discriminatorParameters = []` Contains query parameter names to be resolved as discriminator values Contains query parameter names to be resolved as discriminator values	#

Namespaces

Classes

Interfaces

Exceptions

Class Doctrine\ORM\Query\ResultSetMapping

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters