Class Connection

MvcCore\Ext\Models\Db\Connection implements MvcCore\Model\IConstants, MvcCore\Ext\Models\Db\IConnection

Direct known subclasses

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/Connection.php

Methods summary
`public static array`	# `GetAvailableDrivers( )` Returns array Inheritdocs Implementation of `MvcCore\Ext\Models\Db\IConnection::GetAvailableDrivers()`
`public`	# `__construct( string $dsn, string $username = NULL, string $password = NULL, array $options = [] )` Creates a PDO instance representing a connection to a database. Creates a PDO instance representing a connection to a database. Parameters `$dsn` `$username` `$password` `$options` Throws `Throwable` Implementation of `MvcCore\Ext\Models\Db\IConnection::__construct()`
`public MvcCore\Ext\Models\Db\Statement`	# `Prepare( string\|string[] $sql, array $driverOptions = [\MvcCore\Ext\Models\Db\IStatement::AUTO_CLOSE] )` Parameters `$sql` $statement `$driverOptions` Returns `MvcCore\Ext\Models\Db\Statement` Throws `Throwable` Inheritdocs Implementation of `MvcCore\Ext\Models\Db\IConnection::Prepare()`
`public MvcCore\Ext\Models\Db\Statement`	# `Query( string\|string[] $sql, $connectionIndexOrName = NULL )` Parameters `$sql` `$connectionIndexOrName` Returns `MvcCore\Ext\Models\Db\Statement` Throws `Throwable` Inheritdocs Implementation of `MvcCore\Ext\Models\Db\IConnection::Query()`
`public MvcCore\Ext\Models\Db\Readers\Execution`	# `Execute( string\|string[] $sql, $connectionIndexOrName = NULL )` Parameters `$sql` `$connectionIndexOrName` Returns `MvcCore\Ext\Models\Db\Readers\Execution` Throws `Throwable` Inheritdocs Implementation of `MvcCore\Ext\Models\Db\IConnection::Execute()`
`public integer\|float\|string\|null`	# `LastInsertId( string\|null $sequenceName = NULL, string\|null $targetType = NULL )` Parameters `$sequenceName` `$targetType` Returns integer\|float\|string\|null Inheritdocs Implementation of `MvcCore\Ext\Models\Db\IConnection::LastInsertId()`
`public string`	# `Quote( string $string, integer $paramType = \PDO::PARAM_STR )` Parameters `$string` `$paramType` $parameter_type Returns string Inheritdocs Implementation of `MvcCore\Ext\Models\Db\IConnection::Quote()`
`public string`	# `QuoteName( string $identifierName )` Parameters `$identifierName` Returns string Inheritdocs Implementation of `MvcCore\Ext\Models\Db\IConnection::QuoteName()`
`public mixed`	# `GetAttribute( integer $attribute )` Parameters `$attribute` Returns mixed Inheritdocs Implementation of `MvcCore\Ext\Models\Db\IConnection::GetAttribute()`
`public boolean`	# `SetAttribute( integer $attribute, mixed $value )` Parameters `$attribute` `$value` Returns boolean Inheritdocs Implementation of `MvcCore\Ext\Models\Db\IConnection::SetAttribute()`
`public null\|string`	# `GetVersion( )` Returns null\|string Inheritdocs Implementation of `MvcCore\Ext\Models\Db\IConnection::GetVersion()`
`public boolean\|null`	# `IsMutliStatements( )` Returns boolean\|null Inheritdocs Implementation of `MvcCore\Ext\Models\Db\IConnection::IsMutliStatements()`
`public PDO`	# `GetProvider( )` Returns PDO Inheritdocs Implementation of `MvcCore\Ext\Models\Db\IConnection::GetProvider()`
`public array`	# `GetConfig( )` Returns array Inheritdocs Implementation of `MvcCore\Ext\Models\Db\IConnection::GetConfig()`
`public boolean`	# `InTransaction( )` Returns boolean Inheritdocs Implementation of `MvcCore\Ext\Models\Db\IConnection::InTransaction()`
`public boolean`	# `BeginTransaction( integer $flags = 0, string $name = NULL )` Parameters `$flags` `$name` Returns boolean Throws PDOException\|RuntimeException Inheritdocs Implementation of `MvcCore\Ext\Models\Db\IConnection::BeginTransaction()`
`public boolean`	# `Commit( integer $flags = 0 )` Parameters `$flags` Returns boolean Throws PDOException Inheritdocs Implementation of `MvcCore\Ext\Models\Db\IConnection::Commit()`
`public boolean`	# `RollBack( integer $flags = 0 )` Parameters `$flags` Returns boolean Inheritdocs
`protected PDO`	# `connect( )` Connect into database with `\PDO` provider with possibly configured retries. Connect into database with `\PDO` provider with possibly configured retries. Returns PDO PDO
`protected`	# `setUpConnectionSpecifics( )` Set up connection specific properties depends on this driver. Set up connection specific properties depends on this driver.
`protected boolean`	# `isConnectionLost( Throwable $e )` Check if given exception is about connection lost. Check if given exception is about connection lost. Parameters `$e` Returns boolean
`protected MvcCore\Ext\Models\Db\Statement\|MvcCore\Ext\Models\Db\Readers\Execution`	# `providerInvoke( string $method, array $args, boolean $executeProvider = FALSE, boolean $returnReader = FALSE )` Try to invoke methods `prepare()` or `query()` or `exec()` on internal `\PDO` provider instance and if there has been any exception or any error thrown with message like: `... server has gone away ...`, try to reconnect from PHP and try to process given method with arguments again by configured retry count. Try to invoke methods `prepare()` or `query()` or `exec()` on internal `\PDO` provider instance and if there has been any exception or any error thrown with message like: `... server has gone away ...`, try to reconnect from PHP and try to process given method with arguments again by configured retry count. Parameters `$method` `$args` `$executeProvider` `$returnReader` Returns `MvcCore\Ext\Models\Db\Statement`\|`MvcCore\Ext\Models\Db\Readers\Execution` Throws `Throwable`
`protected`	# `handleError( Throwable $error )` Log given exception and print query with params on development. Log given exception and print query with params on development. Parameters `$error` Throws `Throwable`
`protected array`	# `devDumpQueryWithParams( string $query, array $params )` Replace all params in query to dump query with values on development env. Return array with success boolean and replaced query. Replace all params in query to dump query with values on development env. Return array with success boolean and replaced query. Parameters `$query` `$params` Returns array
`protected PDO\|null`	# `reConnectIfNecessaryOrThrownError( Throwable $e )` Try to reconnect, if connection has been lost. Try to reconnect, if connection has been lost. Parameters `$e` Returns PDO\|null Throws `Throwable`

Methods inherited from MvcCore\Ext\Models\Db\IConnection
`Rollback()`

Constants inherited from MvcCore\Model\IConstants
`PROPS_CONVERT_CAMELCASE_TO_PASCALCASE, PROPS_CONVERT_CAMELCASE_TO_UNDERSCORES, PROPS_CONVERT_CASE_INSENSITIVE, PROPS_CONVERT_PASCALCASE_TO_CAMELCASE, PROPS_CONVERT_PASCALCASE_TO_UNDERSCORES, PROPS_CONVERT_UNDERSCORES_TO_CAMELCASE, PROPS_CONVERT_UNDERSCORES_TO_PASCALCASE, PROPS_INHERIT, PROPS_INITIAL_VALUES, PROPS_NAMES_BY_CODE, PROPS_NAMES_BY_DATABASE, PROPS_PRIVATE, PROPS_PROTECTED, PROPS_PUBLIC`

Properties summary
`protected PDO`	`$provider` `\PDO` connection provider instance. `\PDO` connection provider instance.	# `NULL`
`protected string`	`$dsn` PDO driver specific connection string (it may contains crendentials in come cases). PDO driver specific connection string (it may contains crendentials in come cases).	#
`protected string`	`$username` Connection user name, always not used in file databases without authentication. Connection user name, always not used in file databases without authentication.	#
`protected string`	`$password` Database password, it's stored in memory all the time for reconnection purposes. Database password, it's stored in memory all the time for reconnection purposes.	#
`protected array`	`$options` `\PDO` constructor connection options. `\PDO` constructor connection options.	#
`protected boolean`	`$multiStatements` `TRUE` for multi statements connection type. `TRUE` for multi statements connection type. See https://stackoverflow.com/questions/38305108/disable-multiple-statements-in-php-pdo	# `FALSE`
`protected string\|null`	`$version` Database server version in "PHP-standardized" version number string. Database server version in "PHP-standardized" version number string.	# `NULL`
`protected boolean`	`$inTransaction` Boolean about if current connection is inside transaction or not. Boolean about if current connection is inside transaction or not.	# `FALSE`
`protected string`	`$transactionName` If current connection is inside transaction, this could contains current transaction name, else it's `NULL`. If current connection is inside transaction, this could contains current transaction name, else it's `NULL`.	# `NULL`
`protected integer\|null`	`$retryAttemptsTotal` Retry attemps total count to reconnect by system configuration (if implemented). Retry attemps total count to reconnect by system configuration (if implemented).	# `NULL`
`protected integer`	`$retryAttempts` Retry attemps counter. Retry attemps counter.	# `0`
`protected float`	`$retryDelay` Delay to wait before next reconnect in seconds, it coulds contain miliseconds after decimal point. Delay to wait before next reconnect in seconds, it coulds contain miliseconds after decimal point.	# `0`

Classes

Interfaces

Traits

Exceptions

Functions

Class Connection

Direct known subclasses

Returns

Inheritdocs

Implementation of

Parameters

Throws

Implementation of

Parameters

Returns

Throws

Inheritdocs

Implementation of

Parameters

Returns

Throws

Inheritdocs

Implementation of

Parameters

Returns

Throws

Inheritdocs

Implementation of

Parameters

Returns

Inheritdocs

Implementation of

Parameters

Returns

Inheritdocs

Implementation of

Parameters

Returns

Inheritdocs

Implementation of

Parameters

Returns

Inheritdocs

Implementation of

Parameters

Returns

Inheritdocs

Implementation of

Returns

Inheritdocs

Implementation of

Returns

Inheritdocs

Implementation of

Returns

Inheritdocs

Implementation of

Returns

Inheritdocs

Implementation of

Returns

Inheritdocs

Implementation of

Parameters

Returns

Throws

Inheritdocs

Implementation of

Parameters

Returns

Throws

Inheritdocs

Implementation of

Parameters

Returns

Inheritdocs

Returns

Parameters

Returns

Parameters