ConnectionFactory
in package
Table of Contents
- $container : Container
- The IoC container instance.
- __construct() : void
- Create a new connection factory instance.
- createConnector() : ConnectorInterface
- Create a connector instance based on the configuration.
- make() : Connection
- Establish a PDO connection based on the configuration.
- createConnection() : Connection
- Create a new connection instance.
- createPdoResolver() : Closure
- Create a new Closure that resolves to a PDO instance.
- createPdoResolverWithHosts() : Closure
- Create a new Closure that resolves to a PDO instance with a specific host or an array of hosts.
- createPdoResolverWithoutHosts() : Closure
- Create a new Closure that resolves to a PDO instance where there is no configured host.
- createReadPdo() : Closure
- Create a new PDO instance for reading.
- createReadWriteConnection() : Connection
- Create a single database connection instance.
- createSingleConnection() : Connection
- Create a single database connection instance.
- getReadConfig() : array<string|int, mixed>
- Get the read configuration for a read / write connection.
- getReadWriteConfig() : array<string|int, mixed>
- Get a read / write level configuration.
- getWriteConfig() : array<string|int, mixed>
- Get the read configuration for a read / write connection.
- mergeReadWriteConfig() : array<string|int, mixed>
- Merge a configuration for a read / write connection.
- parseConfig() : array<string|int, mixed>
- Parse and prepare the database configuration.
- parseHosts() : array<string|int, mixed>
- Parse the hosts configuration item into an array.
Properties
$container
The IoC container instance.
protected
Container
$container
Methods
__construct()
Create a new connection factory instance.
public
__construct(Container $container) : void
Parameters
- $container : Container
Return values
void —createConnector()
Create a connector instance based on the configuration.
public
createConnector(array<string|int, mixed> $config) : ConnectorInterface
Parameters
- $config : array<string|int, mixed>
Tags
Return values
ConnectorInterface —make()
Establish a PDO connection based on the configuration.
public
make(array<string|int, mixed> $config[, string $name = null ]) : Connection
Parameters
- $config : array<string|int, mixed>
- $name : string = null
Return values
Connection —createConnection()
Create a new connection instance.
protected
createConnection(string $driver, PDO|Closure $connection, string $database[, string $prefix = '' ][, array<string|int, mixed> $config = [] ]) : Connection
Parameters
- $driver : string
- $connection : PDO|Closure
- $database : string
- $prefix : string = ''
- $config : array<string|int, mixed> = []
Tags
Return values
Connection —createPdoResolver()
Create a new Closure that resolves to a PDO instance.
protected
createPdoResolver(array<string|int, mixed> $config) : Closure
Parameters
- $config : array<string|int, mixed>
Return values
Closure —createPdoResolverWithHosts()
Create a new Closure that resolves to a PDO instance with a specific host or an array of hosts.
protected
createPdoResolverWithHosts(array<string|int, mixed> $config) : Closure
Parameters
- $config : array<string|int, mixed>
Return values
Closure —createPdoResolverWithoutHosts()
Create a new Closure that resolves to a PDO instance where there is no configured host.
protected
createPdoResolverWithoutHosts(array<string|int, mixed> $config) : Closure
Parameters
- $config : array<string|int, mixed>
Return values
Closure —createReadPdo()
Create a new PDO instance for reading.
protected
createReadPdo(array<string|int, mixed> $config) : Closure
Parameters
- $config : array<string|int, mixed>
Return values
Closure —createReadWriteConnection()
Create a single database connection instance.
protected
createReadWriteConnection(array<string|int, mixed> $config) : Connection
Parameters
- $config : array<string|int, mixed>
Return values
Connection —createSingleConnection()
Create a single database connection instance.
protected
createSingleConnection(array<string|int, mixed> $config) : Connection
Parameters
- $config : array<string|int, mixed>
Return values
Connection —getReadConfig()
Get the read configuration for a read / write connection.
protected
getReadConfig(array<string|int, mixed> $config) : array<string|int, mixed>
Parameters
- $config : array<string|int, mixed>
Return values
array<string|int, mixed> —getReadWriteConfig()
Get a read / write level configuration.
protected
getReadWriteConfig(array<string|int, mixed> $config, string $type) : array<string|int, mixed>
Parameters
- $config : array<string|int, mixed>
- $type : string
Return values
array<string|int, mixed> —getWriteConfig()
Get the read configuration for a read / write connection.
protected
getWriteConfig(array<string|int, mixed> $config) : array<string|int, mixed>
Parameters
- $config : array<string|int, mixed>
Return values
array<string|int, mixed> —mergeReadWriteConfig()
Merge a configuration for a read / write connection.
protected
mergeReadWriteConfig(array<string|int, mixed> $config, array<string|int, mixed> $merge) : array<string|int, mixed>
Parameters
- $config : array<string|int, mixed>
- $merge : array<string|int, mixed>
Return values
array<string|int, mixed> —parseConfig()
Parse and prepare the database configuration.
protected
parseConfig(array<string|int, mixed> $config, string $name) : array<string|int, mixed>
Parameters
- $config : array<string|int, mixed>
- $name : string
Return values
array<string|int, mixed> —parseHosts()
Parse the hosts configuration item into an array.
protected
parseHosts(array<string|int, mixed> $config) : array<string|int, mixed>
Parameters
- $config : array<string|int, mixed>