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
203
204
205
206
207
208
|
<?php
/**
* TParameterMap class file.
*
* @author Wei Zhuo <weizhuo[at]gmail[dot]com>
* @link https://github.com/pradosoft/prado
* @copyright Copyright © 2005-2015 The PRADO Group
* @license https://github.com/pradosoft/prado/blob/master/COPYRIGHT
* @package System.Data.SqlMap.Configuration
*/
/**
* TParameterMap corresponds to the <parameterMap> element.
*
* TParameterMap holds one or more parameter child elements that map object
* properties to placeholders in a SQL statement.
*
* A TParameterMap defines an ordered list of values that match up with the
* placeholders of a parameterized query statement. While the attributes
* specified by the map still need to be in the correct order, each parameter
* is named. You can populate the underlying class in any order, and the
* TParameterMap ensures each value is passed in the correct order.
*
* Parameter Maps can be provided as an external element and inline.
* The <parameterMap> element accepts two attributes: id (required) and extends (optional).
*
* @author Wei Zhuo <weizho[at]gmail[dot]com>
* @package System.Data.SqlMap.Configuration
* @since 3.1
*/
class TParameterMap extends TComponent
{
private $_extend;
private $_properties;
private $_propertyMap;
private $_extendMap;
private $_ID;
/**
* Initialize the properties and property map collections.
*/
public function __construct()
{
$this->_properties = new TList;
$this->_propertyMap = new TMap;
}
/**
* @return string a unique identifier for the <parameterMap>.
*/
public function getID()
{
return $this->_ID;
}
/**
* @param string a unique identifier for the <parameterMap>.
*/
public function setID($value)
{
$this->_ID=$value;
}
/**
* @return TParameterProperty[] list of properties for the parameter map.
*/
public function getProperties()
{
return $this->_properties;
}
/**
* @return string name of another <parameterMap> upon which to base this TParameterMap.
*/
public function getExtends()
{
return $this->_extend;
}
/**
* @param string name of another <parameterMap> upon which to base this TParameterMap.
*/
public function setExtends($value)
{
$this->_extend = $value;
}
/**
* @param string name of a parameter property.
* @return TParameterProperty parameter property.
* @throws TSqlMapException if index is not string nor integer.
*/
public function getProperty($index)
{
if(is_string($index))
return $this->_propertyMap->itemAt($index);
else if(is_int($index))
return $this->_properties->itemAt($index);
else
throw new TSqlMapException('sqlmap_index_must_be_string_or_int', $index);
}
/**
* @param TParameterProperty new parameter property
*/
public function addProperty(TParameterProperty $property)
{
$this->_propertyMap->add($property->getProperty(), $property);
$this->_properties->add($property);
}
/**
* @param int parameter property index
* @param TParameterProperty new parameter property.
*/
public function insertProperty($index, TParameterProperty $property)
{
$this->_propertyMap->add($property->getProperty(), $property);
$this->_properties->insertAt($index, $property);
}
/**
* @return array list of property names.
*/
public function getPropertyNames()
{
return $this->_propertyMap->getKeys();
}
/**
* Get the value of a property from the the parameter object.
* @param TSqlMapTypeHandlerRegistry type handler registry.
* @param TParameterProperty parameter proproperty.
* @param mixed parameter object to get the value from.
* @return unknown
*/
public function getPropertyValue($registry, $property, $parameterValue)
{
$value = $this->getObjectValue($parameterValue,$property);
if(($handler=$this->createTypeHandler($property, $registry))!==null)
$value = $handler->getParameter($value);
$value = $this->nullifyDefaultValue($property,$value);
if(($type = $property->getType())!==null)
$value = $registry->convertToType($type, $value);
return $value;
}
/**
* Create type handler from {@link Type setType()} or {@link TypeHandler setTypeHandler}.
* @param TParameterProperty parameter property
* @param TSqlMapTypeHandlerRegistry type handler registry
* @return TSqlMapTypeHandler type handler.
*/
protected function createTypeHandler($property, $registry)
{
$type=$property->getTypeHandler() ? $property->getTypeHandler() : $property->getType();
$handler=$registry->getTypeHandler($type);
if($handler===null && $property->getTypeHandler())
$handler = Prado::createComponent($type);
return $handler;
}
/**
* @param mixed object to obtain the property from.
* @param TParameterProperty parameter property.
* @return mixed property value.
* @throws TSqlMapException if property access is invalid.
*/
protected function getObjectValue($object,$property)
{
try
{
return TPropertyAccess::get($object, $property->getProperty());
}
catch (TInvalidPropertyException $e)
{
throw new TSqlMapException(
'sqlmap_unable_to_get_property_for_parameter',
$this->getID(),
$property->getProperty(),
(is_object($object) ? get_class($object) : gettype($object))
);
}
}
/**
* When the actual value matches the {@link NullValue TParameterProperty::setNullValue()},
* set the current value to null.
* @param TParameterProperty parameter property.
* @param mixed current property value
* @return mixed null if NullValue matches currrent value.
*/
protected function nullifyDefaultValue($property,$value)
{
if(($nullValue = $property->getNullValue())!==null)
{
if($nullValue === $value)
$value = null;
}
return $value;
}
}
|
