| Property | Type | Description | |
|---|---|---|---|
| $_adapters | Libraries::locate() compatible path to adapters for this class. | ||
| $_configurations | `lithium\util\Collection` | A Collection of the configurations you add through Connections::add(). |
| Method | Description | |
|---|---|---|
| add ( string $name, array $config = [] ) : array | Add connection configurations to your app in config/bootstrap/connections.php | |
| get ( string $name = null, array $options = [] ) : mixed | Read the configuration or access the connections you have set up. | |
| remove ( string $name ) | Removing a configuration. |
| Method | Description | |
|---|---|---|
| _class ( array $config, array $paths = [] ) : object | Constructs a data source or adapter object instance from a configuration array. |
| public static add ( string $name, array $config = [] ) : array | ||
| $name | string | The name by which this connection is referenced. Use this name to retrieve the connection again using `Connections::get()`, or to bind a model to it using `Model::$_meta['connection']`. |
| $config | array | Contains all additional configuration information used by the connection, including the name of the adapter class where applicable (i.e. `MySql`), the server name and port or socket to connect to, and (typically) the name of the database or other entity to use. Each adapter has its own specific configuration settings for handling things like connection persistence, data encoding, etc. See the individual adapter or data source class for more information on what configuration settings it supports. Basic / required options supported by most adapters: - `'type'` _string_: The type of data source that defines this connection; typically a class or namespace name. Relational database data sources, use `'database'`, while CouchDB and other HTTP-related data sources use `'http'`, etc. For classes which directly extend `lithium\data\Source`, and do not use an adapter, simply use the name of the class, i.e. `'MongoDb'`. - `'adapter'` _string_: For `type`s such as `'database'` which are adapter-driven, provides the name of the adapter associated with this configuration. - `'host'` _string_: The host name that the database should connect to. Typically defaults to `'localhost'`. - `'login'` _string_: If the connection requires authentication, specifies the login name to use. - `'password'` _string_: If the connection requires authentication, specifies the password to use. |
| return | array | Returns the final post-processed connection information, as stored in the internal configuration array used by `Connections`. |
| public static get ( string $name = null, array $options = [] ) : mixed | ||
| $name | string | The name of the connection to get, as defined in the first parameter of `add()`, when the connection was initially created. |
| $options | array | Options to use when returning the connection: - `'autoCreate'`: If `false`, the connection object is only returned if it has already been instantiated by a previous call. - `'config'`: If `true`, returns an array representing the connection's internal configuration, instead of the connection itself. |
| return | mixed | A configured instance of the connection, or an array of the configuration used. |
| protected static $_adapters |
