oxBase Class Reference

Inheritance diagram for oxBase:

Inheritance graph
[legend]
Collaboration diagram for oxBase:

Collaboration graph
[legend]

List of all members.

Detailed Description

Base class associated with database record

Definition at line 16 of file oxbase.php.


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 ()
 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)
 setInList ()
 isOx ()
 isReadOnly ()
 setReadOnly ($blReadOnly)

Protected Member Functions

 _isInList ()
 _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
 $_blReadOnly = false
 $_blIsInList = 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, oxManufacturer, oxMediaUrl, oxNews, oxNewsletter, oxNewsSubscribed, oxObject2Group, oxOrder, oxOrderArticle, oxPayment, oxPricealarm, oxRating, oxRecommList, oxRemark, oxReview, oxShop, oxSimpleVariant, oxStatistic, oxUser, oxUserBasket, oxUserBasketItem, oxUserPayment, oxVendor, oxVoucher, oxVoucherSerie, and oxWrapping.

Definition at line 146 of file oxbase.php.

Member Function Documentation

oxBase.__set ( $  sName,
$  sValue 
)

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

Parameters:
string $sName name value
mixed $sValue value
Returns:
null

Reimplemented in oxArticle.

Definition at line 173 of file oxbase.php.

oxBase.__get ( $  sName  ) 

Magic getter for older versions and template variables

Parameters:
string $sName variable name
Returns:
mixed

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

Definition at line 195 of file oxbase.php.

oxBase.__isset ( $  mVar  ) 

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

Parameters:
mixed $mVar Supplied class variable
Returns:
bool

Reimplemented in oxArticle.

Definition at line 283 of file oxbase.php.

oxBase.__clone (  ) 

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

Returns:
null;

Definition at line 293 of file oxbase.php.

oxBase.oxClone ( $  oObject  ) 

Clone this object - similar to Copy Constructor.

Parameters:
object $oObject Object to copy
Returns:
null

Definition at line 312 of file oxbase.php.

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

Definition at line 332 of file oxbase.php.

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 oxArticle, oxCategory, oxContent, oxGbEntry, oxI18n, oxManufacturer, oxNews, oxOrder, oxOrderArticle, oxReview, oxVendor, and oxWrapping.

Definition at line 357 of file oxbase.php.

oxBase.getClassName (  ) 

Returns object class name

Returns:
string

Definition at line 386 of file oxbase.php.

oxBase.getCoreTableName (  ) 

Return object core table name

Returns:
string

Definition at line 396 of file oxbase.php.

oxBase.getId (  ) 

Returns unique object id.

Returns:
string

Definition at line 406 of file oxbase.php.

oxBase.setId ( $  sOXID = null  ) 

Sets unique object id

Parameters:
string $sOXID Record ID
Returns:
string

Reimplemented in oxArticle.

Definition at line 418 of file oxbase.php.

oxBase.setShopId ( $  iShopId  ) 

Sets original object shop ID

Parameters:
int $iShopId New shop ID
Returns:
null

Definition at line 439 of file oxbase.php.

oxBase.getShopId (  ) 

Return original object shop id

Returns:
int

Definition at line 449 of file oxbase.php.

oxBase.getViewName (  ) 

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

Returns:
string

Definition at line 459 of file oxbase.php.

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.

Definition at line 472 of file oxbase.php.

oxBase.disableLazyLoading (  ) 

Disables lazy loading mechanism and inits object fully

Returns:
null;

Definition at line 486 of file oxbase.php.

oxBase.isDerived (  ) 

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

Returns:
bool

Definition at line 498 of file oxbase.php.

oxBase.setIsDerived ( $  blVal  ) 

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

Parameters:
bool $blVal if derived
Returns:
null

Definition at line 510 of file oxbase.php.

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.

Definition at line 521 of file oxbase.php.

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 oxArticle, oxI18n, oxNewsSubscribed, oxRemark, oxReview, oxUser, and oxUserPayment.

Definition at line 535 of file oxbase.php.

oxBase.buildSelectString ( $  aWhere = null  ) 

Builds and returns SQL query string.

Parameters:
mixed $aWhere SQL select WHERE conditions array (default false)
Returns:
string

Definition at line 560 of file oxbase.php.

oxBase.assignRecord ( $  sSelect  ) 

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

Parameters:
string $sSelect SQL statement
Returns:
unknown

Definition at line 589 of file oxbase.php.

oxBase.getFieldData ( $  sFieldName  ) 

Gets field data

Parameters:
string $sFieldName name (eg. 'oxtitle') of a data field to get
Returns:
value of a data field

Definition at line 611 of file oxbase.php.

oxBase.getSelectFields (  ) 

Function builds the field list used in select.

Returns:
string

Definition at line 622 of file oxbase.php.

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, oxArticle, oxAttribute, oxCategory, oxContent, oxDelivery, oxDeliverySet, oxDiscount, oxGroups, oxManufacturer, oxMediaUrl, oxNews, oxNewsletter, oxOrder, oxPayment, oxRecommList, oxSelectlist, oxUser, oxUserBasket, oxVendor, and oxVoucherSerie.

Definition at line 646 of file oxbase.php.

oxBase.save (  ) 

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

Returns:
mixed

Reimplemented in oxArticle, oxObject2Group, oxOrder, and oxUser.

Definition at line 678 of file oxbase.php.

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.

Definition at line 730 of file oxbase.php.

oxBase.getSqlFieldName ( $  sField  ) 

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

Parameters:
string $sField Field name
Returns:
string

Reimplemented in oxI18n.

Definition at line 751 of file oxbase.php.

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 oxArticle, oxCategory, and oxI18n.

Definition at line 763 of file oxbase.php.

oxBase.validate (  ) 

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

Returns:
bool

Definition at line 791 of file oxbase.php.

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

Definition at line 816 of file oxbase.php.

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

Definition at line 830 of file oxbase.php.

oxBase.hasErrors (  ) 

Returns number of errors.

Returns:
integer

Definition at line 840 of file oxbase.php.

oxBase.getErrors (  ) 

Returns an errors array.

Returns:
array

Definition at line 850 of file oxbase.php.

oxBase.getError ( $  sField  ) 

Returns error description of false if error field unavailable.

Parameters:
string $sField name of error
Returns:
string

Definition at line 862 of file oxbase.php.

oxBase.getHtmlError ( $  sField  ) 

Returns errors if available.

Parameters:
string $sField name of error
Returns:
array

Definition at line 880 of file oxbase.php.

oxBase.setInList (  ) 

Sets item as list element

Returns:
null

Definition at line 892 of file oxbase.php.

oxBase._isInList (  )  [protected]

Checks if this instance is one of oxList elements.

Returns:
bool

Definition at line 902 of file oxbase.php.

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

Definition at line 915 of file oxbase.php.

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

Definition at line 931 of file oxbase.php.

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;

Definition at line 972 of file oxbase.php.

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.

Definition at line 1008 of file oxbase.php.

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.

Definition at line 1056 of file oxbase.php.

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;

Definition at line 1071 of file oxbase.php.

oxBase._getFieldLongName ( $  sFieldName  )  [protected]

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

Parameters:
string $sFieldName Short field name
Returns:
string

Definition at line 1126 of file oxbase.php.

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 oxArticle, oxCategory, oxContent, oxLinks, oxNews, oxNewsletter, oxOrderArticle, oxStatistic, and oxUserBasketItem.

Definition at line 1146 of file oxbase.php.

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

Definition at line 1189 of file oxbase.php.

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

Definition at line 1222 of file oxbase.php.

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 oxArticle, oxCategory, oxI18n, oxNews, oxNewsSubscribed, oxOrder, oxUser, and oxUserPayment.

Definition at line 1250 of file oxbase.php.

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 oxArticle, oxCategory, oxGbEntry, oxNews, oxNewsSubscribed, oxOrder, oxPricealarm, oxRating, oxRemark, oxReview, oxUser, oxUserBasket, and oxUserPayment.

Definition at line 1289 of file oxbase.php.

oxBase._rebuildCache (  )  [protected]

Clears Smarty cache data.

Returns:
null

Definition at line 1324 of file oxbase.php.

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.

Definition at line 1341 of file oxbase.php.

oxBase._isDisabledFieldCache (  )  [protected]

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

Returns:
bool

Definition at line 1377 of file oxbase.php.

oxBase.isOx (  ) 

Checks if object ID's first two chars are 'o' and 'x'. Returns true or false

Returns:
bool

Definition at line 1392 of file oxbase.php.

oxBase.isReadOnly (  ) 

Is object readonly

Returns:
bool

Definition at line 1406 of file oxbase.php.

oxBase.setReadOnly ( $  blReadOnly  ) 

Set object readonly

Parameters:
bool $blReadOnly readonly flag
Returns:
null

Definition at line 1418 of file oxbase.php.

Member Data Documentation

oxBase.$_sOXID = null [protected]

Definition at line 22 of file oxbase.php.

oxBase.$_iShopId = null [protected]

Definition at line 28 of file oxbase.php.

oxBase.$_blIsSimplyClonable = true [protected]

Definition at line 35 of file oxbase.php.

oxBase.$_aErrors = array() [protected]

Definition at line 41 of file oxbase.php.

oxBase.$_sClassName = 'oxbase' [protected]

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

Definition at line 47 of file oxbase.php.

oxBase.$_sCoreTable = null [protected]

Definition at line 54 of file oxbase.php.

oxBase.$_sViewTable = null [protected]

Definition at line 60 of file oxbase.php.

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

Definition at line 68 of file oxbase.php.

oxBase.$_blIsNewCache = false [protected]

Definition at line 74 of file oxbase.php.

oxBase.$_sCacheKey = null [protected]

Definition at line 81 of file oxbase.php.

oxBase.$_blUseLazyLoading = false [protected]

Reimplemented in oxArticle, oxCategory, and oxSimpleVariant.

Definition at line 88 of file oxbase.php.

oxBase.$_aSkipSaveFields = array() [protected]

Reimplemented in oxContent, oxOrder, oxRemark, and oxUserBasket.

Definition at line 95 of file oxbase.php.

oxBase.$_sExistKey = "oxid" [protected]

Definition at line 101 of file oxbase.php.

oxBase.$_blIsDerived = null [protected]

Definition at line 109 of file oxbase.php.

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

Definition at line 120 of file oxbase.php.

oxBase.$_blIsSeoObject = false [protected]

Reimplemented in oxArticle, oxCategory, oxContent, oxManufacturer, and oxVendor.

Definition at line 127 of file oxbase.php.

oxBase.$_blReadOnly = false [protected]

Definition at line 134 of file oxbase.php.

oxBase.$_blIsInList = false [protected]

Definition at line 141 of file oxbase.php.

The documentation for this class was generated from the following file:
Generated on Wed May 13 13:29:22 2009 for OXID eShop CE by  doxygen 1.5.5