OXID eShop CE  4.8.11
 All Classes Files Functions Variables Pages
oxDb Class Reference
+ Collaboration diagram for oxDb:

Public Member Functions

 quoteArray ($aStrArray)
 resetTblDescCache ()
 getTableDescription ($sTableName)
 convertDBDateTime ($oObject, $blToTimeStamp=false, $blOnlyDate=false)
 convertDBTimestamp ($oObject, $blToTimeStamp=false)
 convertDBDate ($oObject, $blToTimeStamp=false)
 isValidFieldName ($sField)
 escapeString ($sString)
 updateViews ($aTables=null)

Static Public Member Functions

static setConfig ($oConfig)
static getInstance ()
static getDb ($iFetchMode=oxDb::FETCH_MODE_NUM)

Public Attributes

const FETCH_MODE_NUM = ADODB_FETCH_NUM
const FETCH_MODE_ASSOC = ADODB_FETCH_ASSOC

Static Public Attributes

static $configSet = false

Protected Member Functions

 isAdmin ()
 _getModules ()
 _setUp ($oDb)
 _sendMail ($sEmail, $sSubject, $sBody)
 _notifyConnectionErrors ($oDb)
 _onConnectionError ($oDb)
 _getDbInstance ($iInstType=false)
 _setDefaultFormatedValue ($oObject, $sDate, $sLocalDateFormat, $sLocalTimeFormat, $blOnlyDate)
 _defineAndCheckDefaultTimeValues ($blToTimeStamp)
 _defineAndCheckDefaultDateValues ($blToTimeStamp)
 _defaultDatePattern ()
 _defaultTimePattern ()
 _regexp2ValidateDateInput ()
 _regexp2ValidateTimeInput ()
 _defineDateFormattingRules ()
 _defineTimeFormattingRules ()
 _setDefaultDateTimeValue ($oObject, $sLocalDateFormat, $sLocalTimeFormat, $blOnlyDate)
 _setDate ($oObject, $sDateFormat, $aDFields, $aDateMatches)
 _formatCorrectTimeValue ($oObject, $sDateFormat, $sTimeFormat, $aDateMatches, $aTimeMatches, $aTFields, $aDFields)
 _getConnectionId ()

Static Protected Member Functions

static _getConfigParam ($sConfigName)

Static Protected Attributes

static $_instance = null
static $_oDB = null
static $_aTblDescCache = array()

Static Private Attributes

static $_dbType = ''
static $_dbUser = ''
static $_dbPwd = ''
static $_dbName = ''
static $_dbHost = ''
static $_iDebug = 0
static $_blLogChangesInAdmin = false
static $_iUtfMode = 0
static $_sDefaultDatabaseConnection = null
static $_aSlaveHosts
static $_sAdminEmail
static $_iMasterSlaveBalance
static $_sLocalTimeFormat
static $_sLocalDateFormat

Detailed Description

Database connection class

Definition at line 10 of file oxdb.php.

Member Function Documentation

oxDb::_defaultDatePattern ( )
protected

sets default date pattern

Deprecated:
from 2012-11-21, not used here anymore. All date formatting moved to oxutilsdate
Returns
null

Definition at line 615 of file oxdb.php.

oxDb::_defaultTimePattern ( )
protected

sets default time pattern

Deprecated:
from 2012-11-21, not used here anymore. All date formatting moved to oxutilsdate
Returns
null

Definition at line 626 of file oxdb.php.

oxDb::_defineAndCheckDefaultDateValues (   $blToTimeStamp)
protected

defines and checks default date values

Parameters
bool$blToTimeStampmarker how to format
Deprecated:
from 2012-11-21, not used here anymore. All date formatting moved to oxutilsdate
Returns
null

Definition at line 604 of file oxdb.php.

oxDb::_defineAndCheckDefaultTimeValues (   $blToTimeStamp)
protected

defines and checks default time values

Parameters
bool$blToTimeStamp-
Deprecated:
from 2012-11-21, not used here anymore. All date formatting moved to oxutilsdate
Returns
null

Definition at line 591 of file oxdb.php.

oxDb::_defineDateFormattingRules ( )
protected

define date formatting rules

Deprecated:
from 2012-11-21, not used here anymore. All date formatting moved to oxutilsdate
Returns
array

Definition at line 659 of file oxdb.php.

oxDb::_defineTimeFormattingRules ( )
protected

defines time formatting rules

Deprecated:
from 2012-11-21, not used here anymore. All date formatting moved to oxutilsdate
Returns
array

Definition at line 676 of file oxdb.php.

oxDb::_formatCorrectTimeValue (   $oObject,
  $sDateFormat,
  $sTimeFormat,
  $aDateMatches,
  $aTimeMatches,
  $aTFields,
  $aDFields 
)
protected

Formatting correct time value

Parameters
object$oObjectdata field object
string$sDateFormatdate format
string$sTimeFormattime format
array$aDateMatchesnew new date
array$aTimeMatchesnew time
array$aTFieldsdefines the time fields
array$aDFieldsdefines the date fields
Deprecated:
from 2012-11-21, not used here anymore. All date formatting moved to oxutilsdate
Returns
null

Definition at line 760 of file oxdb.php.

static oxDb::_getConfigParam (   $sConfigName)
staticprotected

Return local config value by given name.

Parameters
string$sConfigNamereturning config name.
Returns
mixed

Definition at line 167 of file oxdb.php.

oxDb::_getConnectionId ( )
protected

Get connection ID

Returns
link identifier

Definition at line 785 of file oxdb.php.

oxDb::_getDbInstance (   $iInstType = false)
protected

Returns database instance object for given type

Parameters
int$iInstTypeinstance type
Returns
ADONewConnection

Definition at line 376 of file oxdb.php.

oxDb::_getModules ( )
protected

Returns adodb modules string

Returns
string

Definition at line 215 of file oxdb.php.

oxDb::_notifyConnectionErrors (   $oDb)
protected

Notifying shop owner about connection problems

Parameters
ADOConnection$oDbdatabase connection instance
Returns
null

Definition at line 302 of file oxdb.php.

oxDb::_onConnectionError (   $oDb)
protected

In case of connection error - redirects to setup or send notification message for shop owner

Parameters
ADOConnection$oDbdatabase connection instance
Returns
null

Definition at line 343 of file oxdb.php.

oxDb::_regexp2ValidateDateInput ( )
protected

regular expressions to validate date input

Deprecated:
from 2012-11-21, not used here anymore. All date formatting moved to oxutilsdate
Returns
null

Definition at line 637 of file oxdb.php.

oxDb::_regexp2ValidateTimeInput ( )
protected

regular expressions to validate time input

Deprecated:
from 2012-11-21, not used here anymore. All date formatting moved to oxutilsdate
Returns
null

Definition at line 648 of file oxdb.php.

oxDb::_sendMail (   $sEmail,
  $sSubject,
  $sBody 
)
protected

Returns $oMailer instance

Parameters
string$sEmailemail address
string$sSubjectsubject
string$sBodyemail body
Returns
phpmailer

Definition at line 282 of file oxdb.php.

oxDb::_setDate (   $oObject,
  $sDateFormat,
  $aDFields,
  $aDateMatches 
)
protected

sets date

Parameters
object$oObjectdate field object
string$sDateFormatdate format
array$aDFieldsdays
array$aDateMatchesnew date as array (month, year)
Deprecated:
from 2012-11-21, not used here anymore. All date formatting moved to oxutilsdate
Returns
null

Definition at line 729 of file oxdb.php.

oxDb::_setDefaultDateTimeValue (   $oObject,
  $sLocalDateFormat,
  $sLocalTimeFormat,
  $blOnlyDate 
)
protected

Sets default date time value

Parameters
object$oObjectdate field object
string$sLocalDateFormatinput format
string$sLocalTimeFormatlocal format
bool$blOnlyDatemarker to format only date field (no time)
Deprecated:
from 2012-11-21, not used here anymore. All date formatting moved to oxUtilsDate
Returns
null

Definition at line 698 of file oxdb.php.

oxDb::_setDefaultFormatedValue (   $oObject,
  $sDate,
  $sLocalDateFormat,
  $sLocalTimeFormat,
  $blOnlyDate 
)
protected

sets default formatted value

Parameters
object$oObjectdate field object
string$sDateprefered date
string$sLocalDateFormatinput format
string$sLocalTimeFormatlocal format
bool$blOnlyDatemarker to format only date field (no time)
Deprecated:
from 2012-11-21, not used here anymore. All date formatting moved to oxutilsdate
Returns
null

Definition at line 578 of file oxdb.php.

oxDb::_setUp (   $oDb)
protected

Setting up connection parameters - sql mode, encoding, logging etc

Parameters
ADOConnection$oDbdatabase connection instance
Returns
null

Definition at line 244 of file oxdb.php.

oxDb::convertDBDate (   $oObject,
  $blToTimeStamp = false 
)

Bidirectional converter for date field

Parameters
object$oObjectoxField type object that keeps db field info
bool$blToTimeStampif true - converts value to database compatible timestamp value
Deprecated:
from 2012-11-21, use oxRegistry::get('oxUtilsDate')->convertDBDate()
Returns
string

Definition at line 547 of file oxdb.php.

oxDb::convertDBDateTime (   $oObject,
  $blToTimeStamp = false,
  $blOnlyDate = false 
)

Bidirectional converter for date/datetime field

Parameters
object$oObjectdata field object
bool$blToTimeStampset TRUE to format MySQL compatible value
bool$blOnlyDateset TRUE to format "date" type field
Deprecated:
from 2012-11-21, use oxRegistry::get('oxUtilsDate')->convertDBDateTime()
Returns
string

Definition at line 517 of file oxdb.php.

oxDb::convertDBTimestamp (   $oObject,
  $blToTimeStamp = false 
)

Bidirectional converter for timestamp field

Parameters
object$oObjectoxField type object that keeps db field info
bool$blToTimeStampif true - converts value to database compatible timestamp value
Deprecated:
from 2012-11-21, use oxRegistry::get('oxUtilsDate')->convertDBTimestamp()
Returns
string

Definition at line 532 of file oxdb.php.

oxDb::escapeString (   $sString)

Escape string for using in mysql statements

Parameters
string$sStringstring which will be escaped
Returns
string

Definition at line 797 of file oxdb.php.

static oxDb::getDb (   $iFetchMode = oxDb::FETCH_MODE_NUM)
static

Returns database object

Parameters
int$iFetchMode- fetch mode default numeric - 0
Exceptions
oxConnectionExceptionerror while initiating connection to DB
Returns
oxLegacyDb

Definition at line 407 of file oxdb.php.

static oxDb::getInstance ( )
static

Returns Singleton instance

Returns
oxdb

Definition at line 181 of file oxdb.php.

oxDb::getTableDescription (   $sTableName)

Extracts and returns table metadata from DB.

Parameters
string$sTableNameName of table to invest.
Returns
array

Definition at line 492 of file oxdb.php.

oxDb::isAdmin ( )
protected

Cal function is admin from oxFunction. Need to mock in tests.

Returns
bool

Definition at line 205 of file oxdb.php.

oxDb::isValidFieldName (   $sField)

Checks if given string is valid database field name. It must contain from alphanumeric plus dot and underscore symbols

Parameters
string$sFieldfield name
Returns
bool

Definition at line 560 of file oxdb.php.

oxDb::quoteArray (   $aStrArray)

Quotes an array.

Parameters
array$aStrArrayarray of strings to quote
Returns
array

Definition at line 465 of file oxdb.php.

oxDb::resetTblDescCache ( )

Call to reset table description cache

Returns
null

Definition at line 480 of file oxdb.php.

static oxDb::setConfig (   $oConfig)
static

Sets configs object with method getVar() and properties needed for successful connection.

Parameters
object$oConfigconfigs.
Returns
void

Definition at line 142 of file oxdb.php.

oxDb::updateViews (   $aTables = null)

Updates shop views

Parameters
array$aTablesIf you need to update specific tables, just pass its names as array [optional]
Deprecated:
since v5.0.1 (2012-11-05); Use public oxDbMetaDataHandler::updateViews().
Returns
bool

Definition at line 817 of file oxdb.php.

Member Data Documentation

oxDb::$_aSlaveHosts
staticprivate

Definition at line 109 of file oxdb.php.

oxDb::$_aTblDescCache = array()
staticprotected

Definition at line 49 of file oxdb.php.

oxDb::$_blLogChangesInAdmin = false
staticprivate

Definition at line 91 of file oxdb.php.

oxDb::$_dbHost = ''
staticprivate

Definition at line 79 of file oxdb.php.

oxDb::$_dbName = ''
staticprivate

Definition at line 73 of file oxdb.php.

oxDb::$_dbPwd = ''
staticprivate

Definition at line 67 of file oxdb.php.

oxDb::$_dbType = ''
staticprivate

Definition at line 55 of file oxdb.php.

oxDb::$_dbUser = ''
staticprivate

Definition at line 61 of file oxdb.php.

oxDb::$_iDebug = 0
staticprivate

Definition at line 85 of file oxdb.php.

oxDb::$_iMasterSlaveBalance
staticprivate

Definition at line 121 of file oxdb.php.

oxDb::$_instance = null
staticprotected

Definition at line 35 of file oxdb.php.

oxDb::$_iUtfMode = 0
staticprivate

Definition at line 97 of file oxdb.php.

oxDb::$_oDB = null
staticprotected

Definition at line 42 of file oxdb.php.

oxDb::$_sAdminEmail
staticprivate

Definition at line 115 of file oxdb.php.

oxDb::$_sDefaultDatabaseConnection = null
staticprivate

Definition at line 103 of file oxdb.php.

oxDb::$_sLocalDateFormat
staticprivate

Definition at line 133 of file oxdb.php.

oxDb::$_sLocalTimeFormat
staticprivate

Definition at line 127 of file oxdb.php.

oxDb::$configSet = false
static

Definition at line 28 of file oxdb.php.

const oxDb::FETCH_MODE_ASSOC = ADODB_FETCH_ASSOC

Definition at line 22 of file oxdb.php.

const oxDb::FETCH_MODE_NUM = ADODB_FETCH_NUM

Definition at line 16 of file oxdb.php.


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