class ConnectionFactory

Properties

protected array<string, callable> $extensions

The custom connection resolvers.

Methods

__construct(Container $container)

Create a new connection factory instance.

make(array $config, string|null $name = null)

Establish a PDO connection based on the configuration.

void
extend(string $name, callable $resolver)

Register an extension connection resolver.

void
forgetExtension(string $name)

Remove an extension connection resolver.

makeSqliteFromSharedPdo(PDO $pdo, array $config, string|null $name = null)

Create an in-memory SQLite connection using a shared PDO.

array
parseConfig(array $config, string|null $name)

Parse and prepare the database configuration.

bool
hasReadConfig(array $config)

Determine if the configuration has a read side.

array
configForRead(array $config)

Get the single-role read configuration for a read / write connection.

createSingleConnection(array $config)

Create a single database connection instance.

createReadWriteConnection(array $config)

Create a read / write database connection instance.

createReadPdo(array $config)

Create a new PDO instance for reading.

array
getReadConfig(array $config)

Get the read configuration for a read / write connection.

array
getWriteConfig(array $config)

Get the write configuration for a read / write connection.

array
getReadWriteConfig(array $config, string $type)

Get a read / write level configuration.

array
mergeReadWriteConfig(array $config, array $merge)

Merge a configuration for a read / write connection.

createPdoResolver(array $config)

Create a new Closure that resolves to a PDO instance.

createPdoResolverWithHosts(array $config)

Create a new Closure that resolves to a PDO instance with a specific host or an array of hosts.

array
parseHosts(array $config)

Parse the hosts configuration item into an array.

createPdoResolverWithoutHosts(array $config)

Create a new Closure that resolves to a PDO instance where there is no configured host.

createConnector(array $config)

Create a connector instance based on the configuration.

createConnection(string $driver, PDO|Closure $connection, string $database, string $prefix = '', array $config = [])

Create a new connection instance.

Details

at line 33
__construct(Container $container)

Create a new connection factory instance.

Parameters

Container $container

at line 41
Connection make(array $config, string|null $name = null)

Establish a PDO connection based on the configuration.

Parameters

array $config
string|null $name

Return Value

Connection

at line 74
void extend(string $name, callable $resolver)

Register an extension connection resolver.

Boot-only. The resolver persists in the singleton factory's extensions array for the worker lifetime and applies to every subsequent connection.

Parameters

string $name
callable $resolver

Return Value

void

at line 86
void forgetExtension(string $name)

Remove an extension connection resolver.

Boot or tests only. Mutates the singleton factory's extensions array; concurrent coroutines establishing connections may see the resolver removed mid-resolution.

Parameters

string $name

Return Value

void

at line 101
Connection makeSqliteFromSharedPdo(PDO $pdo, array $config, string|null $name = null)

Create an in-memory SQLite connection using a shared PDO.

Used by connection pooling for in-memory SQLite where all pool slots must share the same PDO instance to see the same data. Without this, each pooled connection would get its own empty in-memory database.

Returns Connection (not SQLiteConnection) to respect custom resolvers that may return a different Connection subclass.

Parameters

PDO $pdo
array $config
string|null $name

Return Value

Connection

at line 123
array parseConfig(array $config, string|null $name)

Parse and prepare the database configuration.

Parameters

array $config
string|null $name

Return Value

array

at line 133
bool hasReadConfig(array $config)

Determine if the configuration has a read side.

Parameters

array $config

Return Value

bool

at line 141
array configForRead(array $config)

Get the single-role read configuration for a read / write connection.

Parameters

array $config

Return Value

array

at line 157
protected Connection createSingleConnection(array $config)

Create a single database connection instance.

Parameters

array $config

Return Value

Connection

at line 173
protected Connection createReadWriteConnection(array $config)

Create a read / write database connection instance.

Parameters

array $config

Return Value

Connection

at line 185
protected Closure createReadPdo(array $config)

Create a new PDO instance for reading.

Parameters

array $config

Return Value

Closure

at line 193
protected array getReadConfig(array $config)

Get the read configuration for a read / write connection.

Parameters

array $config

Return Value

array

at line 204
protected array getWriteConfig(array $config)

Get the write configuration for a read / write connection.

Parameters

array $config

Return Value

array

at line 215
protected array getReadWriteConfig(array $config, string $type)

Get a read / write level configuration.

Parameters

array $config
string $type

Return Value

array

at line 225
protected array mergeReadWriteConfig(array $config, array $merge)

Merge a configuration for a read / write connection.

Parameters

array $config
array $merge

Return Value

array

at line 233
protected Closure createPdoResolver(array $config)

Create a new Closure that resolves to a PDO instance.

Parameters

array $config

Return Value

Closure

at line 243
protected Closure createPdoResolverWithHosts(array $config)

Create a new Closure that resolves to a PDO instance with a specific host or an array of hosts.

Parameters

array $config

Return Value

Closure

at line 267
protected array parseHosts(array $config)

Parse the hosts configuration item into an array.

Parameters

array $config

Return Value

array

Exceptions

InvalidArgumentException

at line 281
protected Closure createPdoResolverWithoutHosts(array $config)

Create a new Closure that resolves to a PDO instance where there is no configured host.

Parameters

array $config

Return Value

Closure

at line 291
ConnectorInterface createConnector(array $config)

Create a connector instance based on the configuration.

Parameters

array $config

Return Value

ConnectorInterface

Exceptions

InvalidArgumentException

at line 315
protected Connection createConnection(string $driver, PDO|Closure $connection, string $database, string $prefix = '', array $config = [])

Create a new connection instance.

Parameters

string $driver
PDO|Closure $connection
string $database
string $prefix
array $config

Return Value

Connection

Exceptions

InvalidArgumentException