order Class Reference
Detailed Description
Order manager. Arranges user ordering data, checks/validates it, on success stores ordering data to DB.Public Member Functions | |
| init () | |
| render () | |
| execute () | |
| getPayment () | |
| getBasket () | |
| getExecuteFnc () | |
| getOrderRemark () | |
| getBasketArticles () | |
| getDelAddress () | |
| getShipSet () | |
| isConfirmAGBActive () | |
| isConfirmCustInfoActive () | |
| isConfirmAGBError () | |
| isConfirmCustInfoError () | |
| showOrderButtonOnTop () | |
Protected Member Functions | |
| _getNextStep ($iSuccess) | |
Protected Attributes | |
| $_oPayment = null | |
| $_oBasket = null | |
| $_sOrderRemark = null | |
| $_oBasketArtList = null | |
| $_sRemoteAddress = null | |
| $_oDelAddress = null | |
| $_oShipSet = null | |
| $_blConfirmAGB = null | |
| $_blShowOrderButtonOnTop = null | |
| $_blConfirmAGBError = null | |
| $_blConfirmCustInfo = null | |
| $_blConfirmCustInfoError = null | |
| $_sThisTemplate = 'order.tpl' | |
| $_blIsOrderStep = true | |
Member Function Documentation
| order.init | ( | ) |
Loads basket oxsession.getBasket(), sets $this->oBasket->blCalcNeeded = true to recalculate, sets back basket to session oxsession.setBasket(), executes parent.init().
- Returns:
- null
Reimplemented from oxUBase.
| order.render | ( | ) |
Executes parent.render(), if basket is empty - redirects to main page and exits the script (oxorder.validateOrder()). Loads and passes payment info to template engine. Refreshes basket articles info by additionally loading each article object (oxorder.getProdFromBasket()), adds customer addressing/delivering data (oxorder.getDelAddressInfo()) and delivery sets info (oxorder.getShipping()). Returns name of template to render order._sThisTemplate.
Template variables: payment, execute_fnc, order_remark, basketitemlist, iplog,oDelAdress, oShipSet, blConfirmAGB, blConfirmCustInfo,
- Returns:
- string
Reimplemented from oxUBase.
| order.execute | ( | ) |
Checks for order rules confirmation ("ord_agb", "ord_custinfo" form values)(if no rules agreed - returns to order view), loads basket contents (plus applied price/amount discount if available - checks for stock, checks user data (if no data is set - returns to user login page). Stores order info to database (oxorder.finalizeOrder()). According to sum for items automatically assigns user to special user group ( oxuser.onOrderExecute(); if this option is not disabled in admin). Finally you will be redirected to next page (order._getNextStep()).
Template variables: agb_err, custinfo_err
- Returns:
- string
| order._getNextStep | ( | $ | iSuccess | ) | [protected] |
Returns next order step. If ordering was sucessfull - returns string "thankyou" (possible additional parameters), otherwise - returns string "payment" with additional error parameters.
- Parameters:
-
integer $iSuccess status code
- Returns:
- string $sNextStep partial parameter url for next step
| order.getPayment | ( | ) |
Template variable getter. Returns payment object
- Returns:
- object
| order.getBasket | ( | ) |
Template variable getter. Returns active basket
- Returns:
- object
| order.getExecuteFnc | ( | ) |
Template variable getter. Returns execution function name
- Returns:
- string
| order.getOrderRemark | ( | ) |
| order.getBasketArticles | ( | ) |
Template variable getter. Returns basket article list
- Returns:
- object
| order.getDelAddress | ( | ) |
| order.getShipSet | ( | ) |
Template variable getter. Returns shipping set
- Returns:
- object
| order.isConfirmAGBActive | ( | ) |
Template variable getter. Returns if option "blConfirmAGB" is on
- Returns:
- bool
| order.isConfirmCustInfoActive | ( | ) |
Template variable getter. Returns if option "blConfirmCustInfo" is on. For compatibility reasons for a while. will be removed in future
- Returns:
- bool
| order.isConfirmAGBError | ( | ) |
Template variable getter. Returns if option "blConfirmAGB" was not set
- Returns:
- bool
| order.isConfirmCustInfoError | ( | ) |
Template variable getter. Returns if option "blConfirmCustInfo" was not set. For compatibility reasons for a while. will be removed in future.
- Returns:
- bool
| order.showOrderButtonOnTop | ( | ) |
Template variable getter. Returns if option "blShowOrderButtonOnTop" is on
- Returns:
- bool
Member Data Documentation
order.$_oPayment = null [protected] |
order.$_oBasket = null [protected] |
order.$_sOrderRemark = null [protected] |
order.$_oBasketArtList = null [protected] |
order.$_sRemoteAddress = null [protected] |
order.$_oDelAddress = null [protected] |
Reimplemented from oxUBase.
order.$_oShipSet = null [protected] |
order.$_blConfirmAGB = null [protected] |
order.$_blShowOrderButtonOnTop = null [protected] |
order.$_blConfirmAGBError = null [protected] |
order.$_blConfirmCustInfo = null [protected] |
order.$_blConfirmCustInfoError = null [protected] |
order.$_sThisTemplate = 'order.tpl' [protected] |
Reimplemented from oxView.
order.$_blIsOrderStep = true [protected] |
Reimplemented from oxView.
The documentation for this class was generated from the following file:
- views/order.php
