oxBase Class Reference

Inheritance diagram for oxBase:

[legend]

Collaboration diagram for oxBase:

[legend]

List of all members.

---

Detailed Description

Base class associated with database record

Public Member Functions
	__construct ()
	__set ($sName, $sValue)
	__get ($sName)
	__isset ($mVar)
	__clone ()
	oxClone ($oObject)
	init ($sTableName=null, $blForceAllFields=false)
	assign ($dbRecord)
	getClassName ()
	getCoreTableName ()
	getId ()
	setId ($sOXID=null)
	setShopId ($iShopId)
	getShopId ()
	getViewName ()
	modifyCacheKey ($sCacheKey, $blOverride=false)
	disableLazyLoading ()
	setForceCoreTableUsage ($blForceCoreTableUsage)
	setDisableShopCheck ($blDisableShopCheck)
	isDerived ()
	setIsDerived ($blVal)
	isMultilang ()
	load ($sOXID)
	buildSelectString ($aWhere=null)
	assignRecord ($sSelect)
	getFieldData ($sFieldName)
	getSelectFields ()
	delete ($sOXID=null)
	save ()
	exists ($sOXID=null)
	getSqlFieldName ($sField)
	getSqlActiveSnippet ($blForceCoreTable=false)
	validate ()
	beforeUpdate ($sOXID=null)
	onChange ($iAction=null, $sOXID=null)
	hasErrors ()
	getErrors ()
	getError ($sField)
	getHtmlError ($sField)
Protected Member Functions
	_getObjectViewName ($sTable, $sShopID=null)
	_getAllFields ($blReturnSimple=false)
	_initDataStructure ($blForceFullStructure=false)
	_getNonCachedFieldNames ($blForceFullStructure=false)
	_getFieldStatus ($sFieldName)
	_addField ($sName, $iStatus, $sType=null, $sLength=null)
	_getFieldLongName ($sFieldName)
	_setFieldData ($sFieldName, $sValue, $iDataType=oxField::T_TEXT)
	_getUpdateFieldValue ($sFieldName, $oField)
	_getUpdateFields ($blUseSkipSaveFields=true)
	_update ()
	_insert ()
	_rebuildCache ()
	_setRecordNumber ($sMaxField, $aWhere=null, $iMaxTryCnt=5)
	_isDisabledFieldCache ()
Protected Attributes
	$_sOXID = null
	$_iShopId = null
	$_blIsSimplyClonable = true
	$_aErrors = array()
	$_sClassName = 'oxbase'
	$_sCoreTable = null
	$_sViewTable = null
	$_aFieldNames = array('oxid' => 0)
	$_blIsNewCache = false
	$_sCacheKey = null
	$_blUseLazyLoading = false
	$_aSkipSaveFields = array()
	$_sExistKey = "oxid"
	$_blIsDerived = null
	$_blIsSeoObject = false
Static Protected Attributes
static	$_blDisableFieldCaching = array()

---

Constructor & Destructor Documentation

oxBase.__construct

(

)

Class constructor, sets active shop.

Reimplemented in oxActions, oxAttribute, oxCategory, oxContent, oxCountry, oxDelivery, oxDeliverySet, oxDiscount, oxGbEntry, oxGroups, oxI18n, oxLinks, oxMediaUrl, oxNews, oxNewsletter, oxNewsSubscribed, oxObject2Group, oxOrder, oxPayment, oxPricealarm, oxRecommList, oxRemark, oxShop, oxStatistic, oxUser, oxUserBasket, oxUserBasketItem, oxUserPayment, oxVendor, oxVoucher, oxVoucherSerie, and oxWrapping.

---

Member Function Documentation

oxBase.__set	(	$	sName,
		$	sValue
	)

Magic setter. If using lazy loading, adds setted field to fields array

Parameters:

	string	$sName
	mixed	$sValue

Returns:

null

oxBase.__get

(

$

sName

)

Magic getter for older versions and template variables

Parameters:

string

$sName variable name

Returns:

mixed

Reimplemented in oxCategory, oxContent, oxOrder, oxUser, oxUserPayment, oxVendor, and oxWrapping.

oxBase.__isset

(

$

mVar

)

Magic isset() handler. Workaround for detecting if protected properties are set.

Parameters:

mixed

$mVar Supplied class variable

Returns:

bool

oxBase.__clone

(

)

Magic fuinction invoked on object cloning. Basically takes care about cloning properly DB fields.

Returns:

null;

oxBase.oxClone

(

$

oObject

)

Clone this object - similar to Copy Constructor.

Parameters:

object

$oObject Object to copy

Returns:

null

oxBase.init	(	$	sTableName = null,
		$	blForceAllFields = false
	)

Sets the names to main and view tables, loads metadata of each table.

Parameters:

	string	$sTableName Name of DB object table
	bool	$blForceAllFields Forces initialisation of all fields overriding lazy loading functionality

Returns:

null

oxBase.assign

(

$

dbRecord

)

Assigns DB field values to object fields. Returns true on success.

Parameters:

array

$dbRecord Associative data values array

Returns:

null

Reimplemented in oxCategory, oxContent, oxGbEntry, oxI18n, oxNews, oxOrder, oxVendor, and oxWrapping.

oxBase.getClassName

(

)

Returns object class name

Returns:

string

oxBase.getCoreTableName

(

)

Return object core table name

Returns:

string

oxBase.getId

(

)

Returns unique object id.

Returns:

string

oxBase.setId

(

$

sOXID = null

)

Sets unique object id

Parameters:

string

$sOXID Record ID

Returns:

string

oxBase.setShopId

(

$

iShopId

)

Sets original object shop ID

Parameters:

int

$iShopId New shop ID

Returns:

null

oxBase.getShopId

(

)

Return original object shop id

Returns:

int

oxBase.getViewName

(

)

Returns main table data is actually selected from (could be a view name as well)

Returns:

string

oxBase.modifyCacheKey	(	$	sCacheKey,
		$	blOverride = false
	)

Lazy loading cache key modifier.

Parameters:

	string	$sCacheKey kache key
	bool	$blOverride marker to force override cache key

Returns:

null;

Reimplemented in oxI18n.

oxBase.disableLazyLoading

(

)

Disables lazy loading mechanism and inits object fully

Returns:

null;

oxBase.setForceCoreTableUsage

(

$

blForceCoreTableUsage

)

Sets $this->_blForceCoreTableUsage property. Set it to true if you want to disable db view usage and select object records from core table (from all shops).

Parameters:

bool

$blForceCoreTableUsage New value

Returns:

null

oxBase.setDisableShopCheck

(

$

blDisableShopCheck

)

Set $this->_blDisableShopCheck class variable.

Parameters:

bool

$blDisableShopCheck New value

Returns:

null

oxBase.isDerived

(

)

Returns true in case the item represented by this object is derived from parent shop

Returns:

bool

oxBase.setIsDerived

(

$

blVal

)

Returns true in case the item represented by this object is derived from parent shop

Parameters:

bool

$blVal

oxBase.isMultilang

(

)

Returns true, if object has multilanguage fields (if object is derived from oxi18n class). In oxBase it is always returns false, as oxBase treats all fields as non multilanguage.

Returns:

bool

Reimplemented in oxI18n.

oxBase.load

(

$

sOXID

)

Loads object data from DB (object data ID is passed to method). Returns true on success. could throw oxObjectException F ?

Parameters:

string

$sOXID Object ID

Returns:

bool

Reimplemented in oxI18n, oxNewsSubscribed, oxRemark, oxUser, and oxUserPayment.

oxBase.buildSelectString

(

$

aWhere = null

)

Builds and returns SQL query string.

Parameters:

mixed

$aWhere SQL select WHERE conditions array (default false)

Returns:

string

oxBase.assignRecord

(

$

sSelect

)

Performs SQL query, assigns record field values to object. Returns true on success.

Parameters:

string

$sSelect SQL statement

Returns:

unknown

oxBase.getFieldData

(

$

sFieldName

)

Gets field data

Parameters:

string

$sFieldName name (eg. 'oxtitle') of a data field to get

Returns:

value of a data field

oxBase.getSelectFields

(

)

Function builds the field list used in select.

Returns:

string

oxBase.delete

(

$

sOXID = null

)

Delete this object from the database, returns true on success.

Parameters:

string

$sOXID Object ID(default null)

Returns:

bool

Reimplemented in oxActions, oxAttribute, oxCategory, oxDelivery, oxDeliverySet, oxDiscount, oxGroups, oxMediaUrl, oxNews, oxNewsletter, oxOrder, oxPayment, oxRecommList, oxSelectlist, oxUser, oxUserBasket, and oxVoucherSerie.

oxBase.save

(

)

Save this Object to database, insert or update as needed.

Returns:

mixed

Reimplemented in oxObject2Group, oxOrder, and oxUser.

oxBase.exists

(

$

sOXID = null

)

Checks if this object exists, returns true on success.

Parameters:

string

$sOXID Object ID(default null)

Returns:

bool

Reimplemented in oxUser.

oxBase.getSqlFieldName

(

$

sField

)

Returns field name. This method is actually used in oxi18n.

Parameters:

string

$sField Field name

Returns:

string

Reimplemented in oxI18n.

oxBase.getSqlActiveSnippet

(

$

blForceCoreTable = false

)

Returns SQL select string with checks if items are available

Parameters:

bool

$blForceCoreTable forces core table usage (optional)

Returns:

string

Reimplemented in oxCategory, and oxI18n.

oxBase.validate

(

)

Checks if methods, stored in _aIdx2FldName array exists in running object methods collection. Returns true if method exists.

Returns:

bool

oxBase.beforeUpdate

(

$

sOXID = null

)

This function is triggered before the record is updated. If you make any update to the database record manually you should also call beforeUpdate() from your script.

Parameters:

string

$sOXID Object ID(default null). Pass the ID in case object is not loaded.

Returns:

null

oxBase.onChange	(	$	iAction = null,
		$	sOXID = null
	)

This function is triggered whenever the object is saved or deleted. onChange() is triggered after saving the changes in Save() method, but before actually deleting the instance from the database. If you make any change to the database record manually you should also call onChange() from your script.

Parameters:

	int	$iAction Action identifier.
	string	$sOXID Object ID(default null). Pass the ID in case object is not loaded.

Returns:

null

oxBase.hasErrors

(

)

Returns number of errors.

Returns:

integer

oxBase.getErrors

(

)

Returns an errors array.

Returns:

array

oxBase.getError

(

$

sField

)

Returns error description of false if error field unavailable.

Parameters:

string

$sField name of error

Returns:

string

oxBase.getHtmlError

(

$

sField

)

Returns errors if available.

Parameters:

string

$sField name of error

Returns:

array

oxBase._getObjectViewName	(	$	sTable,
		$	sShopID = null
	)			[protected]

Returns actual object view or table name

Parameters:

	string	$sTable Original table name
	int	$sShopID Shop ID

Returns:

string

oxBase._getAllFields

(

$

blReturnSimple = false

)

[protected]

Returns meta field or simple array of all object fields. This method is slow and normally is called before field cache is built. Make sure it is not called after first page is loaded and cache data is fully built (until tmp dir is cleaned).

Parameters:

bool

$blReturnSimple Set $blReturnSimple to true when you need simple array (meta data array is returned otherwise)

Returns:

array

oxBase._initDataStructure

(

$

blForceFullStructure = false

)

[protected]

Initilizes object data structure. Either by trying to load from cache or by calling $this->_getNonCachedFieldNames

Parameters:

bool

$blForceFullStructure Set to true if you want to load full structure in any case.

Returns:

null;

oxBase._getNonCachedFieldNames

(

$

blForceFullStructure = false

)

[protected]

Returns the list of fields. This function is slower and its result is normally cached. Basically we have 3 separate cases here: 1. We are in admin so we need extended info for all fields (name, field length and field type) 2. Object is not lazy loaded so we will return all data fields as simple array, as we nede only names 3. Object is lazy loaded so we will return empty array as all fields are loaded on request (in __get()).

Parameters:

bool

$blForceFullStructure Whether to force loading of full data structure

Returns:

array

Reimplemented in oxI18n.

oxBase._getFieldStatus

(

$

sFieldName

)

[protected]

Returns _aFieldName[] value. 0 means - non multilanguage, 1 - multilanguage field. But this is defined only in derived oxi18n class. In oxBase it is always 0, as oxBase treats all fields as non multilanguage.

Parameters:

string

$sFieldName Field name

Returns:

int

Reimplemented in oxI18n.

oxBase._addField	(	$	sName,
		$	iStatus,
		$	sType = null,
		$	sLength = null
	)			[protected]

Adds additional field to meta structure

Parameters:

	string	$sName Field name
	int	$iStatus Field name status. In derived classes it indicates multilanguage status.
	string	$sType Field type
	string	$sLength Field Length

Returns:

null;

oxBase._getFieldLongName

(

$

sFieldName

)

[protected]

Returns long field name in "<table>__<field_name>" format.

Parameters:

string

$sFieldName Short field name

Returns:

string

oxBase._setFieldData	(	$	sFieldName,
		$	sValue,
		$	iDataType = oxField::T_TEXT
	)			[protected]

Sets data field value

Parameters:

	string	$sFieldName index OR name (eg. 'oxarticles__oxtitle') of a data field to set
	string	$sValue value of data field
	int	$iDataType field type

Returns:

null

Reimplemented in oxCategory, oxContent, oxLinks, oxNews, oxNewsletter, oxStatistic, and oxUserBasketItem.

oxBase._getUpdateFieldValue	(	$	sFieldName,
		$	oField
	)			[protected]

returns quoted field value for using in update statement

Parameters:

	string	$sFieldName name of field
	oxField	$oField field object

Returns:

string

oxBase._getUpdateFields

(

$

blUseSkipSaveFields = true

)

[protected]

Get object fields sql part used for updates or inserts: return e.g. fldName1 = 'value1',fldName2 = 'value2'...

Parameters:

bool

$blUseSkipSaveFields forces usage of skip save fields array (default is true)

Returns:

string

oxBase._update

(

)

[protected]

Update this Object into the database, this function only works on the main table, it will not save any dependend tables, which might be loaded through oxlist.

Exceptions:

oxObjectException

Throws on failure inserting

Returns:

bool

Reimplemented in oxCategory, oxI18n, oxNews, oxNewsSubscribed, oxOrder, oxUser, and oxUserPayment.

oxBase._insert

(

)

[protected]

Insert this Object into the database, this function only works on the main table, it will not save any dependend tables, which might be loaded through oxlist.

Returns:

bool

Reimplemented in oxCategory, oxGbEntry, oxNews, oxNewsSubscribed, oxOrder, oxPricealarm, oxRemark, oxUser, oxUserBasket, and oxUserPayment.

oxBase._rebuildCache

(

)

[protected]

Clears Smarty cache data.

Returns:

null

oxBase._setRecordNumber	(	$	sMaxField,
		$	aWhere = null,
		$	iMaxTryCnt = 5
	)			[protected]

Tries to fetch and set next record number in DB. Returns true on success

Parameters:

	string	$sMaxField field name where record number is stored
	string	$aWhere where condition array
	int	$iMaxTryCnt max number of tryouts

Returns:

bool

Reimplemented in oxUser.

oxBase._isDisabledFieldCache

(

)

[protected]

Checks if current class disables field caching. This method is primary used in unit tests.

Returns:

bool

---

Member Data Documentation

oxBase.$_sOXID = null [protected]

oxBase.$_iShopId = null [protected]

oxBase.$_blIsSimplyClonable = true [protected]

oxBase.$_aErrors = array() [protected]

oxBase.$_sClassName = 'oxbase' [protected]

Reimplemented in oxActions, oxAttribute, oxCategory, oxContent, oxCountry, oxDelivery, oxDeliverySet, oxDiscount, oxGbEntry, oxGroups, oxI18n, oxLinks, oxMediaUrl, oxNews, oxNewsletter, oxNewsSubscribed, oxObject2Group, oxOrder, oxPayment, oxPricealarm, oxRecommList, oxRemark, oxSelectlist, oxShop, oxStatistic, oxUser, oxUserBasket, oxUserBasketItem, oxUserPayment, oxVendor, oxVoucher, oxVoucherSerie, and oxWrapping.

oxBase.$_sCoreTable = null [protected]

oxBase.$_sViewTable = null [protected]

oxBase.$_aFieldNames = array('oxid' => 0) [protected]

oxBase.$_blIsNewCache = false [protected]

oxBase.$_sCacheKey = null [protected]

oxBase.$_blUseLazyLoading = false [protected]

Reimplemented in oxCategory.

oxBase.$_aSkipSaveFields = array() [protected]

Reimplemented in oxContent, oxOrder, oxRemark, and oxUserBasket.

oxBase.$_sExistKey = "oxid" [protected]

oxBase.$_blIsDerived = null [protected]

oxBase.$_blDisableFieldCaching = array() [static, protected]

oxBase.$_blIsSeoObject = false [protected]

Reimplemented in oxCategory, oxContent, and oxVendor.

---

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

• core/oxbase.php