Class ConnectionManager
Manages and loads instances of Connection
Provides an interface to loading and creating connection objects. Acts as a registry for the connections defined in an application.
Provides an interface for loading and enumerating connections defined in config/app.php
Property Summary
-
$_aliasMap protected static
arrayA map of connection aliases.
-
$_config protected static
arrayConfiguration sets.
-
$_dsnClassMap protected static
An array mapping url schemes to fully qualified driver class names
-
$_registry protected static
Cake\Datasource\ConnectionRegistryThe ConnectionRegistry used by the manager.
Method Summary
-
alias() public static
Set one or more connection aliases.
-
config() public static
Configure a new connection object.
-
configured() public static
Returns an array containing the named configurations
-
drop() public static
Drops a constructed adapter.
-
dropAlias() public static
Drop an alias.
-
dsnClassMap() public static
Returns or updates the DSN class map for this class
-
get() public static
Get a connection.
-
parseDsn() public static
Parses a DSN into a valid connection configuration
Method Detail
alias() ¶ public static
alias(string $from, string $to): voidSet one or more connection aliases.
Connection aliases allow you to rename active connections without overwriting the aliased connection. This is most useful in the testsuite for replacing connections with their test variant.
Defined aliases will take precedence over normal connection names. For example, if you alias 'default' to 'test', fetching 'default' will always return the 'test' connection as long as the alias is defined.
You can remove aliases with ConnectionManager::dropAlias().
Parameters
-
string$from The connection to add an alias to.
-
string$to The alias to create. $from should return when loaded with get().
Returns
voidThrows
Cake\Datasource\Exception\MissingDatasourceConfigExceptionWhen aliasing a connection that does not exist.
config() ¶ public static
config(string|array $key, array $config = null): mixedConfigure a new connection object.
The connection will not be constructed until it is first used.
Parameters
-
string|array$key The name of the connection config, or an array of multiple configs.
-
array$config optional An array of name => config data for adapter.
Returns
mixednull when adding configuration and an array of configuration data when reading.
Throws
Cake\Core\Exception\ExceptionWhen trying to modify an existing config.
See Also
configured() ¶ public static
configured(): arrayReturns an array containing the named configurations
Returns
arrayArray of configurations.
drop() ¶ public static
drop(string $config): boolDrops a constructed adapter.
If you wish to modify an existing configuration, you should drop it, change configuration and then re-add it.
If the implementing objects supports a $_registry object the named configuration
will also be unloaded from the registry.
Parameters
-
string$config An existing configuration you wish to remove.
Returns
boolSuccess of the removal, returns false when the config does not exist.
dropAlias() ¶ public static
dropAlias(string $name): voidDrop an alias.
Removes an alias from ConnectionManager. Fetching the aliased connection may fail if there is no other connection with that name.
Parameters
-
string$name The connection name to remove aliases for.
Returns
voiddsnClassMap() ¶ public static
dsnClassMap(array|null $map = null): arrayReturns or updates the DSN class map for this class
Parameters
-
array|null$map optional Additions/edits to the class map to apply
Returns
arrayget() ¶ public static
get(string $name, bool $useAliases = true): Cake\Database\ConnectionGet a connection.
If the connection has not been constructed an instance will be added
to the registry. This method will use any aliases that have been
defined. If you want the original unaliased connections pass FALSE
as second parameter.
Parameters
-
string$name The connection name.
-
bool$useAliases optional Set to false to not use aliased connections.
Returns
Cake\Database\ConnectionA connection object.
Throws
Cake\Datasource\Exception\MissingDatasourceConfigExceptionWhen config data is missing.
parseDsn() ¶ public static
parseDsn(array $config = null): arrayParses a DSN into a valid connection configuration
This method allows setting a DSN using formatting similar to that used by PEAR::DB. The following is an example of its usage:
$dsn = 'mysql://user:pass@localhost/database';
$config = ConnectionManager::parseDsn($dsn);
$dsn = 'Cake\Database\Driver\Mysql://localhost:3306/database?className=Cake\Database\Connection';
$config = ConnectionManager::parseDsn($dsn);
$dsn = 'Cake\Database\Connection://localhost:3306/database?driver=Cake\Database\Driver\Mysql';
$config = ConnectionManager::parseDsn($dsn);For all classes, the value of scheme is set as the value of both the className and driver
unless they have been otherwise specified.
Note that querystring arguments are also parsed and set as values in the returned configuration.
Parameters
-
array$config optional An array with a
urlkey mapping to a string DSN
Returns
arrayThe configuration array to be stored after parsing the DSN