Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes

oxArticle Class Reference

Inheritance diagram for oxArticle:
Collaboration diagram for oxArticle:

List of all members.

Public Member Functions

 __construct ($aParams=null)
 __get ($sName)
 __set ($sName, $sValue)
 isInList ()
 setId ($sId=null)
 getActiveCheckQuery ($blForceCoreTable=null)
 getStockCheckQuery ($blForceCoreTable=null)
 getVariantsQuery ($blRemoveNotOrderables, $blForceCoreTable=null)
 getSqlActiveSnippet ($blForceCoreTable=null)
 setSkipAssign ($blSkipAssign)
 disablePriceLoad ()
 enablePriceLoad ()
 getItemKey ()
 setItemKey ($sItemKey)
 setNoVariantLoading ($blLoadVariants)
 isBuyable ()
 getPersParams ()
 isOnComparisonList ()
 setOnComparisonList ($blOnList)
 setLoadParentData ($blLoadParentData)
 setSkipAbPrice ($blSkipAbPrice=null)
 isMultilingualField ($sFieldName)
 isVisible ()
 assign ($aRecord)
 load ($sOXID)
 addToRatingAverage ($iRating)
 setRatingAverage ($iRating)
 setRatingCount ($iRatingCnt)
 getArticleRatingAverage ($blIncludeVariants=false)
 getArticleRatingCount ($blIncludeVariants=false)
 getReviews ()
 getCrossSelling ()
 getAccessoires ()
 getSimilarProducts ()
 getCustomerAlsoBoughtThisProducts ()
 loadAmountPriceInfo ()
 getSelectLists ($sKeyPrefix=null)
 getVariantsCount ()
 hasMdVariants ()
 getVariantSelections ($aFilterIds=null, $sActVariantId=null, $iLimit=0)
 getSelections ($iLimit=null, $aFilter=null)
 getFullVariants ($blRemoveNotOrderables=true, $blForceCoreTable=null)
 getVariants ($blRemoveNotOrderables=true, $blForceCoreTable=null)
 getSimpleVariants ()
 getAdminVariants ($sLanguage=null)
 getCategory ()
 getCategoryIds ($blActCats=false, $blSkipCache=false)
 getVendor ($blShopCheck=true)
 getVendorId ($blForceReload=false)
 getManufacturerId ($blForceReload=false)
 getManufacturer ($blShopCheck=true)
 inCategory ($sCatNid)
 isAssignedToCategory ($sCatId)
 getTPrice ()
 skipDiscounts ()
 setPrice (oxPrice $oPrice)
 getBasePrice ($dAmount=1)
 getPrice ($dAmount=1)
 setArticleUser ($oUser)
 getArticleUser ()
 getBasketPrice ($dAmount, $aSelList, $oBasket)
 delete ($sOXID=null)
 reduceStock ($dAmount, $blAllowNegativeStock=false)
 updateSoldAmount ($dAmount=0)
 disableReminder ()
 save ()
 resetParent ()
 getPictureGallery ()
 onChange ($sAction=null, $sOXID=null, $sParentID=null)
 getCustomVAT ()
 checkForStock ($dAmount, $dArtStockAmount=0)
 getLongDescription ()
 getLongDesc ()
 setArticleLongDesc ($sDesc)
 getAttributes ()
 getAttributesDisplayableInBasket ()
 appendLink ($sAddParams, $iLang=null)
 getBaseSeoLink ($iLang, $blMain=false)
 getLink ($iLang=null, $blMain=false)
 getMainLink ($iLang=null)
 setLinkType ($iType)
 getLinkType ()
 appendStdLink ($sAddParams, $iLang=null)
 getBaseStdLink ($iLang, $blAddId=true, $blFull=true)
 getStdLink ($iLang=null, $aParams=array())
 getStdTagLink ($sTag)
 getTags ()
 saveTags ($sTags)
 addTag ($sTag)
 getMediaUrls ()
 getDynImageDir ()
 getDispSelList ()
 getMoreDetailLink ()
 getToBasketLink ()
 getStockStatus ()
 getDeliveryDate ()
 getFTPrice ()
 getFPrice ()
 resetRemindStatus ()
 getFNetPrice ()
 getPricePerUnit ()
 isParentNotBuyable ()
 isNotBuyable ()
 setBuyableState ($blBuyable=false)
 setSelectlist ($aSelList)
 getPictureUrl ($iIndex=1)
 getIconUrl ($iIndex=0)
 getThumbnailUrl ($bSsl=null)
 getZoomPictureUrl ($iIndex= '')
 getFileUrl ()
 getPriceFromPrefix ()
 getArticleVat ()
 applyVats (oxPrice $oPrice)
 applyDiscountsForVariant ($oPrice)
 getParentArticle ()
 updateVariantsRemind ()
 getProductId ()
 getProductParentId ()
 getParentId ()
 isOrderArticle ()
 isVariant ()
 isMdVariant ()
 getSqlForPriceCategories ($sFields= '')
 inPriceCategory ($sCatNid)
 getMdVariants ()
 getMdSubvariants ()
 getPictureFieldValue ($sFieldName, $iIndex=null)
 getMasterZoomPictureUrl ($iIndex)
 getUnitName ()
 getArticleFiles ($blAddFromParent=false)
 isDownloadable ()
 hasAmountPrice ()
 getFUnitPrice ()
 getUnitPrice ()
 getFMinPrice ()
 getFVarMinPrice ()
 getVarMinPrice ()
 getMinPrice ()
 isRangePrice ()
 setRangePrice ($blIsRangePrice=true)
 getUnitQuantity ()
 getSize ()
 getWeight ()

Protected Member Functions

 _loadFromDb ($sOXID)
 _hasAnyVariant ($blForceCoreTable=null)
 _loadVariantList ($blSimple, $blRemoveNotOrderables=true, $blForceCoreTable=null)
 _getArticleCategories ($sOXID, $blActCats=false)
 _getSelectCatIds ($sOXID, $blActCats=false)
 _calculatePrice ($oPrice, $dVat=null)
 _isStockStatusChanged ()
 _isVisibilityChanged ()
 _saveArtLongDesc ()
 _skipSaveFields ()
 _mergeDiscounts ($aDiscounts, $aItemDiscounts)
 _getGroupPrice ()
 _getAmountPrice ($dAmount=1)
 _modifySelectListPrice ($dPrice, $aChosenList=null)
 _fillAmountPriceList ($aAmPriceList)
 _getVariantsIds ()
 _applyVAT (oxPrice $oPrice, $dVat)
 _applyCurrency (oxPrice $oPrice, $oCur=null)
 _getAttribsString (&$sAttribs, &$iCnt)
 _getSimList ($sAttribs, $iCnt)
 _generateSimListSearchStr ($sArticleTable, $aList)
 _generateSearchStr ($sOXID, $blSearchPriceCat=false)
 _generateSearchStrForCustomerBought ()
 _generateSelectCatStr ($sOXID, $sCatId, $dPriceFromTo=false)
 _getAmountPriceList ()
 _isFieldEmpty ($sFieldName)
 _isImageField ($sFieldName)
 _assignParentFieldValue ($sFieldName)
 _assignParentFieldValues ()
 _assignNotBuyableParent ()
 _assignStock ()
 _assignPrices ()
 _assignPersistentParam ()
 _assignDynImageDir ()
 _assignComparisonListFlag ()
 _insert ()
 _update ()
 _deleteRecords ($sOXID)
 _deleteVariantRecords ($sOXID)
 _deletePics ()
 _onChangeResetCounts ($sOxid, $sVendorId=null, $sManufacturerId=null)
 _onChangeUpdateStock ($sParentID)
 _onChangeStockResetCount ($sOxid)
 _onChangeUpdateVarCount ($sParentID)
 _setVarMinMaxPrice ($sParentId)
 _onChangeUpdateMinVarPrice ($sParentID)
 _applyRangePrice ()
 _hasMasterImage ($iIndex)
 _isPriceViewModeNetto ()
 _getPriceObject ($blCalculationModeNetto=null)
 _getPriceForView ($oPrice)
 _preparePrice ($dPrice, $dVat, $blCalculationModeNetto=null)
 _getUserPriceSufix ()
 _getPrice ()
 _getVarMinPrice ()
 _getSubShopVarMinPrice ()
 _getVarMaxPrice ()
 _getSubShopVarMaxPrice ()
 _updateParentDependFields ()
 _getCopyParentFields ()
 _assignParentDependFields ()
 loadSimpleVariantsForLists ($blSimple)
 _selectVariants ($blRemoveNotOrderables, $blForceCoreTable, $oVariants)

Protected Attributes

 $_sClassName = 'oxarticle'
 $_blUseLazyLoading = true
 $_sItemKey
 $_blCalcPrice = true
 $_oPrice = null
 $_dVarMinPrice = null
 $_dVarMaxPrice = null
 $_dArticleVat = null
 $_aPersistParam = null
 $_blNotBuyable = false
 $_blLoadVariants = true
 $_aVariants = null
 $_aVariantsWithNotOrderables = null
 $_blNotBuyableParent = false
 $_blHasVariants = false
 $_blHasMdVariants = false
 $_blIsOnComparisonList = false
 $_oUser = null
 $_blLoadPrice = true
 $_blSkipAbPrice = false
 $_fPricePerUnit = null
 $_blLoadParentData = false
 $_blAllowEmptyParentId = false
 $_blSkipAssign = false
 $_blSkipDiscounts = null
 $_oAttributeList = null
 $_blIsRangePrice = null
 $_aMediaUrls = null
 $_aDispSelList
 $_blIsSeoObject = true
 $_oAmountPriceList = null
 $_iLinkType = 0
 $_aStdUrls = array()
 $_aSeoUrls = array()
 $_aSeoAddParams = array()
 $_aStdAddParams = array()
 $_sDynImageDir = null
 $_sMoreDetailLink = null
 $_sToBasketLink = null
 $_iStockStatusOnLoad = null
 $_iStockStatus = null
 $_oTPrice = null
 $_oAmountPriceInfo = null
 $_dAmountPrice = null
 $_aNonCopyParentFields
 $_aCopyParentField
 $_oMdVariants = null
 $_oLongDesc = null
 $_aVariantSelections = array()
 $_aArticleFiles = null
 $_blCanUpdateAnyField = null

Static Protected Attributes

static $_aLoadedParents
static $_aSelList
static $_aArticleManufacturers = array()
static $_aArticleVendors = array()
static $_aArticleCats = array()
static $_aSelections = array()
static $_aCategoryCache = null
static $_blHasAmountPrice = null

Detailed Description

Article manager. Creates fully detailed article object, with such information as VAT, discounts, etc.

Definition at line 17 of file oxarticle.php.

Constructor & Destructor Documentation

oxArticle.__construct ( $  aParams = null  ) 

Constructor, sets shop ID for article (oxconfig.getShopId()), initiates parent constructor (parent.oxI18n()).

Parameters:
array $aParams The array of names and values of oxArticle instance properties to be set on object instantiation
Returns:
null

Definition at line 443 of file oxarticle.php.

Member Function Documentation

oxArticle.__get ( $  sName  ) 

Magic getter, deals with values which are loaded on demand. Additionally it sets default value for unknown picture fields

Parameters:
string $sName Variable name
Returns:
mixed

Definition at line 462 of file oxarticle.php.

oxArticle.__set ( $  sName,
$  sValue 
)

Sets article parameter

Parameters:
string $sName name of parameter to set
mixed $sValue parameter value
Returns:
null

Definition at line 481 of file oxarticle.php.

oxArticle._applyCurrency ( oxPrice $  oPrice,
$  oCur = null 
) [protected]

Applies currency factor

Parameters:
oxPrice $oPrice Price object
object $oCur Currency object
Returns:
null

Definition at line 3367 of file oxarticle.php.

oxArticle._applyRangePrice (  )  [protected]

Returns minimum brut price from all (already loaded) variants and if applicable parent article

Deprecated:
since v4.7.0-5.0.0 (2012-10-08); use getFVarMinPrice or getFMinPrice methods
Returns:
null;

Definition at line 4293 of file oxarticle.php.

oxArticle._applyVAT ( oxPrice $  oPrice,
$  dVat 
) [protected]

Applies VAT to article

Parameters:
oxPrice $oPrice Price object
double $dVat VAT percent
Returns:
null

Definition at line 3315 of file oxarticle.php.

oxArticle._assignComparisonListFlag (  )  [protected]

Adds a flag if article is on comparisonlist.

Returns:
null;

Definition at line 3910 of file oxarticle.php.

oxArticle._assignDynImageDir (  )  [protected]

assigns dynimagedir to article

Returns:
null;

Definition at line 3893 of file oxarticle.php.

oxArticle._assignNotBuyableParent (  )  [protected]

if we have variants then depending on config option the parent may be non buyable

Returns:
null

Definition at line 3772 of file oxarticle.php.

oxArticle._assignParentDependFields (  )  [protected]

Set parent field value to child - variants

Returns:
bool

Definition at line 5124 of file oxarticle.php.

oxArticle._assignParentFieldValue ( $  sFieldName  )  [protected]

Assigns parent field values to article

Parameters:
string $sFieldName field name
Returns:
null;

Definition at line 3696 of file oxarticle.php.

oxArticle._assignParentFieldValues (  )  [protected]

Assigns parent field values to article

Returns:
null;

Definition at line 3753 of file oxarticle.php.

oxArticle._assignPersistentParam (  )  [protected]

assigns persistent param to article

Returns:
null;

Definition at line 3879 of file oxarticle.php.

oxArticle._assignPrices (  )  [protected]

Assigns prices to article

Deprecated:
since v4.7.0-5.0.0 (2012-10-08); use getFVarMinPrice or getFMinPrice methods
Returns:
null

Definition at line 3859 of file oxarticle.php.

oxArticle._assignStock (  )  [protected]

Assigns stock status to article

Returns:
null

Definition at line 3786 of file oxarticle.php.

oxArticle._calculatePrice ( $  oPrice,
$  dVat = null 
) [protected]

Calculates price of article (adds taxes, currency and discounts).

Parameters:
oxPrice $oPrice price object
double $dVat vat value, optional, if passed, bypasses "bl_perfCalcVatOnlyForBasketOrder" config value
Returns:
oxPrice

Definition at line 1914 of file oxarticle.php.

oxArticle._deletePics (  )  [protected]

Delete pics

Returns:
null

Definition at line 4072 of file oxarticle.php.

oxArticle._deleteRecords ( $  sOXID  )  [protected]

Deletes records in database

Parameters:
string $sOXID Article ID
Returns:
int

Definition at line 3989 of file oxarticle.php.

oxArticle._deleteVariantRecords ( $  sOXID  )  [protected]

Deletes variant records

Parameters:
string $sOXID Article ID
Returns:
null

Definition at line 4049 of file oxarticle.php.

oxArticle._fillAmountPriceList ( $  aAmPriceList  )  [protected]

Fills amount price list object and sets amount price for article object

Parameters:
array $aAmPriceList Amount price list
Returns:
array

Definition at line 3240 of file oxarticle.php.

oxArticle._generateSearchStr ( $  sOXID,
$  blSearchPriceCat = false 
) [protected]

Generates SearchString for getCategory()

Parameters:
string $sOXID Article ID
bool $blSearchPriceCat Whether to perform the search within price categories
Returns:
string

Definition at line 3495 of file oxarticle.php.

oxArticle._generateSearchStrForCustomerBought (  )  [protected]

Generates SQL select string for getCustomerAlsoBoughtThisProduct

Returns:
string

Definition at line 3519 of file oxarticle.php.

oxArticle._generateSelectCatStr ( $  sOXID,
$  sCatId,
$  dPriceFromTo = false 
) [protected]

Generates select string for isAssignedToCategory()

Parameters:
string $sOXID Article ID
string $sCatId Category ID
bool $dPriceFromTo Article price for price categories
Returns:
string

Definition at line 3579 of file oxarticle.php.

oxArticle._generateSimListSearchStr ( $  sArticleTable,
$  aList 
) [protected]

Generates search string for similar list.

Parameters:
string $sArticleTable Article table name
array $aList A list of original articles
Returns:
string

Definition at line 3457 of file oxarticle.php.

oxArticle._getAmountPrice ( $  dAmount = 1  )  [protected]

Modifies article price depending on given amount. Takes data from oxprice2article table.

Parameters:
double $dAmount Basket amount
Returns:
bool | null

Definition at line 3184 of file oxarticle.php.

oxArticle._getAmountPriceList (  )  [protected]

Collecting assigned to article amount-price list

Returns:
oxList

Definition at line 3607 of file oxarticle.php.

oxArticle._getArticleCategories ( $  sOXID,
$  blActCats = false 
) [protected]

Returns ID's of categories where this article is assigned

Parameters:
string $sOXID Article Id for which category list should be returned
bool $blActCats select categories if all parents are active
Returns:
array

Definition at line 1570 of file oxarticle.php.

oxArticle._getAttribsString ( &$  sAttribs,
&$  iCnt 
) [protected]

gets attribs string

Parameters:
string &$sAttribs Attribute selection snippet
int &$iCnt The number of selected attributes
Returns:
null;

Definition at line 3385 of file oxarticle.php.

oxArticle._getCopyParentFields (  )  [protected]

Returns array of fields which should not changed in variants

Returns:
array

Definition at line 5114 of file oxarticle.php.

oxArticle._getGroupPrice (  )  [protected]

get user Group A, B or C price, returns db price if user is not in groups

Returns:
double

Definition at line 3162 of file oxarticle.php.

oxArticle._getPrice (  )  [protected]

Return prepared price

Returns:
null

Definition at line 4915 of file oxarticle.php.

oxArticle._getPriceForView ( $  oPrice  )  [protected]

Depending on view mode prepare price for viewing

Parameters:
oxPrice $oPrice price object
Returns:
double

Definition at line 4674 of file oxarticle.php.

oxArticle._getPriceObject ( $  blCalculationModeNetto = null  )  [protected]

Depending on view mode prepare oxPrice object

Parameters:
bool $blCalculationModeNetto - if calculation mode netto - true
Returns:
oxPice

Definition at line 4649 of file oxarticle.php.

oxArticle._getSelectCatIds ( $  sOXID,
$  blActCats = false 
) [protected]

Returns query for article categories select

Parameters:
string $sOXID article id
bool $blActCats select categories if all parents are active
Returns:
string

Definition at line 1598 of file oxarticle.php.

oxArticle._getSimList ( $  sAttribs,
$  iCnt 
) [protected]

Gets similar list.

Parameters:
string $sAttribs Attribute selection snippet
int $iCnt Similar list article count
Returns:
array

Definition at line 3415 of file oxarticle.php.

oxArticle._getSubShopVarMaxPrice (  )  [protected]

Return sub shop variant max price

Returns:
null

Definition at line 5031 of file oxarticle.php.

oxArticle._getSubShopVarMinPrice (  )  [protected]

Return sub shop variant min price

Returns:
null

Definition at line 4970 of file oxarticle.php.

oxArticle._getUserPriceSufix (  )  [protected]

Return price suffix

Returns:
null

Definition at line 4891 of file oxarticle.php.

oxArticle._getVariantsIds (  )  [protected]

Collects and returns article variants ids.

Returns:
array

Definition at line 3276 of file oxarticle.php.

oxArticle._getVarMaxPrice (  )  [protected]

Return variant max price

Returns:
null

Definition at line 4997 of file oxarticle.php.

oxArticle._getVarMinPrice (  )  [protected]

Return variant min price

Returns:
null

Definition at line 4936 of file oxarticle.php.

oxArticle._hasAnyVariant ( $  blForceCoreTable = null  )  [protected]

Checks if parent has ANY variant assigned

Parameters:
bool $blForceCoreTable force core table usage
Returns:
bool

Definition at line 1203 of file oxarticle.php.

oxArticle._hasMasterImage ( $  iIndex  )  [protected]

Checks if article has uploaded master image for selected picture

Parameters:
int $iIndex master picture index
Returns:
bool

Definition at line 4493 of file oxarticle.php.

oxArticle._insert (  )  [protected]

Sets article creation date (oxarticle.oxarticles__oxinsert). Then executes parent method parent._insert() and returns insertion status.

Returns:
bool

Definition at line 3928 of file oxarticle.php.

oxArticle._isFieldEmpty ( $  sFieldName  )  [protected]

Detects if field is empty.

Parameters:
string $sFieldName Field name
Returns:
bool

Definition at line 3639 of file oxarticle.php.

oxArticle._isImageField ( $  sFieldName  )  [protected]

Detects if field is an image field by field name

Parameters:
string $sFieldName Field name
Returns:
bool.

Definition at line 3683 of file oxarticle.php.

oxArticle._isPriceViewModeNetto (  )  [protected]

Checks and return true if price view mode is netto

Returns:
bool

Definition at line 4630 of file oxarticle.php.

oxArticle._isStockStatusChanged (  )  [protected]

Check if stock status has changed since loading the article

Returns:
bool

Definition at line 2798 of file oxarticle.php.

oxArticle._isVisibilityChanged (  )  [protected]

Check if visibility has changed since loading the article

Returns:
bool

Definition at line 2808 of file oxarticle.php.

oxArticle._loadFromDb ( $  sOXID  )  [protected]

Get data from db

Parameters:
string $sOXID id
Returns:
array

Definition at line 864 of file oxarticle.php.

oxArticle._loadVariantList ( $  blSimple,
$  blRemoveNotOrderables = true,
$  blForceCoreTable = null 
) [protected]

Loads and returns variants list.

Parameters:
bool $blSimple If parameter $blSimple - list will be filled with oxSimpleVariant objects, else - oxArticle
bool $blRemoveNotOrderables if true, removes from list not orderable articles, which are out of stock [optional]
bool $blForceCoreTable if true forces core table use, default is false [optional]
Returns:
array | oxsimplevariantlist | oxarticlelist

Definition at line 1334 of file oxarticle.php.

oxArticle._mergeDiscounts ( $  aDiscounts,
$  aItemDiscounts 
) [protected]

Merges two discount arrays. If there are two the same discounts, discount values will be added.

Parameters:
array $aDiscounts Discount array
array $aItemDiscounts Discount array
Returns:
array $aDiscounts

Definition at line 3144 of file oxarticle.php.

oxArticle._modifySelectListPrice ( $  dPrice,
$  aChosenList = null 
) [protected]

Modifies article price according to selected select list value

Parameters:
double $dPrice Modifiable price
array $aChosenList Selection list array
Returns:
double

Definition at line 3210 of file oxarticle.php.

oxArticle._onChangeResetCounts ( $  sOxid,
$  sVendorId = null,
$  sManufacturerId = null 
) [protected]

Resets category and vendor counts. This method is supposed to be called on article change trigger.

Parameters:
string $sOxid object to reset id ID
string $sVendorId Vendor ID
string $sManufacturerId Manufacturer ID
Returns:
null

Definition at line 4102 of file oxarticle.php.

oxArticle._onChangeStockResetCount ( $  sOxid  )  [protected]

Resets article count cache when stock value is zero and article goes offline.

Parameters:
string $sOxid product id
Returns:
null

Definition at line 4174 of file oxarticle.php.

oxArticle._onChangeUpdateMinVarPrice ( $  sParentID  )  [protected]

Updates variant min price. This method is supposed to be called on article change triger.

Parameters:
string $sParentID Parent ID
Deprecated:
since v4.7.0-5.0.0 (2012-10-08); use _setVarMinMaxPrice() method
Returns:
null

Definition at line 4257 of file oxarticle.php.

oxArticle._onChangeUpdateStock ( $  sParentID  )  [protected]

Updates article stock. This method is supposed to be called on article change trigger.

Parameters:
string $sParentID product parent id
Returns:
null

Definition at line 4134 of file oxarticle.php.

oxArticle._onChangeUpdateVarCount ( $  sParentID  )  [protected]

Updates variant count. This method is supposed to be called on article change trigger.

Parameters:
string $sParentID Parent ID
Returns:
null

Definition at line 4192 of file oxarticle.php.

oxArticle._preparePrice ( $  dPrice,
$  dVat,
$  blCalculationModeNetto = null 
) [protected]

Depending on view mode prepare price before calculation

Parameters:
double $dPrice - price
double $dVat - VAT
bool $blCalculationModeNetto - if calculation mode netto - true
Returns:
double

Definition at line 4695 of file oxarticle.php.

oxArticle._saveArtLongDesc (  )  [protected]

inserts article long description to artextends table

Returns:
null

Definition at line 3063 of file oxarticle.php.

oxArticle._selectVariants ( $  blRemoveNotOrderables,
$  blForceCoreTable,
$  oVariants 
) [protected]

Variant selection

Parameters:
bool $blRemoveNotOrderables option for removing variant which can't be ordered
bool $blForceCoreTable option for forcing core table usage
object $oVariants variants
Returns:
object $oVariants

Definition at line 5163 of file oxarticle.php.

oxArticle._setVarMinMaxPrice ( $  sParentId  )  [protected]

Updates variant min price. This method is supposed to be called on article change trigger.

Parameters:
string $sParentId Parent ID
Returns:
null

Definition at line 4212 of file oxarticle.php.

oxArticle._skipSaveFields (  )  [protected]

Removes object data fields (oxarticles__oxtimestamp, oxarticles__oxparentid, oxarticles__oxinsert).

Returns:
null

Definition at line 3119 of file oxarticle.php.

oxArticle._update (  )  [protected]

Executes oxarticle._skipSaveFields() and updates article information

Returns:
bool

Definition at line 3945 of file oxarticle.php.

oxArticle._updateParentDependFields (  )  [protected]

Set parent field value to child - variants in DB

Returns:
bool

Definition at line 5092 of file oxarticle.php.

oxArticle.addTag ( $  sTag  ) 

Adds tag

Parameters:
string $sTag new tag
Deprecated:
since v5.0.3 (2012-12-21); Use oxarticletags.addTag instead
Returns:
bool

Definition at line 2666 of file oxarticle.php.

oxArticle.addToRatingAverage ( $  iRating  ) 

Calculates and saves product rating average

Parameters:
integer $iRating new rating value
Returns:
null

Definition at line 912 of file oxarticle.php.

oxArticle.appendLink ( $  sAddParams,
$  iLang = null 
)

Appends article seo url with additional request parameters

Parameters:
string $sAddParams additional parameters which needs to be added to product url
int $iLang language id
Returns:
null

Definition at line 2445 of file oxarticle.php.

oxArticle.appendStdLink ( $  sAddParams,
$  iLang = null 
)

Appends article dynamic url with additional request parameters

Parameters:
string $sAddParams additional parameters which needs to be added to product url
int $iLang language id
Returns:
null

Definition at line 2552 of file oxarticle.php.

oxArticle.applyDiscountsForVariant ( $  oPrice  ) 

Applies discounts which should be applied in general case (for 0 amount)

Parameters:
oxprice $oPrice Price object
Returns:
null

Definition at line 3344 of file oxarticle.php.

oxArticle.applyVats ( oxPrice $  oPrice  ) 

apply article and article use

Parameters:
oxPrice $oPrice target price
Returns:
null

Definition at line 3332 of file oxarticle.php.

oxArticle.assign ( $  aRecord  ) 

Assigns to oxarticle object some base parameters/values (such as detaillink, moredetaillink, etc).

Parameters:
array $aRecord Array representing current field values
Returns:
null

Definition at line 826 of file oxarticle.php.

oxArticle.checkForStock ( $  dAmount,
$  dArtStockAmount = 0 
)

Checks if stock configuration allows to buy user chosen amount $dAmount

Parameters:
double $dAmount buyable amount
double $dArtStockAmount stock amount
Returns:
mixed

Definition at line 2304 of file oxarticle.php.

oxArticle.delete ( $  sOXID = null  ) 

Deletes record and other information related to this article such as images from DB, also removes variants. Returns true on success.

Parameters:
string $sOXID Article id
Returns:
bool

Definition at line 2005 of file oxarticle.php.

oxArticle.disablePriceLoad (  ) 

Disables article price loading. Should be called before assign(), or load()

Returns:
null

Definition at line 642 of file oxarticle.php.

oxArticle.disableReminder (  ) 

Disables reminder functionality for article

Returns:
bool

Definition at line 2093 of file oxarticle.php.

oxArticle.enablePriceLoad (  ) 

Enable article price loading, if disabled.

Returns:
null

Definition at line 652 of file oxarticle.php.

oxArticle.getAccessoires (  ) 

Loads and returns array with accessories information.

Returns:
array

Definition at line 1038 of file oxarticle.php.

oxArticle.getActiveCheckQuery ( $  blForceCoreTable = null  ) 

Returns part of sql query used in active snippet. Query checks if product "oxactive = 1". If config option "blUseTimeCheck" is TRUE additionally checks if "oxactivefrom < current data < oxactiveto"

Parameters:
bool $blForceCoreTable force core table usage
Returns:
string

Definition at line 523 of file oxarticle.php.

oxArticle.getAdminVariants ( $  sLanguage = null  ) 

Loads article variants and returns variants list object. Article language may be set by passing with parameter, or GET/POST/Session variable.

Parameters:
string $sLanguage shop language.
Returns:
object

Definition at line 1438 of file oxarticle.php.

oxArticle.getArticleFiles ( $  blAddFromParent = false  ) 

Return article downloadable file list (oxlist of oxfile)

Parameters:
bool $blAddFromParent - return with parent files if not buyable
Returns:
null|oxList of oxFile

Definition at line 4570 of file oxarticle.php.

oxArticle.getArticleRatingAverage ( $  blIncludeVariants = false  ) 

Returns product rating average

Parameters:
bool $blIncludeVariants - include variant ratings
Returns:
double

Definition at line 957 of file oxarticle.php.

oxArticle.getArticleRatingCount ( $  blIncludeVariants = false  ) 

Returns product rating count

Parameters:
bool $blIncludeVariants - include variant ratings
Returns:
double

Definition at line 974 of file oxarticle.php.

oxArticle.getArticleUser (  ) 

return article user

Returns:
oxUser

Definition at line 1955 of file oxarticle.php.

oxArticle.getArticleVat (  ) 

retrieve article VAT (cached)

Returns:
double

Definition at line 3299 of file oxarticle.php.

oxArticle.getAttributes (  ) 

Loads and returns attribute list associated with this article

Returns:
object

Definition at line 2411 of file oxarticle.php.

oxArticle.getAttributesDisplayableInBasket (  ) 

Loads and returns displayable in basket/order attributes list associated with this article

Returns:
object

Definition at line 2426 of file oxarticle.php.

oxArticle.getBasePrice ( $  dAmount = 1  ) 

Returns base article price from database. Price may differ according to users group Override this function if you want e.g. different prices for diff. usergroups.

Parameters:
double $dAmount article amount. Default is 1
Returns:
double

Definition at line 1848 of file oxarticle.php.

oxArticle.getBaseSeoLink ( $  iLang,
$  blMain = false 
)

Returns raw article seo url

Parameters:
int $iLang language id
bool $blMain force to return main url [optional]
Returns:
string

Definition at line 2465 of file oxarticle.php.

oxArticle.getBaseStdLink ( $  iLang,
$  blAddId = true,
$  blFull = true 
)

Returns base dynamic url: shopurl/index.php?cl=details

Parameters:
int $iLang language id
bool $blAddId add current object id to url or not [optional]
bool $blFull return full including domain name [optional]
Returns:
string

Implements oxIUrl.

Definition at line 2573 of file oxarticle.php.

oxArticle.getBasketPrice ( $  dAmount,
$  aSelList,
$  oBasket 
)

Creates, calculates and returns oxPrice object for basket product.

Parameters:
float $dAmount Amount
string $aSelList Selection list
object $oBasket User shopping basket object
Returns:
oxPrice

Definition at line 1972 of file oxarticle.php.

oxArticle.getCategory (  ) 

Loads and returns article category object. First tries to load assigned category and is such category does not exist, tries to load category by price

Returns:
oxcategory

Definition at line 1471 of file oxarticle.php.

oxArticle.getCategoryIds ( $  blActCats = false,
$  blSkipCache = false 
)

Returns ID's of categories where this article is assigned

Parameters:
bool $blActCats select categories if all parents are active
bool $blSkipCache Whether to skip cache
Returns:
array

Definition at line 1522 of file oxarticle.php.

oxArticle.getCrossSelling (  ) 

Loads and returns array with cross selling information.

Returns:
array|null

Definition at line 1022 of file oxarticle.php.

oxArticle.getCustomerAlsoBoughtThisProducts (  ) 

Loads and returns articles list, bought by same customer.

Returns:
array

Definition at line 1103 of file oxarticle.php.

oxArticle.getCustomVAT (  ) 

Returns custom article VAT value if possible By default value is taken from oxarticle__oxvat field

Returns:
double

Definition at line 2287 of file oxarticle.php.

oxArticle.getDeliveryDate (  ) 

Returns formatted delivery date. If the date is not set ('0000-00-00') returns false.

Returns:
string | bool

Definition at line 2818 of file oxarticle.php.

oxArticle.getDispSelList (  ) 

Returns select lists to display

Returns:
array

Definition at line 2711 of file oxarticle.php.

oxArticle.getDynImageDir (  ) 

Get image url

Returns:
array

Definition at line 2701 of file oxarticle.php.

oxArticle.getFileUrl (  ) 

Returns article file url

Deprecated:
since v5.0.1 (2012-11-15) as article file is duplicate of media. Use getMediaUrls() instead for file media.
Returns:
string

Definition at line 3036 of file oxarticle.php.

oxArticle.getFMinPrice (  ) 

Returns formatted article min price

Deprecated:
since v5.1 (2013-10-04); use oxPrice smarty plugin for formatting in templates
Returns:
string

Definition at line 4763 of file oxarticle.php.

oxArticle.getFNetPrice (  ) 

Returns formatted product's NETTO price.

Deprecated:
since v5.1 (2013-10-03); use getPrice() and oxPrice modifier;
Returns:
double

Definition at line 2881 of file oxarticle.php.

oxArticle.getFPrice (  ) 

Returns formatted product's price.

Deprecated:
since v5.1 (2013-10-04); use oxPrice smarty plugin for formatting in templates
Returns:
double

Definition at line 2850 of file oxarticle.php.

oxArticle.getFTPrice (  ) 

Returns rounded T price.

Deprecated:
since v5.1 (2013-10-03); use getTPrice() and oxPrice modifier;
Returns:
double | bool

Definition at line 2833 of file oxarticle.php.

oxArticle.getFullVariants ( $  blRemoveNotOrderables = true,
$  blForceCoreTable = null 
)

Returns variant list (list contains oxArticle objects)

Parameters:
bool $blRemoveNotOrderables if true, removes from list not orderable articles, which are out of stock [optional]
bool $blForceCoreTable if true forces core table use, default is false [optional]
Returns:
oxarticlelist

Definition at line 1398 of file oxarticle.php.

oxArticle.getFUnitPrice (  ) 

Returns formatted price per unit

Deprecated:
since v5.1 (2013-09-25); use oxPrice smarty plugin for formatting in templates
Returns:
string

Definition at line 4720 of file oxarticle.php.

oxArticle.getFVarMinPrice (  ) 

Returns formatted min article variant price

Deprecated:
since v5.1 (2013-10-04); use oxPrice smarty plugin for formatting in templates
Returns:
string

Definition at line 4781 of file oxarticle.php.

oxArticle.getIconUrl ( $  iIndex = 0  ) 

Returns article icon picture url. If no index specified, will return main icon url.

Parameters:
int $iIndex picture index
Returns:
string

Definition at line 2972 of file oxarticle.php.

oxArticle.getItemKey (  ) 

Returns item key used with oxuserbasket

Returns:
string

Definition at line 662 of file oxarticle.php.

oxArticle.getLink ( $  iLang = null,
$  blMain = false 
)

Gets article link

Parameters:
int $iLang language id [optional]
bool $blMain force to return main url [optional]
Returns:
string

Definition at line 2482 of file oxarticle.php.

oxArticle.getLinkType (  ) 

Get link type

Returns:
int

Definition at line 2539 of file oxarticle.php.

oxArticle.getLongDesc (  ) 

get long description, parsed through smarty. should only be used by exports or so. In templates use [{oxeval var=$oProduct->getLongDescription()->getRawValue()}]

Returns:
string

Definition at line 2384 of file oxarticle.php.

oxArticle.getLongDescription (  ) 

Get article long description

Returns:
object $oField field object

Definition at line 2353 of file oxarticle.php.

oxArticle.getMainLink ( $  iLang = null  ) 

Returns main object URL. If SEO is ON returned link will be in SEO form, else URL will have dynamic form

Parameters:
int $iLang language id [optional]
Returns:
string

Definition at line 2513 of file oxarticle.php.

oxArticle.getManufacturer ( $  blShopCheck = true  ) 

Returns current article Manufacturer object. If $blShopCheck = false, then Manufacturer blReadOnly parameter will be set to true. If Manufacturer is not assigned to current shop

Parameters:
bool $blShopCheck Set false if shop check is not required (default is true)
Returns:
object

Definition at line 1681 of file oxarticle.php.

oxArticle.getManufacturerId ( $  blForceReload = false  ) 

Returns article object Manufacturer ID. Result is cached into self.$_aArticleManufacturers

Parameters:
bool $blForceReload reloads id even if it is cached
Returns:
string

Definition at line 1661 of file oxarticle.php.

oxArticle.getMasterZoomPictureUrl ( $  iIndex  ) 

Get master zoom picture url

Parameters:
int $iIndex picture index
Returns:
string

Definition at line 4536 of file oxarticle.php.

oxArticle.getMdSubvariants (  ) 

Returns first level variants from multidimensional variants list

Returns:
OxMdVariants

Definition at line 4481 of file oxarticle.php.

oxArticle.getMdVariants (  ) 

Returns multidimensional variant structure

Returns:
OxMdVariants

Definition at line 4457 of file oxarticle.php.

oxArticle.getMediaUrls (  ) 

Return article media URL

Returns:
array

Definition at line 2682 of file oxarticle.php.

oxArticle.getMinPrice (  ) 

Returns article min price in calculation included variants

Returns:
oxPrice

Definition at line 4823 of file oxarticle.php.

oxArticle.getMoreDetailLink (  ) 

Get more details link

Returns:
string

Definition at line 2726 of file oxarticle.php.

oxArticle.getParentArticle (  ) 

Get parent article

Returns:
oxArticle

Definition at line 3734 of file oxarticle.php.

oxArticle.getParentId (  ) 

Returns product parent id (oxparentid)

Returns:
string

Definition at line 4374 of file oxarticle.php.

oxArticle.getPersParams (  ) 

Get persistent parameters

Returns:
array

Definition at line 710 of file oxarticle.php.

oxArticle.getPictureFieldValue ( $  sFieldName,
$  iIndex = null 
)

Return article picture file name

Parameters:
string $sFieldName article picture field name
int $iIndex article picture index
Returns:
string

Definition at line 4521 of file oxarticle.php.

oxArticle.getPictureGallery (  ) 

collect article pics, icons, zoompic and puts it all in an array structure of array (ActPicID, ActPic, MorePics, Pics, Icons, ZoomPic)

Returns:
array

Definition at line 2141 of file oxarticle.php.

oxArticle.getPictureUrl ( $  iIndex = 1  ) 

Returns article picture

Parameters:
int $iIndex picture index
Returns:
string

Definition at line 2951 of file oxarticle.php.

oxArticle.getPrice ( $  dAmount = 1  ) 

Calculates and returns price of article (adds taxes and discounts).

Parameters:
float $dAmount article amount
Returns:
oxPrice

Definition at line 1872 of file oxarticle.php.

oxArticle.getPriceFromPrefix (  ) 

Returns string prefix (like "from") if needed or empty string.

Deprecated:
since v4.7.0-5.0.0 (2012-10-08); use getFVarMinPrice or getFMinPrice methods
Returns:
string

Definition at line 3048 of file oxarticle.php.

oxArticle.getPricePerUnit (  ) 

Returns formatted price per unit

Deprecated:
since v5.0 (2012-01-4); use getFUnitPrice();
Returns:
string

Definition at line 2895 of file oxarticle.php.

oxArticle.getProductId (  ) 

Returns product id (oxid) (required for interface oxIArticle)

Returns:
string

Definition at line 4352 of file oxarticle.php.

oxArticle.getProductParentId (  ) 

Returns product parent id (oxparentid)

Deprecated:
since v4.7-5.0 (2012-10-08); use getParentId() method
Returns:
string

Definition at line 4364 of file oxarticle.php.

oxArticle.getReviews (  ) 

Collects user written reviews about an article.

Returns:
oxList

Definition at line 990 of file oxarticle.php.

oxArticle.getSelections ( $  iLimit = null,
$  aFilter = null 
)

Returns product selections lists array (used in azure theme)

Parameters:
int $iLimit if given - will load limited count of selections [optional]
array $aFilter selection filter [optional]
Returns:
array

Definition at line 1273 of file oxarticle.php.

oxArticle.getSelectLists ( $  sKeyPrefix = null  ) 

Returns all selectlists this article has (used in oxbasket)

Parameters:
string $sKeyPrefix Optional key prefix
Returns:
array

Definition at line 1153 of file oxarticle.php.

oxArticle.getSimilarProducts (  ) 

Returns a list of similar products.

Returns:
array

Definition at line 1063 of file oxarticle.php.

oxArticle.getSimpleVariants (  ) 

Simple way to get variants without querying oxArticle table first. This is basically used for lists.

Returns:
null

Definition at line 1421 of file oxarticle.php.

oxArticle.getSize (  ) 

Return Size of product: length*width*height

Returns:
double

Definition at line 5068 of file oxarticle.php.

oxArticle.getSqlActiveSnippet ( $  blForceCoreTable = null  ) 

Returns SQL select string with checks if items are available

Parameters:
bool $blForceCoreTable forces core table usage (optional)
Returns:
string

Definition at line 611 of file oxarticle.php.

oxArticle.getSqlForPriceCategories ( $  sFields = ''  ) 

get Sql for loading price categories which include this article

Parameters:
string $sFields fields to load from oxCategories
Returns:
string

Definition at line 4418 of file oxarticle.php.

oxArticle.getStdLink ( $  iLang = null,
$  aParams = array() 
)

Returns standard URL to product

Parameters:
int $iLang required language. optional
array $aParams additional params to use [optional]
Returns:
string

Implements oxIUrl.

Definition at line 2593 of file oxarticle.php.

oxArticle.getStdTagLink ( $  sTag  ) 

Returns standard product Tag URL

Parameters:
string $sTag tag
Deprecated:
since v5.0.3 (2012-12-21). Use oxarticletags.getStdTagLink instead
Returns:
string

Definition at line 2615 of file oxarticle.php.

oxArticle.getStockCheckQuery ( $  blForceCoreTable = null  ) 

Returns part of sql query used in active snippet. If config option "blUseStock" is TRUE checks if "oxstockflag != 2 or ( oxstock + oxvarstock ) > 0". If config option "blVariantParentBuyable" is TRUE checks if product has variants, and if has - checks is there at least one variant which is buyable. If config option option "blUseTimeCheck" is TRUE additionally checks if variants "oxactivefrom < current data < oxactiveto"

Parameters:
bool $blForceCoreTable force core table usage
Returns:
string

Definition at line 552 of file oxarticle.php.

oxArticle.getStockStatus (  ) 

Get stock status

Returns:
integer

Definition at line 2788 of file oxarticle.php.

oxArticle.getTags (  ) 

Returns article tags

Deprecated:
since v5.0.3 (2012-12-21); Use oxarticletags.getTags instead
Returns:
string;

Definition at line 2629 of file oxarticle.php.

oxArticle.getThumbnailUrl ( $  bSsl = null  ) 

Returns article thumbnail picture url

Parameters:
bool $bSsl to force SSL
Returns:
string

Definition at line 2997 of file oxarticle.php.

oxArticle.getToBasketLink (  ) 

Get to basket link

Returns:
string

Definition at line 2749 of file oxarticle.php.

oxArticle.getTPrice (  ) 

Returns T price

Returns:
oxPrice

Definition at line 1758 of file oxarticle.php.

oxArticle.getUnitName (  ) 

Returns oxarticles__oxunitname value processed by oxLang.translateString()

Returns:
string

Definition at line 4556 of file oxarticle.php.

oxArticle.getUnitPrice (  ) 

Returns price per unit

Returns:
string

Definition at line 4739 of file oxarticle.php.

oxArticle.getUnitQuantity (  ) 

Return unit quantity

Returns:
sting

Definition at line 5058 of file oxarticle.php.

oxArticle.getVariants ( $  blRemoveNotOrderables = true,
$  blForceCoreTable = null 
)

Collects and returns article variants.

Parameters:
bool $blRemoveNotOrderables if true, removes from list not orderable articles, which are out of stock
bool $blForceCoreTable if true forces core table use, default is false [optional]
Returns:
array

Definition at line 1411 of file oxarticle.php.

oxArticle.getVariantsCount (  ) 

Returns amount of variants article has

Returns:
mixed

Definition at line 1222 of file oxarticle.php.

oxArticle.getVariantSelections ( $  aFilterIds = null,
$  sActVariantId = null,
$  iLimit = 0 
)

Returns variants selections lists array

Parameters:
array $aFilterIds ids of active selections [optional]
string $sActVariantId active variant id [optional]
int $iLimit limit variant lists count (if non zero, return limited number of multidimensional variant selections)
Returns:
array

Definition at line 1246 of file oxarticle.php.

oxArticle.getVariantsQuery ( $  blRemoveNotOrderables,
$  blForceCoreTable = null 
)

Returns part of query which checks if product is variant of current object. Additionally if config option "blUseStock" is TRUE checks stock state "( oxstock > 0 or ( oxstock <= 0 and ( oxstockflag = 1 or oxstockflag = 4 ) )"

Parameters:
bool $blRemoveNotOrderables remove or leave non orderable products
bool $blForceCoreTable force core table usage
Returns:
string

Definition at line 587 of file oxarticle.php.

oxArticle.getVarMinPrice (  ) 

Returns article min price of variants

Returns:
oxPrice

Definition at line 4797 of file oxarticle.php.

oxArticle.getVendor ( $  blShopCheck = true  ) 

Returns current article vendor object. If $blShopCheck = false, then vendor loading will fallback to oxI18n object and blReadOnly parameter will be set to true if vendor is not assigned to current shop

Parameters:
bool $blShopCheck Set false if shop check is not required (default is true)
Returns:
object

Definition at line 1620 of file oxarticle.php.

oxArticle.getVendorId ( $  blForceReload = false  ) 

Returns article object vendor ID. Result is cached into self.$_aArticleVendors

Parameters:
bool $blForceReload reloads id even if it is cached
Returns:
string

Definition at line 1644 of file oxarticle.php.

oxArticle.getWeight (  ) 

Return product weight

Returns:
double

Definition at line 5082 of file oxarticle.php.

oxArticle.getZoomPictureUrl ( $  iIndex = ''  ) 

Returns article zoom picture url

Parameters:
int $iIndex picture index
Returns:
string

Definition at line 3019 of file oxarticle.php.

oxArticle.hasAmountPrice (  ) 

Checks if articles has amount price

Returns:
bool

Definition at line 4607 of file oxarticle.php.

oxArticle.hasMdVariants (  ) 

Checks if article has multidimensional variants

Returns:
bool

Definition at line 1232 of file oxarticle.php.

oxArticle.inCategory ( $  sCatNid  ) 

Checks if article is assigned to category $sCatNID.

Parameters:
string $sCatNid category ID
Returns:
bool

Definition at line 1709 of file oxarticle.php.

oxArticle.inPriceCategory ( $  sCatNid  ) 

Checks if article is assigned to price category $sCatNID.

Parameters:
string $sCatNid Price category ID
Returns:
bool

Definition at line 4437 of file oxarticle.php.

oxArticle.isAssignedToCategory ( $  sCatId  ) 

Checks if article is assigned to passed category (even checks if this category is "price category"). Returns true on success.

Parameters:
string $sCatId category ID
Returns:
bool

Definition at line 1722 of file oxarticle.php.

oxArticle.isBuyable (  ) 

Checks if article is buyable.

Returns:
bool

Definition at line 696 of file oxarticle.php.

oxArticle.isDownloadable (  ) 

Returns oxarticles__oxisdownloadable value

Returns:
bool

Definition at line 4597 of file oxarticle.php.

oxArticle.isInList (  ) 

Checks whether object is in list or not It's needed for oxArticle so that it can pass this to widgets

Returns:
bool

Definition at line 492 of file oxarticle.php.

oxArticle.isMdVariant (  ) 

Returns TRUE if product is multidimensional variant, and false if not

Returns:
bool

Definition at line 4404 of file oxarticle.php.

oxArticle.isMultilingualField ( $  sFieldName  ) 

Returns true if the field is multilanguage

Parameters:
string $sFieldName Field name
Returns:
bool

Definition at line 771 of file oxarticle.php.

oxArticle.isNotBuyable (  ) 

Returns true if article is not buyable

Returns:
bool

Definition at line 2915 of file oxarticle.php.

oxArticle.isOnComparisonList (  ) 

Checks whether article is inluded in comparison list

Returns:
bool

Definition at line 720 of file oxarticle.php.

oxArticle.isOrderArticle (  ) 

Returns false if object is not derived from oxorderarticle class

Returns:
bool

Definition at line 4384 of file oxarticle.php.

oxArticle.isParentNotBuyable (  ) 

Returns true if parent is not buyable

Returns:
bool

Definition at line 2905 of file oxarticle.php.

oxArticle.isRangePrice (  ) 

Returns true if article has variant with different price

Returns:
bool

Definition at line 4851 of file oxarticle.php.

oxArticle.isVariant (  ) 

Returns TRUE if product is variant, and false if not

Returns:
bool

Definition at line 4394 of file oxarticle.php.

oxArticle.isVisible (  ) 

Checks if article has visible status. Returns TRUE if its visible

Returns:
bool

Definition at line 787 of file oxarticle.php.

oxArticle.load ( $  sOXID  ) 

Loads object data from DB (object data ID must be passed to method). Converts dates (oxarticle.oxarticles__oxinsert) to international format (oxutils.php oxRegistry.get("oxUtilsDate")->formatDBDate(...)). Returns true if article was loaded successfully.

Parameters:
string $sOXID Article object ID
Returns:
bool

Definition at line 883 of file oxarticle.php.

oxArticle.loadAmountPriceInfo (  ) 

Returns list object with info about article price that depends on amount in basket. Takes data from oxprice2article table. Returns false if such info is not set.

Returns:
mixed

Definition at line 1130 of file oxarticle.php.

oxArticle.loadSimpleVariantsForLists ( $  blSimple  )  [protected]

Simple variant loader

Parameters:
boolean $blSimple modifier for simple list
Returns:
object

Definition at line 5141 of file oxarticle.php.

oxArticle.onChange ( $  sAction = null,
$  sOXID = null,
$  sParentID = null 
)

This function is triggered whenever article is saved or deleted or after the stock is changed. Originally we need to update the oxstock for possible article parent in case parent is not buyable Plus you may want to extend this function to update some extended information. Call oxArticle.onChange($sAction, $sOXID) with ID parameter as static method when changes are executed over SQL. (or use module class instead of oxArticle if such exists)

Parameters:
string $sAction Action constant
string $sOXID Article ID
string $sParentID Parent ID
Returns:
null

Definition at line 2228 of file oxarticle.php.

oxArticle.reduceStock ( $  dAmount,
$  blAllowNegativeStock = false 
)

Reduce article stock. return the affected amount

Parameters:
float $dAmount amount to reduce
bool $blAllowNegativeStock are negative stocks allowed?
Returns:
float

Definition at line 2042 of file oxarticle.php.

oxArticle.resetParent (  ) 

Changes article variant to parent article

Returns:
null

Definition at line 2121 of file oxarticle.php.

oxArticle.resetRemindStatus (  ) 

Resets oxremindactive status. If remindActive status is 2, reminder is already sent.

Returns:
null

Definition at line 2864 of file oxarticle.php.

oxArticle.save (  ) 

(oxArticle._saveArtLongDesc()) save the object using parent.save() method.

Returns:
bool

Definition at line 2104 of file oxarticle.php.

oxArticle.saveTags ( $  sTags  ) 

Saves article tags

Parameters:
string $sTags article tag
Deprecated:
since v5.0.3 (2012-12-21); Use oxarticletags.saveTags instead
Returns:
bool

Definition at line 2645 of file oxarticle.php.

oxArticle.setArticleLongDesc ( $  sDesc  ) 

Save article long description to oxartext table

Parameters:
string $sDesc description to set
Returns:
null

Definition at line 2396 of file oxarticle.php.

oxArticle.setArticleUser ( $  oUser  ) 

sets article user

Parameters:
oxUser $oUser user to set
Returns:
null

Definition at line 1945 of file oxarticle.php.

oxArticle.setBuyableState ( $  blBuyable = false  ) 

Sets product state - buyable or not

Parameters:
bool $blBuyable state - buyable or not (default false)
Returns:
null

Definition at line 2927 of file oxarticle.php.

oxArticle.setId ( $  sId = null  ) 

Sets object ID, additionally sets $this->oxarticles__oxnid field value

Parameters:
string $sId New ID
Returns:
null

Definition at line 504 of file oxarticle.php.

oxArticle.setItemKey ( $  sItemKey  ) 

Sets item key used with oxuserbasket

Parameters:
string $sItemKey Item key
Returns:
null

Definition at line 674 of file oxarticle.php.

oxArticle.setLinkType ( $  iType  ) 

Resets details link

Parameters:
int $iType type of link to load
Returns:
null

Definition at line 2525 of file oxarticle.php.

oxArticle.setLoadParentData ( $  blLoadParentData  ) 

A setter for $_blLoadParentData (whether article parent info should be laoded fully) class variable

Parameters:
bool $blLoadParentData Whether to load parent data
Returns:
null

Definition at line 744 of file oxarticle.php.

oxArticle.setNoVariantLoading ( $  blLoadVariants  ) 

Disables/enables variant loading

Parameters:
bool $blLoadVariants skip variant loading or not
Returns:
null

Definition at line 686 of file oxarticle.php.

oxArticle.setOnComparisonList ( $  blOnList  ) 

Set if article is inluded in comparison list

Parameters:
bool $blOnList Whether is article on the list
Returns:
null

Definition at line 732 of file oxarticle.php.

oxArticle.setPrice ( oxPrice $  oPrice  ) 

Sets the current oxPrice object

Parameters:
oxPrice $oPrice the new price object
Returns:
null

Definition at line 1835 of file oxarticle.php.

oxArticle.setRangePrice ( $  blIsRangePrice = true  ) 

Setter to set if article has range price

Parameters:
bool $blIsRangePrice - true if range, else false
Returns:
null

Definition at line 4881 of file oxarticle.php.

oxArticle.setRatingAverage ( $  iRating  ) 

Set product rating average

Parameters:
integer $iRating new rating value
Returns:
null

Definition at line 933 of file oxarticle.php.

oxArticle.setRatingCount ( $  iRatingCnt  ) 

Set product rating count

Parameters:
integer $iRatingCnt new rating count
Returns:
null

Definition at line 945 of file oxarticle.php.

oxArticle.setSelectlist ( $  aSelList  ) 

Sets selectlists of current product

Parameters:
array $aSelList selectlist
Returns:
object

Definition at line 2939 of file oxarticle.php.

oxArticle.setSkipAbPrice ( $  blSkipAbPrice = null  ) 

Set _blSkipAbPrice value. If is set to true, then "From price" is not calculated for this object.

Parameters:
bool $blSkipAbPrice Whether to skip "From" price loading
Deprecated:
since v4.7.0-5.0.0 (2012-10-08); use getFVarMinPrice or getFMinPrice methods
Returns:
null

Definition at line 758 of file oxarticle.php.

oxArticle.setSkipAssign ( $  blSkipAssign  ) 

Assign condition setter. In case article assignment is skipped ($_blSkipAssign = true), it does not perform additional

Parameters:
bool $blSkipAssign Whether to skip assign process for the article
Returns:
null

Definition at line 632 of file oxarticle.php.

oxArticle.skipDiscounts (  ) 

Checks if discount should be skipped for this article in basket. Returns true if yes.

Returns:
bool

Definition at line 1802 of file oxarticle.php.

oxArticle.updateSoldAmount ( $  dAmount = 0  ) 

Recursive function. Updates quantity of sold articles. Return true on success

Parameters:
float $dAmount Number of articles sold
Returns:
mixed

Definition at line 2067 of file oxarticle.php.

oxArticle.updateVariantsRemind (  ) 

Updates article variants oxremindactive field, as variants inherit this setting from parent

Returns:
null

Definition at line 3964 of file oxarticle.php.

Member Data Documentation

oxArticle.$_aArticleCats = array() [static, protected]

Definition at line 359 of file oxarticle.php.

oxArticle.$_aArticleFiles = null [protected]

Definition at line 427 of file oxarticle.php.

oxArticle.$_aArticleManufacturers = array() [static, protected]

Definition at line 345 of file oxarticle.php.

oxArticle.$_aArticleVendors = array() [static, protected]

Definition at line 352 of file oxarticle.php.

oxArticle.$_aCategoryCache = null [static, protected]

Definition at line 415 of file oxarticle.php.

oxArticle.$_aCopyParentField [protected]
Initial value:
 array('oxarticles__oxnonmaterial',
                                         'oxarticles__oxfreeshipping',
                                         
                                         'oxarticles__oxisdownloadable')

Definition at line 377 of file oxarticle.php.

oxArticle.$_aDispSelList [protected]

Definition at line 230 of file oxarticle.php.

oxArticle.$_aLoadedParents [static, protected]

Definition at line 216 of file oxarticle.php.

oxArticle.$_aMediaUrls = null [protected]

Definition at line 209 of file oxarticle.php.

oxArticle.$_aNonCopyParentFields [protected]
Initial value:
 array('oxarticles__oxinsert',
                                             'oxarticles__oxtimestamp',
                                             'oxarticles__oxnid',
                                             'oxarticles__oxid',
                                             'oxarticles__oxparentid')

Definition at line 366 of file oxarticle.php.

oxArticle.$_aPersistParam = null [protected]

Definition at line 81 of file oxarticle.php.

oxArticle.$_aSelections = array() [static, protected]

Definition at line 409 of file oxarticle.php.

oxArticle.$_aSelList [static, protected]

Definition at line 223 of file oxarticle.php.

oxArticle.$_aSeoAddParams = array() [protected]

Definition at line 275 of file oxarticle.php.

oxArticle.$_aSeoUrls = array() [protected]

Definition at line 268 of file oxarticle.php.

oxArticle.$_aStdAddParams = array() [protected]

Definition at line 282 of file oxarticle.php.

oxArticle.$_aStdUrls = array() [protected]

Definition at line 261 of file oxarticle.php.

oxArticle.$_aVariants = null [protected]

Definition at line 103 of file oxarticle.php.

oxArticle.$_aVariantSelections = array() [protected]

Definition at line 403 of file oxarticle.php.

oxArticle.$_aVariantsWithNotOrderables = null [protected]

Definition at line 110 of file oxarticle.php.

oxArticle.$_blAllowEmptyParentId = false [protected]

Variable used to determine if setting parentId to empty value is allowed

Definition at line 176 of file oxarticle.php.

oxArticle.$_blCalcPrice = true [protected]

Definition at line 46 of file oxarticle.php.

oxArticle.$_blCanUpdateAnyField = null [protected]

Definition at line 433 of file oxarticle.php.

oxArticle.$_blHasAmountPrice = null [static, protected]

Definition at line 421 of file oxarticle.php.

oxArticle.$_blHasMdVariants = false [protected]

$_blHasVariants is set to true if article has multidimensional variants.

Definition at line 131 of file oxarticle.php.

oxArticle.$_blHasVariants = false [protected]

$_blHasVariants is set to true if article has any variants.

Definition at line 126 of file oxarticle.php.

oxArticle.$_blIsOnComparisonList = false [protected]

Definition at line 137 of file oxarticle.php.

oxArticle.$_blIsRangePrice = null [protected]

Definition at line 202 of file oxarticle.php.

oxArticle.$_blIsSeoObject = true [protected]

Definition at line 237 of file oxarticle.php.

oxArticle.$_blLoadParentData = false [protected]

Variable used to force load parent data in export

Definition at line 171 of file oxarticle.php.

oxArticle.$_blLoadPrice = true [protected]

Definition at line 150 of file oxarticle.php.

oxArticle.$_blLoadVariants = true [protected]

Definition at line 96 of file oxarticle.php.

oxArticle.$_blNotBuyable = false [protected]

Definition at line 88 of file oxarticle.php.

oxArticle.$_blNotBuyableParent = false [protected]

Definition at line 120 of file oxarticle.php.

oxArticle.$_blSkipAbPrice = false [protected]

If $_blSkipAbPrice is set to true, then "From price" is not calculated for this object.

Deprecated:
since v4.7.0-5.0.0 (2012-10-08); use getFVarMinPrice or getFMinPrice methods

Definition at line 158 of file oxarticle.php.

oxArticle.$_blSkipAssign = false [protected]

Variable used to force load parent data in export

Definition at line 181 of file oxarticle.php.

oxArticle.$_blSkipDiscounts = null [protected]

Definition at line 188 of file oxarticle.php.

oxArticle.$_blUseLazyLoading = true [protected]

Definition at line 32 of file oxarticle.php.

oxArticle.$_dAmountPrice = null [protected]

Definition at line 338 of file oxarticle.php.

oxArticle.$_dArticleVat = null [protected]

Definition at line 74 of file oxarticle.php.

oxArticle.$_dVarMaxPrice = null [protected]

Definition at line 67 of file oxarticle.php.

oxArticle.$_dVarMinPrice = null [protected]

Definition at line 60 of file oxarticle.php.

oxArticle.$_fPricePerUnit = null [protected]

$_fPricePerUnit holds price per unit value in active shop currency. $_fPricePerUnit is calculated from oxArticle.oxarticles__oxunitquantity->value and from oxArticle.oxarticles__oxuniname->value. If either one of these values is empty then $_fPricePerUnit is not calculated. Example: In case when product price is 10 EUR and product quantity is 0.5 (liters) then $_fPricePerUnit would be 20,00

Definition at line 166 of file oxarticle.php.

oxArticle.$_iLinkType = 0 [protected]

Definition at line 254 of file oxarticle.php.

oxArticle.$_iStockStatus = null [protected]

Definition at line 317 of file oxarticle.php.

oxArticle.$_iStockStatusOnLoad = null [protected]

Definition at line 310 of file oxarticle.php.

oxArticle.$_oAmountPriceInfo = null [protected]

Definition at line 331 of file oxarticle.php.

oxArticle.$_oAmountPriceList = null [protected]

Definition at line 244 of file oxarticle.php.

oxArticle.$_oAttributeList = null [protected]

Object holding the list of attributes and attribute values associated with this article Attributes are loaded only when bl_perfLoadAttributes config option is set to true

Definition at line 194 of file oxarticle.php.

oxArticle.$_oLongDesc = null [protected]

Definition at line 394 of file oxarticle.php.

oxArticle.$_oMdVariants = null [protected]

Definition at line 387 of file oxarticle.php.

oxArticle.$_oPrice = null [protected]

Definition at line 52 of file oxarticle.php.

oxArticle.$_oTPrice = null [protected]

Definition at line 324 of file oxarticle.php.

oxArticle.$_oUser = null [protected]

Definition at line 143 of file oxarticle.php.

oxArticle.$_sClassName = 'oxarticle' [protected]

Definition at line 25 of file oxarticle.php.

oxArticle.$_sDynImageDir = null [protected]

Definition at line 289 of file oxarticle.php.

oxArticle.$_sItemKey [protected]

Definition at line 39 of file oxarticle.php.

oxArticle.$_sMoreDetailLink = null [protected]

Definition at line 296 of file oxarticle.php.

oxArticle.$_sToBasketLink = null [protected]

Definition at line 303 of file oxarticle.php.

The documentation for this class was generated from the following file:
Generated by  doxygen 1.7.1