Public Member Functions | Private Attributes

oxOutOfStockException Class Reference

Inheritance diagram for oxOutOfStockException:
Collaboration diagram for oxOutOfStockException:

List of all members.

Public Member Functions

 setRemainingAmount ($iRemainingAmount)
 getRemainingAmount ()
 setBasketIndex ($sBasketIndex)
 getBasketIndex ()
 getString ()
 getValues ()
 setDestination ($sDestination)

Private Attributes

 $_iRemainingAmount = 0
 $_sBasketIndex = null

Detailed Description

exception class for an article which is out of stock

Definition at line 6 of file oxoutofstockexception.php.

Member Function Documentation

oxOutOfStockException.getBasketIndex (  ) 

The basketindex of the faulty article


Definition at line 58 of file oxoutofstockexception.php.

oxOutOfStockException.getRemainingAmount (  ) 

Amount of articles left


Definition at line 38 of file oxoutofstockexception.php.

oxOutOfStockException.getString (  ) 

Get string dump Overrides oxException.getString()


Reimplemented from oxArticleException.

Definition at line 69 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()


Reimplemented from oxArticleException.

Definition at line 82 of file oxoutofstockexception.php.

oxOutOfStockException.setBasketIndex ( sBasketIndex  ) 

Sets the basket index for the article

string $sBasketIndex Basket index for the faulty article

Definition at line 48 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).

string $sDestination name of the view variable

Reimplemented from oxException.

Definition at line 103 of file oxoutofstockexception.php.

oxOutOfStockException.setRemainingAmount ( iRemainingAmount  ) 

Sets the amount of the article remaining in stock.

integer $iRemainingAmount Articles remaining in stock

Definition at line 28 of file oxoutofstockexception.php.

Member Data Documentation

oxOutOfStockException.$_iRemainingAmount = 0 [private]

Definition at line 14 of file oxoutofstockexception.php.

oxOutOfStockException.$_sBasketIndex = null [private]

Definition at line 21 of file oxoutofstockexception.php.

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