SqliteStatement
in package
implements
DbStatement
Represents a prepared SQLite SQL statement.
Table of Contents
Interfaces
- DbStatement
- Represents a prepared database statement.
Methods
- __construct() : SqliteStatement
- Creates a new SqliteStatement instance.
- addParameter() : void
- Assigns a value to a parameter.
- execute() : int|string
- Executes this statement.
- getLastInsertId() : int|string
- Returns the ID of the last inserted row.
- getParameterCount() : int
- Returns how many parameters there are.
- getResult() : DbResult
- Gets the result after execution.
- nextParameter() : void
- Assigns a value to the next parameter.
- reset() : void
- Resets this statement for reuse.
Methods
__construct()
Creates a new SqliteStatement instance.
public
__construct(SqliteConnection $connection, SQLite3Stmt $statement) : SqliteStatement
Parameters
- $connection : SqliteConnection
-
A reference to the connection which creates this statement.
- $statement : SQLite3Stmt
-
The raw statement instance.
Return values
SqliteStatement —A new statement instance.
addParameter()
Assigns a value to a parameter.
public
addParameter(int $ordinal, mixed $value[, int $type = DbType::AUTO ]) : void
Parameters
- $ordinal : int
-
Index of the target parameter.
- $value : mixed
-
Value to assign to the parameter.
- $type : int = DbType::AUTO
-
Type of the value, if left to DbType::AUTO DbType::detect will be used on $value.
execute()
Executes this statement.
public
execute() : int|string
Return values
int|string —Number of rows affected by the query.
getLastInsertId()
Returns the ID of the last inserted row.
public
getLastInsertId() : int|string
Return values
int|string —Last inserted ID.
getParameterCount()
Returns how many parameters there are.
public
getParameterCount() : int
Return values
int —Number of parameters.
getResult()
Gets the result after execution.
public
getResult() : DbResult
Return values
DbResult —Instance of an implementation of DbResult.
nextParameter()
Assigns a value to the next parameter.
public
nextParameter(mixed $value[, int $type = DbType::AUTO ]) : void
Behaviour of this method may be slightly undefined if addParameter is used at the same time. Overwriting lower ordinals than the current cursor should be fine, but your mileage may vary.
Parameters
- $value : mixed
-
Value to assign to the parameter.
- $type : int = DbType::AUTO
-
Type of the value, if left to DbType::AUTO DbType::detect will be used on $value.
reset()
Resets this statement for reuse.
public
reset() : void