oxIArticle Interface Reference

Inheritance diagram for oxIArticle:

Public Member Functions
	checkForStock ($dAmount, $dArtStockAmount=0)
	getSelectLists ($sKeyPrefix=null)
	getBasketPrice ($dAmount, $aSelList, $oBasket)
	skipDiscounts ()
	getCategoryIds ($blActCats=false, $blSkipCache=false)
	getPrice ()
	getProductId ()
	getBasePrice ($dAmount=1)
	isOrderArticle ()

Detailed Description

Article interface

Definition at line 7 of file oxiarticle.php.

Member Function Documentation

oxIArticle::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

Implemented in oxOrderArticle.

oxIArticle::getBasePrice

(

$dAmount = 1

)

Returns base article price from database

Parameters

double

$dAmount

article amount. Default is 1

Returns

double

Implemented in oxArticle, and oxOrderArticle.

oxIArticle::getBasketPrice	(		$dAmount,
			$aSelList,
			$oBasket
	)

Creates, calculates and returns oxprice object for basket product.

Parameters

double	$dAmount	Amount
string	$aSelList	Selection list
object	$oBasket	User shopping basket object

Returns

oxPrice

Implemented in oxArticle, and oxOrderArticle.

oxIArticle::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

Implemented in oxArticle, and oxOrderArticle.

oxIArticle::getPrice

(

)

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

Returns

oxPrice

Implemented in oxOrderArticle.

oxIArticle::getProductId

(

)

Returns product id (oxid)

Returns

string

Implemented in oxArticle, and oxOrderArticle.

oxIArticle::getSelectLists

(

$sKeyPrefix = null

)

Returns all selectlists this article has.

Parameters

string

$sKeyPrefix

Optionall key prefix

Returns

array

Implemented in oxArticle, and oxOrderArticle.

oxIArticle::isOrderArticle

(

)

Returns true if object is derived from oxorderarticle class

Returns

bool

Implemented in oxArticle, and oxOrderArticle.

oxIArticle::skipDiscounts

(

)

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

Returns

bool

Implemented in oxArticle, and oxOrderArticle.

---

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

• core/interface/oxiarticle.php