Represents a database statement. Statements contains queries that can be executed multiple times by binding different values on each call. This class also helps convert values to their valid representation for the corresponding types.
This class is but a decorator of an actual statement implementation, such as PDOStatement.
__construct( Cake\Database\StatementInterface|null $statement null , Cake\Database\Driver|null $driver null )
Constructor
Cake\Database\StatementInterface
|null $statement
optional null Cake\Database\Driver
|null $driver
optional null __get( string $property )
Magic getter to return $queryString as read-only.
$property
mixed
bind( array $params , array $types )
Binds a set of values to statement object with corresponding type.
$params
$types
Cake\Database\StatementInterface::bind()
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.
$statement->bindValue(1, 'a title'); $statement->bindValue('active', true, 'boolean'); $statement->bindValue(5, new \DateTime(), 'date');
$column
$value
$type
optional 'string' Cake\Database\StatementInterface::bindValue()
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.
Cake\Database\StatementInterface::closeCursor()
columnCount( )
Returns the number of columns this statement's results will contain.
$statement = $connection->prepare('SELECT id, title from articles'); $statement->execute(); echo $statement->columnCount(); // outputs 2
integer
Cake\Database\StatementInterface::columnCount()
count( )
Statements can be passed as argument for count() to return the number for affected rows from last execution.
integer
Cake\Database\StatementInterface::count()
errorCode( )
Returns the error code for the last error that occurred when executing this statement.
integer|string
Cake\Database\StatementInterface::errorCode()
errorInfo( )
Returns the error information for the last error that occurred when executing this statement.
array
Cake\Database\StatementInterface::errorInfo()
execute( array|null $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
.
$params
optional null boolean
Cake\Database\StatementInterface::execute()
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.
$statement = $connection->prepare('SELECT id, title from articles'); $statement->execute(); print_r($statement->fetch('assoc')); // will show ['id' => 1, 'title' => 'a title']
$type
optional 'num' array|false
Cake\Database\StatementInterface::fetch()
fetchAll( string $type 'num' )
Returns an array with all rows resulting from executing this statement.
$statement = $connection->prepare('SELECT id, title from articles'); $statement->execute(); print_r($statement->fetchAll('assoc')); // will show [0 => ['id' => 1, 'title' => 'a title']]
$type
optional 'num' array
Cake\Database\StatementInterface::fetchAll()
getInnerStatement( )
Returns the statement object that was decorated by this class.
Cake\Database\StatementInterface
getIterator( )
Statements are iterable as arrays, this method will return the iterator object for traversing all items in the result.
$statement = $connection->prepare('SELECT id, title from articles'); foreach ($statement as $row) { //do stuff }
Iterator
IteratorAggregate::getIterator()
lastInsertId( string|null $table null , string|null $column null )
Returns the latest primary inserted using this statement.
$table
optional null $column
optional null string
Cake\Database\StatementInterface::lastInsertId()
rowCount( )
Returns the number of rows affected by this SQL statement.
$statement = $connection->prepare('SELECT id, title from articles'); $statement->execute(); print_r($statement->rowCount()); // will show 1
integer
Cake\Database\StatementInterface::rowCount()
cast( mixed $value , Cake\Database\Type|string $type )
Converts a give value to a suitable database value based on type and return relevant internal statement type
$value
Cake\Database\Type
|string $type
array
matchTypes( array $columns , array $types )
Matches columns to corresponding types
Both $columns and $types should either be numeric based or string key based at the same time.
$columns
$types
array
© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Database.Statement.StatementDecorator.html