Class \Prado\Data\SqlMap\Configuration\TResultMap

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 \Prado\Data\SqlMap\Configuration\Class property must be a PHP class object or array instance.

The optional \Prado\Data\SqlMap\Configuration\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>.

Class hierarchy

\Prado\Data\SqlMap\Configuration\TResultMap

\Prado\TComponent

Author: Wei Zhuo <weizho[at]gmail[dot]com>
Since: 3.1

Methods summary
`public`	`__construct() : mixed` Initialize the columns collection.
`public`	`addResultProperty(TResultProperty $property) : mixed` Add a TResultProperty to result mapping.
`public`	`createInstanceOfResult(TSqlMapTypeHandlerRegistry $registry) : mixed` Create a new instance of the class of this result map.
`public`	`getClass() : string`
`public`	`getColumns() : TMap`
`public`	`getDiscriminator() : TDiscriminator`
`public`	`getExtends() : string`
`public`	`getGroupBy() : string`
`public`	`getID() : string`
`public`	`resolveSubMap(TSqlMapTypeHandlerRegistry $registry, array<string\|int, mixed> $row) : TResultMap` Result sub-mappings using the discriminiator column.
`public`	`setClass(string $value) : mixed`
`public`	`setDiscriminator(TDiscriminator $value) : mixed`
`public`	`setExtends(string $value) : mixed`
`public`	`setGroupBy(string $value) : mixed`
`public`	`setID(string $value) : mixed`

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEventHandlers, getListeningToGlobalEvents, getSubProperty, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, listen, raiseEvent, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Inherited constants
`\Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Data\SqlMap\Configuration\TResultMap

Class hierarchy