Inheritance diagram for oxERPType:

Collaboration diagram for oxERPType:

Public Member Functions
	getFunctionSuffix ()
	getShopObjectName ()
	getBaseTableName ()
	__construct ()
	setFunctionSuffix ($sNew)
	setFieldList ($aFieldList)
	getTableName ($iShopID=null, $iLanguage=0)
	getSQL ($sWhere, $iLanguage=0, $iShopId=1)
	getSortString ($sFieldName=null, $sType=null)
	checkWriteAccess ($oObj, $aData=null)
	checkCreateAccess ($aData)
	getObjectForDeletion ($sId)
	checkForDeletion ($sId)
	delete ($sID)
	deleteObject ($oObj, $sID)
	addExportData ($aFields)
	addImportData ($aFields)
	getRightFields ()
	getFieldList ()
	getKeyFields ()
	getOxidFromKeyFields ($aData)
	hasKeyFields ()
	saveObject ($aData, $blAllowCustomShopId)

Static Public Attributes
static	$ERROR_WRONG_SHOPID = "Wrong shop id, operation not allowed!"

Protected Member Functions
	_getSqlFieldName ($sField, $iLanguage=0, $iShopID=1)
	_isAllowedToEdit ($iShopId)
	_directSqlCheckForDeletion ($sId)
	_preAssignObject ($oShopObject, $aData, $blAllowCustomShopId)
	_preSaveObject ($oShopObject, $aData)
	_postSaveObject ($oShopObject, $aData)

Protected Attributes
	$_sTableName = null
	$_sFunctionSuffix = null
	$_aFieldList = null
	$_aKeyFieldList = null
	$_sShopObjectName = null
	$_blRestrictedByShopId = false
	$_aFieldListVersions = null

Private Member Functions
	_getMultilangualFields ()

Detailed Description

main erp type superclass - includes methods abstraction and basic implementation for all erp object types

Definition at line 7 of file oxerptype.php.

Constructor & Destructor Documentation

oxERPType::__construct ( )

class constructor

Returns: null

Reimplemented in oxERPType_Article, oxERPType_Article2Attribute, oxERPType_Accessoire, oxERPType_Artextends, oxERPType_Article2Action, oxERPType_Article2Category, oxERPType_Attribute, oxERPType_Category, oxERPType_Content, oxERPType_Country, oxERPType_Crossselling, oxERPType_Order, oxERPType_OrderArticle, oxERPType_ScalePrice, oxERPType_User, and oxERPType_Vendor.

Definition at line 66 of file oxerptype.php.

Member Function Documentation

oxERPType::_directSqlCheckForDeletion ( $sId )

protected

direct sql check if it is allowed to delete the OXID of the current table

Parameters

string $sId object id

Exceptions

Exception on no access

Returns: null

Definition at line 324 of file oxerptype.php.

oxERPType::_getMultilangualFields ( )

private

Creates Array with [iLanguage][sFieldName]

Returns: array

Definition at line 117 of file oxerptype.php.

oxERPType::_getSqlFieldName	(	$sField,
		$iLanguage = `0`,
		$iShopID = `1`
	)

protected

return sql column name of given table column

Parameters

string	$sField	field to get
int	$iLanguage	language id
int	$iShopID	shop id

Returns: string

Reimplemented in oxERPType_OrderArticle.

Definition at line 144 of file oxerptype.php.

oxERPType::_isAllowedToEdit ( $iShopId )

protected

checks if user is allowed to edit in this shop

Parameters

int $iShopId shop id

Returns: bool

Definition at line 301 of file oxerptype.php.

oxERPType::_postSaveObject	(	$oShopObject,
		$aData
	)

protected

post saving hook. can finish transactions if needed or ajust related data

Parameters

oxBase	$oShopObject	shop object
data	$aData	data to save

Returns: mixed data to return

Reimplemented in oxERPType_Article.

Definition at line 644 of file oxerptype.php.

oxERPType::_preAssignObject	(	$oShopObject,
		$aData,
		$blAllowCustomShopId
	)

protected

issued before saving an object. can modify aData for saving

Parameters

oxBase	$oShopObject	shop object
array	$aData	data to prepare
bool	$blAllowCustomShopId	if allow custom shop id

Returns: array

Reimplemented in oxERPType_Article, oxERPType_OrderArticle, and oxERPType_Category.

Definition at line 540 of file oxerptype.php.

oxERPType::_preSaveObject	(	$oShopObject,
		$aData
	)

protected

prepares object for saving in shop returns true if save can proceed further

Parameters

oxBase	$oShopObject	shop object
array	$aData	data for importing

Returns: boolean

Reimplemented in oxERPType_Artextends.

Definition at line 570 of file oxerptype.php.

oxERPType::addExportData ( $aFields )

We have the possibility to add some data

Parameters

array $aFields initial data

Returns: array

Definition at line 407 of file oxerptype.php.

oxERPType::addImportData ( $aFields )

allows to modify data before import

Parameters

array $aFields initial data

See Also: _preAssignObject

Returns: array

Definition at line 421 of file oxerptype.php.

oxERPType::checkCreateAccess ( $aData )

Basic access check for creating new objects

Parameters

array $aData fields to be written

Exceptions

Exception on now access

Returns: null

Definition at line 248 of file oxerptype.php.

oxERPType::checkForDeletion ( $sId )

default check if it is allowed to delete the OXID of the current table

Parameters

string $sId object id

Exceptions

Exception on no access

Returns: null

Definition at line 348 of file oxerptype.php.

oxERPType::checkWriteAccess	(	$oObj,
		$aData = `null`
	)

Basic access check for writing data, checks for same shopid, should be overridden if field oxshopid does not exist

Parameters

oxBase	$oObj	loaded shop object
array	$aData	fields to be written, null for default

Exceptions

Exception on now access

Returns: null

Reimplemented in oxERPType_Article, oxERPType_User, and oxERPType_OrderArticle.

Definition at line 230 of file oxerptype.php.

oxERPType::delete ( $sID )

default deletion of the given OXID in the current table

Parameters

string $sID object id

Returns: bool

Definition at line 378 of file oxerptype.php.

oxERPType::deleteObject	(	$oObj,
		$sID
	)

default delete call to the given object

Parameters

object	$oObj	object
string	$sID	object id

Returns: bool

Definition at line 395 of file oxerptype.php.

oxERPType::getBaseTableName ( )

getter for _sTableName

Returns: string

Definition at line 56 of file oxerptype.php.

oxERPType::getFieldList ( )

returns the predefined field list

Returns: array

Definition at line 449 of file oxerptype.php.

oxERPType::getFunctionSuffix ( )

getter for _sFunctionSuffix

Returns: string

Definition at line 36 of file oxerptype.php.

oxERPType::getKeyFields ( )

returns the keylist array

Returns: array

Definition at line 478 of file oxerptype.php.

oxERPType::getObjectForDeletion ( $sId )

checks done to make sure deletion is possible and allowed

Parameters

string $sId id of object

Exceptions

Exception on error

Returns: object

Definition at line 261 of file oxerptype.php.

oxERPType::getOxidFromKeyFields ( $aData )

returns oxid of this data type from key fields

Parameters

array $aData data for object

Returns: string

Definition at line 490 of file oxerptype.php.

oxERPType::getRightFields ( )

used for the RR implementation, right now not really used

Returns: array

Definition at line 431 of file oxerptype.php.

oxERPType::getShopObjectName ( )

getter for _sShopObjectName

Returns: string

Definition at line 46 of file oxerptype.php.

oxERPType::getSortString	(	$sFieldName = `null`,
		$sType = `null`
	)

returns the "order by " string for a sql query

Parameters

string	$sFieldName	order by that field
string	$sType	allowed values ASC and DESC

Returns: string

Definition at line 206 of file oxerptype.php.

oxERPType::getSQL	(	$sWhere,
		$iLanguage = `0`,
		$iShopId = `1`
	)

returns SQL string for this type

Parameters

string	$sWhere	where part of sql
int	$iLanguage	language id
int	$iShopId	shop id

Returns: string

Reimplemented in oxERPType_OrderArticle, and oxERPType_User.

Definition at line 174 of file oxerptype.php.

oxERPType::getTableName	(	$iShopID = `null`,
		$iLanguage = `0`
	)

Returns table or Viewname

Parameters

int	$iShopID	shop id - default is the current shop id
int	$iLanguage	language id

Returns: string

Definition at line 103 of file oxerptype.php.

oxERPType::hasKeyFields ( )

returns try if type has key fields array

Returns: bool

Definition at line 523 of file oxerptype.php.

oxERPType::saveObject	(	$aData,
		$blAllowCustomShopId
	)

saves data by calling object saving

Parameters

array	$aData	data for saving
bool	$blAllowCustomShopId	allow custom shop id

Returns: string | false

Reimplemented in oxERPType_Artextends.

Definition at line 583 of file oxerptype.php.

oxERPType::setFieldList ( $aFieldList )

setter for field list

Parameters

array $aFieldList fields to set

Returns: null

Definition at line 90 of file oxerptype.php.

oxERPType::setFunctionSuffix ( $sNew )

setter for the function prefix

Parameters

string $sNew new suffix

Returns: null

Definition at line 78 of file oxerptype.php.

Member Data Documentation

oxERPType::$_aFieldList = null

protected

Definition at line 13 of file oxerptype.php.

oxERPType::$_aFieldListVersions = null

protected

Definition at line 29 of file oxerptype.php.

oxERPType::$_aKeyFieldList = null

protected

Definition at line 14 of file oxerptype.php.

oxERPType::$_blRestrictedByShopId = false

protected

Definition at line 22 of file oxerptype.php.

oxERPType::$_sFunctionSuffix = null

protected

Definition at line 12 of file oxerptype.php.

oxERPType::$_sShopObjectName = null

protected

Definition at line 15 of file oxerptype.php.

oxERPType::$_sTableName = null

protected

Definition at line 11 of file oxerptype.php.

oxERPType::$ERROR_WRONG_SHOPID = "Wrong shop id, operation not allowed!"

static

Definition at line 9 of file oxerptype.php.

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

core/objects/oxerptype.php

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation