oxOrderArticle Class Reference

Inheritance diagram for oxOrderArticle:

[legend]

Collaboration diagram for oxOrderArticle:

[legend]

List of all members.

Public Member Functions
	__construct ()
	copyThis ($oProduct)
	assign ($dbRecord)
	updateArticleStock ($dAddAmount=null, $blAllowNegativeStock=null)
	getPersParams ()
	setPersParams ($aParams)
	loadInLang ($iLanguage, $sOxid)
	getProductId ()
	getProductParentId ()
	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 ()
Public Attributes
	$aStatuses = null
	$aPersParam = null
	$ftotbrutprice = null
	$fbrutprice = null
	$fnetprice = null
Protected Member Functions
	_getArtStock ($dAddAmount=null, $blAllowNegativeStock=null)
	_setDeprecatedValues ()
	_setFieldData ($sFieldName, $sValue, $iDataType=oxField::T_TEXT)
	_setArticleParams ()
	_getOrderArticle ($sArticleId=null)
Protected Attributes
	$_sClassName = 'oxorderarticle'
	$_aPersParam = null
	$_aStatuses = null
	$_aOrderArticleSelList = null
	$_oOrderArticle = null
	$_blIsNewOrderItem = false

---

Detailed Description

Order article manager. Performs copying of article.

Definition at line 7 of file oxorderarticle.php.

---

Constructor & Destructor Documentation

oxOrderArticle.__construct

(

)

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

Reimplemented from oxBase.

Definition at line 99 of file oxorderarticle.php.

---

Member Function Documentation

oxOrderArticle._getArtStock	(	$	dAddAmount = null,
		$	blAllowNegativeStock = null
	)			[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

Definition at line 177 of file oxorderarticle.php.

oxOrderArticle._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:

oxarticle | false

Definition at line 379 of file oxorderarticle.php.

oxOrderArticle._setArticleParams

(

)

[protected]

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

Returns:

null

Definition at line 321 of file oxorderarticle.php.

oxOrderArticle._setDeprecatedValues

(

)

[protected]

Sets deprecate values

Deprecated:

This method as well as all deprecated class variables is deprecated

Returns:

null

Definition at line 236 of file oxorderarticle.php.

oxOrderArticle._setFieldData	(	$	sFieldName,
		$	sValue,
		$	iDataType = oxField::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

Reimplemented from oxBase.

Definition at line 258 of file oxorderarticle.php.

oxOrderArticle.assign

(

$

dbRecord

)

Assigns DB field values to object fields.

Parameters:

string

$dbRecord DB record

Returns:

null

Reimplemented from oxBase.

Definition at line 132 of file oxorderarticle.php.

oxOrderArticle.cancelOrderArticle

(

)

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

Returns:

null

Definition at line 626 of file oxorderarticle.php.

oxOrderArticle.checkForStock	(	$	dAmount,
		$	dArtStockAmount = 0
	)

Returns true, implements iBaseArticle interface method

Parameters:

	double	$dAmount stock to check
	double	$dArtStockAmount stock amount

Returns:

bool

Implements oxIArticle.

Definition at line 366 of file oxorderarticle.php.

oxOrderArticle.copyThis

(

$

oProduct

)

Copies passed to method product into $this.

Parameters:

object

$oProduct product to copy

Returns:

null

Definition at line 112 of file oxorderarticle.php.

oxOrderArticle.delete

(

$

sOXID = null

)

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

Parameters:

string

$sOXID Article id

Returns:

bool

Reimplemented from oxBase.

Definition at line 645 of file oxorderarticle.php.

oxOrderArticle.getBasePrice

(

$

dAmount = 1

)

Returns base article price from database

Parameters:

double

$dAmount article amount. Default is 1

Returns:

double

Implements oxIArticle.

Definition at line 532 of file oxorderarticle.php.

oxOrderArticle.getBasketPrice	(	$	dAmount,
		$	aSelList,
		$	oBasket
	)

Returns basket order article price

Parameters:

	double	$dAmount basket item amount
	array	$aSelList chosen selection list
	oxbasket	$oBasket basket

Returns:

oxprice

Implements oxIArticle.

Definition at line 483 of file oxorderarticle.php.

oxOrderArticle.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 oxIArticle.

Definition at line 506 of file oxorderarticle.php.

oxOrderArticle.getLanguage

(

)

Returns current session language id

Returns:

int

Definition at line 520 of file oxorderarticle.php.

oxOrderArticle.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

Definition at line 417 of file oxorderarticle.php.

oxOrderArticle.getPersParams

(

)

Order persistent data getter

Returns:

array

Definition at line 201 of file oxorderarticle.php.

oxOrderArticle.getPrice

(

)

Returns order article unit price

Returns:

oxprice

Implements oxIArticle.

Definition at line 542 of file oxorderarticle.php.

oxOrderArticle.getProductId

(

)

Returns ordered article id, implements iBaseArticle interface getter method

Returns:

string

Implements oxIArticle.

Definition at line 292 of file oxorderarticle.php.

oxOrderArticle.getProductParentId

(

)

Returns product parent id (oxparentid)

Returns:

string

Implements oxIArticle.

Definition at line 302 of file oxorderarticle.php.

oxOrderArticle.getSelectLists

(

$

sKeyPrefix = null

)

Returns article select lists, implements iBaseArticle interface method

Parameters:

string

$sKeyPrefix prefix (not used)

Returns:

array

Implements oxIArticle.

Definition at line 400 of file oxorderarticle.php.

oxOrderArticle.getWrapping

(

)

get used wrapping

Returns:

oxWrapping

Definition at line 681 of file oxorderarticle.php.

oxOrderArticle.isNewOrderItem

(

)

Returns TRUE if current order article is newly added to order

Returns:

bool

Definition at line 570 of file oxorderarticle.php.

oxOrderArticle.isOrderArticle

(

)

Returns true if object is derived from oxorderarticle class

Returns:

bool

Implements oxIArticle.

Definition at line 614 of file oxorderarticle.php.

oxOrderArticle.loadInLang	(	$	iLanguage,
		$	sOxid
	)

Executes oxOrderArticle.load() and returns its result

Parameters:

	int	$iLanguage language id
	string	$sOxid order article id

Returns:

bool

Definition at line 282 of file oxorderarticle.php.

oxOrderArticle.save

(

)

Saves order article object. If saving succeded - updates article stock information if oxOrderArticle.isNewOrderItem() returns TRUE. Returns saving status

Returns:

bool

Reimplemented from oxBase.

Definition at line 663 of file oxorderarticle.php.

oxOrderArticle.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

Returns:

null

Definition at line 560 of file oxorderarticle.php.

oxOrderArticle.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

Returns:

null

Definition at line 584 of file oxorderarticle.php.

oxOrderArticle.setPersParams

(

$

aParams

)

Order persistent params setter

Parameters:

array

$aParams array of params

Returns:

null

Definition at line 221 of file oxorderarticle.php.

oxOrderArticle.skipDiscounts

(

)

Returns false, implements iBaseArticle interface method

Returns:

bool

Implements oxIArticle.

Definition at line 493 of file oxorderarticle.php.

oxOrderArticle.updateArticleStock	(	$	dAddAmount = null,
		$	blAllowNegativeStock = null
	)

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

Returns:

null

Definition at line 149 of file oxorderarticle.php.

---

Member Data Documentation

oxOrderArticle.$_aOrderArticleSelList = null [protected]

Definition at line 80 of file oxorderarticle.php.

oxOrderArticle.$_aPersParam = null [protected]

Definition at line 21 of file oxorderarticle.php.

oxOrderArticle.$_aStatuses = null [protected]

Definition at line 28 of file oxorderarticle.php.

oxOrderArticle.$_blIsNewOrderItem = false [protected]

Definition at line 94 of file oxorderarticle.php.

oxOrderArticle.$_oOrderArticle = null [protected]

Definition at line 87 of file oxorderarticle.php.

oxOrderArticle.$_sClassName = 'oxorderarticle' [protected]

Reimplemented from oxBase.

Definition at line 14 of file oxorderarticle.php.

oxOrderArticle.$aPersParam = null

Definition at line 46 of file oxorderarticle.php.

oxOrderArticle.$aStatuses = null

Definition at line 37 of file oxorderarticle.php.

oxOrderArticle.$fbrutprice = null

Definition at line 64 of file oxorderarticle.php.

oxOrderArticle.$fnetprice = null

Definition at line 73 of file oxorderarticle.php.

oxOrderArticle.$ftotbrutprice = null

Definition at line 55 of file oxorderarticle.php.

---

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

• core/oxorderarticle.php