PHP Class Prado\Data\SqlMap\Configuration\TSqlMapStatement

Mapped Statements can hold any SQL statement and can use Parameter Maps and Result Maps for input and output. The element is a general "catch all" element that can be used for any type of SQL statement. Generally it is a good idea to use one of the more specific statement-type elements. The more specific elements provided better error-checking and even more functionality. (For example, the insert statement can return a database-generated key.)

Since: 3.1

Inheritance: extends Prado\TComponent

显示文件 Open project: pradosoft/prado

Public Methods

Method	Description
__sleep ( )
createInstanceOfListClass ( $registry ) : ArrayAccess
createInstanceOfResultClass ( $registry, $row ) : mixed	Create a new instance of result class.
getCache ( ) : TSqlMapCacheModel
getCacheModel ( ) : string
getExtends ( ) : string
getID ( ) : string
getListClass ( ) : string
getParameterClass ( ) : string
getParameterMap ( ) : string
getResultClass ( ) : string
getResultMap ( ) : string
getSqlText ( ) : TStaticSql
initialize ( $manager )
parameterMap ( ) : TParameterMap
resultMap ( ) : TResultMap
setCache ( $value )
setCacheModel ( $value )
setExtends ( $value )
setID ( $value )
setInlineParameterMap ( $map )
setListClass ( $value )	An \ArrayAccess class can be specified to handle the type of objects in the collection.
setParameterClass ( $value )	If a {@link ParameterMap setParameterMap()} property is not specified, you may specify a ParameterClass instead and use inline parameters.
setParameterMap ( $value )	A Parameter Map defines an ordered list of values that match up with the "?" placeholders of a standard, parameterized query statement.
setResultClass ( $value )	If a {@link ResultMap setResultMap()} is not specified, you may specify a ResultClass instead. The value of the ResultClass property can be the name of a PHP class or primitives like integer, string, or array. The class specified will be automatically mapped to the columns in the result, based on the result metadata.
setResultMap ( $value )	A Result Map lets you control how data is extracted from the result of a query, and how the columns are mapped to object properties.
setSqlText ( $value )

Protected Methods

Method	Description
createInstanceOf ( $registry, $type, $row = null ) : mixed	Create a new instance of a given type.

Method Details

__sleep() public method

public __sleep ( )

createInstanceOf() protected method

Create a new instance of a given type.

protected createInstanceOf ( $registry, $type, $row = null ) : mixed
return	mixed	result object.

createInstanceOfListClass() public method

public createInstanceOfListClass ( $registry ) : ArrayAccess
return	ArrayAccess	new instance of list class.

createInstanceOfResultClass() public method

Create a new instance of result class.

public createInstanceOfResultClass ( $registry, $row ) : mixed
return	mixed	result object.

getCache() public method

public getCache ( ) : TSqlMapCacheModel
return	TSqlMapCacheModel	cache implementation instance for this statement.

getCacheModel() public method

public getCacheModel ( ) : string
return	string	cache mode name.

getExtends() public method

public getExtends ( ) : string
return	string	another statement element name.

getID() public method

public getID ( ) : string
return	string	name for this statement, unique to each sql map manager.

getListClass() public method

public getListClass ( ) : string
return	string	name of a PHP class that implements \ArrayAccess.

getParameterClass() public method

public getParameterClass ( ) : string
return	string	parameter class name.

getParameterMap() public method

public getParameterMap ( ) : string
return	string	name of a parameter map.

getResultClass() public method

public getResultClass ( ) : string
return	string	result class name.

getResultMap() public method

public getResultMap ( ) : string
return	string	result map name.

getSqlText() public method

public getSqlText ( ) : TStaticSql
return	TStaticSql	sql text container.

initialize() public method

public initialize ( $manager )

parameterMap() public method

public parameterMap ( ) : TParameterMap
return	TParameterMap	the parameter map corresponding to the {@link ParameterMap getParameterMap()} property.

resultMap() public method

public resultMap ( ) : TResultMap
return	TResultMap	the result map corresponding to the {@link ResultMap getResultMap()} property.

setCache() public method

public setCache ( $value )

setCacheModel() public method

public setCacheModel ( $value )

setExtends() public method

public setExtends ( $value )

setID() public method

public setID ( $value )

setInlineParameterMap() public method

public setInlineParameterMap ( $map )

setListClass() public method

An \ArrayAccess class can be specified to handle the type of objects in the collection.

public setListClass ( $value )

setParameterClass() public method

The value of the parameterClass attribute can be any existing PHP class name.

public setParameterClass ( $value )

setParameterMap() public method

A Parameter Map defines an ordered list of values that match up with the "?" placeholders of a standard, parameterized query statement.

public setParameterMap ( $value )

setResultClass() public method

If a {@link ResultMap setResultMap()} is not specified, you may specify a ResultClass instead. The value of the ResultClass property can be the name of a PHP class or primitives like integer, string, or array. The class specified will be automatically mapped to the columns in the result, based on the result metadata.

public setResultClass ( $value )

setResultMap() public method

A Result Map lets you control how data is extracted from the result of a query, and how the columns are mapped to object properties.

public setResultMap ( $value )

setSqlText() public method

public setSqlText ( $value )