Class TParameterMap
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).
Constructor Summary |
public |
Initialize the properties and property map collections.
|
Method Summary |
void
|
|
protected
TSqlMapTypeHandler
|
Create type handler from Type or TypeHandler.
|
string
|
|
string
|
|
protected
mixed
|
|
TParameterProperty[]
|
|
TParameterProperty
|
|
array
|
|
unknown
|
Get the value of a property from the the parameter object.
|
void
|
|
protected
mixed
|
When the actual value matches the NullValue, set the current value to null.
|
void
|
|
void
|
|
Methods Inherited From TComponent |
TComponent::addParsedObject(), TComponent::attachEventHandler(), TComponent::canGetProperty(), TComponent::canSetProperty(), TComponent::createdOnTemplate(), TComponent::detachEventHandler(), TComponent::evaluateExpression(), TComponent::evaluateStatements(), TComponent::getEventHandlers(), TComponent::getSubProperty(), TComponent::hasEvent(), TComponent::hasEventHandler(), TComponent::hasProperty(), TComponent::raiseEvent(), TComponent::setSubProperty(), TComponent::__get(), TComponent::__set()
|
Constructor Details |
__construct
Initialize the properties and property map collections.
|
Method Details |
addProperty
public void addProperty |
(TParameterProperty $property ) |
Input |
TParameterProperty | $property | new parameter property |
Output |
Exception |
|
createTypeHandler
Create type handler from Type or TypeHandler.
|
getExtends
public string getExtends |
() |
Output |
string
| name of another <parameterMap> upon which to base this TParameterMap. |
Exception |
|
getID
Output |
string
| a unique identifier for the <parameterMap>. |
Exception |
|
getObjectValue
Input |
mixed | $object | object to obtain the property from. |
TParameterProperty | $property | parameter property. |
Output |
mixed
| property value. |
Exception |
throws | TSqlMapException if property access is invalid. |
|
getProperties
public TParameterProperty[] getProperties |
() |
Output |
TParameterProperty[]
| list of properties for the parameter map. |
Exception |
|
getProperty
Input |
string | $index | name of a parameter property. |
Output |
TParameterProperty
| parameter property. |
Exception |
throws | TSqlMapException if index is not string nor integer. |
|
getPropertyNames
public array getPropertyNames |
() |
Output |
array
| list of property names. |
Exception |
|
getPropertyValue
Get the value of a property from the the parameter object.
|
insertProperty
public void insertProperty |
(int $index , TParameterProperty $property ) |
Input |
int | $index | parameter property index |
TParameterProperty | $property | new parameter property. |
Output |
Exception |
|
nullifyDefaultValue
When the actual value matches the NullValue, set the current value to null.
Input |
TParameterProperty | $property | parameter property. |
mixed | $value | current property value |
Output |
mixed
| null if NullValue matches currrent value. |
Exception |
|
setExtends
public void setExtends |
(string $value ) |
Input |
string | $value | name of another <parameterMap> upon which to base this TParameterMap. |
Output |
Exception |
|
setID
public void setID |
(string $value ) |
Input |
string | $value | a unique identifier for the <parameterMap>. |
Output |
Exception |
|
|