Open Journal Systems  3.3.0
DBConnection Class Reference

Public Member Functions

 __construct ()
 
 connect ()
 
 disconnect ()
 
getDBConn ()
 
 getDriver ()
 
 getNumQueries ()
 
 initConn ()
 
 initCustomDBConnection ($driver, $host, $username, $password, $databaseName, $persistent=false, $connectionCharset=false, $connectOnInit=true, $debug=false, $forceNew=false)
 
 initDefaultDBConnection ()
 
 isConnected ()
 
 reconnect ($forceNew=false)
 

Static Public Member Functions

static & getConn ()
 
static getInstance ($setInstance=null)
 
static logAdodbMessage ($msg, $newline=true)
 

Data Fields

 $connected
 
 $connectionCharset
 
 $connectOnInit
 
 $databaseName
 
 $dbconn
 
 $debug
 
 $driver
 
 $forceNew
 
 $host
 
 $password
 
 $persistent
 
 $username
 

Detailed Description

Class for accessing the low-level database connection. Currently integrated with ADOdb (from http://adodb.sourceforge.net).

Definition at line 19 of file DBConnection.inc.php.

Constructor & Destructor Documentation

◆ __construct()

DBConnection::__construct ( )

Constructor. Calls initDefaultDBConnection if no arguments are passed, otherwise calls initCustomDBConnection with custom connection parameters.

Definition at line 58 of file DBConnection.inc.php.

References initDefaultDBConnection().

Member Function Documentation

◆ connect()

DBConnection::connect ( )

Establish connection to the database.

Returns
boolean

Definition at line 156 of file DBConnection.inc.php.

References $connected.

Referenced by initConn(), and reconnect().

◆ disconnect()

DBConnection::disconnect ( )

Disconnect from the database.

Definition at line 192 of file DBConnection.inc.php.

Referenced by reconnect().

◆ getConn()

static& DBConnection::getConn ( )
static

Return a reference to a single static instance of the database connection.

Returns
ADONewConnection

Definition at line 257 of file DBConnection.inc.php.

References getInstance().

Referenced by DAO\__construct(), XmlToSqlTool\execute(), DBDataXMLParser\executeData(), AdminHandler\systemInfo(), DBDataXMLParserTest\testParseSQLData(), DBDataXMLParserTest\testParseSQLDDL(), and DBDataXMLParserTest\testParseTableData().

◆ getDBConn()

& DBConnection::getDBConn ( )

Return the database connection object.

Returns
ADONewConnection

Definition at line 216 of file DBConnection.inc.php.

References $dbconn.

◆ getDriver()

DBConnection::getDriver ( )

Return the name of the driver used for this connection.

Returns
string

Definition at line 266 of file DBConnection.inc.php.

References $driver.

◆ getInstance()

static DBConnection::getInstance (   $setInstance = null)
static

Return a reference to a single static instance of the database connection manager.

Parameters
$setInstanceDBConnection
Returns
DBConnection

Definition at line 241 of file DBConnection.inc.php.

References Registry\get().

Referenced by PKPApplication\__construct(), PKPInstall\createDatabase(), InstallPluginVersionTool\execute(), getConn(), DAO\getDriver(), PKPLocale\initialize(), PKPInstall\preInstall(), Installer\preInstall(), and DatabaseTestCase\setUp().

◆ getNumQueries()

DBConnection::getNumQueries ( )

Get number of database queries executed.

Returns
int

Definition at line 232 of file DBConnection.inc.php.

◆ initConn()

DBConnection::initConn ( )

Initialize database connection object and establish connection to the database.

Returns
boolean

Definition at line 140 of file DBConnection.inc.php.

References connect().

Referenced by initCustomDBConnection(), and initDefaultDBConnection().

◆ initCustomDBConnection()

DBConnection::initCustomDBConnection (   $driver,
  $host,
  $username,
  $password,
  $databaseName,
  $persistent = false,
  $connectionCharset = false,
  $connectOnInit = true,
  $debug = false,
  $forceNew = false 
)

Create new database connection with the specified connection parameters.

Parameters
$driverstring
$hoststring (Use host:socket and host:port for non-standard port and socket)
$usernamestring
$passwordstring
$databaseNamestring
$persistentboolean use persistent connections (default false)
$connectionCharsetstring character set to use for the connection (default none)
$connectOnInitboolean establish database connection on initiation (default true)
$debugboolean enable verbose debug output (default false)
$forceNewboolean force a new connection (default false)
Returns
boolean

Definition at line 121 of file DBConnection.inc.php.

References $connectionCharset, $connectOnInit, $databaseName, $debug, $driver, $forceNew, $host, $password, $persistent, $username, and initConn().

◆ initDefaultDBConnection()

DBConnection::initDefaultDBConnection ( )

Create new database connection with the connection parameters from the system configuration.

Returns
boolean

Definition at line 84 of file DBConnection.inc.php.

References Config\getVar(), and initConn().

Referenced by __construct().

◆ isConnected()

DBConnection::isConnected ( )

Check if a database connection has been established.

Returns
boolean

Definition at line 224 of file DBConnection.inc.php.

References $connected.

◆ logAdodbMessage()

static DBConnection::logAdodbMessage (   $msg,
  $newline = true 
)
static

Log message handler for ADODB.

Parameters
$msgstring
$newlineboolean
See also
ADOConnection::outp

Definition at line 75 of file DBConnection.inc.php.

References Registry\get(), and PKPString\html2text().

◆ reconnect()

DBConnection::reconnect (   $forceNew = false)

Reconnect to the database.

Parameters
$forceNewboolean force a new connection

Definition at line 203 of file DBConnection.inc.php.

References $forceNew, connect(), and disconnect().

Field Documentation

◆ $connected

boolean DBConnection::$connected

indicate connection status

Definition at line 50 of file DBConnection.inc.php.

Referenced by connect(), and isConnected().

◆ $connectionCharset

DBConnection::$connectionCharset

Definition at line 31 of file DBConnection.inc.php.

Referenced by initCustomDBConnection().

◆ $connectOnInit

boolean DBConnection::$connectOnInit

establish connection on initiation

Definition at line 38 of file DBConnection.inc.php.

Referenced by initCustomDBConnection().

◆ $databaseName

DBConnection::$databaseName

Definition at line 29 of file DBConnection.inc.php.

Referenced by initCustomDBConnection().

◆ $dbconn

DBConnection::$dbconn

The underlying database connection object

Definition at line 22 of file DBConnection.inc.php.

Referenced by getDBConn().

◆ $debug

DBConnection::$debug

Definition at line 44 of file DBConnection.inc.php.

Referenced by initCustomDBConnection().

◆ $driver

DBConnection::$driver

Database connection parameters

Definition at line 25 of file DBConnection.inc.php.

Referenced by getDriver(), and initCustomDBConnection().

◆ $forceNew

DBConnection::$forceNew

Definition at line 32 of file DBConnection.inc.php.

Referenced by initCustomDBConnection(), and reconnect().

◆ $host

DBConnection::$host

Definition at line 26 of file DBConnection.inc.php.

Referenced by initCustomDBConnection().

◆ $password

DBConnection::$password

Definition at line 28 of file DBConnection.inc.php.

Referenced by initCustomDBConnection().

◆ $persistent

DBConnection::$persistent

Definition at line 30 of file DBConnection.inc.php.

Referenced by initCustomDBConnection().

◆ $username

DBConnection::$username

Definition at line 27 of file DBConnection.inc.php.

Referenced by initCustomDBConnection().


The documentation for this class was generated from the following file: