oxERPType Class Reference

Inheritance diagram for oxERPType:

Inheritance graph
[legend]
Collaboration diagram for oxERPType:

Collaboration graph
[legend]

List of all members.

Detailed Description

ERP base description class

Definition at line 6 of file oxerptype.php.


Public Member Functions

 getFunctionSuffix ()
 getShopObjectName ()
 getBaseTableName ()
 __construct ()
 setFunctionSuffix ($sNew)
 setFieldList ($aFieldList)
 getTableName ($iShopID=1)
 getSQL ($sWhere, $iLanguage=0, $iShopID=1)
 getSortString ($sFieldName=null, $sType=null)
 checkWriteAccess ($sOxid)
 getObjectForDeletion ($sId)
 checkForDeletion ($sId)
 delete ($sID)
 deleteObject ($oObj, $sID)
 addExportData ($aFields)
 addImportData ($aFields)
 getRightFields ()
 getFieldList ()
 getKeyFields ()
 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 ()

Constructor & Destructor Documentation

oxERPType.__construct (  ) 

Class constructor

Returns:
null

Reimplemented in oxERPType_Accessoire, oxERPType_Artextends, oxERPType_Article, oxERPType_Article2Action, oxERPType_Article2Category, oxERPType_ArticleStock, oxERPType_Category, oxERPType_Country, oxERPType_Crossselling, oxERPType_Order, oxERPType_OrderArticle, oxERPType_OrderStatus, oxERPType_ScalePrice, oxERPType_User, and oxERPType_Vendor.

Definition at line 93 of file oxerptype.php.

Member Function Documentation

oxERPType.getFunctionSuffix (  ) 

getter for _sFunctionSuffix

Returns:
string

Definition at line 63 of file oxerptype.php.

oxERPType.getShopObjectName (  ) 

getter for _sShopObjectName

Returns:
string

Definition at line 73 of file oxerptype.php.

oxERPType.getBaseTableName (  ) 

getter for _sTableName

Returns:
string

Definition at line 83 of file oxerptype.php.

oxERPType.setFunctionSuffix ( $  sNew  ) 

setter for the function prefix

Parameters:
string $sNew new function suffix
Returns:
null

Definition at line 108 of file oxerptype.php.

oxERPType.setFieldList ( $  aFieldList  ) 

Setter for field list

Parameters:
array $aFieldList field list to store at oxErpType._aFieldList
Returns:
null

Definition at line 120 of file oxerptype.php.

oxERPType.getTableName ( $  iShopID = 1  ) 

Returns table or Viewname

Parameters:
int $iShopID table shop id
Returns:
string

Definition at line 132 of file oxerptype.php.

oxERPType._getMultilangualFields (  )  [private]

Creates Array with [iLanguage][sFieldName]

Returns:
array

Definition at line 142 of file oxerptype.php.

oxERPType.getSqlFieldName ( $  sField,
$  iLanguage = 0,
$  iShopID = 1 
) [protected]

return sql column name of given table column

Parameters:
string $sField object field anme
int $iLanguage language id
int $iShopID shop id
Returns:
string

Reimplemented in oxERPType_Article, oxERPType_Category, oxERPType_Country, oxERPType_Order, oxERPType_OrderArticle, oxERPType_OrderStatus, oxERPType_User, and oxERPType_Vendor.

Definition at line 169 of file oxerptype.php.

oxERPType.getSQL ( $  sWhere,
$  iLanguage = 0,
$  iShopID = 1 
)

return sql column name of given table column

Parameters:
string $sWhere where condition
int $iLanguage language id
int $iShopID shop id
Returns:
string

Reimplemented in oxERPType_OrderArticle, oxERPType_OrderStatus, and oxERPType_User.

Definition at line 190 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 231 of file oxerptype.php.

oxERPType.checkWriteAccess ( $  sOxid  ) 

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

Parameters:
string $sOxid the oxid of the object
Exceptions:
Exception exceltion is thrown when user has no write access
Returns:
null

Reimplemented in oxERPType_ArticleStock, oxERPType_OrderArticle, oxERPType_OrderStatus, and oxERPType_User.

Definition at line 254 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 exception is thrown when deletion is not possible
Returns:
object of given type

Reimplemented in oxERPType_User.

Definition at line 278 of file oxerptype.php.

oxERPType._isAllowedToEdit ( $  iShopId  )  [protected]

Checks if user rights alllows to edit. Returns TRUE if rights allow

Parameters:
int $iShopId shop id
Returns:
bool

Definition at line 312 of file oxerptype.php.

oxERPType._directSqlCheckForDeletion ( $  sId  )  [protected]

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

Parameters:
string $sId entry id
Returns:
null

Definition at line 331 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
Returns:
null

Definition at line 352 of file oxerptype.php.

oxERPType.delete ( $  sID  ) 

default deletion of the given OXID in the current table

Parameters:
string $sID deletable object id
Returns:
bool

Definition at line 382 of file oxerptype.php.

oxERPType.deleteObject ( $  oObj,
$  sID 
)

default delete call to the given object

Parameters:
object $oObj object to delete
string $sID object id
Returns:
bool

Definition at line 398 of file oxerptype.php.

oxERPType.addExportData ( $  aFields  ) 

We have the possibility to add some data

Parameters:
array $aFields export fields
Returns:
array

Reimplemented in oxERPType_OrderArticle, oxERPType_OrderStatus, and oxERPType_User.

Definition at line 411 of file oxerptype.php.

oxERPType.addImportData ( $  aFields  ) 

allows to modify data before import

Parameters:
array $aFields import fields
Deprecated:
See also:
_preAssignObject
Returns:
array

Definition at line 426 of file oxerptype.php.

oxERPType.getRightFields (  ) 

used for the RR implementation, right now not really used

Returns:
array

Definition at line 436 of file oxerptype.php.

oxERPType.getFieldList (  ) 

returns the predefined field list

Returns:
array

Definition at line 451 of file oxerptype.php.

oxERPType.getKeyFields (  ) 

returns the keylist array

Returns:
array

Definition at line 461 of file oxerptype.php.

oxERPType.hasKeyFields (  ) 

returns try if type has key fields array

Returns:
bool

Definition at line 471 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 used in assign
bool $blAllowCustomShopId if TRUE - custom shop id is allowed
Returns:
array

Reimplemented in oxERPType_Article, oxERPType_ArticleStock, oxERPType_Category, oxERPType_Order, oxERPType_OrderArticle, oxERPType_OrderStatus, and oxERPType_User.

Definition at line 488 of file oxerptype.php.

oxERPType._preSaveObject ( $  oShopObject,
$  aData 
) [protected]

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

Parameters:
object $oShopObject shop object
array $aData object data
Returns:
boolean

Reimplemented in oxERPType_User.

Definition at line 540 of file oxerptype.php.

oxERPType.saveObject ( $  aData,
$  blAllowCustomShopId 
)

saves data by calling object saving

Parameters:
array $aData object data to save
bool $blAllowCustomShopId if TRUE - custom shop id allowed
Returns:
string | false

Definition at line 553 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 post save data
Returns:
mixed data to return

Reimplemented in oxERPType_Order.

Definition at line 596 of file oxerptype.php.

Member Data Documentation

oxERPType.$ERROR_WRONG_SHOPID = "Wrong shop id, operation not allowed!" [static]

Definition at line 12 of file oxerptype.php.

oxERPType.$_sTableName = null [protected]

Definition at line 18 of file oxerptype.php.

oxERPType.$_sFunctionSuffix = null [protected]

Definition at line 24 of file oxerptype.php.

oxERPType.$_aFieldList = null [protected]

Definition at line 30 of file oxerptype.php.

oxERPType.$_aKeyFieldList = null [protected]

Definition at line 36 of file oxerptype.php.

oxERPType.$_sShopObjectName = null [protected]

Definition at line 42 of file oxerptype.php.

oxERPType.$_blRestrictedByShopId = false [protected]

Definition at line 49 of file oxerptype.php.

oxERPType.$_aFieldListVersions = null [protected]

Reimplemented in oxERPType_Artextends, oxERPType_Article, oxERPType_Category, oxERPType_Country, oxERPType_Order, oxERPType_OrderArticle, oxERPType_User, and oxERPType_Vendor.

Definition at line 56 of file oxerptype.php.

The documentation for this class was generated from the following file:
Generated on Wed Apr 22 12:31:00 2009 for OXID eShop CE by  doxygen 1.5.5