order Class Reference

Inheritance diagram for order:

Collaboration diagram for order:

List of all members.

Public Member Functions
	init ()
	render ()
	execute ()
	getPayment ()
	getBasket ()
	getExecuteFnc ()
	getOrderRemark ()
	getBasketArticles ()
	getDelAddress ()
	getShipSet ()
	isConfirmAGBActive ()
	isConfirmCustInfoActive ()
	isConfirmAGBError ()
	isConfirmCustInfoError ()
	showOrderButtonOnTop ()
	isWrapping ()
	getBreadCrumb ()
	getAddressError ()
	getDeliveryAddressMD5 ()
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 = 'page/checkout/order.tpl'
	$_blIsOrderStep = true
	$_iWrapCnt = null

---

Detailed Description

Order manager. Arranges user ordering data, checks/validates it, on success stores ordering data to DB.

Definition at line 7 of file order.php.

---

Member Function Documentation

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

Definition at line 240 of file order.php.

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()).

Returns:

string

Definition at line 182 of file order.php.

order.getAddressError

(

)

Return error number

Returns:

int

Definition at line 512 of file order.php.

order.getBasket

(

)

Template variable getter. Returns active basket

Returns:

object

Definition at line 313 of file order.php.

order.getBasketArticles

(

)

Template variable getter. Returns basket article list

Returns:

object

Definition at line 355 of file order.php.

order.getBreadCrumb

(

)

Returns Bread Crumb - you are here page1/page2/page3...

Returns:

array

Reimplemented from oxUBase.

Definition at line 494 of file order.php.

order.getDelAddress

(

)

Template variable getter. Returns delivery address

Returns:

object

Definition at line 371 of file order.php.

order.getDeliveryAddressMD5

(

)

Return users setted delivery address md5

Returns:

string

Definition at line 522 of file order.php.

order.getExecuteFnc

(

)

Template variable getter. Returns execution function name

Returns:

string

Definition at line 329 of file order.php.

order.getOrderRemark

(

)

Template variable getter. Returns user remark

Returns:

string

Definition at line 339 of file order.php.

order.getPayment

(

)

Template variable getter. Returns payment object

Returns:

object

Definition at line 284 of file order.php.

order.getShipSet

(

)

Template variable getter. Returns shipping set

Returns:

object

Definition at line 386 of file order.php.

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.

Definition at line 110 of file order.php.

order.isConfirmAGBActive

(

)

Template variable getter. Returns if option "blConfirmAGB" is on

Returns:

bool

Definition at line 405 of file order.php.

order.isConfirmAGBError

(

)

Template variable getter. Returns if option "blConfirmAGB" was not set

Returns:

bool

Definition at line 437 of file order.php.

order.isConfirmCustInfoActive

(

)

Template variable getter. Returns if option "blConfirmCustInfo" is on. For compatibility reasons for a while. will be removed in future

Returns:

bool

Definition at line 420 of file order.php.

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

Definition at line 448 of file order.php.

order.isWrapping

(

)

Returns wrapping options availability state (TRUE/FALSE)

Returns:

bool

Definition at line 472 of file order.php.

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.

Returns:

string

Reimplemented from oxUBase.

Definition at line 133 of file order.php.

order.showOrderButtonOnTop

(

)

Template variable getter. Returns if option "blShowOrderButtonOnTop" is on

Returns:

bool

Definition at line 458 of file order.php.

---

Member Data Documentation

order.$_blConfirmAGB = null [protected]

Definition at line 55 of file order.php.

order.$_blConfirmAGBError = null [protected]

Definition at line 67 of file order.php.

order.$_blConfirmCustInfo = null [protected]

Definition at line 74 of file order.php.

order.$_blConfirmCustInfoError = null [protected]

Definition at line 81 of file order.php.

order.$_blIsOrderStep = true [protected]

Reimplemented from oxUBase.

Definition at line 95 of file order.php.

order.$_blShowOrderButtonOnTop = null [protected]

Definition at line 61 of file order.php.

order.$_iWrapCnt = null [protected]

Count of wrapping + cards options

Definition at line 100 of file order.php.

order.$_oBasket = null [protected]

Definition at line 19 of file order.php.

order.$_oBasketArtList = null [protected]

Definition at line 31 of file order.php.

order.$_oDelAddress = null [protected]

Reimplemented from oxUBase.

Definition at line 43 of file order.php.

order.$_oPayment = null [protected]

Definition at line 13 of file order.php.

order.$_oShipSet = null [protected]

Definition at line 49 of file order.php.

order.$_sOrderRemark = null [protected]

Definition at line 25 of file order.php.

order.$_sRemoteAddress = null [protected]

Definition at line 37 of file order.php.

order.$_sThisTemplate = 'page/checkout/order.tpl' [protected]

Reimplemented from oxView.

Definition at line 88 of file order.php.

---

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

• application/controllers/order.php