Order manager. Performs creation assigning, updating, deleting and other order functions.
Definition at line 7 of file oxorder.php.
oxOrder.__construct | ( | ) |
Class constructor, initiates parent constructor (parent.oxBase()).
Reimplemented from oxBase.
Definition at line 175 of file oxorder.php.
oxOrder.__get | ( | $ | sName | ) |
Getter made for order deliveryset object access
string | $sName parameter name |
Reimplemented from oxBase.
Definition at line 192 of file oxorder.php.
oxOrder._addArticlesToBasket | ( | $ | oBasket, | |
$ | aArticles | |||
) | [protected] |
Adds new products to basket/order
oxbasket | $oBasket basket to add articles | |
array | $aArticles article array |
Definition at line 1676 of file oxorder.php.
oxOrder._addOrderArticlesToBasket | ( | $ | oBasket, | |
$ | aOrderArticles | |||
) | [protected] |
Adds order articles back to virtual basket. Needed for recalculating order.
oxBasket | $oBasket basket object | |
array | $aOrderArticles order articles |
Definition at line 1656 of file oxorder.php.
oxOrder._checkOrderExist | ( | $ | sOxId = null |
) | [protected] |
Checking if this order is already stored.
string | $sOxId order ID |
Definition at line 1478 of file oxorder.php.
oxOrder._executePayment | ( | oxBasket $ | oBasket, | |
$ | oUserpayment | |||
) | [protected] |
Executes payment. Additionally loads oxPaymentGateway object, initiates it by adding payment parameters (oxPaymentGateway.setPaymentParams()) and finally executes it (oxPaymentGateway.executePayment()). On failure - deletes order and returns * error code 2.
oxBasket | $oBasket basket object | |
object | $oUserpayment user payment object |
Definition at line 761 of file oxorder.php.
oxOrder._getCountryTitle | ( | $ | sCountryId | ) | [protected] |
Gets country title by country id.
string | $sCountryId Cuntry ID |
Definition at line 236 of file oxorder.php.
oxOrder._getGateway | ( | ) | [protected] |
Returns the correct gateway. At the moment only switch between default and IPayment, can be extended later.
Definition at line 794 of file oxorder.php.
oxOrder._getOrderBasket | ( | $ | blStockCheck = true |
) | [protected] |
Returns basket object filled up with discount, delivery, wrapping and all other info
bool | $blStockCheck perform stock check or not (default true) |
Definition at line 1207 of file oxorder.php.
oxOrder._insert | ( | ) | [protected] |
Inserts order object information in DB. Returns true on success.
Reimplemented from oxBase.
Definition at line 1075 of file oxorder.php.
oxOrder._loadFromBasket | ( | oxBasket $ | oBasket | ) | [protected] |
Gathers and assigns to new oxorder object customer data, payment, delivery and shipping info, customer odere remark, currency, voucher, language data. Additionally stores general discount and wrapping. Sets order status to "error" and creates oxorderarticle objects and assigns to them basket articles.
oxBasket | $oBasket Shopping basket object |
Definition at line 484 of file oxorder.php.
oxOrder._makeSelListArray | ( | $ | sArtId = null , |
|
$ | sOrderArtSelList = null | |||
) | [protected] |
Make select list array from oxorderarticles__oxselvariant string. This select list array is used when recalculating order and adding items to basket (oxBasket.addToBaske())
string | $sArtId order article ID | |
string | $sOrderArtSelList select list string stored in oxorderarticles__oxselvariant |
Definition at line 1642 of file oxorder.php.
oxOrder._markVouchers | ( | $ | oBasket, | |
$ | oUser | |||
) | [protected] |
Marks voucher as used (oxvoucher.markAsUsed()) and sets them to $this->_aVoucherList.
Definition at line 974 of file oxorder.php.
oxOrder._sendOrderByEmail | ( | $ | oUser = null , |
|
$ | oBasket = null , |
|||
$ | oPayment = null | |||
) | [protected] |
Send order to shop owner and user
oxUser | $oUser order user | |
oxBasket | $oBasket current order basket | |
oxPayment | $oPayment order payment |
Definition at line 1501 of file oxorder.php.
oxOrder._setDeprecatedValues | ( | ) | [protected] |
Sets deprecate values
Definition at line 1699 of file oxorder.php.
oxOrder._setFolder | ( | ) | [protected] |
oxOrder._setOrderArticles | ( | $ | aArticleList | ) | [protected] |
Creates oxorderarticle objects and assigns to them basket articles. Updates quantity of sold articles (oxarticle.updateSoldAmount()).
array | $aArticleList article list |
Definition at line 664 of file oxorder.php.
oxOrder._setOrderStatus | ( | $ | sStatus | ) | [protected] |
Updates order transaction status. Faster than saving whole object
string | $sStatus order transaction status |
Definition at line 464 of file oxorder.php.
oxOrder._setPayment | ( | $ | sPaymentid | ) | [protected] |
Creats and returns user payment.
string | $sPaymentid used payment id |
Definition at line 806 of file oxorder.php.
oxOrder._setUser | ( | $ | oUser | ) | [protected] |
Assigns to new oxorder object customer delivery and shipping info
object | $oUser user object |
Definition at line 586 of file oxorder.php.
oxOrder._setWrapping | ( | oxBasket $ | oBasket | ) | [protected] |
Assigns wrapping VAT and card price + card message info
oxBasket | $oBasket basket object |
Definition at line 635 of file oxorder.php.
oxOrder._update | ( | ) | [protected] |
Updates object parameters to DB.
Reimplemented from oxBase.
Definition at line 1109 of file oxorder.php.
oxOrder._updateNoticeList | ( | $ | aArticleList, | |
$ | oUser | |||
) | [protected] |
After order is finished this method cleans up users notice list, by removing bought items from users notice list
array | $aArticleList array of basket products | |
oxuser | $oUser basket user object |
Definition at line 924 of file oxorder.php.
oxOrder._updateStock | ( | ) | [protected] |
oxOrder._updateWishlist | ( | $ | aArticleList, | |
$ | oUser | |||
) | [protected] |
aAdds/removes user chosen article to/from his noticelist or wishlist (oxuserbasket.addItemToBasket()).
array | $aArticleList basket products | |
object | $oUser user object |
Definition at line 884 of file oxorder.php.
oxOrder.assign | ( | $ | dbRecord | ) |
Assigns data, stored in DB to oxorder object
mixed | $dbRecord DB record |
Reimplemented from oxBase.
Definition at line 214 of file oxorder.php.
oxOrder.cancelOrder | ( | ) |
oxOrder.delete | ( | $ | sOxId = null |
) |
Updates stock information, deletes current ordering details from DB, returns true on success.
string | $sOxId Ordering ID (default null) |
Reimplemented from oxBase.
Definition at line 1123 of file oxorder.php.
oxOrder.finalizeOrder | ( | oxBasket $ | oBasket, | |
$ | oUser, | |||
$ | blRecalculatingOrder = false | |||
) |
Order checking, processing and saving method. Before saving performed checking if order is still not executed (checks in database oxorder table for order with know ID), if yes - returns error code 3, if not - loads payment data, assigns all info from basket to new oxorder object and saves full order with error status. Then executes payment. On failure - deletes order and returns error code 2. On success - saves order (oxorder.save()), removes article from wishlist (oxorder._updateWishlist()), updates voucher data (oxorder._markVouchers()). Finally sends order confirmation email to customer (oxemail.SendOrderEMailToUser()) and shop owner (oxemail.SendOrderEMailToOwner()). If this is order racalculation, skipping payment execution, marking vouchers as used and sending order by email to shop owner and user Mailing status (1 if OK, 0 on error) is returned.
oxBasket | $oBasket Shopping basket object | |
object | $oUser Current user object | |
bool | $blRecalculatingOrder Order recalculation |
Definition at line 377 of file oxorder.php.
oxOrder.genPdf | ( | $ | sFilename, | |
$ | iSelLang = 0 | |||
) |
Fake entries, pdf is generated in modules.. myorder.
string | $sFilename file name | |
int | $iSelLang selected language |
Definition at line 1359 of file oxorder.php.
oxOrder.getBasket | ( | ) |
oxOrder.getBillCountry | ( | ) |
Get billing country name from billing country id
Definition at line 1770 of file oxorder.php.
oxOrder.getDelAddressInfo | ( | ) |
Loads and returns delivery adress object or null if deladrid is not configured, or object was not loaded
Definition at line 1016 of file oxorder.php.
oxOrder.getDelCountry | ( | ) |
Get delivery country name from delivery country id
Definition at line 1783 of file oxorder.php.
oxOrder.getDelSet | ( | ) |
oxOrder.getGiftCard | ( | ) |
oxOrder.getInvoiceNum | ( | ) |
oxOrder.getLastUserPaymentType | ( | $ | sUserId | ) |
Get users payment type from last order
string | $sUserId order user id |
Definition at line 1622 of file oxorder.php.
oxOrder.getNextBillNum | ( | ) |
Returns next possible (free) order bill number.
Definition at line 1379 of file oxorder.php.
oxOrder.getOrderArticles | ( | $ | blExcludeCanceled = false |
) |
Assigns data, stored in oxorderarticles to oxorder object .
bool | $blExcludeCanceled excludes canceled items from list |
Definition at line 255 of file oxorder.php.
oxOrder.getOrderCnt | ( | $ | blToday = false |
) |
Returns orders count
bool | $blToday if true calculates only current day orders |
Definition at line 1458 of file oxorder.php.
oxOrder.getOrderCurrency | ( | ) |
Returns actual order currency object. In case currency was not recognized due to changed name returns first shop currency object
Definition at line 1836 of file oxorder.php.
oxOrder.getOrderDeliveryPrice | ( | ) |
Returns order delivery expenses price object
Definition at line 293 of file oxorder.php.
oxOrder.getOrderLanguage | ( | ) |
Returns language id of current order object. If order allready has language defined - checks if this language is defined in shops config
Definition at line 567 of file oxorder.php.
oxOrder.getOrderNetSum | ( | ) |
Returns order netto sum (total price, including delivery, payment etc - VAT) (A. this is very unprecise :())
Definition at line 345 of file oxorder.php.
oxOrder.getOrderPaymentPrice | ( | ) |
Returns order payment expenses price object
Definition at line 327 of file oxorder.php.
oxOrder.getOrderSum | ( | $ | blToday = false |
) |
Returns orders total price
bool | $blToday if true calculates only current day orders |
Definition at line 1439 of file oxorder.php.
oxOrder.getOrderUser | ( | ) |
oxOrder.getOrderWrappingPrice | ( | ) |
Returns order wrapping expenses price object
Definition at line 310 of file oxorder.php.
oxOrder.getPayment | ( | ) |
oxOrder.getPaymentType | ( | ) |
oxOrder.getProductVats | ( | $ | blFormatCurrency = true |
) |
Returns array of palain of formatted VATs stored in order
bool | $blFormatCurrency enambles currency formating |
Definition at line 1745 of file oxorder.php.
oxOrder.getShippingSetList | ( | ) |
Loads possible shipping sets for this order
Definition at line 1390 of file oxorder.php.
oxOrder.getTotalOrderSum | ( | ) |
oxOrder.getVoucherList | ( | ) |
oxOrder.getVoucherNrList | ( | ) |
Get vouchers numbers list which were used with this order
Definition at line 1417 of file oxorder.php.
oxOrder.pdfFooter | ( | $ | oPdf | ) |
Fake entries, pdf is generated in modules.. myorder.
mixed | $oPdf pdf object |
Definition at line 1325 of file oxorder.php.
oxOrder.pdfHeader | ( | $ | oPdf | ) |
Fake entries, pdf is generated in modules.. myorder.
mixed | $oPdf pdf object |
Definition at line 1347 of file oxorder.php.
oxOrder.pdfHeaderplus | ( | $ | oPdf | ) |
Fake entries, pdf is generated in modules.. myorder.
mixed | $oPdf pdf object |
Definition at line 1336 of file oxorder.php.
oxOrder.recalculateOrder | ( | $ | aNewArticles = array() |
) |
Recalculates order. Starts transactions, deletes current order and order articles from DB, adds current order articles to virtual basket and finaly recalculates order by calling oxorder.finalizeOrder() If no errors, finishing transaction.
array | $aNewArticles article list of new order |
Definition at line 1163 of file oxorder.php.
oxOrder.reloadDelivery | ( | $ | blReload | ) |
Tells to keep old or reload delivery costs while recalculating order
bool | $blReload reload state marker |
Definition at line 1797 of file oxorder.php.
oxOrder.reloadDiscount | ( | $ | blReload | ) |
Tells to keep old or reload discount while recalculating order
bool | $blReload reload state marker |
Definition at line 1809 of file oxorder.php.
oxOrder.save | ( | ) |
Updates/inserts order object and related info to DB
Reimplemented from oxBase.
Definition at line 994 of file oxorder.php.
oxOrder.setDelivery | ( | $ | sDeliveryId | ) |
Sets new delivery id for order and forces order to recalculate using new delivery type. Order is not recalculated automatically, to do this oxOrder.recalculateOrder() must be called ;
string | $sDeliveryId new delivery id |
Definition at line 1275 of file oxorder.php.
oxOrder.setOrderArticleList | ( | $ | aOrderArticleList | ) |
Order article list setter
object | $aOrderArticleList order article list |
Definition at line 283 of file oxorder.php.
oxOrder.setSeparateNumbering | ( | $ | blSeparateNumbering = null |
) |
Set usage of seperate orders numbering for different shops
bool | $blSeparateNumbering use or not separate orders numbering |
Definition at line 1610 of file oxorder.php.
oxOrder.validateDelivery | ( | $ | oBasket | ) |
Checks if delivery set used for current order is available and active. Throws exception if not available
oxbasket | $oBasket basket object |
Definition at line 1889 of file oxorder.php.
oxOrder.validateOrder | ( | $ | oBasket, | |
$ | oUser | |||
) |
Validates order parameters like stock, delivery and payment parameters
oxbasket | $oBasket basket object | |
oxuser | $oUser order user |
Definition at line 1863 of file oxorder.php.
oxOrder.validatePayment | ( | $ | oBasket | ) |
Checks if payment used for current order is available and active. Throws exception if not available
oxbasket | $oBasket basket object |
Definition at line 1918 of file oxorder.php.
oxOrder.validateStock | ( | $ | oBasket | ) |
Function whitch cheks if article stock is valid. If not displays error and returns false.
object | $oBasket basket object |
oxOutOfStockException | exception |
Definition at line 1043 of file oxorder.php.
oxOrder.$_aSkipSaveFields = array( 'oxorderdate' ) [protected] |
Reimplemented from oxBase.
Definition at line 51 of file oxorder.php.
oxOrder.$_aVoucherList = null [protected] |
Definition at line 93 of file oxorder.php.
oxOrder.$_blReloadDelivery = true [protected] |
Definition at line 156 of file oxorder.php.
oxOrder.$_blReloadDiscount = true [protected] |
Definition at line 163 of file oxorder.php.
oxOrder.$_blSeparateNumbering = null [protected] |
Definition at line 142 of file oxorder.php.
oxOrder.$_iOrderLang = null [protected] |
Definition at line 149 of file oxorder.php.
oxOrder.$_oArticles = null [protected] |
Definition at line 58 of file oxorder.php.
oxOrder.$_oBasket = null [protected] |
Definition at line 114 of file oxorder.php.
oxOrder.$_oDelPrice = null [protected] |
Definition at line 100 of file oxorder.php.
oxOrder.$_oDelSet = null [protected] |
Definition at line 65 of file oxorder.php.
oxOrder.$_oGiftCard = null [protected] |
Definition at line 72 of file oxorder.php.
oxOrder.$_oOrderBasket = null [protected] |
Definition at line 1199 of file oxorder.php.
oxOrder.$_oOrderCurrency = null [protected] |
Definition at line 170 of file oxorder.php.
oxOrder.$_oPayment = null [protected] |
Definition at line 86 of file oxorder.php.
oxOrder.$_oPaymentPrice = null [protected] |
Definition at line 128 of file oxorder.php.
oxOrder.$_oPaymentType = null [protected] |
Definition at line 79 of file oxorder.php.
oxOrder.$_oUser = null [protected] |
Definition at line 107 of file oxorder.php.
oxOrder.$_oWrappingPrice = null [protected] |
Definition at line 121 of file oxorder.php.
oxOrder.$_sClassName = 'oxorder' [protected] |
Reimplemented from oxBase.
Definition at line 135 of file oxorder.php.
const oxOrder.ORDER_STATE_INVALIDDELIVERY = 4 |
Definition at line 38 of file oxorder.php.
const oxOrder.ORDER_STATE_INVALIDPAYMENT = 5 |
Definition at line 44 of file oxorder.php.
const oxOrder.ORDER_STATE_MAILINGERROR = 0 |
Definition at line 14 of file oxorder.php.
const oxOrder.ORDER_STATE_OK = 1 |
Definition at line 20 of file oxorder.php.
const oxOrder.ORDER_STATE_ORDEREXISTS = 3 |
Definition at line 32 of file oxorder.php.
const oxOrder.ORDER_STATE_PAYMENTERROR = 2 |
Definition at line 26 of file oxorder.php.