$_config
$_config : array
Configuration sets.
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
$_registry : \Cake\Datasource\ConnectionRegistry
The ConnectionRegistry used by the manager.
setConfig(string|array $key, array|null $config = null) : void
Configure a new connection object.
The connection will not be constructed until it is first used.
| string|array | $key | The name of the connection config, or an array of multiple configs. |
| array|null | $config | An array of name => config data for adapter. |
When trying to modify an existing config.
config(string|array $key, array|null $config = null) : array|null
This 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.
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);| string|array | $key | The name of the configuration, or an array of multiple configs. |
| array|null | $config | An array of name => configuration data for adapter. |
When trying to modify an existing config.
Null when adding configuration or an array of configuration data when reading.
drop(string $config) : boolean
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.
| string | $config | An existing configuration you wish to remove. |
Success of the removal, returns false when the config does not exist.
parseDsn(string|null $config = null) : array
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.
| string|null | $config | The DSN string to convert to a configuration array |
The configuration array to be stored after parsing the DSN
alias(string $alias, string $source) : void
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().
// Make 'things' resolve to 'test_things' connection
ConnectionManager::alias('test_things', 'things');| string | $alias | The alias to add. Fetching $source will return $alias when loaded with get. |
| string | $source | The connection to add an alias to. |
When aliasing a connection that does not exist.
get(string $name, boolean $useAliases = true) : \Cake\Datasource\ConnectionInterface
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.
| string | $name | The connection name. |
| boolean | $useAliases | Set to false to not use aliased connections. |
When config data is missing.
A connection object.
Loading…