Definition at line 17 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) | |
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() |
| 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, oxOrderArticle, oxPayment, oxPricealarm, oxRating, oxRecommList, oxRemark, oxReview, oxShop, oxStatistic, oxUser, oxUserBasket, oxUserBasketItem, oxUserPayment, oxVendor, oxVoucher, oxVoucherSerie, and oxWrapping.
Definition at line 133 of file oxbase.php.
| oxBase.__set | ( | $ | sName, | |
| $ | sValue | |||
| ) |
Magic setter. If using lazy loading, adds setted field to fields array
| string | $sName name value | |
| mixed | $sValue value |
Definition at line 160 of file oxbase.php.
| oxBase.__get | ( | $ | sName | ) |
Magic getter for older versions and template variables
| string | $sName variable name |
Reimplemented in oxCategory, oxContent, oxOrder, oxUser, oxUserPayment, oxVendor, and oxWrapping.
Definition at line 182 of file oxbase.php.
| oxBase.__isset | ( | $ | mVar | ) |
Magic isset() handler. Workaround for detecting if protected properties are set.
| mixed | $mVar Supplied class variable |
Definition at line 266 of file oxbase.php.
| oxBase.__clone | ( | ) |
Magic fuinction invoked on object cloning. Basically takes care about cloning properly DB fields.
Definition at line 276 of file oxbase.php.
| oxBase.oxClone | ( | $ | oObject | ) |
Clone this object - similar to Copy Constructor.
| object | $oObject Object to copy |
Definition at line 295 of file oxbase.php.
| oxBase.init | ( | $ | sTableName = null, |
|
| $ | blForceAllFields = false | |||
| ) |
Sets the names to main and view tables, loads metadata of each table.
| string | $sTableName Name of DB object table | |
| bool | $blForceAllFields Forces initialisation of all fields overriding lazy loading functionality |
Definition at line 315 of file oxbase.php.
| oxBase.assign | ( | $ | dbRecord | ) |
Assigns DB field values to object fields. Returns true on success.
| array | $dbRecord Associative data values array |
Reimplemented in oxCategory, oxContent, oxGbEntry, oxI18n, oxNews, oxOrder, oxOrderArticle, oxReview, oxVendor, and oxWrapping.
Definition at line 340 of file oxbase.php.
| oxBase.getClassName | ( | ) |
| oxBase.getCoreTableName | ( | ) |
| oxBase.getId | ( | ) |
| oxBase.setId | ( | $ | sOXID = null |
) |
Sets unique object id
| string | $sOXID Record ID |
Definition at line 401 of file oxbase.php.
| oxBase.setShopId | ( | $ | iShopId | ) |
Sets original object shop ID
| int | $iShopId New shop ID |
Definition at line 422 of file oxbase.php.
| oxBase.getShopId | ( | ) |
| oxBase.getViewName | ( | ) |
Returns main table data is actually selected from (could be a view name as well)
Definition at line 442 of file oxbase.php.
| oxBase.modifyCacheKey | ( | $ | sCacheKey, | |
| $ | blOverride = false | |||
| ) |
Lazy loading cache key modifier.
| string | $sCacheKey kache key | |
| bool | $blOverride marker to force override cache key |
Reimplemented in oxI18n.
Definition at line 455 of file oxbase.php.
| oxBase.disableLazyLoading | ( | ) |
Disables lazy loading mechanism and inits object fully
Definition at line 469 of file oxbase.php.
| oxBase.isDerived | ( | ) |
Returns true in case the item represented by this object is derived from parent shop
Definition at line 481 of file oxbase.php.
| oxBase.setIsDerived | ( | $ | blVal | ) |
Returns true in case the item represented by this object is derived from parent shop
| bool | $blVal if derived |
Definition at line 493 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.
Reimplemented in oxI18n.
Definition at line 504 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 ?
| string | $sOXID Object ID |
Reimplemented in oxI18n, oxNewsSubscribed, oxRemark, oxReview, oxUser, and oxUserPayment.
Definition at line 518 of file oxbase.php.
| oxBase.buildSelectString | ( | $ | aWhere = null |
) |
Builds and returns SQL query string.
| mixed | $aWhere SQL select WHERE conditions array (default false) |
Definition at line 543 of file oxbase.php.
| oxBase.assignRecord | ( | $ | sSelect | ) |
Performs SQL query, assigns record field values to object. Returns true on success.
| string | $sSelect SQL statement |
Definition at line 572 of file oxbase.php.
| oxBase.getFieldData | ( | $ | sFieldName | ) |
Gets field data
| string | $sFieldName name (eg. 'oxtitle') of a data field to get |
Definition at line 594 of file oxbase.php.
| oxBase.getSelectFields | ( | ) |
Function builds the field list used in select.
Definition at line 605 of file oxbase.php.
| oxBase.delete | ( | $ | sOXID = null |
) |
Delete this object from the database, returns true on success.
| string | $sOXID Object ID(default null) |
Reimplemented in oxActions, oxAttribute, oxCategory, oxDelivery, oxDeliverySet, oxDiscount, oxGroups, oxMediaUrl, oxNews, oxNewsletter, oxOrder, oxPayment, oxRecommList, oxSelectlist, oxUser, oxUserBasket, and oxVoucherSerie.
Definition at line 629 of file oxbase.php.
| oxBase.save | ( | ) |
Save this Object to database, insert or update as needed.
Reimplemented in oxObject2Group, oxOrder, and oxUser.
Definition at line 661 of file oxbase.php.
| oxBase.exists | ( | $ | sOXID = null |
) |
Checks if this object exists, returns true on success.
| string | $sOXID Object ID(default null) |
Reimplemented in oxUser.
Definition at line 714 of file oxbase.php.
| oxBase.getSqlFieldName | ( | $ | sField | ) |
Returns field name. This method is actually used in oxi18n.
| string | $sField Field name |
Reimplemented in oxI18n.
Definition at line 735 of file oxbase.php.
| oxBase.getSqlActiveSnippet | ( | $ | blForceCoreTable = false |
) |
Returns SQL select string with checks if items are available
| bool | $blForceCoreTable forces core table usage (optional) |
Reimplemented in oxCategory, and oxI18n.
Definition at line 747 of file oxbase.php.
| oxBase.validate | ( | ) |
Checks if methods, stored in _aIdx2FldName array exists in running object methods collection. Returns true if method exists.
Definition at line 775 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.
| string | $sOXID Object ID(default null). Pass the ID in case object is not loaded. |
Definition at line 800 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.
| int | $iAction Action identifier. | |
| string | $sOXID Object ID(default null). Pass the ID in case object is not loaded. |
Definition at line 814 of file oxbase.php.
| oxBase.hasErrors | ( | ) |
| oxBase.getErrors | ( | ) |
| oxBase.getError | ( | $ | sField | ) |
Returns error description of false if error field unavailable.
| string | $sField name of error |
Definition at line 846 of file oxbase.php.
| oxBase.getHtmlError | ( | $ | sField | ) |
Returns errors if available.
| string | $sField name of error |
Definition at line 864 of file oxbase.php.
| oxBase._getObjectViewName | ( | $ | sTable, | |
| $ | sShopID = null | |||
| ) | [protected] |
Returns actual object view or table name
| string | $sTable Original table name | |
| int | $sShopID Shop ID |
Definition at line 879 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).
| bool | $blReturnSimple Set $blReturnSimple to true when you need simple array (meta data array is returned otherwise) |
Definition at line 895 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
| bool | $blForceFullStructure Set to true if you want to load full structure in any case. |
Definition at line 936 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()).
| bool | $blForceFullStructure Whether to force loading of full data structure |
Reimplemented in oxI18n.
Definition at line 972 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.
| string | $sFieldName Field name |
Reimplemented in oxI18n.
Definition at line 1020 of file oxbase.php.
| oxBase._addField | ( | $ | sName, | |
| $ | iStatus, | |||
| $ | sType = null, |
|||
| $ | sLength = null | |||
| ) | [protected] |
Adds additional field to meta structure
| string | $sName Field name | |
| int | $iStatus Field name status. In derived classes it indicates multilanguage status. | |
| string | $sType Field type | |
| string | $sLength Field Length |
Definition at line 1035 of file oxbase.php.
| oxBase._getFieldLongName | ( | $ | sFieldName | ) | [protected] |
Returns long field name in "<table>__<field_name>" format.
| string | $sFieldName Short field name |
Definition at line 1090 of file oxbase.php.
| oxBase._setFieldData | ( | $ | sFieldName, | |
| $ | sValue, | |||
| $ | iDataType = oxField::T_TEXT | |||
| ) | [protected] |
Sets data field value
| string | $sFieldName index OR name (eg. 'oxarticles__oxtitle') of a data field to set | |
| string | $sValue value of data field | |
| int | $iDataType field type |
Reimplemented in oxCategory, oxContent, oxLinks, oxNews, oxNewsletter, oxOrderArticle, oxStatistic, and oxUserBasketItem.
Definition at line 1110 of file oxbase.php.
| oxBase._getUpdateFieldValue | ( | $ | sFieldName, | |
| $ | oField | |||
| ) | [protected] |
returns quoted field value for using in update statement
| string | $sFieldName name of field | |
| oxField | $oField field object |
Definition at line 1153 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'...
| bool | $blUseSkipSaveFields forces usage of skip save fields array (default is true) |
Definition at line 1186 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.
| oxObjectException | Throws on failure inserting |
Reimplemented in oxCategory, oxI18n, oxNews, oxNewsSubscribed, oxOrder, oxUser, and oxUserPayment.
Definition at line 1214 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.
Reimplemented in oxCategory, oxGbEntry, oxNews, oxNewsSubscribed, oxOrder, oxPricealarm, oxRating, oxRemark, oxReview, oxUser, oxUserBasket, and oxUserPayment.
Definition at line 1253 of file oxbase.php.
| oxBase._rebuildCache | ( | ) | [protected] |
| oxBase._setRecordNumber | ( | $ | sMaxField, | |
| $ | aWhere = null, |
|||
| $ | iMaxTryCnt = 5 | |||
| ) | [protected] |
Tries to fetch and set next record number in DB. Returns true on success
| string | $sMaxField field name where record number is stored | |
| string | $aWhere where condition array | |
| int | $iMaxTryCnt max number of tryouts |
Reimplemented in oxUser.
Definition at line 1304 of file oxbase.php.
| oxBase._isDisabledFieldCache | ( | ) | [protected] |
Checks if current class disables field caching. This method is primary used in unit tests.
Definition at line 1340 of file oxbase.php.
oxBase.$_sOXID = null [protected] |
Definition at line 23 of file oxbase.php.
oxBase.$_iShopId = null [protected] |
Definition at line 29 of file oxbase.php.
oxBase.$_blIsSimplyClonable = true [protected] |
Definition at line 36 of file oxbase.php.
oxBase.$_aErrors = array() [protected] |
Definition at line 42 of file oxbase.php.
oxBase.$_sClassName = 'oxbase' [protected] |
Reimplemented in oxActions, oxAttribute, oxCategory, oxContent, oxCountry, oxDelivery, oxDeliverySet, oxDiscount, oxGbEntry, oxGroups, oxI18n, oxLinks, 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 48 of file oxbase.php.
oxBase.$_sCoreTable = null [protected] |
Definition at line 55 of file oxbase.php.
oxBase.$_sViewTable = null [protected] |
Definition at line 61 of file oxbase.php.
oxBase.$_aFieldNames = array('oxid' => 0) [protected] |
Definition at line 69 of file oxbase.php.
oxBase.$_blIsNewCache = false [protected] |
Definition at line 75 of file oxbase.php.
oxBase.$_sCacheKey = null [protected] |
Definition at line 82 of file oxbase.php.
oxBase.$_blUseLazyLoading = false [protected] |
oxBase.$_aSkipSaveFields = array() [protected] |
Reimplemented in oxContent, oxOrder, oxRemark, and oxUserBasket.
Definition at line 96 of file oxbase.php.
oxBase.$_sExistKey = "oxid" [protected] |
Definition at line 102 of file oxbase.php.
oxBase.$_blIsDerived = null [protected] |
Definition at line 110 of file oxbase.php.
oxBase.$_blDisableFieldCaching = array() [static, protected] |
Definition at line 121 of file oxbase.php.
oxBase.$_blIsSeoObject = false [protected] |
1.5.5