OxidEsales\EshopCommunity\Application\Controller\OrderController Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Controller\OrderController:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Controller\OrderController:

Public Member Functions
	init ()
	render ()
	execute ()
	getPayment ()
	getBasket ()
	getExecuteFnc ()
	getOrderRemark ()
	getBasketArticles ()
	getDelAddress ()
	getShipSet ()
	isConfirmAGBActive ()
	isConfirmAGBError ()
	showOrderButtonOnTop ()
	isWrapping ()
	getBreadCrumb ()
	getAddressError ()
	getDeliveryAddressMD5 ()
	getBasketContentMarkGenerator ()

Protected Member Functions
	_getNextStep ($iSuccess)
	_validateTermsAndConditions ()
	getUtilsObjectInstance ()

Protected Attributes
	$_oPayment = null
	$_oBasket = null
	$_sOrderRemark = null
	$_oBasketArtList = null
	$_sRemoteAddress = null
	$_oDelAddress = null
	$_oShipSet = null
	$_blConfirmAGB = null
	$_blShowOrderButtonOnTop = null
	$_blConfirmAGBError = 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.

Member Function Documentation

_getNextStep()

OxidEsales\EshopCommunity\Application\Controller\OrderController::_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

_validateTermsAndConditions()

OxidEsales\EshopCommunity\Application\Controller\OrderController::_validateTermsAndConditions ( )

protected

Validates whether necessary terms and conditions checkboxes were checked.

Returns

bool

execute()

OxidEsales\EshopCommunity\Application\Controller\OrderController::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 (\OxidEsales\Eshop\Application\Model\Order::finalizeOrder()). According to sum for items automatically assigns user to special user group ( \OxidEsales\Eshop\Application\Model\User::onOrderExecute(); if this option is not disabled in admin). Finally you will be redirected to next page (order::_getNextStep()).

Returns

string

getAddressError()

OxidEsales\EshopCommunity\Application\Controller\OrderController::getAddressError

(

)

Return error number

Returns

int

getBasket()

OxidEsales\EshopCommunity\Application\Controller\OrderController::getBasket

(

)

Template variable getter. Returns active basket

Returns

oxBasket

getBasketArticles()

OxidEsales\EshopCommunity\Application\Controller\OrderController::getBasketArticles

(

)

Template variable getter. Returns basket article list

Returns

object

getBasketContentMarkGenerator()

OxidEsales\EshopCommunity\Application\Controller\OrderController::getBasketContentMarkGenerator

(

)

Method returns object with explanation marks for articles in basket.

Returns

oxBasketContentMarkGenerator

getBreadCrumb()

OxidEsales\EshopCommunity\Application\Controller\OrderController::getBreadCrumb

(

)

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

Returns

array

getDelAddress()

OxidEsales\EshopCommunity\Application\Controller\OrderController::getDelAddress

(

)

Template variable getter. Returns delivery address

Returns

object

getDeliveryAddressMD5()

OxidEsales\EshopCommunity\Application\Controller\OrderController::getDeliveryAddressMD5

(

)

Return users setted delivery address md5

Returns

string

getExecuteFnc()

OxidEsales\EshopCommunity\Application\Controller\OrderController::getExecuteFnc

(

)

Template variable getter. Returns execution function name

Returns

string

getOrderRemark()

OxidEsales\EshopCommunity\Application\Controller\OrderController::getOrderRemark

(

)

Template variable getter. Returns user remark

Returns

string

getPayment()

OxidEsales\EshopCommunity\Application\Controller\OrderController::getPayment

(

)

Template variable getter. Returns payment object

Returns

object

getShipSet()

OxidEsales\EshopCommunity\Application\Controller\OrderController::getShipSet

(

)

Template variable getter. Returns shipping set

Returns

object

getUtilsObjectInstance()

OxidEsales\EshopCommunity\Application\Controller\OrderController::getUtilsObjectInstance ( )

protected

Returns

UtilsObject

init()

OxidEsales\EshopCommunity\Application\Controller\OrderController::init

(

)

Loads basket \OxidEsales\Eshop\Core\Session::getBasket(), sets $this->oBasket->blCalcNeeded = true to recalculate, sets back basket to session \OxidEsales\Eshop\Core\Session::setBasket(), executes parent::init().

isConfirmAGBActive()

OxidEsales\EshopCommunity\Application\Controller\OrderController::isConfirmAGBActive

(

)

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

Returns

bool

isConfirmAGBError()

OxidEsales\EshopCommunity\Application\Controller\OrderController::isConfirmAGBError

(

)

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

Returns

bool

isWrapping()

OxidEsales\EshopCommunity\Application\Controller\OrderController::isWrapping

(

)

Returns wrapping options availability state (TRUE/FALSE)

Returns

bool

render()

OxidEsales\EshopCommunity\Application\Controller\OrderController::render

(

)

Executes parent::render(), if basket is empty - redirects to main page and exits the script (\OxidEsales\Eshop\Application\Model\Order::validateOrder()). Loads and passes payment info to template engine. Refreshes basket articles info by additionally loading each article object (\OxidEsales\Eshop\Application\Model\Order::getProdFromBasket()), adds customer addressing/delivering data (\OxidEsales\Eshop\Application\Model\Order::getDelAddressInfo()) and delivery sets info (\OxidEsales\Eshop\Application\Model\Order::getShipping()). Returns name of template to render order::_sThisTemplate.

Returns

string

showOrderButtonOnTop()

OxidEsales\EshopCommunity\Application\Controller\OrderController::showOrderButtonOnTop

(

)

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

Returns

bool

Member Data Documentation

$_blConfirmAGB

OxidEsales\EshopCommunity\Application\Controller\OrderController::$_blConfirmAGB = null

protected

$_blConfirmAGBError

OxidEsales\EshopCommunity\Application\Controller\OrderController::$_blConfirmAGBError = null

protected

$_blIsOrderStep

OxidEsales\EshopCommunity\Application\Controller\OrderController::$_blIsOrderStep = true

protected

$_blShowOrderButtonOnTop

OxidEsales\EshopCommunity\Application\Controller\OrderController::$_blShowOrderButtonOnTop = null

protected

$_iWrapCnt

OxidEsales\EshopCommunity\Application\Controller\OrderController::$_iWrapCnt = null

protected

Count of wrapping + cards options

$_oBasket

OxidEsales\EshopCommunity\Application\Controller\OrderController::$_oBasket = null

protected

$_oBasketArtList

OxidEsales\EshopCommunity\Application\Controller\OrderController::$_oBasketArtList = null

protected

$_oDelAddress

OxidEsales\EshopCommunity\Application\Controller\OrderController::$_oDelAddress = null

protected

$_oPayment

OxidEsales\EshopCommunity\Application\Controller\OrderController::$_oPayment = null

protected

$_oShipSet

OxidEsales\EshopCommunity\Application\Controller\OrderController::$_oShipSet = null

protected

$_sOrderRemark

OxidEsales\EshopCommunity\Application\Controller\OrderController::$_sOrderRemark = null

protected

$_sRemoteAddress

OxidEsales\EshopCommunity\Application\Controller\OrderController::$_sRemoteAddress = null

protected

$_sThisTemplate

OxidEsales\EshopCommunity\Application\Controller\OrderController::$_sThisTemplate = 'page/checkout/order.tpl'

protected

---

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

• /oxideshop-ce/source/Application/Controller/OrderController.php