PDOConnectionFactory extends ConnectionFactory
A factory for creating database connections
Table of Contents
| $create | Create connection supplier | Closure |
|---|---|---|
| $connections | A list of active connections [hash => IDBConnection] | array |
| $props | DB props | IConnectionProperties |
| __construct() | mixed | |
| createNewConnection() | Create a new connection | IDBConnection |
| createNewConnection() | Create a new connection. Override this in the child class. | IDBConnection |
| __construct() | mixed | |
| getConnection() | Retrieve a database connection | IDBConnection |
| createConnection() | Connect to a database host | IDBConnection |
| close() | Close all connections. | void |
| closeConnection() | Close a specific connection. | mixed |
Properties
$create
Create connection supplier
private
Closure
$create
$connections
A list of active connections [hash => IDBConnection]
private
array
$connections
= []
$props
DB props
private
IConnectionProperties
$props
Methods
__construct()
public
__construct(
$args :
IConnectionProperties
, $createConnection :
Closure
)
: mixed
Parameters
- $args : IConnectionProperties
Arguments
- $createConnection : Closure
Supplier that creates instances of a db connection f( IConnectionProperties $args ) : IDBConnection
Return values
mixedcreateNewConnection()
Create a new connection
protected
createNewConnection(
$args :
IConnectionProperties
)
: IDBConnection
Parameters
- $args : IConnectionProperties
Return values
IDBConnectioncreateNewConnection()
Create a new connection. Override this in the child class.
protected
abstract createNewConnection(
$args :
IConnectionProperties
)
: IDBConnection
Parameters
- $args : IConnectionProperties
Return values
IDBConnection__construct()
public
__construct(
$args :
IConnectionProperties
)
: mixed
Parameters
- $args : IConnectionProperties
Return values
mixedgetConnection()
Retrieve a database connection
public
getConnection(
[ $forceNew :
bool
= false ]
)
: IDBConnection
Parameters
- $forceNew : bool = false
Return values
IDBConnectioncreateConnection()
Connect to a database host
public
createConnection(
[ $args :
IConnectionProperties
= null ]
[, $forceNew :
bool
= false ]
)
: IDBConnection
Parameters
- $args : IConnectionProperties = null
Connection arguments
- $forceNew : bool = false
Force a new connection
Tags
Return values
IDBConnection —db connection
close()
Close all connections.
public
close(
)
: void
This simply sets the internal reference to null.
closeConnection()
Close a specific connection.
public
closeConnection(
$conn :
IDBConnection
)
: mixed
This simply sets the internal reference to null.
Parameters
- $conn : IDBConnection