Class \Prado\Data\SqlMap\Configuration\TResultProperty

TResultProperty corresponds a <property> tags inside a <resultMap> tag.

The \Prado\Data\SqlMap\Configuration\NullValue attribute can be set to any valid value (based on property type). The \Prado\Data\SqlMap\Configuration\NullValue attribute is used to specify an outgoing null value replacement. What this means is that when a null value is detected in the result, the corresponding value of the \Prado\Data\SqlMap\Configuration\NullValue will be used instead.

The \Prado\Data\SqlMap\Configuration\Select property is used to describe a relationship between objects and to automatically load complex (i.e. user defined) property types. The value of the \Prado\Data\SqlMap\Configuration\Select property must be the name of another mapped statement. The value of the database \Prado\Data\SqlMap\Configuration\Column that is defined in the same property element as this statement attribute will be passed to the related mapped statement as the parameter. The \Prado\Data\SqlMap\Configuration\LazyLoad attribute can be specified with the \Prado\Data\SqlMap\Configuration\Select .

Class hierarchy

\Prado\Data\SqlMap\Configuration\TResultProperty

\Prado\TComponent

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

Methods summary
`public`	`__construct([TResultMap $resultMap = null ]) : mixed` Gets the containing result map ID.
`public`	`__sleep() : mixed` Returns an array with the names of all variables of that object that should be serialized. Do not call this method. This is a PHP magic method that will be called automatically prior to any serialization.
`public`	`getColumn() : string`
`public`	`getColumnIndex() : int`
`public`	`getLazyLoad() : bool`
`public`	`getNestedResultMap() : TResultMap`
`public`	`getNullValue() : mixed`
`public`	`getProperty() : string`
`public`	`getPropertyValue(TSqlMapTypeHandlerRegistry $registry, array<string\|int, mixed> $row) : mixed` Gets the value for the current property, converts to applicable type if necessary.
`public`	`getResultMapping() : string`
`public`	`getSelect() : string`
`public`	`getType() : string`
`public`	`getTypeHandler() : string`
`public`	`instanceOfArrayType(object $target) : bool` Returns true if the result property {@see Type getType()} is of \ArrayAccess or that the actual result object is an array or implements \ArrayAccess
`public`	`instanceOfListType(object $target) : bool` Returns true if the result property {@see Type getType()} is of TList type or that the actual result object is an instance of TList.
`public`	`setColumn(string $value) : mixed`
`public`	`setColumnIndex(int $value) : mixed`
`public`	`setLazyLoad(bool $value) : mixed`
`public`	`setNestedResultMap(TResultMap $value) : mixed`
`public`	`setNullValue(mixed $value) : mixed`
`public`	`setProperty(string $value) : mixed`
`public`	`setResultMapping(string $value) : mixed`
`public`	`setSelect(string $value) : mixed` The select property is used to describe a relationship between objects and to automatically load complex (i.e. user defined) property types.
`public`	`setType(string $value) : mixed`
`public`	`setTypeHandler(string $value) : mixed`
`protected`	`createTypeHandler(TSqlMapTypeHandlerRegistry $registry) : TSqlMapTypeHandler` Create type handler from {@see Type setType()} or {@see TypeHandler setTypeHandler}.
`protected`	`getPropertyValueType() : int` Determines if the type is an instance of \ArrayAccess, TList or an array.
`protected`	`getTypedValue(TSqlMapTypeHandlerRegistry $registry, mixed $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

Constants summary
`public mixed`	`ARRAY_TYPE`	`1`
`public mixed`	`LIST_TYPE`	`0`

Inherited constants
`\Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Data\SqlMap\Configuration\TResultProperty

Class hierarchy