W3cubDocs

/CakePHP 3.4

Trait PDODriverTrait

PDO driver trait

Direct Users

Properties summary

Method Summary

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

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

Method Detail

_connect()source protected

_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

beginTransaction( )

Starts a transaction

Returns

boolean
true on success, false otherwise

commitTransaction()source public

commitTransaction( )

Commits a transaction

Returns

boolean
true on success, false otherwise

connection()source public

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

disconnect( )

Disconnects from database server

isConnected()source public

isConnected( )

Checks whether or not the driver is connected.

Returns

boolean

lastInsertId()source public

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

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

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

rollbackTransaction( )

Rollback a transaction

Returns

boolean
true on success, false otherwise

supportsQuoting()source public

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.

null

© 2005–2017 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.4/class-Cake.Database.Driver.PDODriverTrait.html