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
string[]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 deprecated
This method can be used to define configuration adapters for an application or read existing configuration.
-
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 deprecated
Returns or updates the DSN class map for this class.
-
get() public static
Get a connection.
-
getConfig() public static
Reads existing configuration.
-
getConfigOrFail() public static
Reads existing configuration for a specific key.
-
getDsnClassMap() public static
Returns the DSN class map for this class.
-
parseDsn() public static
Parses a DSN into a valid connection configuration
-
setConfig() public static
Configure a new connection object.
-
setDsnClassMap() public static
Updates the DSN class map for this class.
Method Detail
alias() ¶ public static
alias(string $alias, string $source): 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 test-suite 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().
Usage
// Make 'things' resolve to 'test_things' connection
ConnectionManager::alias('test_things', 'things');Parameters
-
string$alias The alias to add. Fetching $source will return $alias when loaded with get.
-
string$source The connection to add an alias to.
Returns
voidThrows
Cake\Datasource\Exception\MissingDatasourceConfigExceptionWhen aliasing a connection that does not exist.
config() ¶ public static
config(string|array $key, array|null $config = null): array|nullThis method can be used to define configuration adapters for an application or read existing configuration.
To change an adapter's configuration at runtime, first drop the adapter and then reconfigure it.
Adapters will not be constructed until the first operation is done.
Usage
Assuming that the class' name is Cache the following scenarios
are supported:
Reading config data back:
Cache::config('default');Setting a cache engine up.
Cache::config('default', $settings);Injecting a constructed adapter in:
Cache::config('default', $instance);Configure multiple adapters at once:
Cache::config($arrayOfConfig);Parameters
-
string|array$key The name of the configuration, or an array of multiple configs.
-
array|null$config optional An array of name => configuration data for adapter.
Returns
array|nullNull when adding configuration or an array of configuration data when reading.
Throws
BadMethodCallExceptionWhen trying to modify an existing config.
configured() ¶ public static
configured(): string[]Returns an array containing the named configurations
Returns
string[]Array 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(string[]|null $map = null): string[]Returns or updates the DSN class map for this class.
Parameters
-
string[]|null$map optional Additions/edits to the class map to apply.
Returns
string[]get() ¶ public static
get(string $name, bool $useAliases = true): Cake\Datasource\ConnectionInterfaceGet 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\Datasource\ConnectionInterfaceA connection object.
Throws
Cake\Datasource\Exception\MissingDatasourceConfigExceptionWhen config data is missing.
getConfig() ¶ public static
getConfig(string $key): mixed|nullReads existing configuration.
Parameters
-
string$key The name of the configuration.
Returns
mixed|nullConfiguration data at the named key or null if the key does not exist.
getConfigOrFail() ¶ public static
getConfigOrFail(string|null $key): mixedReads existing configuration for a specific key.
The config value for this key must exist, it can never be null.
Parameters
-
string|null$key The name of the configuration.
Returns
mixedConfiguration data at the named key.
Throws
InvalidArgumentExceptionIf value does not exist.
getDsnClassMap() ¶ public static
getDsnClassMap(): string[]Returns the DSN class map for this class.
Returns
string[]parseDsn() ¶ public static
parseDsn(string|null $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 query-string arguments are also parsed and set as values in the returned configuration.
Parameters
-
string|null$config optional The DSN string to convert to a configuration array
Returns
arrayThe configuration array to be stored after parsing the DSN
setConfig() ¶ public static
setConfig(string|array $key, array|object|null $config = null): voidConfigure 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|object|null$config optional An array of name => config data for adapter.
Returns
voidThrows
Cake\Core\Exception\ExceptionWhen trying to modify an existing config.
See Also
setDsnClassMap() ¶ public static
setDsnClassMap(string[] $map): voidUpdates the DSN class map for this class.
Parameters
-
string[]$map Additions/edits to the class map to apply.
Returns
void