Interface StatementInterface

Represents a database statement. Concrete implementations can either use PDOStatement or a native driver

Namespace: Cake\Database

Constants summary

  • string
    FETCH_TYPE_ASSOC
    'assoc'
  • string
    FETCH_TYPE_NUM
    'num'
  • string
    FETCH_TYPE_OBJ
    'obj'

Method Summary

  • bind() public

    Binds a set of values to statement object with corresponding type

  • bindValue() public

    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.

  • closeCursor() public

    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.

  • columnCount() public

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

  • count() public

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

  • errorCode() public

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

  • errorInfo() public

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

  • execute() public

    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

  • fetch() public

    Returns the next row for the result set after executing this statement.

  • fetchAll() public

    Returns an array with all rows resulting from executing this statement

  • lastInsertId() public

    Returns the latest primary inserted using this statement

  • rowCount() public

    Returns the number of rows affected by this SQL statement

Method Detail

bind() public 

bind(mixed $params, mixed $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

bindValue() public 

bindValue(mixed $column, mixed $value, mixed $type)

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|int $column

name or param position to be bound

mixed $value

The value to bind to variable in query

string $type optional

name of configured Type class

closeCursor() 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.

columnCount() 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

int

count() public 

count()

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

Returns

int

errorCode() public 

errorCode()

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

Returns

int|string

errorInfo() public 

errorInfo()

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

Returns

array

execute() public 

execute(mixed $params)

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|null $params optional

list of values to be bound to query

Returns

bool

true on success, false otherwise

fetch() public 

fetch(mixed $type)

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' for positional columns, assoc for named columns

Returns

array|false

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

fetchAll() public 

fetchAll(mixed $type)

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 for fetching columns as positional keys or assoc for column names as keys

Returns

array

list of all results from database for this statement

lastInsertId() public 

lastInsertId(mixed $table, mixed $column)

Returns the latest primary inserted using this statement

Parameters

string|null $table optional

table name or sequence to get last insert value from

string|null $column optional

the name of the column representing the primary key

Returns

string

rowCount() 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

int

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.9/interface-Cake.Database.StatementInterface.html