Inheritance diagram for OxidEsales\EshopCommunity\Application\Model\Contract\ArticleInterface:
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
Member Function Documentation
◆ checkForStock()
| OxidEsales\EshopCommunity\Application\Model\Contract\ArticleInterface::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 OxidEsales\EshopCommunity\Application\Model\OrderArticle.
◆ getBasePrice()
| OxidEsales\EshopCommunity\Application\Model\Contract\ArticleInterface::getBasePrice | ( | $dAmount = 1 | ) |
Returns base article price from database
- Parameters
-
double $dAmount article amount. Default is 1
- Returns
- double
Implemented in OxidEsales\EshopCommunity\Application\Model\OrderArticle.
◆ getBasketPrice()
| OxidEsales\EshopCommunity\Application\Model\Contract\ArticleInterface::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 OxidEsales\EshopCommunity\Application\Model\OrderArticle.
◆ getCategoryIds()
| OxidEsales\EshopCommunity\Application\Model\Contract\ArticleInterface::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 OxidEsales\EshopCommunity\Application\Model\OrderArticle.
◆ getPrice()
| OxidEsales\EshopCommunity\Application\Model\Contract\ArticleInterface::getPrice | ( | ) |
Calculates and returns price of article (adds taxes and discounts).
- Returns
- oxPrice
Implemented in OxidEsales\EshopCommunity\Application\Model\OrderArticle.
◆ getProductId()
| OxidEsales\EshopCommunity\Application\Model\Contract\ArticleInterface::getProductId | ( | ) |
Returns product id (oxid)
- Returns
- string
Implemented in OxidEsales\EshopCommunity\Application\Model\OrderArticle.
◆ getSelectLists()
| OxidEsales\EshopCommunity\Application\Model\Contract\ArticleInterface::getSelectLists | ( | $sKeyPrefix = null | ) |
Returns all selectlists this article has.
- Parameters
-
string $sKeyPrefix Optionall key prefix
- Returns
- array
Implemented in OxidEsales\EshopCommunity\Application\Model\OrderArticle.
◆ isOrderArticle()
| OxidEsales\EshopCommunity\Application\Model\Contract\ArticleInterface::isOrderArticle | ( | ) |
Returns true if object is derived from oxorderarticle class
- Returns
- bool
Implemented in OxidEsales\EshopCommunity\Application\Model\OrderArticle.
◆ skipDiscounts()
| OxidEsales\EshopCommunity\Application\Model\Contract\ArticleInterface::skipDiscounts | ( | ) |
Checks if discount should be skipped for this article in basket. Returns true if yes.
- Returns
- bool
Implemented in OxidEsales\EshopCommunity\Application\Model\OrderArticle.
The documentation for this interface was generated from the following file:
- /oxideshop-ce/source/Application/Model/Contract/ArticleInterface.php
