Trait PDODriverTrait

PDO driver trait

Namespace: Cake\Database\Driver
Deprecated: 3.6.0 The methods of this trait have been added to Driver class.
Location: Database/Driver/PDODriverTrait.php

Properties summary

Method Summary

  • _connect() protected deprecated
    Establishes a connection to the database server
  • beginTransaction() public deprecated
    Starts a transaction
  • commitTransaction() public deprecated
    Commits a transaction
  • connection() public deprecated

    Returns correct connection resource or object that is internally used If first argument is passed, it will set internal connection object or result to the value passed

  • disconnect() public deprecated
    Disconnects from database server
  • isConnected() public deprecated
    Checks whether or not the driver is connected.
  • lastInsertId() public deprecated
    Returns last id generated for a table or sequence in database
  • prepare() public deprecated
    Prepares a sql statement to be executed
  • quote() public deprecated
    Returns a value in a safe representation to be used in a query string
  • rollbackTransaction() public deprecated
    Rollback a transaction
  • supportsQuoting() public deprecated
    Checks if the driver supports quoting, as PDO_ODBC does not support it.

Method Detail

_connect()source protected deprecated 

_connect( string $dsn , array $config )

Establishes a connection to the database server

Parameters

string $dsn
A Driver-specific PDO-DSN
array $config
configuration to be used for creating connection

Returns

boolean
true on success

beginTransaction()source public deprecated 

beginTransaction( )

Starts a transaction

Returns

boolean
true on success, false otherwise

commitTransaction()source public deprecated 

commitTransaction( )

Commits a transaction

Returns

boolean
true on success, false otherwise

connection()source public deprecated 

connection( null|PDO $connection = null )

Returns correct connection resource or object that is internally used If first argument is passed, it will set internal connection object or result to the value passed

Parameters

null|PDO $connection optional null
The PDO connection instance.

Returns

PDO
connection object used internally

disconnect()source public deprecated 

disconnect( )

Disconnects from database server

isConnected()source public deprecated 

isConnected( )

Checks whether or not the driver is connected.

Returns

boolean

lastInsertId()source public deprecated 

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

Returns last id generated for a table or sequence in database

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

prepare()source public deprecated 

prepare( string|Cake\Database\Query $query )

Prepares a sql statement to be executed

Parameters

string|Cake\Database\Query $query
The query to turn into a prepared statement.

Returns

Cake\Database\StatementInterface

quote()source public deprecated 

quote( mixed $value , string $type )

Returns a value in a safe representation to be used in a query string

Parameters

mixed $value
The value to quote.
string $type
Type to be used for determining kind of quoting to perform

Returns

string

rollbackTransaction()source public deprecated 

rollbackTransaction( )

Rollback a transaction

Returns

boolean
true on success, false otherwise

supportsQuoting()source public deprecated 

supportsQuoting( )

Checks if the driver supports quoting, as PDO_ODBC does not support it.

Returns

boolean

Properties detail

$_connectionsource

protected PDO|null

Instance of PDO.

© 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.Driver.PDODriverTrait.html