Class StatementDecorator

__constructsource public

__construct( Cake\Database\StatementInterface|null $statement null , Cake\Database\Driver|null $driver null )

Constructor

Parameters

Cake\Database\StatementInterface|null $statement optional null

Statement implementation such as PDOStatement

Cake\Database\Driver|null $driver optional null

Driver instance

__getsource public

__get( string $property )

Magic getter to return $queryString as read-only.

Parameters

string $property

internal property to get

Returns

mixed
mixed

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

Implementation of

Cake\Database\StatementInterface::bind()

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

Implementation of

Cake\Database\StatementInterface::bindValue()

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.

Implementation of

Cake\Database\StatementInterface::closeCursor()

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

Implementation of

Cake\Database\StatementInterface::columnCount()

countsource public

count( )

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

Returns

integer
int

Implementation of

Cake\Database\StatementInterface::count()

errorCodesource public

errorCode( )

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

Returns

integer|string
int|string

Implementation of

Cake\Database\StatementInterface::errorCode()

errorInfosource public

errorInfo( )

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

Returns

array
array

Implementation of

Cake\Database\StatementInterface::errorInfo()

executesource public

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.

Parameters

array|null $params optional null

list of values to be bound to query

Returns

boolean
true on success, false otherwise

Implementation of

Cake\Database\StatementInterface::execute()

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

Implementation of

Cake\Database\StatementInterface::fetch()

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

Implementation of

Cake\Database\StatementInterface::fetchAll()

getInnerStatementsource public

getInnerStatement( )

Returns the statement object that was decorated by this class.

Returns

Cake\Database\StatementInterface
\Cake\Database\StatementInterface

getIteratorsource public

getIterator( )

Statements are iterable as arrays, this method will return the iterator object for traversing all items in the result.

Example:

$statement = $connection->prepare('SELECT id, title from articles');
foreach ($statement as $row) {
  //do stuff
}

Returns

Iterator
\Iterator

Implementation of

IteratorAggregate::getIterator()

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

Implementation of

Cake\Database\StatementInterface::lastInsertId()

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

Implementation of

Cake\Database\StatementInterface::rowCount()

castsource public

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

Parameters

mixed $value

The value to cast

Cake\Database\Type|string $type

The type name or type instance to use.

Returns

array
list containing converted value and internal type

matchTypessource public

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.

Parameters

array $columns

list or associative array of columns and parameters to be bound with types

array $types

list or associative array of types

Returns

array
array

false