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.
<b>Users should use the public methods.</b>
- Author: Roman Borschel <roman@code-factory.org>
Synopsis
class ResultSetMapping
{
- // members
- public boolean $isMixed;
- public array $aliasMap;
- public array $relationMap;
- public array $parentAliasMap;
- public array $fieldMappings;
- public array $scalarMappings;
- public array $typeMappings;
- public array $entityMappings;
- public array $metaMappings;
- public array $columnOwnerMap;
- public array $discriminatorColumns;
- public array $indexByMap;
- public array $declaringClasses;
- public array $isIdentifierColumn;
- // methods
- public ResultSetMapping addEntityResult()
- public ResultSetMapping setDiscriminatorColumn()
- public ResultSetMapping addIndexBy()
- public ResultSetMapping addIndexByScalar()
- public ResultSetMapping addIndexByColumn()
- public boolean hasIndexBy()
- public boolean isFieldResult()
- public ResultSetMapping addFieldResult()
- public ResultSetMapping addJoinedEntityResult()
- public ResultSetMapping addScalarResult()
- public boolean isScalarResult()
- public string getClassName()
- public string getScalarAlias()
- public string getDeclaringClass()
- public AssociationMapping getRelation()
- public boolean isRelation()
- public string getEntityAlias()
- public string getParentAlias()
- public boolean hasParentAlias()
- public string getFieldName()
- public array getAliasMap()
- public integer getEntityResultCount()
- public boolean isMixedResult()
- public ResultSetMapping addMetaResult()
Hierarchy
Extended by
Tasks
Line | Task |
---|---|
36+ | Think about whether the number of lookup maps can be reduced. |
132+ | Rename: addRootEntity |
155+ | Rename: addDiscriminatorColumn |
183 | check if this exception can be put back, for now it's gone because of assumptions made by some ORM internals |
233+ | Rename: isIndexed($alias) |
246+ | Rename: isField |
265+ | Rename: addField |
291+ | Rename: addJoinedEntity |
311+ | Rename: addScalar |
330+ | Rename: isScalar |
Members
public
- $aliasMap — array
- $columnOwnerMap — array
- $declaringClasses — array
- $discriminatorColumns — array
- $entityMappings — array
- $fieldMappings — array
- $indexByMap — array
- $isIdentifierColumn — array
- $isMixed — boolean
- $metaMappings — array
- $parentAliasMap — array
- $relationMap — array
- $scalarMappings — array
- $typeMappings — array
Methods
public
- addEntityResult() — Adds an entity result to this ResultSetMapping.
- addFieldResult() — Adds a field to the result that belongs to an entity or joined entity.
- addIndexBy() — Sets a field to use for indexing an entity result or joined entity result.
- addIndexByColumn() — Sets a column to use for indexing an entity or joined entity result by the given alias name.
- addIndexByScalar() — Set to index by a scalar result column name
- addJoinedEntityResult() — Adds a joined entity result.
- addMetaResult() — Adds a meta column (foreign key or discriminator column) to the result set.
- addScalarResult() — Adds a scalar result mapping.
- getAliasMap()
- getClassName() — Gets the name of the class of an entity result or joined entity result, identified by the given unique alias.
- getDeclaringClass() — Gets the name of the class that owns a field mapping for the specified column.
- getEntityAlias() — Gets the alias of the class that owns a field mapping for the specified column.
- getEntityResultCount() — Gets the number of different entities that appear in the mapped result.
- getFieldName() — Gets the field name for a column name.
- getParentAlias() — Gets the parent alias of the given alias.
- getRelation()
- getScalarAlias() — Gets the field alias for a column that is mapped as a scalar value.
- hasIndexBy() — Checks whether an entity result or joined entity result with a given alias has a field set for indexing.
- hasParentAlias() — Checks whether the given alias has a parent alias.
- isFieldResult() — Checks whether the column with the given name is mapped as a field result as part of an entity result or joined entity result.
- isMixedResult() — Checks whether this ResultSetMapping defines a mixed result.
- isRelation()
- isScalarResult() — Checks whether a column with a given name is mapped as a scalar result.
- setDiscriminatorColumn() — Sets a discriminator column for an entity result or joined entity result.