Skip to content

Instantly share code, notes, and snippets.

@rob-murray
Last active March 11, 2020 11:14
Show Gist options
  • Star 4 You must be signed in to star a gist
  • Fork 4 You must be signed in to fork a gist
  • Save rob-murray/5454707 to your computer and use it in GitHub Desktop.
Save rob-murray/5454707 to your computer and use it in GitHub Desktop.
An class for a PHP PDO connection - a singleton implementation. An instance method returns a new PDO Connection with the specified connection attributes.
<?php
namespace ACompany\AnAppName\Dao\PdoImpl;
/**
* PDOConnection is a singleton implementation.
* getConnection() returning an instance of PDO connection.
*
* <code>
* Example usage:
*
* $pdo = PDOConnection::instance();
* $conn = $pdo->getConnection( 'dsn', 'username', 'password' );
*
* $results = $conn->query("SELECT * FROM Table");
*
* </code>
*
* @author rmurray
*/
class PDOConnection {
/**
* singleton instance
*
* @var PDOConnection
*/
protected static $_instance = null;
/**
* Returns singleton instance of PDOConnection
*
* @return PDOConnection
*/
public static function instance() {
if ( !isset( self::$_instance ) ) {
self::$_instance = new PDOConnection();
}
return self::$_instance;
}
/**
* Hide constructor, protected so only subclasses and self can use
*/
protected function __construct() {}
function __destruct(){}
/**
* Return a PDO connection using the dsn and credentials provided
*
* @param string $dsn The DSN to the database
* @param string $username Database username
* @param string $password Database password
* @return PDO connection to the database
* @throws PDOException
* @throws Exception
*/
public function getConnection($dsn, $username, $password) {
$conn = null;
try {
$conn = new \PDO($dsn, $username, $password);
//Set common attributes
$conn->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);
return $conn;
} catch (PDOException $e) {
//TODO: flag to disable errors?
throw $e;
}
catch(Exception $e) {
//TODO: flag to disable errors?
throw $e;
}
}
/** PHP seems to need these stubbed to ensure true singleton **/
public function __clone()
{
return false;
}
public function __wakeup()
{
return false;
}
}
@jspringe
Copy link

@jorygun - You are right to have questions about why he wasn't instantiating PDO in the constructor. Try my fork out and see if it works. It's only loosely tested, and not "production hardened" (nor is this code), but it better represents (IMHO) how this should look.

@odan
Copy link

odan commented Jul 5, 2017

@ffflabs
Copy link

ffflabs commented Nov 28, 2018

I believe $conn should be a protected static, so you actually return the same connection everytime. Otherwise, you return the same instance of the class when calling PDOConnection::instance() but you create a new connection when you call PDOConnection::getConnection()

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment