oxDbMetaDataHandler Class Reference

Inheritance diagram for oxDbMetaDataHandler:

Collaboration diagram for oxDbMetaDataHandler:

Public Member Functions
	getFields ($sTableName)
	tableExists ($sTableName)
	fieldExists ($sFieldName, $sTableName)
	getAllTables ()
	getAllMultiTables ($sTable)
	getAddFieldSql ($sTable, $sField, $sNewField, $sPrevField, $sTableSet=null)
	getAddFieldIndexSql ($sTable, $sField, $sNewField, $sTableSet=null)
	getCurrentMaxLangId ()
	getNextLangId ()
	getMultilangFields ($sTable)
	getSinglelangFields ($sTable, $iLang)
	addNewMultilangField ($sTable)
	resetMultilangFields ($iLangId, $sTableName)
	addNewLangToDb ()
	resetLanguage ($iLangId)
	executeSql ($aSql)
	updateViews ($aTables=null)
Public Member Functions inherited from oxSuperCfg
	__call ($sMethod, $aArgs)
	__construct ()
	getConfig ()
	setConfig ($oConfig)
	getSession ()
	setSession ($oSession)
	getUser ()
	setUser ($oUser)
	isAdmin ()
	setAdminMode ($blAdmin)

Protected Member Functions
	_getCreateTableSetSql ($sTable, $iLang)

Protected Attributes
	$_aDbTablesFields = null
	$_aTables = null
	$_iCurrentMaxLangId
	$_aSkipTablesOnReset = array("oxcountry")

Additional Inherited Members
Static Protected Attributes inherited from oxSuperCfg
static	$_oConfig = null
static	$_oSession = null
static	$_oRights = null
static	$_oActUser = null
static	$_blIsAdmin = null

Detailed Description

Class for handling database related operations

Definition at line 7 of file oxdbmetadatahandler.php.

Member Function Documentation

oxDbMetaDataHandler::_getCreateTableSetSql (   $sTable,   $iLang  )

protected

Get sql for new multi-language table set creation

Parameters

string	$sTable	core table name
string	$iLang	language id

Returns

string

Definition at line 145 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::addNewLangToDb

(

)

Add new language to database. Scans all tables and adds new multi-language fields

Definition at line 417 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::addNewMultilangField

(

$sTable

)

Add new multi-languages fields to table. Duplicates all multi-language fields and fields indexes with next available language ID

Parameters

string

$sTable

table name

Definition at line 341 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::executeSql

(

$aSql

)

Executes array of sql strings

Parameters

array

$aSql

SQL query array

Definition at line 466 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::fieldExists	(		$sFieldName,
			$sTableName
	)

Check if field exists in table

Parameters

string	$sFieldName	field name
string	$sTableName	table name

Returns

bool

Definition at line 78 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::getAddFieldIndexSql	(		$sTable,
			$sField,
			$sNewField,
			$sTableSet = null
	)

Get sql for new multi-language field index creation

Parameters

string	$sTable	core table name
string	$sField	field name
string	$sNewField	new field name
string	$sTableSet	table to change (if not set take core table)

Returns

string

Definition at line 205 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::getAddFieldSql	(		$sTable,
			$sField,
			$sNewField,
			$sPrevField,
			$sTableSet = null
	)

Get sql for new multi-language field creation

Parameters

string	$sTable	core table name
string	$sField	field name
string	$sNewField	new field name
string	$sPrevField	previous field in table
string	$sTableSet	table to change (if not set take core table)

Returns

string

Definition at line 169 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::getAllMultiTables

(

$sTable

)

return all DB tables for the language sets

Parameters

string

$sTable

table name to check

Returns

array

Definition at line 123 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::getAllTables

(

)

Get all tables names from db. Views tables are not included in this list.

Returns

array

Definition at line 100 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::getCurrentMaxLangId

(

)

Get max language ID used in shop. For checking is used table "oxarticle" field "oxtitle"

Returns

int

Definition at line 254 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::getFields

(

$sTableName

)

Get table fields

Parameters

string

$sTableName

table name

Returns

array

Definition at line 42 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::getMultilangFields

(

$sTable

)

Get table multi-language fields

Parameters

string

$sTable

table name

Returns

array

Definition at line 291 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::getNextLangId

(

)

Get next available language ID

Returns

int

Definition at line 279 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::getSinglelangFields	(		$sTable,
			$iLang
	)

Get single language fields

Parameters

string	$sTable	table name
int	$iLang	language id

Returns

array

Definition at line 313 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::resetLanguage

(

$iLangId

)

Resetting all multi-language fields with specific language id to default value in all tables. Only if language ID > 0.

Parameters

int

$iLangId

Language id

Returns

null

Definition at line 440 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::resetMultilangFields	(		$iLangId,
			$sTableName
	)

Resetting all multi-language fields with specific language id to default value in selected table

Parameters

int	$iLangId	Language id
string	$sTableName	Table name

Returns

null

Definition at line 386 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::tableExists

(

$sTableName

)

Check if table exists

Parameters

string

$sTableName

table name

Returns

bool

Definition at line 62 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::updateViews

(

$aTables = null

)

Updates all views

Parameters

array

$aTables

array of DB table name that can store different data per shop like oxArticle

Returns

bool

Definition at line 487 of file oxdbmetadatahandler.php.

Member Data Documentation

oxDbMetaDataHandler::$_aDbTablesFields = null

protected

Definition at line 14 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::$_aSkipTablesOnReset = array("oxcountry")

protected

Definition at line 33 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::$_aTables = null

protected

Definition at line 21 of file oxdbmetadatahandler.php.

oxDbMetaDataHandler::$_iCurrentMaxLangId

protected

Definition at line 27 of file oxdbmetadatahandler.php.

---

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

• core/oxdbmetadatahandler.php