oxERPBase Class Reference

Inheritance diagram for oxERPBase:

[legend]

Collaboration diagram for oxERPBase:

[legend]

List of all members.

---

Detailed Description

Definition at line 14 of file oxerpbase.php.

Public Member Functions
	getStatistics ()
	getSessionID ()
	getImportData ()
	__call ($sMethod, $aArguments)
	init ($sUserName, $sPassword, $iShopID=1, $iLanguage=0)
	loadSessionData ($sSessionID)
	exportType ($sType, $sWhere=null, $iStart=null, $iCount=null, $sSortFieldName=null, $sSortType=null)
	Import ()
Static Public Member Functions
static	getRequestedVersion ()
static	getUsedDbFieldsVersion ()
static	setVersion ($sDbLayerVersion= '')
Public Attributes
	$_aStatistics = array()
	$_iIdx = 0
Static Public Attributes
static	$ERROR_USER_WRONG = "ERROR: Could not login"
static	$ERROR_USER_NO_RIGHTS = "Not sufficient rights to perform operation!"
static	$ERROR_USER_EXISTS = "ERROR: User already exists"
static	$ERROR_NO_INIT = "Init not executed, Access denied!"
static	$ERROR_DELETE_NO_EMPTY_CATEGORY = "Only empty category can be deleated"
static	$ERROR_OBJECT_NOT_EXISTING = "Object does not exist"
static	$MODE_IMPORT = "Import"
static	$MODE_DELETE = "Delete"
Protected Member Functions
	_beforeExport ($sType)
	_afterExport ($sType)
	_beforeImport ()
	_afterImport ()
	_getImportType (&$aData)
	_getImportMode ($Data)
	_modifyData ($aData, $oType)
	_getInstanceOfType ($sType)
	_export ($sType, $sWhere, $iStart=null, $iCount=null, $sSortFieldName=null, $sSortType=null)
	_OutputMappingArray ($sTable)
	_getKeyID ($oType, $aData)
	_resetIdx ()
	_nextIdx ()
	_checkAccess ($oType, $blWrite, $sOxid=null)
	_importOne ()
	_Save (oxERPType &$oType, $aData, $blAllowCustomShopId=false)
Protected Attributes
	$_blInit = false
	$_iLanguage = null
	$_sUserID = null
	$_sSID = null
Static Protected Attributes
static	$_sRequestedVersion = ''
static	$_aDbLayer2ShopDbVersions

---

Member Function Documentation

oxERPBase.getStatistics

(

)

Definition at line 49 of file oxerpbase.php.

oxERPBase.getSessionID

(

)

Definition at line 50 of file oxerpbase.php.

oxERPBase._beforeExport

(

$

sType

)

[abstract, protected]

Reimplemented in oxErpCsv.

oxERPBase._afterExport

(

$

sType

)

[abstract, protected]

Reimplemented in oxErpCsv.

oxERPBase._beforeImport

(

)

[abstract, protected]

Reimplemented in oxErpCsv.

oxERPBase._afterImport

(

)

[abstract, protected]

Reimplemented in oxErpCsv.

oxERPBase.getImportData

(

)

[abstract]

Reimplemented in oxErpCsv.

oxERPBase._getImportType

(

&$

aData

)

[abstract, protected]

Reimplemented in oxErpCsv, and oxErpGenImport.

oxERPBase._getImportMode

(

$

Data

)

[abstract, protected]

Reimplemented in oxErpCsv, and oxErpGenImport.

oxERPBase._modifyData	(	$	aData,
		$	oType
	)			[abstract, protected]

Reimplemented in oxErpCsv, and oxErpGenImport.

oxERPBase.__call	(	$	sMethod,
		$	aArguments
	)

default fallback if some handler is missing

Parameters:

	string	$sMethod
	array	$aArguments

Reimplemented in oxErpGenImport.

Definition at line 67 of file oxerpbase.php.

oxERPBase.init	(	$	sUserName,
		$	sPassword,
		$	iShopID = 1,
		$	iLanguage = 0
	)

oxERPBase.Init() Init ERP Framework Creates Objects, checks Rights etc.

Parameters:

	mixed	$sUserName
	mixed	$sPassword
	integer	$iShopID
	integer	$iLanguage

Returns:

boolean

Reimplemented in oxErpGenImport.

Definition at line 92 of file oxerpbase.php.

oxERPBase.loadSessionData

(

$

sSessionID

)

[abstract]

oxERPBase.loadSessionData()

different handeling for SOAP request and CSV usage (V0.1)

Parameters:

string

$sSessionID

Reimplemented in oxErpCsv.

oxERPBase.exportType	(	$	sType,
		$	sWhere = null,
		$	iStart = null,
		$	iCount = null,
		$	sSortFieldName = null,
		$	sSortType = null
	)

Export one object type

Parameters:

	string	$sType
	string	$sWhere

Definition at line 157 of file oxerpbase.php.

oxERPBase.Import

(

)

imports all data set up before

Reimplemented in oxErpCsv.

Definition at line 168 of file oxerpbase.php.

oxERPBase._getInstanceOfType

(

$

sType

)

[protected]

Factory for ERP types

Parameters:

string

$sType

Returns:

object

Reimplemented in oxErpCsv.

Definition at line 181 of file oxerpbase.php.

oxERPBase._export	(	$	sType,
		$	sWhere,
		$	iStart = null,
		$	iCount = null,
		$	sSortFieldName = null,
		$	sSortType = null
	)			[protected]

Exports one type

Parameters:

	string	$sType
	string	$sWhere

Definition at line 201 of file oxerpbase.php.

oxERPBase._OutputMappingArray

(

$

sTable

)

[protected]

Just used for developing

Parameters:

array

$aData

Definition at line 254 of file oxerpbase.php.

oxERPBase._getKeyID	(	$	oType,
		$	aData
	)			[protected]

Definition at line 267 of file oxerpbase.php.

oxERPBase._resetIdx

(

)

[protected]

Reset import counter, if retry is detected, only failed imports are repeated

Definition at line 304 of file oxerpbase.php.

oxERPBase._nextIdx

(

)

[protected]

Increase import counter, if retry is detected, only failed imports are repeated

Definition at line 318 of file oxerpbase.php.

oxERPBase._checkAccess	(	$	oType,
		$	blWrite,
		$	sOxid = null
	)			[protected]

Checks if user as sufficient rights

Parameters:

	string	$sTable
	boolean	$blWrite
	integer	$sShopID

Definition at line 336 of file oxerpbase.php.

oxERPBase._importOne

(

)

[protected]

Main Import Handler, imports one row/call/object...

Returns:

boolean

Definition at line 413 of file oxerpbase.php.

oxERPBase._Save	(	oxERPType &$	oType,
		$	aData,
		$	blAllowCustomShopId = false
	)			[protected]

Insert or Update a Row into database

Parameters:

	oxERPType	$oType
	array	$aData assoc. Array with fieldnames, values what should be stored in this table

Returns:

string | false

Definition at line 462 of file oxerpbase.php.

static oxERPBase.getRequestedVersion

(

)

[static]

gets requested db layer version

Returns:

string

Definition at line 486 of file oxerpbase.php.

static oxERPBase.getUsedDbFieldsVersion

(

)

[static]

gets requested version for db fields used

Returns:

string

Definition at line 506 of file oxerpbase.php.

static oxERPBase.setVersion

(

$

sDbLayerVersion = ''

)

[static]

gets requested db layer version

Parameters:

string

$sDbLayerVersion

Definition at line 516 of file oxerpbase.php.

---

Member Data Documentation

oxERPBase.$ERROR_USER_WRONG = "ERROR: Could not login" [static]

Definition at line 17 of file oxerpbase.php.

oxERPBase.$ERROR_USER_NO_RIGHTS = "Not sufficient rights to perform operation!" [static]

Definition at line 18 of file oxerpbase.php.

oxERPBase.$ERROR_USER_EXISTS = "ERROR: User already exists" [static]

Definition at line 19 of file oxerpbase.php.

oxERPBase.$ERROR_NO_INIT = "Init not executed, Access denied!" [static]

Definition at line 20 of file oxerpbase.php.

oxERPBase.$ERROR_DELETE_NO_EMPTY_CATEGORY = "Only empty category can be deleated" [static]

Definition at line 21 of file oxerpbase.php.

oxERPBase.$ERROR_OBJECT_NOT_EXISTING = "Object does not exist" [static]

Definition at line 22 of file oxerpbase.php.

oxERPBase.$MODE_IMPORT = "Import" [static]

Definition at line 24 of file oxerpbase.php.

oxERPBase.$MODE_DELETE = "Delete" [static]

Definition at line 25 of file oxerpbase.php.

oxERPBase.$_blInit = false [protected]

Definition at line 27 of file oxerpbase.php.

oxERPBase.$_iLanguage = null [protected]

Definition at line 28 of file oxerpbase.php.

oxERPBase.$_sUserID = null [protected]

Definition at line 29 of file oxerpbase.php.

oxERPBase.$_sSID = null [protected]

Definition at line 31 of file oxerpbase.php.

oxERPBase.$_sRequestedVersion = '' [static, protected]

Definition at line 33 of file oxerpbase.php.

oxERPBase.$_aDbLayer2ShopDbVersions [static, protected]

Initial value:

 array(
        '1' => '1', '1.1' => '1', '2' => '2',
    )

Definition at line 41 of file oxerpbase.php.

oxERPBase.$_aStatistics = array()

Definition at line 45 of file oxerpbase.php.

oxERPBase.$_iIdx = 0

Definition at line 46 of file oxerpbase.php.

---

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

• core/oxerpbase.php