OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject Class Reference

Public Member Functions
	getBaseTableName ()
	setFieldList ($aFieldList)
	checkWriteAccess ($shopObject, $data=null)
	checkCreateAccess ($data)
	import ($data)
	getRightFields ()
	getFieldList ()
	getKeyFields ()

Protected Member Functions
	getShopObjectName ()
	getTableName ()
	preAssignObject ($shopObject, $data, $allowCustomShopId)
	preSaveObject ($shopObject, $data)
	saveObject ($data, $allowCustomShopId)
	postSaveObject ($shopObject, $data)
	getOxidFromKeyFields ($data)
	isAllowedToEdit ($shopId)
	checkIdField ($id)
	createShopObject ()

Protected Attributes
	$tableName = null
	$fieldList = null
	$keyFieldList = null
	$shopObjectName = null

Detailed Description

Main import object - includes basic implementations of methods.

Member Function Documentation

checkCreateAccess()

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::checkCreateAccess

(

$data

)

Basic access check for creating new objects

Parameters

array

$data

fields to be written

Exceptions

Exception

on now access

checkIdField()

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::checkIdField (   $id )

protected

Checks if id field is valid.

Parameters

string

$id

field check id

Exceptions

Exception

checkWriteAccess()

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::checkWriteAccess	(		$shopObject,
			$data = null
	)

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

Parameters

\OxidEsales\Eshop\Core\Model\BaseModel	$shopObject	Loaded shop object.
array	$data	Fields to be written, null for default.

Exceptions

Exception

on now access

createShopObject()

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::createShopObject ( )

protected

Creates shop object.

Returns

\OxidEsales\Eshop\Core\Model\BaseModel

getBaseTableName()

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::getBaseTableName

(

)

Getter for _sTableName

Returns

string

getFieldList()

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::getFieldList

(

)

Returns the predefined field list.

Returns

array

getKeyFields()

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::getKeyFields

(

)

Returns the keylist array.

Returns

array

getOxidFromKeyFields()

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::getOxidFromKeyFields (   $data )

protected

Returns oxid of this data type from key fields.

Parameters

array

$data

Data for object.

Returns

string

getRightFields()

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::getRightFields

(

)

Used for the RR implementation, right now not really used.

Returns

array

getShopObjectName()

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::getShopObjectName ( )

protected

Getter for _sShopObjectName.

Returns

string

getTableName()

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::getTableName ( )

protected

Returns table or View name.

Returns

string

import()

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::import

(

$data

)

Insert or Update a Row into database.

Parameters

array

$data

Assoc. array with field names, values what should be stored in this table.

Returns

string|false

isAllowedToEdit()

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::isAllowedToEdit (   $shopId )

protected

Checks if user is allowed to edit in this shop.

Parameters

int

$shopId

shop id

Returns

bool

postSaveObject()

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::postSaveObject (   $shopObject,   $data  )

protected

Post saving hook. can finish transactions if needed or adjust related data.

Parameters

\OxidEsales\Eshop\Core\Model\BaseModel	$shopObject	Shop object.
array	$data	Data to save.

Returns

mixed data to return

preAssignObject()

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::preAssignObject (   $shopObject,   $data,   $allowCustomShopId  )

protected

Issued before saving an object. can modify aData for saving.

Parameters

\OxidEsales\Eshop\Core\Model\BaseModel	$shopObject	shop object
array	$data	data to prepare
bool	$allowCustomShopId	if allow custom shop id

Returns

array

preSaveObject()

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::preSaveObject (   $shopObject,   $data  )

protected

Prepares object for saving in shop. Returns true if save can proceed further.

Parameters

\OxidEsales\Eshop\Core\Model\BaseModel	$shopObject	Shop object.
array	$data	Data for importing.

Returns

boolean

saveObject()

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::saveObject (   $data,   $allowCustomShopId  )

protected

Saves object data.

Parameters

array	$data	data for saving
bool	$allowCustomShopId	allow custom shop id

Returns

string|false

setFieldList()

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::setFieldList

(

$aFieldList

)

setter for field list

Parameters

array

$aFieldList

fields to set

Member Data Documentation

$fieldList

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::$fieldList = null

protected

$keyFieldList

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::$keyFieldList = null

protected

$shopObjectName

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::$shopObjectName = null

protected

$tableName

OxidEsales\EshopCommunity\Core\GenericImport\ImportObject\ImportObject::$tableName = null

protected

---

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

• /oxideshop-ce/source/Core/GenericImport/ImportObject/ImportObject.php