## Interface IMappedStatement

Description

Interface for all mapping statements.

- since: 3.1
- version: $Id: IMappedStatement.php 1555 2006-12-04 00:02:23Z wei $
- author: Wei Zhuo <weizho[at]gmail[dot]com>

Located in /Data/SqlMap/Statements/IMappedStatement.php (line 18)

Method Summary
TList executeQueryForList (IDbConnection $connection, mixed $parameter, [TList $result = null], [integer $skip = -1], [integer $max = -1])
TMap executeQueryForMap (IDbConnection $connection, mixed $parameter, string $keyProperty, [string $valueProperty = null])
object result. executeQueryForObject (IDbConnection $connection, mixed $parameter, [object The $result = null])
integer executeUpdate (IDbConnection $connection, mixed $parameter)
string getID ()
TSqlMap getManager ()
TSqlMapStatement getStatement ()
Methods
executeQueryForList (line 69)

Executes the SQL and retuns a subset of the rows selected.

- return: A TList of result objects.
- access: public

TList executeQueryForList (IDbConnection $connection, mixed $parameter, [TList $result = null], [integer $skip = -1], [integer $max = -1])

- IDbConnection $connection: database connection to execute the query
- mixed $parameter: The object used to set the parameters in the SQL.
- TList $result: A list to populate the result with.
- integer $skip: The number of rows to skip over.
- integer $max: The maximum number of rows to return.

executeQueryForMap (line 47)

Executes the SQL and retuns all rows selected in a map that is keyed on

the property named in the <tt>$keyProperty</tt> parameter. The value at each key will be the value of the property specified in the <tt>$valueProperty</tt> parameter. If <tt>$valueProperty</tt> is <tt>null</tt>, the entire result object will be entered.

- return: A map of object containing the rows keyed by <tt>$keyProperty</tt>.
- access: public

TMap executeQueryForMap (IDbConnection $connection, mixed $parameter, string $keyProperty, [string $valueProperty = null])

- IDbConnection $connection: database connection to execute the query
- mixed $parameter: The object used to set the parameters in the SQL.
- string $keyProperty: The property of the result object to be used as the key.
- string $valueProperty: The property of the result object to be used as the value (or null)

executeQueryForObject (line 80)

Executes an SQL statement that returns a single row as an object of the type of the <tt>$result</tt> passed in as a parameter.

- access: public

object result. executeQueryForObject (IDbConnection $connection, mixed $parameter, [object The $result = null])

- IDbConnection $connection: database connection to execute the query
- mixed $parameter: The object used to set the parameters in the SQL.
- object The $result: result object.

executeUpdate (line 57)

Execute an update statement. Also used for delete statement. Return the number of row effected.

- return: The number of row effected.
- access: public

integer executeUpdate (IDbConnection $connection, mixed $parameter)

- IDbConnection $connection: database connection to execute the query
- mixed $parameter: The object used to set the parameters in the SQL.

getID (line 23)

- return: Name used to identify the MappedStatement amongst the others.
- access: public

string getID ()
getManager (line 33)

- return: The TSqlMap used by this TMappedStatement
- access: public

TSqlMap getManager ()
getStatement (line 28)

- return: The SQL statment used by this TMappedStatement.
- access: public

TSqlMapStatement getStatement ()

Documentation generated on Sun, 14 Jan 2007 21:40:28 -0500 by phpDocumentor 1.3.0RC4