1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
<?php
/**
* TResultMap class file.
*
* @author Wei Zhuo <weizhuo[at]gmail[dot]com>
* @link http://www.pradosoft.com/
* @copyright Copyright © 2005-2014 PradoSoft
* @license http://www.pradosoft.com/license/
* @package Prado\Data\SqlMap\Configuration
*/
namespace Prado\Data\SqlMap\Configuration;
use Prado\Collections\TMap;
use Prado\Data\SqlMap\DataMapper\TSqlMapException;
/**
* 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 {@link Class setClass()} property must be a PHP class object or array instance.
*
* The optional {@link Extends setExtends()} 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>.
*
* @author Wei Zhuo <weizho[at]gmail[dot]com>
* @package Prado\Data\SqlMap\Configuration
* @since 3.1
*/
class TResultMap extends \Prado\TComponent
{
private $_columns;
private $_class;
private $_extends;
private $_groupBy;
private $_discriminator;
private $_typeHandlers;
private $_ID;
/**
* Initialize the columns collection.
*/
public function __construct()
{
$this->_columns=new TMap;
}
/**
* @return string a unique identifier for the <resultMap>.
*/
public function getID()
{
return $this->_ID;
}
/**
* @param string a unique identifier for the <resultMap>.
*/
public function setID($value)
{
$this->_ID=$value;
}
/**
* @return string result class name.
*/
public function getClass()
{
return $this->_class;
}
/**
* @param string result class name.
*/
public function setClass($value)
{
$this->_class = $value;
}
/**
* @return TMap result columns.
*/
public function getColumns()
{
return $this->_columns;
}
/**
* @return string result map extends another result map.
*/
public function getExtends()
{
return $this->_extends;
}
/**
* @param string result map extends another result map.
*/
public function setExtends($value)
{
$this->_extends = $value;
}
/**
* @return string result map groups by.
*/
public function getGroupBy()
{
return $this->_groupBy;
}
/**
* @param string result map group by
*/
public function setGroupBy($value)
{
$this->_groupBy = $value;
}
/**
* @return TDiscriminator result class discriminator.
*/
public function getDiscriminator()
{
return $this->_discriminator;
}
/**
* @param TDiscriminator result class discriminator.
*/
public function setDiscriminator(TDiscriminator $value)
{
$this->_discriminator = $value;
}
/**
* Add a TResultProperty to result mapping.
* @param TResultProperty result property.
*/
public function addResultProperty(TResultProperty $property)
{
$this->_columns[$property->getProperty()] = $property;
}
/**
* Create a new instance of the class of this result map.
* @param TSqlMapTypeHandlerRegistry type handler registry.
* @return mixed new result object.
* @throws TSqlMapException
*/
public function createInstanceOfResult($registry)
{
$handler = $registry->getTypeHandler($this->getClass());
try
{
if($handler!==null)
return $handler->createNewInstance();
else
return $registry->createInstanceOf($this->getClass());
}
catch (TSqlMapException $e)
{
throw new TSqlMapException(
'sqlmap_unable_to_create_new_instance',
$this->getClass(), get_class($handler), $this->getID());
}
}
/**
* Result sub-mappings using the discriminiator column.
* @param TSqlMapTypeHandlerRegistry type handler registry
* @param array row data.
* @return TResultMap result sub-map.
*/
public function resolveSubMap($registry,$row)
{
$subMap = $this;
if(($disc = $this->getDiscriminator())!==null)
{
$value = $disc->getMapping()->getPropertyValue($registry,$row);
$subMap = $disc->getSubMap((string)$value);
if($subMap===null)
$subMap = $this;
else if($subMap !== $this)
$subMap = $subMap->resolveSubMap($registry,$row);
}
return $subMap;
}
}
|
