Interface ConnectionInterface
This interface defines the methods you can depend on in a connection.
Direct Implementers
Method Summary
-
config() public
Get the configuration data used to create the connection. -
configName() public
Get the configuration name for this connection. -
disableConstraints() public
Run an operation with constraints disabled. -
logQueries() public
Enables or disables query logging for this connection. -
logger() public
Sets the logger object instance. When called with no arguments it returns the currently setup logger instance.
-
transactional() public
Executes a callable function inside a transaction, if any exception occurs while executing the passed callable, the transaction will be rolled back If the result of the callable function is
false, the transaction will also be rolled back. Otherwise the transaction is committed after executing the callback.
Method Detail
disableConstraints() public ¶
disableConstraints( callable $operation )
Run an operation with constraints disabled.
Constraints should be re-enabled after the callback succeeds/fails.
Parameters
- callable $operation
- The callback to execute within a transaction.
Returns
The return value of the callback.
Throws
Will re-throw any exception raised in $callback after rolling back the transaction.
logQueries() public ¶
logQueries( boolean|null $enable null )
Enables or disables query logging for this connection.
Parameters
- boolean|null $enable optional null
whether to turn logging on or disable it. Use null to read current value.
Returns
logger() public ¶
logger( object|null $instance null )
Sets the logger object instance. When called with no arguments it returns the currently setup logger instance.
Deprecated
Parameters
- object|null $instance optional null
- logger object instance
Returns
logger instance
transactional() public ¶
transactional( callable $transaction )
Executes a callable function inside a transaction, if any exception occurs
while executing the passed callable, the transaction will be rolled back
If the result of the callable function is false, the transaction will
also be rolled back. Otherwise the transaction is committed after executing
the callback.
The callback will receive the connection instance as its first argument.
Parameters
- callable $transaction
- The callback to execute within a transaction.
Returns
The return value of the callback.
Throws
Will re-throw any exception raised in $callback after rolling back the transaction.
Magic methods summary
execute() public ¶
execute( $query , $params , array $types )
getLogger() public ¶
getLogger( )
Get the current logger instance
Returns
getSchemaCollection() public ¶
getSchemaCollection( )
Returns
isQueryLoggingEnabled() public ¶
isQueryLoggingEnabled( )
Returns
newQuery() public ¶
newQuery( )
Returns
prepare() public ¶
prepare( $sql )
quote() public ¶
quote( $value , $type )
Parameters
- $value
- $type optional
Returns
supportsDynamicConstraints() public ¶
supportsDynamicConstraints( )