Inheritance diagram for oxOutOfStockException:
Collaboration diagram for oxOutOfStockException:
Public Member Functions | |
| setRemainingAmount ($iRemainingAmount) | |
| getRemainingAmount () | |
| getString () | |
| getValues () | |
| setDestination ($sDestination) | |
Private Attributes | |
| $_iRemainingAmount = 0 | |
Detailed Description
exception class for an article which is out of stock
Definition at line 6 of file oxoutofstockexception.php.
Member Function Documentation
| oxOutOfStockException.getRemainingAmount | ( | ) |
| oxOutOfStockException.getString | ( | ) |
Get string dump Overrides oxException.getString()
- Returns:
- string
Reimplemented from oxArticleException.
Definition at line 43 of file oxoutofstockexception.php.
| oxOutOfStockException.getValues | ( | ) |
Creates an array of field name => field value of the object. To make a easy conversion of exceptions to error messages possible. Should be extended when additional fields are used! Overrides oxException.getValues()
- Returns:
- array
Reimplemented from oxArticleException.
Definition at line 56 of file oxoutofstockexception.php.
| oxOutOfStockException.setDestination | ( | $ | sDestination | ) |
Defines a name of the view variable containing the messages. Currently it checks if destination value is set, and if not - overrides default error message with:
$this->getMessage(). $this->getRemainingAmount()
It is necessary to display correct stock error message on any view (except basket).
- Parameters:
-
string $sDestination name of the view variable
- Returns:
- null
Reimplemented from oxException.
Definition at line 77 of file oxoutofstockexception.php.
| oxOutOfStockException.setRemainingAmount | ( | $ | iRemainingAmount | ) |
Sets the amount of the article remaining in stock.
- Parameters:
-
integer $iRemainingAmount Articles remaining in stock
- Returns:
- null
Definition at line 22 of file oxoutofstockexception.php.
Member Data Documentation
oxOutOfStockException.$_iRemainingAmount = 0 [private] |
Definition at line 13 of file oxoutofstockexception.php.
The documentation for this class was generated from the following file:
- core/exception/oxoutofstockexception.php
