Interface IConnection

Direct known implementers

MvcCore\Ext\Models\Db\Connection

Indirect known implementers

MvcCore\Ext\Models\Db\Providers\Connections\MySql, MvcCore\Ext\Models\Db\Providers\Connections\PgSql, MvcCore\Ext\Models\Db\Providers\Connections\SQLite, MvcCore\Ext\Models\Db\Providers\Connections\SqlSrv

Namespace: MvcCore\Ext\Models\Db
Located at ext-model-db/src/MvcCore/Ext/Models/Db/IConnection.php

Methods summary
`public static array`	# `GetAvailableDrivers( )` Return an array of available `\PDO` drivers. Return an array of available `\PDO` drivers. Returns array
`public`	# `__construct( string $dsn, string\|null $username = NULL, string\|null $password = NULL, array $options = [] )` Connect into database by given dsn, credentials and options or thrown an error. Connect into database by given dsn, credentials and options or thrown an error. Parameters `$dsn` `$username` `$password` `$options` Throws `Throwable`
`public MvcCore\Ext\Models\Db\Statement`	# `Prepare( string\|string[] $sql, integer\|string $connectionIndexOrName = NULL )` Prepares a statement for execution and returns a statement object. Prepares a statement for execution and returns a statement object. Parameters `$sql` `$connectionIndexOrName` Returns `MvcCore\Ext\Models\Db\Statement`
`public MvcCore\Ext\Models\Db\Statement`	# `Query( string\|string[] $sql, $connectionIndexOrName = NULL )` Executes an SQL statement and returns a statement object. Executes an SQL statement and returns a statement object. Parameters `$sql` `$connectionIndexOrName` Returns `MvcCore\Ext\Models\Db\Statement` Throws `Throwable`
`public MvcCore\Ext\Models\Db\Readers\Execution`	# `Execute( string\|string[] $sql, $connectionIndexOrName = NULL )` Execute an SQL statement and returns a reader object. Execute an SQL statement and returns a reader object. Parameters `$sql` `$connectionIndexOrName` Returns `MvcCore\Ext\Models\Db\Readers\Execution` Throws `Throwable`
`public integer\|float\|string\|null`	# `LastInsertId( string\|null $sequenceName = NULL, string\|null $targetType = NULL )` Returns the ID of the last inserted row or sequence value. Returns the ID of the last inserted row or sequence value. Parameters `$sequenceName` `$targetType` Returns integer\|float\|string\|null
`public string`	# `Quote( string $string, integer $paramType = \PDO::PARAM_STR )` Quotes a string for use in a query. Quotes a string for use in a query. Parameters `$string` `$paramType` Returns string
`public string`	# `QuoteName( string $identifierName )` Quote database identifier by provider specfic way, usually table or column name. Quote database identifier by provider specfic way, usually table or column name. Parameters `$identifierName` Returns string
`public mixed`	# `GetAttribute( integer $attribute )` Retrieve a `\PDO` database connection attribute. Retrieve a `\PDO` database connection attribute. Parameters `$attribute` Returns mixed
`public boolean`	# `SetAttribute( integer $attribute, mixed $value )` Set a `\PDO` database connection attribute. Set a `\PDO` database connection attribute. Parameters `$attribute` `$value` Returns boolean
`public null\|string`	# `GetVersion( )` Return database server version in "PHP-standardized" version number string. Return database server version in "PHP-standardized" version number string. Returns null\|string
`public boolean\|null`	# `IsMutliStatements( )` Return `TRUE` for multi statements connection type. Return `TRUE` for multi statements connection type. Returns boolean\|null
`public PDO`	# `GetProvider( )` Return internal `\PDO` database connection instance. Return internal `\PDO` database connection instance. Returns PDO
`public array`	# `GetConfig( )` Get `__construct()` function arguments values. Get `__construct()` function arguments values. Returns array
`public boolean`	# `InTransaction( )` Checks if this connection is already inside transaction or not. Checks if this connection is already inside transaction or not. Returns boolean
`public boolean`	# `BeginTransaction( integer $flags = 0, string $name = NULL )` Initiates a transaction. Initiates a transaction. Parameters `$flags` Transaction isolation, read/write mode and more, depends on database driver. `$name` String without spaces to identify transaction in logs. Returns boolean Throws PDOException\|RuntimeException
`public boolean`	# `Commit( integer $flags = 0 )` Commits a transaction. Commits a transaction. Parameters `$flags` Returns boolean Throws PDOException
`public boolean`	# `Rollback( integer $flags = 0 )` Rolls back a transaction. Rolls back a transaction. Parameters `$flags` Returns boolean Throws PDOException