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

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

Public Member Functions
	__construct ()

	copyThis ($oProduct)

	assign ($dbRecord)

	updateArticleStock ($dAddAmount, $blAllowNegativeStock=false)

	getPersParams ()

	setPersParams ($aParams)

	loadInLang ($iLanguage, $sOxid)

	getProductId ()

	getParentId ()

	checkForStock ($dAmount, $dArtStockAmount=0)

	getSelectLists ($sKeyPrefix=null)

	getOrderArticleSelectList ($sArtId=null, $sOrderArtSelList=null)

	getBasketPrice ($dAmount, $aSelList, $oBasket)

	skipDiscounts ()

	getCategoryIds ($blActCats=false, $blSkipCache=false)

	getLanguage ()

	getBasePrice ($dAmount=1)

	getPrice ()

	setIsNewOrderItem ($blIsNew)

	isNewOrderItem ()

	setNewAmount ($iNewAmount)

	isOrderArticle ()

	cancelOrderArticle ()

	delete ($sOXID=null)

	save ()

	getWrapping ()

	isBundle ()

	getTotalBrutPriceFormated ()

	getBrutPriceFormated ()

	getNetPriceFormated ()

	getOrder ()

	setArticle ($oArticle)

	getArticle ()

	_setOrderFiles ()

	getTotalNetPriceFormated ()

Protected Member Functions
	_getArtStock ($dAddAmount=0, $blAllowNegativeStock=false)

	_setFieldData ($sFieldName, $sValue, $iDataType=\OxidEsales\Eshop\Core\Field::T_TEXT)

	_setArticleParams ()

	_getOrderArticle ($sArticleId=null)

	_insert ()

Protected Attributes
	$_sClassName = 'oxorderarticle'

	$_aPersParam = null

	$_aStatuses = null

	$_aOrderArticleSelList = null

	$_oOrderArticle = null

	$_oArticle = null

	$_blIsNewOrderItem = false

	$_aSkipSaveFields = ['oxtimestamp']

Static Protected Attributes
static	$_aOrderCache = []

Detailed Description

Order article manager. Performs copying of article.

Constructor & Destructor Documentation

◆ __construct()

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

Class constructor, initiates class constructor (parent::oxbase()).

Member Function Documentation

◆ _getArtStock()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::_getArtStock	(	$dAddAmount = `0`,
		$blAllowNegativeStock = `false`
	)

protected

Adds or substracts defined amount passed by param from arcticle stock

Parameters

double	$dAddAmount	amount which will be added/substracled from value in db
bool	$blAllowNegativeStock	allow/disallow negative stock value

Returns: double

◆ _getOrderArticle()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::_getOrderArticle ( $sArticleId = null )

protected

Loads, caches and returns real order article instance. If article is not available (deleted from db or so) false is returned

Parameters

string $sArticleId article id (optional, is not passed oxorderarticles__oxartid will be used)

Returns: \OxidEsales\Eshop\Application\Model\Article | false

◆ _insert()

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

protected

Sets article creation date (\OxidEsales\Eshop\Application\Model\OrderArticle::oxorderarticles__oxtimestamp). Then executes parent method parent::_insert() and returns insertion status.

Returns: bool

◆ _setArticleParams()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::_setArticleParams ( )

protected

Sets article parameters to current object, so this object can be used for basket calculation

◆ _setFieldData()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::_setFieldData	(	$sFieldName,
		$sValue,
		$iDataType = `\OxidEsales\Eshop\Core\Field::T_TEXT`
	)

protected

Sets data field value

Parameters

string	$sFieldName	index OR name (eg. 'oxarticles__oxtitle') of a data field to set
string	$sValue	value of data field
int	$iDataType	field type

Returns: null

◆ _setOrderFiles()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::_setOrderFiles ( )

Set order files

◆ assign()

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

Assigns DB field values to object fields.

Parameters

string $dbRecord DB record

◆ cancelOrderArticle()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::cancelOrderArticle ( )

Sets order article storno value to 1 and if stock control is on - restores previous oxarticle stock state

◆ checkForStock()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::checkForStock	(	$dAmount,
		$dArtStockAmount = `0`
	)

Returns true, implements iBaseArticle interface method

Parameters

double	$dAmount	stock to check
double	$dArtStockAmount	stock amount

Returns: bool

Implements OxidEsales\EshopCommunity\Application\Model\Contract\ArticleInterface.

◆ copyThis()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::copyThis ( $oProduct )

Copies passed to method product into $this.

Parameters

object $oProduct product to copy

◆ delete()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::delete ( $sOXID = null )

Deletes order article object. If deletion succeded - updates article stock information. Returns deletion status

Parameters

string $sOXID Article id

Returns: bool

◆ getArticle()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::getArticle ( )

Get article

Returns: \OxidEsales\Eshop\Application\Model\Article

◆ getBasePrice()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::getBasePrice ( $dAmount = 1 )

Returns base article price from database

Parameters

double $dAmount article amount. Default is 1

Returns: object

Implements OxidEsales\EshopCommunity\Application\Model\Contract\ArticleInterface.

◆ getBasketPrice()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::getBasketPrice	(	$dAmount,
		$aSelList,
		$oBasket
	)

Returns basket order article price

Parameters

double	$dAmount	basket item amount
array	$aSelList	chosen selection list
\OxidEsales\Eshop\Application\Model\Basket	$oBasket	basket

Returns: oxprice

Implements OxidEsales\EshopCommunity\Application\Model\Contract\ArticleInterface.

◆ getBrutPriceFormated()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::getBrutPriceFormated ( )

Get brut price formated

Returns: string

◆ getCategoryIds()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::getCategoryIds	(	$blActCats = `false`,
		$blSkipCache = `false`
	)

Returns empty array, implements iBaseArticle interface getter method

Parameters

bool	$blActCats	select categories if all parents are active
bool	$blSkipCache	force reload or not (default false - no reload)

Returns: array

Implements OxidEsales\EshopCommunity\Application\Model\Contract\ArticleInterface.

◆ getLanguage()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::getLanguage ( )

Returns current session language id

Returns: int

◆ getNetPriceFormated()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::getNetPriceFormated ( )

Get Net price formated

Returns: string

◆ getOrder()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::getOrder ( )

Returns oxOrder object that the article belongs to

Returns: mixed - on success returns oxOrder object, else returns null

◆ getOrderArticleSelectList()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::getOrderArticleSelectList	(	$sArtId = `null`,
		$sOrderArtSelList = `null`
	)

Returns order article selection list array

Parameters

string	$sArtId	ordered article id [optional]
string	$sOrderArtSelList	order article selection list [optional]

Returns: array

◆ getParentId()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::getParentId ( )

Returns product parent id

Returns: string

◆ getPersParams()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::getPersParams ( )

Order persistent data getter

Returns: array

◆ getPrice()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::getPrice ( )

Returns order article unit price

Returns: oxprice

Implements OxidEsales\EshopCommunity\Application\Model\Contract\ArticleInterface.

◆ getProductId()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::getProductId ( )

Returns ordered article id, implements iBaseArticle interface getter method

Returns: string

Implements OxidEsales\EshopCommunity\Application\Model\Contract\ArticleInterface.

◆ getSelectLists()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::getSelectLists ( $sKeyPrefix = null )

Returns article select lists, implements iBaseArticle interface method

Parameters

string $sKeyPrefix prefix (not used)

Returns: array

Implements OxidEsales\EshopCommunity\Application\Model\Contract\ArticleInterface.

◆ getTotalBrutPriceFormated()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::getTotalBrutPriceFormated ( )

Get Total brut price formated

Returns: string

◆ getTotalNetPriceFormated()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::getTotalNetPriceFormated ( )

Get Total brut price formated

Returns: string

◆ getWrapping()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::getWrapping ( )

get used wrapping

Returns: oxWrapping

◆ isBundle()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::isBundle ( )

Returns true if ordered product is bundle

Returns: bool

◆ isNewOrderItem()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::isNewOrderItem ( )

Returns TRUE if current order article is newly added to order

Returns: bool

◆ isOrderArticle()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::isOrderArticle ( )

Returns true if object is derived from oxorderarticle class

Returns: bool

Implements OxidEsales\EshopCommunity\Application\Model\Contract\ArticleInterface.

◆ loadInLang()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::loadInLang	(	$iLanguage,
		$sOxid
	)

Executes \OxidEsales\Eshop\Application\Model\OrderArticle::load() and returns its result

Parameters

int	$iLanguage	language id
string	$sOxid	order article id

Returns: bool

◆ save()

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

Saves order article object. If saving succeded - updates article stock information if \OxidEsales\Eshop\Application\Model\OrderArticle::isNewOrderItem() returns TRUE. Returns saving status

Returns: bool

◆ setArticle()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::setArticle ( $oArticle )

Set article

Parameters

object $oArticle - article object

◆ setIsNewOrderItem()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::setIsNewOrderItem ( $blIsNew )

Marks object as new order item (this marker useful when recalculating stocks after order recalculation)

Parameters

bool $blIsNew marker value - TRUE if this item is newy added to order

◆ setNewAmount()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::setNewAmount ( $iNewAmount )

Ordered article stock setter. Before setting new stock value additionally checks for original article stock value. Is stock values <= preferred, adjusts order stock according to it

Parameters

int $iNewAmount new ordered items amount

◆ setPersParams()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::setPersParams ( $aParams )

Order persistent params setter

Parameters

array $aParams array of params

◆ skipDiscounts()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::skipDiscounts ( )

Returns false, implements iBaseArticle interface method

Returns: bool

Implements OxidEsales\EshopCommunity\Application\Model\Contract\ArticleInterface.

◆ updateArticleStock()

OxidEsales\EshopCommunity\Application\Model\OrderArticle::updateArticleStock	(	$dAddAmount,
		$blAllowNegativeStock = `false`
	)

Performs stock modification for current order article. Additionally executes changeable article onChange/updateSoldAmount methods to update chained data

Parameters

double	$dAddAmount	amount which will be substracled from value in db
bool	$blAllowNegativeStock	amount allow or not negative stock value

Member Data Documentation

◆ $_aOrderArticleSelList

OxidEsales\EshopCommunity\Application\Model\OrderArticle::$_aOrderArticleSelList = null

protected

◆ $_aOrderCache

OxidEsales\EshopCommunity\Application\Model\OrderArticle::$_aOrderCache = []

staticprotected

Order cache

◆ $_aPersParam

OxidEsales\EshopCommunity\Application\Model\OrderArticle::$_aPersParam = null

protected

◆ $_aSkipSaveFields

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

protected

◆ $_aStatuses

OxidEsales\EshopCommunity\Application\Model\OrderArticle::$_aStatuses = null

protected

◆ $_blIsNewOrderItem

OxidEsales\EshopCommunity\Application\Model\OrderArticle::$_blIsNewOrderItem = false

protected

◆ $_oArticle

OxidEsales\EshopCommunity\Application\Model\OrderArticle::$_oArticle = null

protected

◆ $_oOrderArticle

OxidEsales\EshopCommunity\Application\Model\OrderArticle::$_oOrderArticle = null

protected

◆ $_sClassName

OxidEsales\EshopCommunity\Application\Model\OrderArticle::$_sClassName = 'oxorderarticle'

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getArtStock()

◆ _getOrderArticle()

◆ _insert()

◆ _setArticleParams()

◆ _setFieldData()

◆ _setOrderFiles()

◆ assign()

◆ cancelOrderArticle()

◆ checkForStock()

◆ copyThis()

◆ delete()

◆ getArticle()

◆ getBasePrice()

◆ getBasketPrice()

◆ getBrutPriceFormated()

◆ getCategoryIds()

◆ getLanguage()

◆ getNetPriceFormated()

◆ getOrder()

◆ getOrderArticleSelectList()

◆ getParentId()

◆ getPersParams()

◆ getPrice()

◆ getProductId()

◆ getSelectLists()

◆ getTotalBrutPriceFormated()

◆ getTotalNetPriceFormated()

◆ getWrapping()

◆ isBundle()

◆ isNewOrderItem()

◆ isOrderArticle()

◆ loadInLang()

◆ save()

◆ setArticle()

◆ setIsNewOrderItem()

◆ setNewAmount()

◆ setPersParams()

◆ skipDiscounts()

◆ updateArticleStock()

Member Data Documentation

◆ $_aOrderArticleSelList

◆ $_aOrderCache

◆ $_aPersParam

◆ $_aSkipSaveFields

◆ $_aStatuses

◆ $_blIsNewOrderItem

◆ $_oArticle

◆ $_oOrderArticle

◆ $_sClassName