Inheritance diagram for OxidEsales\EshopCommunity\Application\Model\Order:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Model\Order:

Public Member Functions
	__construct ()

	__get ($sName)

	assign ($dbRecord)

	getOrderArticles ($blExcludeCanceled=false)

	setOrderArticleList ($oOrderArticleList)

	getOrderDeliveryPrice ()

	getOrderWrappingPrice ()

	getOrderGiftCardPrice ()

	getOrderPaymentPrice ()

	getOrderNetSum ()

	finalizeOrder (\OxidEsales\Eshop\Application\Model\Basket $oBasket, $oUser, $blRecalculatingOrder=false)

	isNettoMode ()

	getOrderLanguage ()

	save ()

	getDelAddressInfo ()

	validateStock ($oBasket)

	delete ($sOxId=null)

	recalculateOrder ($aNewArticles=[])

	setDelivery ($sDeliveryId)

	getOrderUser ()

	pdfFooter ($oPdf)

	pdfHeaderplus ($oPdf)

	pdfHeader ($oPdf)

	genPdf ($sFilename, $iSelLang=0)

	getInvoiceNum ()

	getNextBillNum ()

	getShippingSetList ()

	getVoucherNrList ()

	getOrderSum ($blToday=false)

	getOrderCnt ($blToday=false)

	getBasket ()

	getPayment ()

	getVoucherList ()

	getDelSet ()

	getPaymentType ()

	getGiftCard ()

	setSeparateNumbering ($blSeparateNumbering=null)

	getLastUserPaymentType ($sUserId)

	getTotalOrderSum ()

	getProductVats ($blFormatCurrency=true)

	getBillCountry ()

	getDelCountry ()

	reloadDelivery ($blReload)

	reloadDiscount ($blReload)

	cancelOrder ()

	getOrderCurrency ()

	validateOrder ($oBasket, $oUser)

	validateBasket ($oBasket)

	validateDeliveryAddress ($oUser)

	validateDelivery ($oBasket)

	validatePayment ($oBasket)

	getFormattedTotalNetSum ()

	getFormattedTotalBrutSum ()

	getFormattedDeliveryCost ()

	getFormattedeliveryCost ()

	getFormattedPayCost ()

	getFormattedWrapCost ()

	getFormattedGiftCardCost ()

	getFormattedTotalVouchers ()

	getFormattedDiscount ()

	getFormattedTotalOrderSum ()

	getTrackCode ()

	getShipmentTrackingUrl ()

Public Attributes
const	ORDER_STATE_MAILINGERROR = 0

const	ORDER_STATE_OK = 1

const	ORDER_STATE_PAYMENTERROR = 2

const	ORDER_STATE_ORDEREXISTS = 3

const	ORDER_STATE_INVALIDDELIVERY = 4

const	ORDER_STATE_INVALIDPAYMENT = 5

const	ORDER_STATE_INVALIDDElADDRESSCHANGED = 7

const	ORDER_STATE_INVALIDDELADDRESSCHANGED = 7

const	ORDER_STATE_BELOWMINPRICE = 8

Protected Member Functions
	_getCountryTitle ($sCountryId)

	_getArticles ($blExcludeCanceled=false)

	_setOrderStatus ($sStatus)

	_convertVat ($sVat)

	_resetVats ()

	_loadFromBasket (\OxidEsales\Eshop\Application\Model\Basket $oBasket)

	_setUser ($oUser)

	_setWrapping (\OxidEsales\Eshop\Application\Model\Basket $oBasket)

	_setOrderArticles ($aArticleList)

	_executePayment (\OxidEsales\Eshop\Application\Model\Basket $oBasket, $oUserpayment)

	_getGateway ()

	_setPayment ($sPaymentid)

	_setFolder ()

	_updateWishlist ($aArticleList, $oUser)

	_updateNoticeList ($aArticleList, $oUser)

	_updateOrderDate ()

	_markVouchers ($oBasket, $oUser)

	_insert ()

	_getCounterIdent ()

	_setNumber ()

	_update ()

	_getOrderBasket ($blStockCheck=true)

	_checkOrderExist ($sOxId=null)

	_sendOrderByEmail ($oUser=null, $oBasket=null, $oPayment=null)

	_addOrderArticlesToBasket ($oBasket, $aOrderArticles)

	_addArticlesToBasket ($oBasket, $aArticles)

Protected Attributes
	$_aSkipSaveFields = ['oxtimestamp']

	$_oArticles = null

	$_oDelSet = null

	$_oGiftCard = null

	$_oPaymentType = null

	$_oPayment = null

	$_aVoucherList = null

	$_oDelPrice = null

	$_oUser = null

	$_oBasket = null

	$_oWrappingPrice = null

	$_oGiftCardPrice = null

	$_oPaymentPrice = null

	$_sClassName = 'oxorder'

	$_blSeparateNumbering = null

	$_iOrderLang = null

	$_blReloadDelivery = true

	$_blReloadDiscount = true

	$_oOrderCurrency = null

	$_oOrderFiles = null

	$_sShipTrackUrl = null

	$_oOrderBasket = null

Private Member Functions
	isValidPaymentId ($paymentId)

	isValidPayment ($basket)

	getDynamicValues ()

	getDynamicValuesFromPaymentType ()

Detailed Description

Order manager. Performs creation assigning, updating, deleting and other order functions.

Constructor & Destructor Documentation

◆ __construct()

OxidEsales\EshopCommunity\Application\Model\Order::__construct ( )

Class constructor, initiates parent constructor (parent::oxBase()).

Member Function Documentation

◆ __get()

OxidEsales\EshopCommunity\Application\Model\Order::__get ( $sName )

Getter made for order delivery set object access

Parameters

string $sName parameter name

Returns: mixed

◆ _addArticlesToBasket()

OxidEsales\EshopCommunity\Application\Model\Order::_addArticlesToBasket	(	$oBasket,
		$aArticles
	)

protected

Adds new products to basket/order

Parameters

\OxidEsales\Eshop\Application\Model\Basket	$oBasket	basket to add articles
array	$aArticles	article array

◆ _addOrderArticlesToBasket()

OxidEsales\EshopCommunity\Application\Model\Order::_addOrderArticlesToBasket	(	$oBasket,
		$aOrderArticles
	)

protected

Adds order articles back to virtual basket. Needed for recalculating order.

Parameters

\OxidEsales\Eshop\Application\Model\Basket	$oBasket	basket object
array	$aOrderArticles	order articles

◆ _checkOrderExist()

OxidEsales\EshopCommunity\Application\Model\Order::_checkOrderExist ( $sOxId = null )

protected

Checking if this order is already stored.

Parameters

string $sOxId order ID

Returns: bool

◆ _convertVat()

OxidEsales\EshopCommunity\Application\Model\Order::_convertVat ( $sVat )

protected

Converts string VAT representation into float e.g. 7,6 to 7.6

Parameters

string $sVat vat value

Returns: float

◆ _executePayment()

OxidEsales\EshopCommunity\Application\Model\Order::_executePayment	(	\OxidEsales\Eshop\Application\Model\Basket	$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.

Parameters

\OxidEsales\Eshop\Application\Model\Basket	$oBasket	basket object
object	$oUserpayment	user payment object

Returns: integer 2 or an error code

◆ _getArticles()

OxidEsales\EshopCommunity\Application\Model\Order::_getArticles ( $blExcludeCanceled = false )

protected

returned assigned orderarticles from order

Parameters

bool $blExcludeCanceled excludes canceled items from list

Returns: \oxlist

◆ _getCounterIdent()

OxidEsales\EshopCommunity\Application\Model\Order::_getCounterIdent ( )

protected

creates counter ident

Returns: String

◆ _getCountryTitle()

OxidEsales\EshopCommunity\Application\Model\Order::_getCountryTitle ( $sCountryId )

protected

Gets country title by country id.

Parameters

string $sCountryId country ID

Returns: string

◆ _getGateway()

OxidEsales\EshopCommunity\Application\Model\Order::_getGateway ( )

protected

Returns the correct gateway. At the moment only switch between default and IPayment, can be extended later.

Returns: object $oPayTransaction payment gateway object

◆ _getOrderBasket()

OxidEsales\EshopCommunity\Application\Model\Order::_getOrderBasket ( $blStockCheck = true )

protected

Returns basket object filled up with discount, delivery, wrapping and all other info

Parameters

bool $blStockCheck perform stock check or not (default true)

Returns: \OxidEsales\Eshop\Application\Model\Basket

◆ _insert()

OxidEsales\EshopCommunity\Application\Model\Order::_insert ( )

protected

Inserts order object information in DB. Returns true on success.

Returns: bool

◆ _loadFromBasket()

OxidEsales\EshopCommunity\Application\Model\Order::_loadFromBasket ( \OxidEsales\Eshop\Application\Model\Basket $oBasket )

protected

Gathers and assigns to new oxOrder object customer data, payment, delivery and shipping info, customer order 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.

Parameters

\OxidEsales\Eshop\Application\Model\Basket $oBasket Shopping basket object

◆ _markVouchers()

OxidEsales\EshopCommunity\Application\Model\Order::_markVouchers	(	$oBasket,
		$oUser
	)

protected

Marks voucher as used (oxvoucher::markAsUsed()) and sets them to $this->_aVoucherList.

Parameters

\OxidEsales\Eshop\Application\Model\Basket	$oBasket	basket object
\OxidEsales\Eshop\Application\Model\User	$oUser	user object

◆ _resetVats()

OxidEsales\EshopCommunity\Application\Model\Order::_resetVats ( )

protected

Reset Vat info

◆ _sendOrderByEmail()

OxidEsales\EshopCommunity\Application\Model\Order::_sendOrderByEmail	(	$oUser = `null`,
		$oBasket = `null`,
		$oPayment = `null`
	)

protected

Send order to shop owner and user

Parameters

\OxidEsales\Eshop\Application\Model\User	$oUser	order user
\OxidEsales\Eshop\Application\Model\Basket	$oBasket	current order basket
\OxidEsales\Eshop\Application\Model\UserPayment	$oPayment	order payment

Returns: bool

◆ _setFolder()

OxidEsales\EshopCommunity\Application\Model\Order::_setFolder ( )

protected

Assigns oxfolder as new

◆ _setNumber()

OxidEsales\EshopCommunity\Application\Model\Order::_setNumber ( )

protected

Tries to fetch and set next record number in DB. Returns true on success

Returns: bool

◆ _setOrderArticles()

OxidEsales\EshopCommunity\Application\Model\Order::_setOrderArticles ( $aArticleList )

protected

Creates OrderArticle objects and assigns to them basket articles. Updates quantity of sold articles (\OxidEsales\Eshop\Application\Model\Article::updateSoldAmount()).

Parameters

array $aArticleList article list

◆ _setOrderStatus()

OxidEsales\EshopCommunity\Application\Model\Order::_setOrderStatus ( $sStatus )

protected

Updates order transaction status. Faster than saving whole object

Parameters

string $sStatus order transaction status

◆ _setPayment()

OxidEsales\EshopCommunity\Application\Model\Order::_setPayment ( $sPaymentid )

protected

Creates and returns user payment.

Parameters

string $sPaymentid used payment id

Returns: \OxidEsales\Eshop\Application\Model\UserPayment

◆ _setUser()

OxidEsales\EshopCommunity\Application\Model\Order::_setUser ( $oUser )

protected

Assigns to new oxorder object customer delivery and shipping info

Parameters

object $oUser user object

◆ _setWrapping()

OxidEsales\EshopCommunity\Application\Model\Order::_setWrapping ( \OxidEsales\Eshop\Application\Model\Basket $oBasket )

protected

Assigns wrapping VAT and card price + card message info

Parameters

\OxidEsales\Eshop\Application\Model\Basket $oBasket basket object

◆ _update()

OxidEsales\EshopCommunity\Application\Model\Order::_update ( )

protected

Updates object parameters to DB.

Returns: null

◆ _updateNoticeList()

OxidEsales\EshopCommunity\Application\Model\Order::_updateNoticeList	(	$aArticleList,
		$oUser
	)

protected

After order is finished this method cleans up users notice list, by removing bought items from users notice list

Parameters

array	$aArticleList	array of basket products
\OxidEsales\Eshop\Application\Model\User	$oUser	basket user object

Returns: null

◆ _updateOrderDate()

OxidEsales\EshopCommunity\Application\Model\Order::_updateOrderDate ( )

protected

Updates order date to current date

◆ _updateWishlist()

OxidEsales\EshopCommunity\Application\Model\Order::_updateWishlist	(	$aArticleList,
		$oUser
	)

protected

aAdds/removes user chosen article to/from his noticelist or wishlist (oxuserbasket::addItemToBasket()).

Parameters

array	$aArticleList	basket products
object	$oUser	user object

◆ assign()

OxidEsales\EshopCommunity\Application\Model\Order::assign ( $dbRecord )

Assigns data, stored in DB to oxorder object

Parameters

mixed $dbRecord DB record

◆ cancelOrder()

OxidEsales\EshopCommunity\Application\Model\Order::cancelOrder ( )

Performs order cancel process

◆ delete()

OxidEsales\EshopCommunity\Application\Model\Order::delete ( $sOxId = null )

Updates stock information, deletes current ordering details from DB, returns true on success.

Parameters

string $sOxId Ordering ID (default null)

Returns: bool

◆ finalizeOrder()

OxidEsales\EshopCommunity\Application\Model\Order::finalizeOrder	(	\OxidEsales\Eshop\Application\Model\Basket	$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 Order object and saves full order with error status. Then executes payment. On failure - deletes order and returns error code 2. On success - saves order (\OxidEsales\Eshop\Application\Model\Order::save()), removes article from wishlist (\OxidEsales\Eshop\Application\Model\Order::_updateWishlist()), updates voucher data (\OxidEsales\Eshop\Application\Model\Order::_markVouchers()). Finally sends order confirmation email to customer (\OxidEsales\Eshop\Core\Email::SendOrderEMailToUser()) and shop owner (\OxidEsales\Eshop\Core\Email::SendOrderEMailToOwner()). If this is order recalculation, 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.

Parameters

\OxidEsales\Eshop\Application\Model\Basket	$oBasket	Basket object
object	$oUser	Current User object
bool	$blRecalculatingOrder	Order recalculation

Returns: integer

◆ genPdf()

OxidEsales\EshopCommunity\Application\Model\Order::genPdf	(	$sFilename,
		$iSelLang = `0`
	)

Fake entries, pdf is generated in modules.. myorder.

Parameters

string	$sFilename	file name
int	$iSelLang	selected language

◆ getBasket()

OxidEsales\EshopCommunity\Application\Model\Order::getBasket ( )

Returns order basket

Returns: \OxidEsales\Eshop\Application\Model\Basket

◆ getBillCountry()

OxidEsales\EshopCommunity\Application\Model\Order::getBillCountry ( )

Get billing country name from billing country id

Returns: oxField

◆ getDelAddressInfo()

OxidEsales\EshopCommunity\Application\Model\Order::getDelAddressInfo ( )

Loads and returns delivery address object or null if deladrid is not configured, or object was not loaded

Returns: \OxidEsales\Eshop\Application\Model\Address|null

◆ getDelCountry()

OxidEsales\EshopCommunity\Application\Model\Order::getDelCountry ( )

Get delivery country name from delivery country id

Returns: oxField

◆ getDelSet()

OxidEsales\EshopCommunity\Application\Model\Order::getDelSet ( )

Returns order deliveryset object

Returns: oxDeliverySet

◆ getDynamicValues()

OxidEsales\EshopCommunity\Application\Model\Order::getDynamicValues ( )

private

Returns: mixed

◆ getDynamicValuesFromPaymentType()

OxidEsales\EshopCommunity\Application\Model\Order::getDynamicValuesFromPaymentType ( )

private

Returns: mixed

◆ getFormattedDeliveryCost()

OxidEsales\EshopCommunity\Application\Model\Order::getFormattedDeliveryCost ( )

Get Delivery cost sum formatted

Returns: string

◆ getFormattedDiscount()

OxidEsales\EshopCommunity\Application\Model\Order::getFormattedDiscount ( )

Get Discount formatted

Returns: string

◆ getFormattedeliveryCost()

OxidEsales\EshopCommunity\Application\Model\Order::getFormattedeliveryCost ( )

Get Delivery cost sum formatted

Deprecated:: in v5.2.0 on 2014-04-12; Typo use \OxidEsales\Eshop\Application\Model\Order::getFormattedPayCost()

Returns: string

◆ getFormattedGiftCardCost()

OxidEsales\EshopCommunity\Application\Model\Order::getFormattedGiftCardCost ( )

Get wrap cost sum formatted

Returns: string

◆ getFormattedPayCost()

OxidEsales\EshopCommunity\Application\Model\Order::getFormattedPayCost ( )

Get pay cost sum formatted

Returns: string

◆ getFormattedTotalBrutSum()

OxidEsales\EshopCommunity\Application\Model\Order::getFormattedTotalBrutSum ( )

Get total brut sum formatted

Returns: string

◆ getFormattedTotalNetSum()

OxidEsales\EshopCommunity\Application\Model\Order::getFormattedTotalNetSum ( )

Get total net sum formatted

Returns: string

◆ getFormattedTotalOrderSum()

OxidEsales\EshopCommunity\Application\Model\Order::getFormattedTotalOrderSum ( )

Get formatted total sum from last order

Returns: string

◆ getFormattedTotalVouchers()

OxidEsales\EshopCommunity\Application\Model\Order::getFormattedTotalVouchers ( )

Get total vouchers formatted

Returns: string

◆ getFormattedWrapCost()

OxidEsales\EshopCommunity\Application\Model\Order::getFormattedWrapCost ( )

Get wrap cost sum formatted

Returns: string

◆ getGiftCard()

OxidEsales\EshopCommunity\Application\Model\Order::getGiftCard ( )

Get gift card

Returns: oxWrapping

◆ getInvoiceNum()

OxidEsales\EshopCommunity\Application\Model\Order::getInvoiceNum ( )

Returns order invoice number.

Returns: integer

◆ getLastUserPaymentType()

OxidEsales\EshopCommunity\Application\Model\Order::getLastUserPaymentType ( $sUserId )

Get users payment type from last order

Parameters

string $sUserId order user id

Returns: string $sLastPaymentId payment id

◆ getNextBillNum()

OxidEsales\EshopCommunity\Application\Model\Order::getNextBillNum ( )

Returns next possible (free) order bill number.

Returns: integer

◆ getOrderArticles()

OxidEsales\EshopCommunity\Application\Model\Order::getOrderArticles ( $blExcludeCanceled = false )

Assigns data, stored in oxorderarticles to oxorder object .

Parameters

bool $blExcludeCanceled excludes canceled items from list

Returns: \oxlist

◆ getOrderCnt()

OxidEsales\EshopCommunity\Application\Model\Order::getOrderCnt ( $blToday = false )

Returns orders count

Parameters

bool $blToday if true calculates only current day orders

Returns: int

◆ getOrderCurrency()

OxidEsales\EshopCommunity\Application\Model\Order::getOrderCurrency ( )

Returns actual order currency object. In case currency was not recognized due to changed name returns first shop currency object

Returns: stdClass

◆ getOrderDeliveryPrice()

OxidEsales\EshopCommunity\Application\Model\Order::getOrderDeliveryPrice ( )

Returns order delivery expenses price object

Returns: ShopPrice

◆ getOrderGiftCardPrice()

OxidEsales\EshopCommunity\Application\Model\Order::getOrderGiftCardPrice ( )

Returns order wrapping expenses price object

Returns: ShopPrice

◆ getOrderLanguage()

OxidEsales\EshopCommunity\Application\Model\Order::getOrderLanguage ( )

Returns language id of current order object. If order already has language defined - checks if this language is defined in shops config

Returns: int

◆ getOrderNetSum()

OxidEsales\EshopCommunity\Application\Model\Order::getOrderNetSum ( )

Returns order netto sum (total order price - VAT)

Returns: double

◆ getOrderPaymentPrice()

OxidEsales\EshopCommunity\Application\Model\Order::getOrderPaymentPrice ( )

Returns order payment expenses price object

Returns: ShopPrice

◆ getOrderSum()

OxidEsales\EshopCommunity\Application\Model\Order::getOrderSum ( $blToday = false )

Returns orders total price

Parameters

bool $blToday if true calculates only current day orders

Returns: double

◆ getOrderUser()

OxidEsales\EshopCommunity\Application\Model\Order::getOrderUser ( )

Returns current order user object

Returns: \OxidEsales\Eshop\Application\Model\User

◆ getOrderWrappingPrice()

OxidEsales\EshopCommunity\Application\Model\Order::getOrderWrappingPrice ( )

Returns order wrapping expenses price object

Returns: ShopPrice

◆ getPayment()

OxidEsales\EshopCommunity\Application\Model\Order::getPayment ( )

Returns order payment

Returns: \OxidEsales\Eshop\Application\Model\UserPayment

◆ getPaymentType()

OxidEsales\EshopCommunity\Application\Model\Order::getPaymentType ( )

Get payment type

Returns: \OxidEsales\Eshop\Application\Model\UserPayment

◆ getProductVats()

OxidEsales\EshopCommunity\Application\Model\Order::getProductVats ( $blFormatCurrency = true )

Returns array of plain formatted VATs stored in order

Parameters

bool $blFormatCurrency enables currency formatting

Returns: array

◆ getShipmentTrackingUrl()

OxidEsales\EshopCommunity\Application\Model\Order::getShipmentTrackingUrl ( )

Returns shipment tracking url if oxtrackcode and shipment tracking url are supplied

Returns: string

◆ getShippingSetList()

OxidEsales\EshopCommunity\Application\Model\Order::getShippingSetList ( )

Loads possible shipping sets for this order

Returns: oxdeliverysetlist

◆ getTotalOrderSum()

OxidEsales\EshopCommunity\Application\Model\Order::getTotalOrderSum ( )

Get total sum from last order

Returns: string

◆ getTrackCode()

OxidEsales\EshopCommunity\Application\Model\Order::getTrackCode ( )

Returns shipment tracking code

Returns: string

◆ getVoucherList()

OxidEsales\EshopCommunity\Application\Model\Order::getVoucherList ( )

Returns order vouchers marked as used

Returns: array

◆ getVoucherNrList()

OxidEsales\EshopCommunity\Application\Model\Order::getVoucherNrList ( )

Get vouchers numbers list which were used with this order

Returns: array

◆ isNettoMode()

OxidEsales\EshopCommunity\Application\Model\Order::isNettoMode ( )

Return true if order store in netto mode

Returns: bool

◆ isValidPayment()

OxidEsales\EshopCommunity\Application\Model\Order::isValidPayment ( $basket )

private

Returns true if payment is valid.

Parameters

\OxidEsales\Eshop\Application\Model\Basket $basket

Returns: bool

◆ isValidPaymentId()

OxidEsales\EshopCommunity\Application\Model\Order::isValidPaymentId ( $paymentId )

private

Returns true if paymentId is valid.

Parameters

int $paymentId

Returns: bool

◆ pdfFooter()

OxidEsales\EshopCommunity\Application\Model\Order::pdfFooter ( $oPdf )

Fake entries, pdf is generated in modules.. myorder.

Parameters

mixed $oPdf pdf object

◆ pdfHeader()

OxidEsales\EshopCommunity\Application\Model\Order::pdfHeader ( $oPdf )

Fake entries, pdf is generated in modules.. myorder.

Parameters

mixed $oPdf pdf object

◆ pdfHeaderplus()

OxidEsales\EshopCommunity\Application\Model\Order::pdfHeaderplus ( $oPdf )

Fake entries, pdf is generated in modules.. myorder.

Parameters

mixed $oPdf pdf object

◆ recalculateOrder()

OxidEsales\EshopCommunity\Application\Model\Order::recalculateOrder ( $aNewArticles = [] )

Recalculates order. Starts transactions, deletes current order and order articles from DB, adds current order articles to virtual basket and finally recalculates order by calling \OxidEsales\Eshop\Application\Model\Order::finalizeOrder() If no errors, finishing transaction.

Parameters

array $aNewArticles article list of new order

Exceptions

Exception

◆ reloadDelivery()

OxidEsales\EshopCommunity\Application\Model\Order::reloadDelivery ( $blReload )

Tells to keep old or reload delivery costs while recalculating order

Parameters

bool $blReload reload state marker

◆ reloadDiscount()

OxidEsales\EshopCommunity\Application\Model\Order::reloadDiscount ( $blReload )

Tells to keep old or reload discount while recalculating order

Parameters

bool $blReload reload state marker

◆ save()

OxidEsales\EshopCommunity\Application\Model\Order::save ( )

Updates/inserts order object and related info to DB

Returns: null

◆ setDelivery()

OxidEsales\EshopCommunity\Application\Model\Order::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 \OxidEsales\Eshop\Application\Model\Order::recalculateOrder() must be called ;

Parameters

string $sDeliveryId new delivery id

◆ setOrderArticleList()

OxidEsales\EshopCommunity\Application\Model\Order::setOrderArticleList ( $oOrderArticleList )

Order article list setter

Parameters

\OxidEsales\Eshop\Application\Model\OrderArticleList $oOrderArticleList

◆ setSeparateNumbering()

OxidEsales\EshopCommunity\Application\Model\Order::setSeparateNumbering ( $blSeparateNumbering = null )

Set usage of separate orders numbering for different shops

Parameters

bool $blSeparateNumbering use or not separate orders numbering

◆ validateBasket()

OxidEsales\EshopCommunity\Application\Model\Order::validateBasket ( $oBasket )

Validates basket. Currently checks if minimum order price > basket price

Parameters

\OxidEsales\Eshop\Application\Model\Basket $oBasket basket object

Returns: bool

◆ validateDelivery()

OxidEsales\EshopCommunity\Application\Model\Order::validateDelivery ( $oBasket )

Checks if delivery set used for current order is available and active. Throws exception if not available

Parameters

\OxidEsales\Eshop\Application\Model\Basket $oBasket basket object

Returns: null

◆ validateDeliveryAddress()

OxidEsales\EshopCommunity\Application\Model\Order::validateDeliveryAddress ( $oUser )

Checks if delivery address (billing or shipping) was not changed during checkout Throws exception if not available

Parameters

\OxidEsales\Eshop\Application\Model\User $oUser user object

Returns: int

◆ validateOrder()

OxidEsales\EshopCommunity\Application\Model\Order::validateOrder	(	$oBasket,
		$oUser
	)

Validates order parameters like stock, delivery and payment parameters

Parameters

\OxidEsales\Eshop\Application\Model\Basket	$oBasket	basket object
\OxidEsales\Eshop\Application\Model\User	$oUser	order user

Returns: null

◆ validatePayment()

OxidEsales\EshopCommunity\Application\Model\Order::validatePayment ( $oBasket )

Checks if payment used for current order is available and active. Throws exception if not available

Parameters

\OxidEsales\Eshop\Application\Model\Basket $oBasket basket object

Returns: null

◆ validateStock()

OxidEsales\EshopCommunity\Application\Model\Order::validateStock ( $oBasket )

Function which checks if article stock is valid. If not displays error and returns false.

Parameters

object $oBasket basket object

Exceptions

Member Data Documentation

◆ $_aSkipSaveFields

OxidEsales\EshopCommunity\Application\Model\Order::$_aSkipSaveFields = ['oxtimestamp']

protected

◆ $_aVoucherList

OxidEsales\EshopCommunity\Application\Model\Order::$_aVoucherList = null

protected

◆ $_blReloadDelivery

OxidEsales\EshopCommunity\Application\Model\Order::$_blReloadDelivery = true

protected

◆ $_blReloadDiscount

OxidEsales\EshopCommunity\Application\Model\Order::$_blReloadDiscount = true

protected

◆ $_blSeparateNumbering

OxidEsales\EshopCommunity\Application\Model\Order::$_blSeparateNumbering = null

protected

◆ $_iOrderLang

OxidEsales\EshopCommunity\Application\Model\Order::$_iOrderLang = null

protected

◆ $_oArticles

OxidEsales\EshopCommunity\Application\Model\Order::$_oArticles = null

protected

◆ $_oBasket

OxidEsales\EshopCommunity\Application\Model\Order::$_oBasket = null

protected

◆ $_oDelPrice

OxidEsales\EshopCommunity\Application\Model\Order::$_oDelPrice = null

protected

◆ $_oDelSet

OxidEsales\EshopCommunity\Application\Model\Order::$_oDelSet = null

protected

◆ $_oGiftCard

OxidEsales\EshopCommunity\Application\Model\Order::$_oGiftCard = null

protected

◆ $_oGiftCardPrice

OxidEsales\EshopCommunity\Application\Model\Order::$_oGiftCardPrice = null

protected

◆ $_oOrderBasket

OxidEsales\EshopCommunity\Application\Model\Order::$_oOrderBasket = null

protected

◆ $_oOrderCurrency

OxidEsales\EshopCommunity\Application\Model\Order::$_oOrderCurrency = null

protected

◆ $_oOrderFiles

OxidEsales\EshopCommunity\Application\Model\Order::$_oOrderFiles = null

protected

◆ $_oPayment

OxidEsales\EshopCommunity\Application\Model\Order::$_oPayment = null

protected

◆ $_oPaymentPrice

OxidEsales\EshopCommunity\Application\Model\Order::$_oPaymentPrice = null

protected

◆ $_oPaymentType

OxidEsales\EshopCommunity\Application\Model\Order::$_oPaymentType = null

protected

◆ $_oUser

OxidEsales\EshopCommunity\Application\Model\Order::$_oUser = null

protected

◆ $_oWrappingPrice

OxidEsales\EshopCommunity\Application\Model\Order::$_oWrappingPrice = null

protected

◆ $_sClassName

OxidEsales\EshopCommunity\Application\Model\Order::$_sClassName = 'oxorder'

protected

◆ $_sShipTrackUrl

OxidEsales\EshopCommunity\Application\Model\Order::$_sShipTrackUrl = null

protected

◆ ORDER_STATE_BELOWMINPRICE

const OxidEsales\EshopCommunity\Application\Model\Order::ORDER_STATE_BELOWMINPRICE = 8

◆ ORDER_STATE_INVALIDDElADDRESSCHANGED

const OxidEsales\EshopCommunity\Application\Model\Order::ORDER_STATE_INVALIDDElADDRESSCHANGED = 7

◆ ORDER_STATE_INVALIDDELADDRESSCHANGED

const OxidEsales\EshopCommunity\Application\Model\Order::ORDER_STATE_INVALIDDELADDRESSCHANGED = 7

◆ ORDER_STATE_INVALIDDELIVERY

const OxidEsales\EshopCommunity\Application\Model\Order::ORDER_STATE_INVALIDDELIVERY = 4

◆ ORDER_STATE_INVALIDPAYMENT

const OxidEsales\EshopCommunity\Application\Model\Order::ORDER_STATE_INVALIDPAYMENT = 5

◆ ORDER_STATE_MAILINGERROR

const OxidEsales\EshopCommunity\Application\Model\Order::ORDER_STATE_MAILINGERROR = 0

◆ ORDER_STATE_OK

const OxidEsales\EshopCommunity\Application\Model\Order::ORDER_STATE_OK = 1

◆ ORDER_STATE_ORDEREXISTS

const OxidEsales\EshopCommunity\Application\Model\Order::ORDER_STATE_ORDEREXISTS = 3

◆ ORDER_STATE_PAYMENTERROR

const OxidEsales\EshopCommunity\Application\Model\Order::ORDER_STATE_PAYMENTERROR = 2

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

/oxideshop-ce/source/Application/Model/Order.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __get()

◆ _addArticlesToBasket()

◆ _addOrderArticlesToBasket()

◆ _checkOrderExist()

◆ _convertVat()

◆ _executePayment()

◆ _getArticles()

◆ _getCounterIdent()

◆ _getCountryTitle()

◆ _getGateway()

◆ _getOrderBasket()

◆ _insert()

◆ _loadFromBasket()

◆ _markVouchers()

◆ _resetVats()

◆ _sendOrderByEmail()

◆ _setFolder()

◆ _setNumber()

◆ _setOrderArticles()

◆ _setOrderStatus()

◆ _setPayment()

◆ _setUser()

◆ _setWrapping()

◆ _update()

◆ _updateNoticeList()

◆ _updateOrderDate()

◆ _updateWishlist()

◆ assign()

◆ cancelOrder()

◆ delete()

◆ finalizeOrder()

◆ genPdf()

◆ getBasket()

◆ getBillCountry()

◆ getDelAddressInfo()

◆ getDelCountry()

◆ getDelSet()

◆ getDynamicValues()

◆ getDynamicValuesFromPaymentType()

◆ getFormattedDeliveryCost()

◆ getFormattedDiscount()

◆ getFormattedeliveryCost()

◆ getFormattedGiftCardCost()

◆ getFormattedPayCost()

◆ getFormattedTotalBrutSum()

◆ getFormattedTotalNetSum()

◆ getFormattedTotalOrderSum()

◆ getFormattedTotalVouchers()

◆ getFormattedWrapCost()

◆ getGiftCard()

◆ getInvoiceNum()

◆ getLastUserPaymentType()

◆ getNextBillNum()

◆ getOrderArticles()

◆ getOrderCnt()

◆ getOrderCurrency()

◆ getOrderDeliveryPrice()

◆ getOrderGiftCardPrice()

◆ getOrderLanguage()

◆ getOrderNetSum()

◆ getOrderPaymentPrice()

◆ getOrderSum()

◆ getOrderUser()

◆ getOrderWrappingPrice()

◆ getPayment()

◆ getPaymentType()

◆ getProductVats()

◆ getShipmentTrackingUrl()

◆ getShippingSetList()

◆ getTotalOrderSum()

◆ getTrackCode()