PHP Class Prado\Data\SqlMap\Configuration\TParameterMap

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 element accepts two attributes: id (required) and extends (optional).

Since: 3.1

Inheritance: extends Prado\TComponent

Afficher le fichier Open project: pradosoft/prado Class Usage Examples

Méthodes publiques

Méthode	Description
__construct ( )	Initialize the properties and property map collections.
addProperty ( TParameterProperty $property )
getExtends ( ) : string
getID ( ) : string
getProperties ( ) : TParameterProperty[]
getProperty ( $index ) : TParameterProperty
getPropertyNames ( ) : array
getPropertyValue ( $registry, $property, $parameterValue ) : unknown	Get the value of a property from the the parameter object.
insertProperty ( $index, TParameterProperty $property )
setExtends ( $value )
setID ( $value )

Méthodes protégées

Méthode	Description
createTypeHandler ( $property, $registry ) : TSqlMapTypeHandler	Create type handler from {@link Type setType()} or {@link TypeHandler setTypeHandler}.
getObjectValue ( $object, $property ) : mixed
nullifyDefaultValue ( $property, $value ) : mixed	When the actual value matches the {@link NullValue TParameterProperty::setNullValue()}, set the current value to null.

Method Details

__construct() public méthode

Initialize the properties and property map collections.

public __construct ( )

addProperty() public méthode

public addProperty ( TParameterProperty $property )
$property	TParameterProperty

createTypeHandler() protected méthode

Create type handler from {@link Type setType()} or {@link TypeHandler setTypeHandler}.

protected createTypeHandler ( $property, $registry ) : TSqlMapTypeHandler
Résultat	TSqlMapTypeHandler	type handler.

getExtends() public méthode

public getExtends ( ) : string
Résultat	string	name of another upon which to base this TParameterMap.

getID() public méthode

public getID ( ) : string
Résultat	string	a unique identifier for the .

getObjectValue() protected méthode

protected getObjectValue ( $object, $property ) : mixed
Résultat	mixed	property value.

getProperties() public méthode

public getProperties ( ) : TParameterProperty[]
Résultat	TParameterProperty[]	list of properties for the parameter map.

getProperty() public méthode

public getProperty ( $index ) : TParameterProperty
Résultat	TParameterProperty	parameter property.

getPropertyNames() public méthode

public getPropertyNames ( ) : array
Résultat	array	list of property names.

getPropertyValue() public méthode

Get the value of a property from the the parameter object.

public getPropertyValue ( $registry, $property, $parameterValue ) : unknown
Résultat	unknown

insertProperty() public méthode

public insertProperty ( $index, TParameterProperty $property )
$property	TParameterProperty

nullifyDefaultValue() protected méthode

When the actual value matches the {@link NullValue TParameterProperty::setNullValue()}, set the current value to null.

protected nullifyDefaultValue ( $property, $value ) : mixed
Résultat	mixed	null if NullValue matches currrent value.

setExtends() public méthode

public setExtends ( $value )

setID() public méthode

public setID ( $value )