Inheritance diagram for oxERPBase:

Collaboration diagram for oxERPBase:

Public Member Functions
	getImportedRowCount ()
	setImportedIds ($key)
	getStatistics ()
	getSessionID ()
	getImportData ($iIdx=null)
	__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 ()
	createPluginObject ($sId)

Static Public Member Functions
static	getRequestedVersion ()
static	getUsedDbFieldsVersion ()
static	setVersion ($sDbLayerVersion= '')

Public Attributes
const	ERROR_USER_WRONG = "ERROR: Could not login"
const	ERROR_USER_NO_RIGHTS = "Not sufficient rights to perform operation!"
const	ERROR_USER_EXISTS = "ERROR: User already exists"
const	ERROR_NO_INIT = "Init not executed, Access denied!"
const	ERROR_DELETE_NO_EMPTY_CATEGORY = "Only empty category can be deleated"
const	ERROR_OBJECT_NOT_EXISTING = "Object does not exist"
const	ERROR_ERP_VERSION_NOT_SUPPORTED_BY_SHOP = "ERROR: shop does not support requested ERP version."
const	ERROR_SHOP_VERSION_NOT_SUPPORTED_BY_ERP = "ERROR: ERP does not support current shop version."
	$_aStatistics = array()
	$_iIdx = 0

Static Public Attributes
static	$MODE_IMPORT = "Import"
static	$MODE_DELETE = "Delete"

Protected Member Functions
	_beforeExport ($sType)
	_afterExport ($sType)
	_beforeImport ()
	_afterImport ()
	_getImportType (&$aData)
	_getImportMode ($aData)
	_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)

Static Protected Member Functions
static	_checkShopVersion ()
static	_checkRequestedVersion ()

Protected Attributes
	$_blInit = false
	$_iLanguage = null
	$_sUserID = null
	$_sSID = null
	$_aImportedIds = array()
	$_iImportedRowCount = 0

Static Protected Attributes
static	$_sRequestedVersion = ''
static	$_aDbLayer2ShopDbVersions

Detailed Description

oxERPBase class, provides all basic functions, needed for ERP to function

Definition at line 6 of file oxerpbase.php.

Member Function Documentation

oxERPBase::__call	(	$sMethod,
		$aArguments
	)

default fallback if some handler is missing

Parameters

string	$sMethod	method name
array	$aArguments	arguments

Exceptions

Exception not implemented

Returns: null

Reimplemented in oxErpGenImport.

Definition at line 171 of file oxerpbase.php.

oxERPBase::_afterExport ( $sType )

abstractprotected

hook after export

Parameters

string $sType type of export

Returns: null

Reimplemented in oxErpCsv.

oxERPBase::_afterImport ( )

abstractprotected

hook after import

Returns: null

Reimplemented in oxErpCsv.

oxERPBase::_beforeExport ( $sType )

abstractprotected

hook before export

Parameters

string $sType type of export

Returns: null

Reimplemented in oxErpCsv.

oxERPBase::_beforeImport ( )

abstractprotected

hook before import

Returns: null

Reimplemented in oxErpCsv.

oxERPBase::_checkAccess	(	$oType,
		$blWrite,
		$sOxid = `null`
	)

protected

Checks if user as sufficient rights

Parameters

oxErpType	$oType	data type object
boolean	$blWrite	check also for write access
string	$sOxid	check write access for this OXID

Returns: null

Definition at line 480 of file oxerpbase.php.

static oxERPBase::_checkRequestedVersion ( )

staticprotected

checks requested version if it is supported by shop

Exceptions

Exception on not supported version

Returns: null

Definition at line 596 of file oxerpbase.php.

static oxERPBase::_checkShopVersion ( )

staticprotected

checks if erp version is supported by shop

Exceptions

Exception on not supported shop version

Returns: null

Definition at line 578 of file oxerpbase.php.

oxERPBase::_export	(	$sType,
		$sWhere,
		$iStart = `null`,
		$iCount = `null`,
		$sSortFieldName = `null`,
		$sSortType = `null`
	)

protected

Exports one type internal function, called after _beforeExport and before _afterExport methods

Parameters

string	$sType	data type name in objects dir
string	$sWhere	where filter for export
int	$iStart	limit start
int	$iCount	limit
string	$sSortFieldName	field name to sort by
string	$sSortType	"asc" or "desc"

Returns: null

Definition at line 352 of file oxerpbase.php.

oxERPBase::_getImportMode ( $aData )

abstractprotected

retrieve import mode

Parameters

array $aData data

Returns: string

Reimplemented in oxErpGenImport, and oxErpCsv.

oxERPBase::_getImportType ( & $aData )

abstractprotected

retrieve import type

Parameters

array &$aData data

Returns: string

Reimplemented in oxErpGenImport, and oxErpCsv.

oxERPBase::_getInstanceOfType ( $sType )

protected

Factory for ERP types

Parameters

string $sType type name in objects dir

Returns: oxErpType

Reimplemented in oxErpCsv.

Definition at line 324 of file oxerpbase.php.

oxERPBase::_getKeyID	(	$oType,
		$aData
	)

protected

return key id for data record

Parameters

oxErpType	$oType	data type object
array	$aData	data

Returns: string

Definition at line 429 of file oxerpbase.php.

oxERPBase::_importOne ( )

protected

Main Import Handler, imports one row/call/object... returns true if there were any data processed, and master loop should run import again.

after importing, fills $this->_aStatistics[$this->_iIdx] with array of r=>(boolean)result, m=>(string)error message

Returns: boolean

Definition at line 501 of file oxerpbase.php.

oxERPBase::_modifyData	(	$aData,
		$oType
	)

abstractprotected

prepare data for import

Parameters

array	$aData	data
oxErpType	$oType	data type object

Returns: array

Reimplemented in oxErpGenImport, and oxErpCsv.

oxERPBase::_nextIdx ( )

protected

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

Returns: null

Definition at line 460 of file oxerpbase.php.

oxERPBase::_outputMappingArray ( $sTable )

protected

Just used for developing

Parameters

string $sTable table name

Returns: null

Definition at line 408 of file oxerpbase.php.

oxERPBase::_resetIdx ( )

protected

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

Returns: null

Definition at line 444 of file oxerpbase.php.

oxERPBase::_save	(	oxERPType &	$oType,
			$aData,
			$blAllowCustomShopId = `false`
	)

protected

Insert or Update a Row into database

Parameters

oxERPType	&$oType	data type object
array	$aData	assoc. Array with fieldnames, values what should be stored in this table
bool	$blAllowCustomShopId	if custom shop id is allowed

Returns: string | false

Definition at line 557 of file oxerpbase.php.

oxERPBase::createPluginObject ( $sId )

create plugin object

Parameters

string $sId the name of the plugin

Returns: oxErpPluginBase

Definition at line 649 of file oxerpbase.php.

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

Export one object type

Parameters

string	$sType	data type name in objects dir
string	$sWhere	where filter for export
int	$iStart	limit start
int	$iCount	limit
string	$sSortFieldName	field name to sort by
string	$sSortType	"asc" or "desc"

Returns: null

Definition at line 297 of file oxerpbase.php.

oxERPBase::getImportData ( $iIdx = null )

abstract

import data getter

Parameters

int $iIdx data index

Returns: array

Reimplemented in oxErpCsv.

oxERPBase::getImportedRowCount ( )

abstract

gets count of imported rows, total, during import

Returns: int $_iImportedRowCount

Reimplemented in oxErpCsv.

static oxERPBase::getRequestedVersion ( )

static

gets requested db layer version

Exceptions

Exception on not supported version

Returns: string

Definition at line 608 of file oxerpbase.php.

oxERPBase::getSessionID ( )

session id getter

Returns: string

Definition at line 87 of file oxerpbase.php.

oxERPBase::getStatistics ( )

_aStatistics getter

Returns: array

Definition at line 77 of file oxerpbase.php.

static oxERPBase::getUsedDbFieldsVersion ( )

static

gets requested version for db fields used

Returns: string

Definition at line 621 of file oxerpbase.php.

oxERPBase::import ( )

imports all data set up before

Returns: null

Reimplemented in oxErpCsv.

Definition at line 309 of file oxerpbase.php.

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

Init ERP Framework Creates Objects, checks Rights etc.

Parameters

string	$sUserName	user login name
string	$sPassword	user password
int	$iShopID	shop id to login
int	$iLanguage	main language id

Returns: boolean

Reimplemented in oxErpGenImport.

Definition at line 195 of file oxerpbase.php.

oxERPBase::loadSessionData ( $sSessionID )

oxERPBase::loadSessionData() load session - should be called on init

Parameters

string $sSessionID session id

Returns: null

Reimplemented in oxErpCsv.

Definition at line 251 of file oxerpbase.php.

oxERPBase::setImportedIds ( $key )

abstract

adds true to $_aImportedIds where key is given

Parameters

mixed $key - given key

Returns: null

Reimplemented in oxErpCsv.

static oxERPBase::setVersion ( $sDbLayerVersion = '' )

static

gets requested db layer version

Parameters

string $sDbLayerVersion requested version

Exceptions

Exception on not supported version

Returns: null

Definition at line 635 of file oxerpbase.php.

Member Data Documentation

oxERPBase::$_aDbLayer2ShopDbVersions

staticprotected

Initial value:

 array(
        '2.9.0' => '8', 
    )

Definition at line 40 of file oxerpbase.php.

oxERPBase::$_aImportedIds = array()

protected

Definition at line 48 of file oxerpbase.php.

oxERPBase::$_aStatistics = array()

Definition at line 56 of file oxerpbase.php.

oxERPBase::$_blInit = false

protected

Definition at line 20 of file oxerpbase.php.

oxERPBase::$_iIdx = 0

Definition at line 57 of file oxerpbase.php.

oxERPBase::$_iImportedRowCount = 0

protected

Definition at line 54 of file oxerpbase.php.

oxERPBase::$_iLanguage = null

protected

Definition at line 21 of file oxerpbase.php.

oxERPBase::$_sRequestedVersion = ''

staticprotected

Definition at line 26 of file oxerpbase.php.

oxERPBase::$_sSID = null

protected

Definition at line 24 of file oxerpbase.php.

oxERPBase::$_sUserID = null

protected

Definition at line 22 of file oxerpbase.php.

oxERPBase::$MODE_DELETE = "Delete"

static

Definition at line 18 of file oxerpbase.php.

oxERPBase::$MODE_IMPORT = "Import"

static

Definition at line 17 of file oxerpbase.php.

const oxERPBase::ERROR_DELETE_NO_EMPTY_CATEGORY = "Only empty category can be deleated"

Definition at line 12 of file oxerpbase.php.

const oxERPBase::ERROR_ERP_VERSION_NOT_SUPPORTED_BY_SHOP = "ERROR: shop does not support requested ERP version."

Definition at line 14 of file oxerpbase.php.

const oxERPBase::ERROR_NO_INIT = "Init not executed, Access denied!"

Definition at line 11 of file oxerpbase.php.

const oxERPBase::ERROR_OBJECT_NOT_EXISTING = "Object does not exist"

Definition at line 13 of file oxerpbase.php.

const oxERPBase::ERROR_SHOP_VERSION_NOT_SUPPORTED_BY_ERP = "ERROR: ERP does not support current shop version."

Definition at line 15 of file oxerpbase.php.

const oxERPBase::ERROR_USER_EXISTS = "ERROR: User already exists"

Definition at line 10 of file oxerpbase.php.

const oxERPBase::ERROR_USER_NO_RIGHTS = "Not sufficient rights to perform operation!"

Definition at line 9 of file oxerpbase.php.

const oxERPBase::ERROR_USER_WRONG = "ERROR: Could not login"

Definition at line 8 of file oxerpbase.php.

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

core/oxerpbase.php

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation