SetaFramework API Reference

Index

\com\setasign\SetaFramework
1. Database

com\setasign\SetaFramework\Database

DatabaseConnectionManager

File: /SetaFramework/src/Database/DatabaseConnectionManager.php

Class hierarchy

DatabaseConnectionManager

Summary

Methods

__construct()
closeAllConnections()
closeConnection()
getConnection()
getConnectionByApplicationConfig()
getConnectionConfig()

Properties

$config
$connections
$logHandler

Properties

$config

private \com\setasign\SetaFramework\Config\Config DatabaseConnectionManager::$config

$connections

private Database[] DatabaseConnectionManager::$connections = array()

$logHandler

private \com\setasign\SetaFramework\Log\LogHandler DatabaseConnectionManager::$logHandler

Methods

__construct()

public DatabaseConnectionManager::__construct (

\com\setasign\SetaFramework\Log\LogHandler $logHandler,
?\com\setasign\SetaFramework\Config\Config $config

)

DatabaseConnectionManager constructor.

Parameters

$logHandler : \com\setasign\SetaFramework\Log\LogHandler
$config : ?\com\setasign\SetaFramework\Config\Config

closeAllConnections()

public DatabaseConnectionManager::closeAllConnections (

void

): void

Close all known connections. Like closeConnection() technically this method doesn't close the connections.

See

DatabaseConnectionManager::closeConnection()

closeConnection()

public DatabaseConnectionManager::closeConnection (

string $identifier = 'default'

): void

Close the connection with the given identifier.

If the identifier is unknown nothing will happen.

Technically this method will NOT close the connection but just forget about the connection - if the instance is referenced somewhere else the connection will still remain but the next call to getConnection() will create a new connection.

Parameters

$identifier : string

getConnection()

public DatabaseConnectionManager::getConnection (

string $identifier = 'default'

Parameters

$identifier : string

Exceptions

Throws \com\setasign\SetaFramework\InvalidConfigurationException If identifier cannot be found or the configuration is invalid.

Throws ConnectionException

getConnectionByApplicationConfig()

public DatabaseConnectionManager::getConnectionByApplicationConfig (

\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig

Parameters

$applicationConfig : \com\setasign\SetaFramework\Application\ApplicationConfig

Exceptions

Throws ConnectionException

getConnectionConfig()

public DatabaseConnectionManager::getConnectionConfig (

string $identifier = 'default'

): \com\setasign\SetaFramework\Config\Config

Parameters

$identifier : string