Interface StatementInterface

bindsource public

bind( array $params , array $types )

Binds a set of values to statement object with corresponding type

Parameters

array $params

list of values to be bound

array $types

list of types to be used, keys should match those in $params

bindValuesource public

bindValue( string|integer $column , mixed $value , string $type 'string' )

Assign a value to a positional or named variable in prepared query. If using positional variables you need to start with index one, if using named params then just use the name in any order.

It is not allowed to combine positional and named variables in the same statement

Examples:

$statement->bindValue(1, 'a title');
$statement->bindValue('active', true, 'boolean');
$statement->bindValue(5, new \DateTime(), 'date');

Parameters

string|integer $column

name or param position to be bound

mixed $value

The value to bind to variable in query

string $type optional 'string'

name of configured Type class

closeCursorsource public

closeCursor( )

Closes a cursor in the database, freeing up any resources and memory allocated to it. In most cases you don't need to call this method, as it is automatically called after fetching all results from the result set.

columnCountsource public

columnCount( )

Returns the number of columns this statement's results will contain

Example:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
echo $statement->columnCount(); // outputs 2

Returns

integer
int

countsource public

count( )

Statements can be passed as argument for count() to return the number for affected rows from last execution

Returns

integer
int

errorCodesource public

errorCode( )

Returns the error code for the last error that occurred when executing this statement

Returns

integer|string
int|string

errorInfosource public

errorInfo( )

Returns the error information for the last error that occurred when executing this statement

Returns

array
array

executesource public

execute( array $params null )

Executes the statement by sending the SQL query to the database. It can optionally take an array or arguments to be bound to the query variables. Please note that binding parameters from this method will not perform any custom type conversion as it would normally happen when calling bindValue

Parameters

array $params optional null

list of values to be bound to query

Returns

boolean
true on success, false otherwise

fetchsource public

fetch( string $type 'num' )

Returns the next row for the result set after executing this statement. Rows can be fetched to contain columns as names or positions. If no rows are left in result set, this method will return false

Example:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetch('assoc')); // will show ['id' => 1, 'title' => 'a title']

Parameters

string $type optional 'num'

'num' for positional columns, assoc for named columns

Returns

array|false
Result array containing columns and values or false if no results are left

fetchAllsource public

fetchAll( string $type 'num' )

Returns an array with all rows resulting from executing this statement

Example:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetchAll('assoc')); // will show [0 => ['id' => 1, 'title' => 'a title']]

Parameters

string $type optional 'num'

num for fetching columns as positional keys or assoc for column names as keys

Returns

array
list of all results from database for this statement

lastInsertIdsource public

lastInsertId( string|null $table null , string|null $column null )

Returns the latest primary inserted using this statement

Parameters

string|null $table optional null

table name or sequence to get last insert value from

string|null $column optional null

the name of the column representing the primary key

Returns

string
string

rowCountsource public

rowCount( )

Returns the number of rows affected by this SQL statement

Example:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->rowCount()); // will show 1

Returns

integer
int