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)
	getUnitQuantity ()
	getSize ()
	getWeight ()
	getSqlActiveSnippet ($blForceCoreTable=null)
	setSkipAssign ($blSkipAssign)
	disablePriceLoad ()
	enablePriceLoad ()
	getItemKey ()
	setItemKey ($sItemKey)
	setNoVariantLoading ($blLoadVariants)
	isBuyable ()
	getPersParams ()
	isOnComparisonList ()
	setOnComparisonList ($blOnList)
	setLoadParentData ($blLoadParentData)
	isMultilingualField ($sFieldName)
	getFUnitPrice ()
	getUnitPrice ()
	getFMinPrice ()
	getFVarMinPrice ()
	getVarMinPrice ()
	getMinPrice ()
	isRangePrice ()
	setRangePrice ($blIsRangePrice=true)
	isVisible ()
	assign ($aRecord)
	load ($sOXID)
	hasSortingFieldsChanged ()
	addToRatingAverage ($iRating)
	setRatingAverage ($iRating)
	setRatingCount ($iRatingCnt)
	getArticleRatingAverage ($blIncludeVariants=false)
	getArticleRatingCount ($blIncludeVariants=false)
	getReviews ()
	getCrossSelling ()
	getAccessoires ()
	getSimilarProducts ()
	getCustomerAlsoBoughtThisProducts ()
	loadAmountPriceInfo ()
	getSelectLists ($sKeyPrefix=null)
	getVariantsCount ()
	hasMdVariants ()
	hasIntangibleAgreement ()
	hasDownloadableAgreement ()
	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)
	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())
	getMediaUrls ()
	getDynImageDir ()
	getDispSelList ()
	getMoreDetailLink ()
	getToBasketLink ()
	getStockStatus ()
	getDeliveryDate ()
	getFTPrice ()
	getFPrice ()
	resetRemindStatus ()
	getFNetPrice ()
	isParentNotBuyable ()
	isNotBuyable ()
	setBuyableState ($blBuyable=false)
	setSelectlist ($aSelList)
	getPictureUrl ($iIndex=1)
	getIconUrl ($iIndex=0)
	getThumbnailUrl ($bSsl=null)
	getZoomPictureUrl ($iIndex= '')
	applyVats (oxPrice $oPrice)
	applyDiscountsForVariant ($oPrice)
	getParentArticle ()
	updateVariantsRemind ()
	getProductId ()
	getParentId ()
	isOrderArticle ()
	isVariant ()
	isMdVariant ()
	getSqlForPriceCategories ($sFields= '')
	inPriceCategory ($sCatNid)
	getMdVariants ()
	getMdSubvariants ()
	getPictureFieldValue ($sFieldName, $iIndex=null)
	getMasterZoomPictureUrl ($iIndex)
	getUnitName ()
	getArticleFiles ($blAddFromParent=false)
	isDownloadable ()
	hasAmountPrice ()
	getVariantIds ($blActiveVariants=true)
	getArticleVat ()
Protected Member Functions
	_loadVariantList ($blSimple, $blRemoveNotOrderables=true, $blForceCoreTable=null)
	_selectCategoryIds ($sSql, $sField)
	_getCategoryIdsSelect ($blActCats=false)
	_getActiveCategorySelectSnippet ()
	_getSelectCatIds ($sOXID, $blActCats=false)
	_calculatePrice ($oPrice, $dVat=null)
	_hasAnyVariant ($blForceCoreTable=null)
	_isStockStatusChanged ()
	_isVisibilityChanged ()
	_saveArtLongDesc ()
	_skipSaveFields ()
	_mergeDiscounts ($aDiscounts, $aItemDiscounts)
	_getGroupPrice ()
	_getAmountPrice ($dAmount=1)
	_modifySelectListPrice ($dPrice, $aChosenList=null)
	_fillAmountPriceList ($aAmPriceList)
	_getVariantsIds ($blActiveVariants=true)
	_applyVAT (oxPrice $oPrice, $dVat)
	_applyCurrency (oxPrice $oPrice, $oCur=null)
	_getAttribsString (&$sAttributeSql, &$iCnt)
	_getSimList ($sAttributeSql, $iCnt)
	_generateSimListSearchStr ($sArticleTable, $aList)
	_generateSearchStr ($sOXID, $blSearchPriceCat=false)
	_generateSearchStrForCustomerBought ()
	_generateSelectCatStr ($sOXID, $sCatId, $dPriceFromTo=false)
	_getAmountPriceList ()
	_isFieldEmpty ($sFieldName)
	_assignParentFieldValue ($sFieldName)
	_isImageField ($sFieldName)
	_assignParentFieldValues ()
	_assignNotBuyableParent ()
	_assignStock ()
	_assignPersistentParam ()
	_assignDynImageDir ()
	_assignComparisonListFlag ()
	_insert ()
	_update ()
	_deleteRecords ($sOXID)
	_deleteVariantRecords ($sOXID)
	_deletePics ()
	_onChangeResetCounts ($sOxid, $sVendorId=null, $sManufacturerId=null)
	_onChangeUpdateStock ($sParentID)
	_onChangeStockResetCount ($sOxid)
	_onChangeUpdateVarCount ($sParentID)
	_setVarMinMaxPrice ($sParentId)
	_hasMasterImage ($iIndex)
	_isPriceViewModeNetto ()
	_getPriceObject ($blCalculationModeNetto=null)
	_getPriceForView ($oPrice)
	_preparePrice ($dPrice, $dVat, $blCalculationModeNetto=null)
	_getUserPriceSufix ()
	_getPrice ()
	_getVarMinPrice ()
	_getSubShopVarMinPrice ()
	_getVarMaxPrice ()
	_getSubShopVarMaxPrice ()
	_loadFromDb ($sOXID)
	_updateParentDependFields ()
	_getCopyParentFields ()
	_assignParentDependFields ()
	_saveSortingFieldValuesOnLoad ()
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
	$_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
	$_aSortingFieldsOnLoad = array()
	$_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 453 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 472 of file oxarticle.php.

oxArticle.__set	(	$	sName,
		$	sValue
	)

Sets article parameter

Parameters:

	string	$sName name of parameter to set
	mixed	$sValue parameter value

Definition at line 489 of file oxarticle.php.

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

Applies currency factor

Parameters:

	oxPrice	$oPrice Price object
	object	$oCur Currency object

Definition at line 3804 of file oxarticle.php.

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

Applies VAT to article

Parameters:

	oxPrice	$oPrice Price object
	double	$dVat VAT percent

Definition at line 3788 of file oxarticle.php.

oxArticle._assignComparisonListFlag

(

)

[protected]

Adds a flag if article is on comparisonlist.

Definition at line 4270 of file oxarticle.php.

oxArticle._assignDynImageDir

(

)

[protected]

assigns dynimagedir to article

Definition at line 4255 of file oxarticle.php.

oxArticle._assignNotBuyableParent

(

)

[protected]

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

Definition at line 4159 of file oxarticle.php.

oxArticle._assignParentDependFields

(

)

[protected]

Set parent field value to child - variants

Definition at line 4914 of file oxarticle.php.

oxArticle._assignParentFieldValue

(

$

sFieldName

)

[protected]

Assigns parent field values to article

Parameters:

string

$sFieldName field name

Returns:

null;

Definition at line 4092 of file oxarticle.php.

oxArticle._assignParentFieldValues

(

)

[protected]

Assigns parent field values to article

Definition at line 4142 of file oxarticle.php.

oxArticle._assignPersistentParam

(

)

[protected]

assigns persistent param to article

Definition at line 4243 of file oxarticle.php.

oxArticle._assignStock

(

)

[protected]

Assigns stock status to article

Definition at line 4172 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 3443 of file oxarticle.php.

oxArticle._deletePics

(

)

[protected]

Delete pics

Definition at line 4407 of file oxarticle.php.

oxArticle._deleteRecords

(

$

sOXID

)

[protected]

Deletes records in database

Parameters:

string

$sOXID Article ID

Returns:

int

Definition at line 4328 of file oxarticle.php.

oxArticle._deleteVariantRecords

(

$

sOXID

)

[protected]

Deletes variant records

Parameters:

string

$sOXID Article ID

Definition at line 4386 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 3693 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 3902 of file oxarticle.php.

oxArticle._generateSearchStrForCustomerBought

(

)

[protected]

Generates SQL select string for getCustomerAlsoBoughtThisProduct

Returns:

string

Definition at line 3927 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 3987 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 3879 of file oxarticle.php.

oxArticle._getActiveCategorySelectSnippet

(

)

[protected]

Returns active category select snippet

Returns:

string

Definition at line 3403 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 3635 of file oxarticle.php.

oxArticle._getAmountPriceList

(

)

[protected]

Collecting assigned to article amount-price list

Returns:

oxList

Definition at line 4016 of file oxarticle.php.

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

gets attribs string

Parameters:

	string	&$sAttributeSql Attribute selection snippet
	int	&$iCnt The number of selected attributes

Definition at line 3820 of file oxarticle.php.

oxArticle._getCategoryIdsSelect

(

$

blActCats = false

)

[protected]

Returns query for article categories select

Parameters:

bool

$blActCats select categories if all parents are active

Returns:

string

Definition at line 3377 of file oxarticle.php.

oxArticle._getCopyParentFields

(

)

[protected]

Returns array of fields which should not changed in variants

Returns:

array

Definition at line 4906 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 3613 of file oxarticle.php.

oxArticle._getPrice

(

)

[protected]

Return prepared price

Returns:

null

Definition at line 4714 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 4646 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 4621 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

Deprecated:

since v5.2 (2013-11-18); use oxArticle._getCategoryIdsSelect instead

Returns:

string

Definition at line 3421 of file oxarticle.php.

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

Gets similar list.

Parameters:

	string	$sAttributeSql Attribute selection snippet
	int	$iCnt Similar list article count

Returns:

array

Definition at line 3845 of file oxarticle.php.

oxArticle._getSubShopVarMaxPrice

(

)

[protected]

Return sub shop variant max price

Returns:

null

Definition at line 4838 of file oxarticle.php.

oxArticle._getSubShopVarMinPrice

(

)

[protected]

Return sub shop variant min price

Returns:

null

Definition at line 4773 of file oxarticle.php.

oxArticle._getUserPriceSufix

(

)

[protected]

Return price suffix

Returns:

null

Definition at line 4690 of file oxarticle.php.

oxArticle._getVariantsIds

(

$

blActiveVariants = true

)

[protected]

Collects and returns active/all variant ids of article.

Parameters:

bool

$blActiveVariants Parameter to load only active variants.

Deprecated:

since v5.2.0 (2014-04-30); Naming was changed and the method was made to public. Now use function getVariantIds().

Returns:

array

Definition at line 3763 of file oxarticle.php.

oxArticle._getVarMaxPrice

(

)

[protected]

Return variant max price

Returns:

null

Definition at line 4801 of file oxarticle.php.

oxArticle._getVarMinPrice

(

)

[protected]

Return variant min price

Returns:

null

Definition at line 4736 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 3474 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 4574 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 4287 of file oxarticle.php.

oxArticle._isFieldEmpty

(

$

sFieldName

)

[protected]

Detects if field is empty.

Parameters:

string

$sFieldName Field name

Returns:

bool

Definition at line 4048 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 4132 of file oxarticle.php.

oxArticle._isPriceViewModeNetto

(

)

[protected]

Checks and return true if price view mode is netto

Returns:

bool

Definition at line 4602 of file oxarticle.php.

oxArticle._isStockStatusChanged

(

)

[protected]

Check if stock status has changed since loading the article

Returns:

bool

Definition at line 3494 of file oxarticle.php.

oxArticle._isVisibilityChanged

(

)

[protected]

Check if visibility has changed since loading the article

Returns:

bool

Definition at line 3504 of file oxarticle.php.

oxArticle._loadFromDb

(

$

sOXID

)

[protected]

Get data from db

Parameters:

string

$sOXID id

Returns:

array

Definition at line 4868 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 3265 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 3594 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 3663 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

Definition at line 4435 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

Definition at line 4497 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

Definition at line 4459 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

Definition at line 4514 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 4667 of file oxarticle.php.

oxArticle._saveArtLongDesc

(

)

[protected]

inserts article long description to artextends table

Returns:

null

Definition at line 3514 of file oxarticle.php.

oxArticle._saveSortingFieldValuesOnLoad

(

)

[protected]

Saves values of sorting fields on article load.

Definition at line 4929 of file oxarticle.php.

oxArticle._selectCategoryIds	(	$	sSql,
		$	sField
	)			[protected]

Selects category IDs from given SQL statement and ID field name

Parameters:

	string	$sSql sql statement
	string	$sField category ID field name

Returns:

array

Definition at line 3353 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

Definition at line 4532 of file oxarticle.php.

oxArticle._skipSaveFields

(

)

[protected]

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

Definition at line 3568 of file oxarticle.php.

oxArticle._update

(

)

[protected]

Executes oxarticle._skipSaveFields() and updates article information

Returns:

bool

Definition at line 4307 of file oxarticle.php.

oxArticle._updateParentDependFields

(

)

[protected]

Set parent field value to child - variants in DB

Returns:

bool

Definition at line 4884 of file oxarticle.php.

oxArticle.addToRatingAverage

(

$

iRating

)

Calculates and saves product rating average

Parameters:

integer

$iRating new rating value

Definition at line 1095 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

Definition at line 2456 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

Definition at line 2561 of file oxarticle.php.

oxArticle.applyDiscountsForVariant

(

$

oPrice

)

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

Parameters:

oxprice

$oPrice Price object

Definition at line 2954 of file oxarticle.php.

oxArticle.applyVats

(

oxPrice $

oPrice

)

apply article and article use

Parameters:

oxPrice

$oPrice target price

Definition at line 2944 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 1007 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 2314 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 2014 of file oxarticle.php.

oxArticle.disablePriceLoad

(

)

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

Definition at line 678 of file oxarticle.php.

oxArticle.disableReminder

(

)

Disables reminder functionality for article

Returns:

bool

Definition at line 2105 of file oxarticle.php.

oxArticle.enablePriceLoad

(

)

Enable article price loading, if disabled.

Definition at line 686 of file oxarticle.php.

oxArticle.getAccessoires

(

)

Loads and returns array with accessories information.

Returns:

array

Definition at line 1217 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 531 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 1546 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 3202 of file oxarticle.php.

oxArticle.getArticleRatingAverage

(

$

blIncludeVariants = false

)

Returns product rating average

Parameters:

bool

$blIncludeVariants - include variant ratings

Returns:

double

Definition at line 1136 of file oxarticle.php.

oxArticle.getArticleRatingCount

(

$

blIncludeVariants = false

)

Returns product rating count

Parameters:

bool

$blIncludeVariants - include variant ratings

Returns:

double

Definition at line 1154 of file oxarticle.php.

oxArticle.getArticleUser

(

)

return article user

Returns:

oxUser

Definition at line 1963 of file oxarticle.php.

oxArticle.getArticleVat

(

)

retrieve article VAT (cached)

Returns:

double

Definition at line 3773 of file oxarticle.php.

oxArticle.getAttributes

(

)

Loads and returns attribute list associated with this article

Returns:

object

Definition at line 2424 of file oxarticle.php.

oxArticle.getAttributesDisplayableInBasket

(

)

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

Returns:

object

Definition at line 2439 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 1888 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 2582 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 1981 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 1579 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 1630 of file oxarticle.php.

oxArticle.getCrossSelling

(

)

Loads and returns array with cross selling information.

Returns:

array

Definition at line 1203 of file oxarticle.php.

oxArticle.getCustomerAlsoBoughtThisProducts

(

)

Loads and returns articles list, bought by same customer.

Returns:

array

Definition at line 1278 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 2299 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 2739 of file oxarticle.php.

oxArticle.getDispSelList

(

)

Returns select lists to display

Returns:

array

Definition at line 2651 of file oxarticle.php.

oxArticle.getDynImageDir

(

)

Get image url

Returns:

array

Definition at line 2641 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 841 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 2801 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 2772 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 2755 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 1507 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 800 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 859 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 2877 of file oxarticle.php.

oxArticle.getItemKey

(

)

Returns item key used with oxuserbasket

Returns:

string

Definition at line 696 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 2495 of file oxarticle.php.

oxArticle.getLinkType

(

)

Get link type

Returns:

int

Definition at line 2550 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 2399 of file oxarticle.php.

oxArticle.getLongDescription

(

)

Get article long description

Returns:

object $oField field object

Definition at line 2364 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 2526 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 1721 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 1700 of file oxarticle.php.

oxArticle.getMasterZoomPictureUrl

(

$

iIndex

)

Get master zoom picture url

Parameters:

int

$iIndex picture index

Returns:

string

Definition at line 3168 of file oxarticle.php.

oxArticle.getMdSubvariants

(

)

Returns first level variants from multidimensional variants list

Returns:

OxMdVariants

Definition at line 3139 of file oxarticle.php.

oxArticle.getMdVariants

(

)

Returns multidimensional variant structure

Returns:

OxMdVariants

Definition at line 3115 of file oxarticle.php.

oxArticle.getMediaUrls

(

)

Return article media URL

Returns:

array

Definition at line 2621 of file oxarticle.php.

oxArticle.getMinPrice

(

)

Returns article min price in calculation included variants

Returns:

oxPrice

Definition at line 900 of file oxarticle.php.

oxArticle.getMoreDetailLink

(

)

Get more details link

Returns:

string

Definition at line 2667 of file oxarticle.php.

oxArticle.getParentArticle

(

)

Get parent article

Returns:

oxArticle

Definition at line 2974 of file oxarticle.php.

oxArticle.getParentId

(

)

Returns product parent id (oxparentid)

Returns:

string

Definition at line 3030 of file oxarticle.php.

oxArticle.getPersParams

(

)

Get persistent parameters

Returns:

array

Definition at line 740 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 3152 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 2152 of file oxarticle.php.

oxArticle.getPictureUrl

(

$

iIndex = 1

)

Returns article picture

Parameters:

int

$iIndex picture index

Returns:

string

Definition at line 2855 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 1913 of file oxarticle.php.

oxArticle.getProductId

(

)

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

Returns:

string

Definition at line 3020 of file oxarticle.php.

oxArticle.getReviews

(

)

Collects user written reviews about an article.

Returns:

oxList

Definition at line 1171 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 1447 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 1327 of file oxarticle.php.

oxArticle.getSimilarProducts

(

)

Returns a list of similar products.

Returns:

array

Definition at line 1240 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 1531 of file oxarticle.php.

oxArticle.getSize

(

)

Return Size of product: length*width*height

Returns:

double

Definition at line 627 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 653 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 3074 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 2603 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 560 of file oxarticle.php.

oxArticle.getStockStatus

(

)

Get stock status

Returns:

integer

Definition at line 2729 of file oxarticle.php.

oxArticle.getThumbnailUrl

(

$

bSsl = null

)

Returns article thumbnail picture url

Parameters:

bool

$bSsl to force SSL

Returns:

string

Definition at line 2905 of file oxarticle.php.

oxArticle.getToBasketLink

(

)

Get to basket link

Returns:

string

Definition at line 2690 of file oxarticle.php.

oxArticle.getTPrice

(

)

Returns T price

Returns:

oxPrice

Definition at line 1800 of file oxarticle.php.

oxArticle.getUnitName

(

)

Returns oxarticles__oxunitname value processed by oxLang.translateString()

Returns:

string

Definition at line 3188 of file oxarticle.php.

oxArticle.getUnitPrice

(

)

Returns price per unit

Returns:

string

Definition at line 818 of file oxarticle.php.

oxArticle.getUnitQuantity

(

)

Return unit quantity

Returns:

sting

Definition at line 617 of file oxarticle.php.

oxArticle.getVariantIds

(

$

blActiveVariants = true

)

Collects and returns active/all variant ids of article.

Parameters:

bool

$blActiveVariants Parameter to load only active variants.

Returns:

array

Definition at line 3730 of file oxarticle.php.

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

Collects and returns article variants. Note: Only active variants are returned by this method. If you need full variant list use oxArticle.getAdminVariants()

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 1521 of file oxarticle.php.

oxArticle.getVariantsCount

(

)

Returns amount of variants article has

Returns:

mixed

Definition at line 1376 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 1420 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 595 of file oxarticle.php.

oxArticle.getVarMinPrice

(

)

Returns article min price of variants

Returns:

oxPrice

Definition at line 875 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 1657 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 1682 of file oxarticle.php.

oxArticle.getWeight

(

)

Return product weight

Returns:

double

Definition at line 641 of file oxarticle.php.

oxArticle.getZoomPictureUrl

(

$

iIndex = ''

)

Returns article zoom picture url

Parameters:

int

$iIndex picture index

Returns:

string

Definition at line 2928 of file oxarticle.php.

oxArticle.hasAmountPrice

(

)

Checks if articles has amount price

Returns:

bool

Definition at line 3239 of file oxarticle.php.

oxArticle.hasDownloadableAgreement

(

)

Returns if article has downloadable agreement with which customer will have to agree.

Returns:

bool

Definition at line 1406 of file oxarticle.php.

oxArticle.hasIntangibleAgreement

(

)

Returns if article has intangible agreement with which customer will have to agree.

Returns:

bool

Definition at line 1396 of file oxarticle.php.

oxArticle.hasMdVariants

(

)

Checks if article has multidimensional variants

Returns:

bool

Definition at line 1386 of file oxarticle.php.

oxArticle.hasSortingFieldsChanged

(

)

Checks whether sorting fields changed from last article loading.

Returns:

bool

Definition at line 1073 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 1750 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 3094 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 1763 of file oxarticle.php.

oxArticle.isBuyable

(

)

Checks if article is buyable.

Returns:

bool

Definition at line 726 of file oxarticle.php.

oxArticle.isDownloadable

(

)

Returns oxarticles__oxisdownloadable value

Returns:

bool

Definition at line 3229 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 500 of file oxarticle.php.

oxArticle.isMdVariant

(

)

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

Returns:

bool

Definition at line 3060 of file oxarticle.php.

oxArticle.isMultilingualField

(

$

sFieldName

)

Returns true if the field is multilanguage

Parameters:

string

$sFieldName Field name

Returns:

bool

Definition at line 783 of file oxarticle.php.

oxArticle.isNotBuyable

(

)

Returns true if article is not buyable

Returns:

bool

Definition at line 2823 of file oxarticle.php.

oxArticle.isOnComparisonList

(

)

Checks whether article is inluded in comparison list

Returns:

bool

Definition at line 750 of file oxarticle.php.

oxArticle.isOrderArticle

(

)

Returns false if object is not derived from oxorderarticle class

Returns:

bool

Definition at line 3040 of file oxarticle.php.

oxArticle.isParentNotBuyable

(

)

Returns true if parent is not buyable

Returns:

bool

Definition at line 2813 of file oxarticle.php.

oxArticle.isRangePrice

(

)

Returns true if article has variant with different price

Returns:

bool

Definition at line 927 of file oxarticle.php.

oxArticle.isVariant

(

)

Returns TRUE if product is variant, and false if not

Returns:

bool

Definition at line 3050 of file oxarticle.php.

oxArticle.isVisible

(

)

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

Returns:

bool

Definition at line 967 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 1045 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 1303 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 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 2240 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 2051 of file oxarticle.php.

oxArticle.resetParent

(

)

Changes article variant to parent article

Definition at line 2132 of file oxarticle.php.

oxArticle.resetRemindStatus

(

)

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

Definition at line 2785 of file oxarticle.php.

oxArticle.save

(

)

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

Returns:

bool

Definition at line 2117 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 2411 of file oxarticle.php.

oxArticle.setArticleUser

(

$

oUser

)

sets article user

Parameters:

oxUser

$oUser user to set

Definition at line 1953 of file oxarticle.php.

oxArticle.setBuyableState

(

$

blBuyable = false

)

Sets product state - buyable or not

Parameters:

bool

$blBuyable state - buyable or not (default false)

Definition at line 2833 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 512 of file oxarticle.php.

oxArticle.setItemKey

(

$

sItemKey

)

Sets item key used with oxuserbasket

Parameters:

string

$sItemKey Item key

Definition at line 706 of file oxarticle.php.

oxArticle.setLinkType

(

$

iType

)

Resets details link

Parameters:

int

$iType type of link to load

Definition at line 2536 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

Definition at line 770 of file oxarticle.php.

oxArticle.setNoVariantLoading

(

$

blLoadVariants

)

Disables/enables variant loading

Parameters:

bool

$blLoadVariants skip variant loading or not

Definition at line 716 of file oxarticle.php.

oxArticle.setOnComparisonList

(

$

blOnList

)

Set if article is inluded in comparison list

Parameters:

bool

$blOnList Whether is article on the list

Definition at line 760 of file oxarticle.php.

oxArticle.setPrice

(

oxPrice $

oPrice

)

Sets the current oxPrice object

Parameters:

oxPrice

$oPrice the new price object

Definition at line 1875 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 957 of file oxarticle.php.

oxArticle.setRatingAverage

(

$

iRating

)

Set product rating average

Parameters:

integer

$iRating new rating value

Definition at line 1114 of file oxarticle.php.

oxArticle.setRatingCount

(

$

iRatingCnt

)

Set product rating count

Parameters:

integer

$iRatingCnt new rating count

Definition at line 1124 of file oxarticle.php.

oxArticle.setSelectlist

(

$

aSelList

)

Sets selectlists of current product

Parameters:

array

$aSelList selectlist

Definition at line 2843 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

Definition at line 670 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 1844 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 2077 of file oxarticle.php.

oxArticle.updateVariantsRemind

(

)

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

Definition at line 2996 of file oxarticle.php.

---

Member Data Documentation

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

Definition at line 364 of file oxarticle.php.

oxArticle.$_aArticleFiles = null [protected]

Definition at line 436 of file oxarticle.php.

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

Definition at line 350 of file oxarticle.php.

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

Definition at line 357 of file oxarticle.php.

oxArticle.$_aCategoryCache = null [static, protected]

Definition at line 422 of file oxarticle.php.

oxArticle.$_aCopyParentField [protected]

Initial value:

 array('oxarticles__oxnonmaterial',
                                         'oxarticles__oxfreeshipping',
                                         'oxarticles__oxisdownloadable',
                                         'oxarticles__oxshowcustomagreement')

Definition at line 382 of file oxarticle.php.

oxArticle.$_aDispSelList [protected]

Definition at line 228 of file oxarticle.php.

oxArticle.$_aLoadedParents [static, protected]

Definition at line 214 of file oxarticle.php.

oxArticle.$_aMediaUrls = null [protected]

Definition at line 207 of file oxarticle.php.

oxArticle.$_aNonCopyParentFields [protected]

Initial value:

 array('oxarticles__oxinsert',
                                             'oxarticles__oxtimestamp',
                                             'oxarticles__oxnid',
                                             'oxarticles__oxid',
                                             'oxarticles__oxparentid')

Definition at line 371 of file oxarticle.php.

oxArticle.$_aPersistParam = null [protected]

Definition at line 84 of file oxarticle.php.

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

Definition at line 415 of file oxarticle.php.

oxArticle.$_aSelList [static, protected]

Definition at line 221 of file oxarticle.php.

oxArticle.$_aSeoAddParams = array() [protected]

Definition at line 273 of file oxarticle.php.

oxArticle.$_aSeoUrls = array() [protected]

Definition at line 266 of file oxarticle.php.

oxArticle.$_aSortingFieldsOnLoad = array() [protected]

Definition at line 315 of file oxarticle.php.

oxArticle.$_aStdAddParams = array() [protected]

Definition at line 280 of file oxarticle.php.

oxArticle.$_aStdUrls = array() [protected]

Definition at line 259 of file oxarticle.php.

oxArticle.$_aVariants = null [protected]

Definition at line 106 of file oxarticle.php.

oxArticle.$_aVariantSelections = array() [protected]

Definition at line 408 of file oxarticle.php.

oxArticle.$_aVariantsWithNotOrderables = null [protected]

Definition at line 113 of file oxarticle.php.

oxArticle.$_blAllowEmptyParentId = false [protected]

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

Definition at line 174 of file oxarticle.php.

oxArticle.$_blCalcPrice = true [protected]

Definition at line 48 of file oxarticle.php.

oxArticle.$_blCanUpdateAnyField = null [protected]

Definition at line 443 of file oxarticle.php.

oxArticle.$_blHasAmountPrice = null [static, protected]

Definition at line 429 of file oxarticle.php.

oxArticle.$_blHasMdVariants = false [protected]

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

Definition at line 134 of file oxarticle.php.

oxArticle.$_blHasVariants = false [protected]

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

Definition at line 129 of file oxarticle.php.

oxArticle.$_blIsOnComparisonList = false [protected]

Definition at line 141 of file oxarticle.php.

oxArticle.$_blIsRangePrice = null [protected]

Definition at line 200 of file oxarticle.php.

oxArticle.$_blIsSeoObject = true [protected]

Definition at line 235 of file oxarticle.php.

oxArticle.$_blLoadParentData = false [protected]

Variable used to force load parent data in export

Definition at line 169 of file oxarticle.php.

oxArticle.$_blLoadPrice = true [protected]

Definition at line 156 of file oxarticle.php.

oxArticle.$_blLoadVariants = true [protected]

Definition at line 99 of file oxarticle.php.

oxArticle.$_blNotBuyable = false [protected]

Definition at line 91 of file oxarticle.php.

oxArticle.$_blNotBuyableParent = false [protected]

Definition at line 123 of file oxarticle.php.

oxArticle.$_blSkipAssign = false [protected]

Variable used to force load parent data in export

Definition at line 179 of file oxarticle.php.

oxArticle.$_blSkipDiscounts = null [protected]

Definition at line 186 of file oxarticle.php.

oxArticle.$_blUseLazyLoading = true [protected]

Definition at line 33 of file oxarticle.php.

oxArticle.$_dAmountPrice = null [protected]

Definition at line 343 of file oxarticle.php.

oxArticle.$_dArticleVat = null [protected]

Definition at line 77 of file oxarticle.php.

oxArticle.$_dVarMaxPrice = null [protected]

Definition at line 70 of file oxarticle.php.

oxArticle.$_dVarMinPrice = null [protected]

Definition at line 63 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 164 of file oxarticle.php.

oxArticle.$_iLinkType = 0 [protected]

Definition at line 252 of file oxarticle.php.

oxArticle.$_iStockStatus = null [protected]

Definition at line 322 of file oxarticle.php.

oxArticle.$_iStockStatusOnLoad = null [protected]

Definition at line 308 of file oxarticle.php.

oxArticle.$_oAmountPriceInfo = null [protected]

Definition at line 336 of file oxarticle.php.

oxArticle.$_oAmountPriceList = null [protected]

Definition at line 242 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 192 of file oxarticle.php.

oxArticle.$_oLongDesc = null [protected]

Definition at line 399 of file oxarticle.php.

oxArticle.$_oMdVariants = null [protected]

Definition at line 392 of file oxarticle.php.

oxArticle.$_oPrice = null [protected]

Definition at line 55 of file oxarticle.php.

oxArticle.$_oTPrice = null [protected]

Definition at line 329 of file oxarticle.php.

oxArticle.$_oUser = null [protected]

Definition at line 148 of file oxarticle.php.

oxArticle.$_sClassName = 'oxarticle' [protected]

Definition at line 26 of file oxarticle.php.

oxArticle.$_sDynImageDir = null [protected]

Definition at line 287 of file oxarticle.php.

oxArticle.$_sItemKey [protected]

Definition at line 40 of file oxarticle.php.

oxArticle.$_sMoreDetailLink = null [protected]

Definition at line 294 of file oxarticle.php.

oxArticle.$_sToBasketLink = null [protected]

Definition at line 301 of file oxarticle.php.

---

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

• application/models/oxarticle.php