Class Driver
Represents a database driver containing all specificities for a database engine including its SQL dialect.
Properties summary
- $_autoQuoting protected
bool
Indicates whether or not the driver is doing automatic identifier quoting for all queries
- $_baseConfig protected
array
Base configuration that is merged into the user supplied configuration data.
- $_config protected
array
Configuration data.
- $_connection protected
\PDO|null
Instance of PDO.
Method Summary
- __debugInfo() public
Returns an array that can be used to describe the internal state of this object.
- autoQuoting() public
Returns whether or not this driver should automatically quote identifiers in queries
- compileQuery() public
Transforms the passed query to this Driver's dialect and returns an instance of the transformed query and the full compiled SQL string.
- 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.
- enableAutoQuoting() public
Sets whether or not this driver should automatically quote identifiers in queries.
- enabled() abstract public
Returns whether php is able to use this driver for connecting to database.
- isAutoQuotingEnabled() public
Returns whether or not this driver should automatically quote identifiers in queries.
- queryTranslator() abstract public
Returns a callable function that will be used to transform a passed Query object.
- quoteIdentifier() abstract public
Quotes a database identifier (a column name, table name, etc..) to be used safely in queries without the risk of using reserved words.
- supportsDynamicConstraints() abstract public
Returns whether the driver supports adding or dropping constraints to already created tables.
- supportsSavePoints() public
Returns whether this driver supports save points for nested transactions.
Method Detail
__construct() public
__construct(mixed $config)
Constructor
Parameters
-
array
$config optional The configuration for the driver.
Throws
InvalidArgumentException
__debugInfo() public
__debugInfo()
Returns an array that can be used to describe the internal state of this object.
Returns
array
__destruct() public
__destruct()
Destructor
_connect() protected
_connect(mixed $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
bool
true on success
autoQuoting() public
autoQuoting(mixed $enable)
Returns whether or not this driver should automatically quote identifiers in queries
If called with a boolean argument, it will toggle the auto quoting setting to the passed value
Parameters
-
bool|null
$enable optional Whether to enable auto quoting
Returns
bool
beginTransaction() public
beginTransaction()
Starts a transaction.
Returns
bool
True on success, false otherwise.
commitTransaction() public
commitTransaction()
Commits a transaction.
Returns
bool
True on success, false otherwise.
compileQuery() public
compileQuery(\Cake\Database\Query $query, \Cake\Database\ValueBinder $generator)
Transforms the passed query to this Driver's dialect and returns an instance of the transformed query and the full compiled SQL string.
Parameters
-
\Cake\Database\Query
$query The query to compile.
-
\Cake\Database\ValueBinder
$generator The value binder to use.
Returns
array
containing 2 entries. The first entity is the transformed query and the second one the compiled SQL.
connect() abstract public
connect()
Establishes a connection to the database server.
Returns
bool
True on success, false on failure.
connection() public
connection(mixed $connection)
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
-
mixed
$connection optional The PDO connection instance.
Returns
mixed
Connection object used internally.
disableAutoQuoting() public
disableAutoQuoting()
Disable auto quoting of identifiers in queries.
Returns
$this
disableForeignKeySQL() abstract public
disableForeignKeySQL()
Get the SQL for disabling foreign keys.
Returns
string
disconnect() public
disconnect()
Disconnects from database server.
enableAutoQuoting() public
enableAutoQuoting(mixed $enable)
Sets whether or not this driver should automatically quote identifiers in queries.
Parameters
-
bool
$enable optional Whether to enable auto quoting
Returns
$this
enableForeignKeySQL() abstract public
enableForeignKeySQL()
Get the SQL for enabling foreign keys.
Returns
string
enabled() abstract public
enabled()
Returns whether php is able to use this driver for connecting to database.
Returns
bool
True if it is valid to use this driver.
getConnection() public
getConnection()
Get the internal PDO connection instance.
Returns
\PDO
isAutoQuotingEnabled() public
isAutoQuotingEnabled()
Returns whether or not this driver should automatically quote identifiers in queries.
Returns
bool
isConnected() public
isConnected()
Checks whether or not the driver is connected.
Returns
bool
lastInsertId() public
lastInsertId(mixed $table, mixed $column)
Returns last id generated for a table or sequence in database.
Parameters
-
string|null
$table optional table name or sequence to get last insert value from.
-
string|null
$column optional the name of the column representing the primary key.
Returns
string|int
newCompiler() public
newCompiler()
Returns an instance of a QueryCompiler.
Returns
\Cake\Database\QueryCompiler
newTableSchema() public
newTableSchema(mixed $table, array $columns)
Constructs new TableSchema.
Parameters
-
string
$table The table name.
-
array
$columns optional The list of columns for the schema.
Returns
\Cake\Database\Schema\TableSchemaInterface
prepare() public
prepare(mixed $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
queryTranslator() abstract public
queryTranslator(mixed $type)
Returns a callable function that will be used to transform a passed Query object.
This function, in turn, will return an instance of a Query object that has been transformed to accommodate any specificities of the SQL dialect in use.
Parameters
-
string
$type The type of query to be transformed (select, insert, update, delete).
Returns
callable
quote() public
quote(mixed $value, mixed $type)
Returns a value in a safe representation to be used in a query string
Parameters
-
mixed
$value The value to quote.
-
int
$type Type to be used for determining kind of quoting to perform.
Returns
string
quoteIdentifier() abstract public
quoteIdentifier(mixed $identifier)
Quotes a database identifier (a column name, table name, etc..) to be used safely in queries without the risk of using reserved words.
Parameters
-
string
$identifier The identifier expression to quote.
Returns
string
releaseSavePointSQL() abstract public
releaseSavePointSQL(mixed $name)
Get the SQL for releasing a save point.
Parameters
-
string|int
$name The table name.
Returns
string
rollbackSavePointSQL() abstract public
rollbackSavePointSQL(mixed $name)
Get the SQL for rollingback a save point.
Parameters
-
string|int
$name The table name.
Returns
string
rollbackTransaction() public
rollbackTransaction()
Rollbacks a transaction.
Returns
bool
True on success, false otherwise.
savePointSQL() abstract public
savePointSQL(mixed $name)
Get the SQL for creating a save point.
Parameters
-
string|int
$name The table name.
Returns
string
schema() public
schema()
Returns the schema name that's being used.
Returns
string
schemaDialect() abstract public
schemaDialect()
Get the schema dialect.
Used by Cake\Database\Schema package to reflect schema and generate schema.
If all the tables that use this Driver specify their own schemas, then this may return null.
Returns
\Cake\Database\Schema\BaseSchema
schemaValue() public
schemaValue(mixed $value)
Escapes values for use in schema definitions.
Parameters
-
mixed
$value The value to escape.
Returns
string
String for use in schema definitions.
setConnection() public
setConnection(mixed $connection)
Set the internal PDO connection instance.
Parameters
-
\PDO
$connection PDO instance.
Returns
$this
supportsDynamicConstraints() abstract public
supportsDynamicConstraints()
Returns whether the driver supports adding or dropping constraints to already created tables.
Returns
bool
True if driver supports dynamic constraints.
supportsQuoting() public
supportsQuoting()
Checks if the driver supports quoting, as PDO_ODBC does not support it.
Returns
bool
supportsSavePoints() public
supportsSavePoints()
Returns whether this driver supports save points for nested transactions.
Returns
bool
True if save points are supported, false otherwise.
Property Detail
$_autoQuoting protected
Indicates whether or not the driver is doing automatic identifier quoting for all queries
Type
bool
$_baseConfig protected
Base configuration that is merged into the user supplied configuration data.
Type
array
$_config protected
Configuration data.
Type
array
$_connection protected
Instance of PDO.
Type
\PDO|null
© 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.9/class-Cake.Database.Driver.html