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

Namespace: Cake\Datasource

Properties summary

  • $_aliasMap protected static
    string[]

    A map of connection aliases.

  • $_config protected static
    array

    Configuration sets.

  • $_dsnClassMap protected static
    string[]

    An array mapping url schemes to fully qualified driver class names

  • $_registry protected static
    \Cake\Datasource\ConnectionRegistry

    The ConnectionRegistry used by the manager.

Method Summary

  • alias() public static

    Set one or more connection aliases.

  • configured() public static

    Returns an array containing the named configurations

  • drop() public static

    Drops a constructed adapter.

  • dropAlias() public static

    Drop an alias.

  • 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)

Set 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.

Throws

Cake\Datasource\Exception\MissingDatasourceConfigException
When aliasing a connection that does not exist.

configured() public static 

configured()

Returns an array containing the named configurations

Returns

string[]

Array of configurations.

drop() public static 

drop(string $config)

Drops 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

bool

Success of the removal, returns false when the config does not exist.

dropAlias() public static 

dropAlias(string $name)

Drop 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.

get() public static 

get(string $name, bool $useAliases)

Get 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\ConnectionInterface

A connection object.

Throws

Cake\Datasource\Exception\MissingDatasourceConfigException
When config data is missing.

getConfig() public static 

getConfig(string $key)

Reads existing configuration.

Parameters

string $key

The name of the configuration.

Returns

mixed|null

Configuration data at the named key or null if the key does not exist.

getConfigOrFail() public static 

getConfigOrFail(string $key)

Reads existing configuration for a specific key.

The config value for this key must exist, it can never be null.

Parameters

string $key

The name of the configuration.

Returns

mixed

Configuration data at the named key.

Throws

InvalidArgumentException
If value does not exist.

getDsnClassMap() public static 

getDsnClassMap()

Returns the DSN class map for this class.

Returns

string[]

parseDsn() public static 

parseDsn(string $config)

Parses 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 $config

The DSN string to convert to a configuration array

Returns

array

The configuration array to be stored after parsing the DSN

setConfig() public static 

setConfig(mixed $key, mixed $config)

Configure 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|null $config optional

An array of name => config data for adapter.

Throws

Cake\Core\Exception\Exception
When trying to modify an existing config.

See Also

\Cake\Core\StaticConfigTrait::config()

setDsnClassMap() public static 

setDsnClassMap(array $map)

Updates the DSN class map for this class.

Parameters

string[] $map

Additions/edits to the class map to apply.

Property Detail

$_aliasMap protected static

A map of connection aliases.

Type

string[]

$_config protected static

Configuration sets.

Type

array

$_dsnClassMap protected static

An array mapping url schemes to fully qualified driver class names

Type

string[]

$_registry protected static

The ConnectionRegistry used by the manager.

Type

\Cake\Datasource\ConnectionRegistry

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Datasource.ConnectionManager.html