TResultMap corresponds to <resultMap> mapping tag.
A TResultMap lets you control how data is extracted from the result of a query, and how the columns are mapped to object properties. A TResultMap can describe the column type, a null value replacement, and complex property mappings including Collections.
The <resultMap> can contain any number of property mappings that map object properties to the columns of a result element. The property mappings are applied, and the columns are read, in the order that they are defined. Maintaining the element order ensures consistent results between different drivers and providers.
The Class property must be a PHP class object or array instance.
The optional Extends attribute can be set to the ID of another <resultMap> upon which to base this <resultMap>. All properties of the "parent" <resultMap> will be included as part of this <resultMap>, and values from the "parent" <resultMap> are set before any values specified by this <resultMap>.
Method Details |
addResultProperty
public void addResultProperty |
(TResultProperty $property ) |
Add a TResultProperty to result mapping.
Input |
TResultProperty | $property | result property. |
Output |
Exception |
|
createInstanceOfResult
Create a new instance of the class of this result map.
|
getClass
public string getClass |
() |
Output |
string
| result class name. |
Exception |
|
getColumns
public TMap getColumns |
() |
Output |
TMap
| result columns. |
Exception |
|
getDiscriminator
|
getExtends
public string getExtends |
() |
Output |
string
| result map extends another result map. |
Exception |
|
getGroupBy
public string getGroupBy |
() |
Output |
string
| result map groups by. |
Exception |
|
getID
Output |
string
| a unique identifier for the <resultMap>. |
Exception |
|
resolveSubMap
Result sub-mappings using the discriminiator column.
|
setClass
public void setClass |
(string $value ) |
Input |
string | $value | result class name. |
Output |
Exception |
|
setDiscriminator
public void setDiscriminator |
(TDiscriminator $value ) |
Input |
TDiscriminator | $value | result class discriminator. |
Output |
Exception |
|
setExtends
public void setExtends |
(string $value ) |
Input |
string | $value | result map extends another result map. |
Output |
Exception |
|
setGroupBy
public void setGroupBy |
(string $value ) |
Input |
string | $value | result map group by |
Output |
Exception |
|
setID
public void setID |
(string $value ) |
Input |
string | $value | a unique identifier for the <resultMap>. |
Output |
Exception |
|