W3cubDocs

/CakePHP 3.8

Class PDOStatement

Decorator for \PDOStatement class mainly used for converting human readable fetch modes into PDO constants.

Cake\Database\Statement\StatementDecorator implements Cake\Database\StatementInterface, Countable, IteratorAggregate uses Cake\Database\TypeConverterTrait
Extended by Cake\Database\Statement\PDOStatement

Inherited Constants

Inherited Magic Properties

Inherited Properties

Method Summary

  • __construct() public
    Constructor
  • 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.

  • fetch() public

    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

  • fetchAll() public
    Returns an array with all rows resulting from executing this statement

Method Detail

__construct()source public

__construct( Cake\Database\Statement\PDOStatement $statement = null , Cake\Database\Driver|null $driver = null )

Constructor

Parameters

Cake\Database\Statement\PDOStatement $statement optional null
Original statement to be decorated.
Cake\Database\Driver|null $driver optional null
Driver instance.

Overrides

Cake\Database\Statement\StatementDecorator::__construct()

bindValue()source public

bindValue( string|integer $column , mixed $value , string|integer $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.

You can pass PDO compatible constants for binding values with a type or optionally any type name registered in the Type class. Any value will be converted to the valid type representation if needed.

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

Examples:

$statement->bindValue(1, 'a title');
$statement->bindValue(2, 5, PDO::INT);
$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|integer $type optional 'string'
PDO type or name of configured Type class

Overrides

Cake\Database\Statement\StatementDecorator::bindValue()

fetch()source public

fetch( string $type = parent::FETCH_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 parent::FETCH_TYPE_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


Overrides

Cake\Database\Statement\StatementDecorator::fetch()

fetchAll()source public

fetchAll( string $type = parent::FETCH_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 parent::FETCH_TYPE_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

Overrides

Cake\Database\Statement\StatementDecorator::fetchAll()

Methods inherited from Cake\Database\Statement\StatementDecorator

__get()source public

__get( string $property )

Magic getter to return $queryString as read-only.

Parameters

string $property
internal property to get

Returns

mixed

bind()source 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()

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

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

Implementation of

Cake\Database\StatementInterface::columnCount()

count()source public

count( )

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

Returns

integer

Implementation of

Cake\Database\StatementInterface::count()

errorCode()source public

errorCode( )

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

Returns

integer|string

Implementation of

Cake\Database\StatementInterface::errorCode()

errorInfo()source public

errorInfo( )

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

Returns

array

Implementation of

Cake\Database\StatementInterface::errorInfo()

execute()source 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()

fetchAssoc()source public

fetchAssoc( )

Returns the next row in a result set as an associative array. Calling this function is the same as calling $statement->fetch(StatementDecorator::FETCH_TYPE_ASSOC). If no results are found false is returned.

Returns

array
Result array containing columns and values an an associative array or an empty array if no results

fetchColumn()source public

fetchColumn( integer $position )

Returns the value of the result at position.

Parameters

integer $position
The numeric position of the column to retrieve in the result

Returns

mixed|false
Returns the specific value of the column designated at $position

getInnerStatement()source public

getInnerStatement( )

Returns the statement object that was decorated by this class.

Returns

Cake\Database\StatementInterface|PDOStatement

getIterator()source 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

Cake\Database\StatementInterface|PDOStatement

Implementation of

IteratorAggregate::getIterator()

lastInsertId()source 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|integer

Implementation of

Cake\Database\StatementInterface::lastInsertId()

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

Implementation of

Cake\Database\StatementInterface::rowCount()

Methods used from Cake\Database\TypeConverterTrait

cast()source 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

matchTypes()source 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

© 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.8/class-Cake.Database.Statement.PDOStatement.html