OxidEsales\EshopCommunity\Application\Model\VariantHandler Class Reference

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

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

Public Member Functions
	init ($oArticles)
	buildMdVariants ($oVariants, $sParentId)
	genVariantFromSell ($aSels, $oArticle)
	isMdVariant ($oArticle)
	buildVariantSelections ($sVarName, $oVariantList, $aFilter, $sActVariantId, $iLimit=0)

Protected Member Functions
	_assignValues ($aValues, $oVariants, $oArticle, $aConfLanguages)
	_getValuePrice ($oValue, $dParentPrice)
	_createNewVariant ($aParams=null, $sParentId=null)
	_updateArticleVarName ($sUpdate, $sArtId)
	_fillVariantSelections ($oVariantList, $iVarSelCnt, &$aFilter, $sActVariantId)
	_cleanFilter ($aFilter)
	_applyVariantSelectionsFilter ($aSelections, $aFilter)
	_buildVariantSelectionsList ($aVarSelects, $aSelections)
	_getSelections ($sTitle)

Protected Attributes
	$_oArticles = null
	$_sMdSeparator = " | "
	$_oMdVariants = null

Detailed Description

VariantHandler encapsulates methods dealing with multidimensional variant and variant names.

Member Function Documentation

_applyVariantSelectionsFilter()

OxidEsales\EshopCommunity\Application\Model\VariantHandler::_applyVariantSelectionsFilter (   $aSelections,   $aFilter  )

protected

Applies filter on variant selection array

Parameters

array	$aSelections	selections
array	$aFilter	filter

Returns

array

_assignValues()

OxidEsales\EshopCommunity\Application\Model\VariantHandler::_assignValues (   $aValues,   $oVariants,   $oArticle,   $aConfLanguages  )

protected

Assigns values of selection list to variants

Parameters

array	$aValues	multilang values of selection list
object	$oVariants	variant list
object	$oArticle	parent article
array	$aConfLanguages	array of all active languages

Returns

mixed

_buildVariantSelectionsList()

OxidEsales\EshopCommunity\Application\Model\VariantHandler::_buildVariantSelectionsList (   $aVarSelects,   $aSelections  )

protected

Builds variant selections list - array containing oxVariantSelectList

Parameters

array	$aVarSelects	variant selection titles
array	$aSelections	variant selections

Returns

array

_cleanFilter()

OxidEsales\EshopCommunity\Application\Model\VariantHandler::_cleanFilter (   $aFilter )

protected

Cleans up user given filter. If filter was empty - returns false

Parameters

array

$aFilter

user given filter

Returns

array | bool

_createNewVariant()

OxidEsales\EshopCommunity\Application\Model\VariantHandler::_createNewVariant (   $aParams = null,   $sParentId = null  )

protected

Creates new article variant.

Parameters

array	$aParams	assigned parameters
string	$sParentId	parent article id

Returns

null

_fillVariantSelections()

OxidEsales\EshopCommunity\Application\Model\VariantHandler::_fillVariantSelections (   $oVariantList,   $iVarSelCnt, &  $aFilter,   $sActVariantId  )

protected

Creates array/matrix with variant selections

Parameters

\OxidEsales\Eshop\Application\Model\ArticleList	$oVariantList	variant list
int	$iVarSelCnt	possible variant selection count
array	$aFilter	active filter array
string	$sActVariantId	active variant id

Returns

array

_getSelections()

OxidEsales\EshopCommunity\Application\Model\VariantHandler::_getSelections (   $sTitle )

protected

In case multidimentional variants ON explodes title by _sMdSeparator and returns array, else - returns array containing title

Parameters

string

$sTitle

title to process

Returns

array

_getValuePrice()

OxidEsales\EshopCommunity\Application\Model\VariantHandler::_getValuePrice (   $oValue,   $dParentPrice  )

protected

Returns article price

Parameters

object	$oValue	selection list value
double	$dParentPrice	parent article price

Returns

double

_updateArticleVarName()

OxidEsales\EshopCommunity\Application\Model\VariantHandler::_updateArticleVarName (   $sUpdate,   $sArtId  )

protected

Inserts article variant name for all languages

Parameters

string	$sUpdate	query for update variant name
string	$sArtId	parent article id

buildMdVariants()

OxidEsales\EshopCommunity\Application\Model\VariantHandler::buildMdVariants	(		$oVariants,
			$sParentId
	)

Returns multidimensional variant structure

Parameters

object	$oVariants	all article variants
string	$sParentId	parent article id

Returns

oxMdVariant

buildVariantSelections()

OxidEsales\EshopCommunity\Application\Model\VariantHandler::buildVariantSelections	(		$sVarName,
			$oVariantList,
			$aFilter,
			$sActVariantId,
			$iLimit = 0
	)

Builds variant selection list

Parameters

string	$sVarName	product (parent product) oxvarname value
\OxidEsales\Eshop\Application\Model\ArticleList	$oVariantList	variant list
array	$aFilter	variant filter
string	$sActVariantId	active variant id
int	$iLimit	limit variant lists count (if non zero, return limited number of multidimensional variant selections)

Returns

Ambigous false | array

genVariantFromSell()

OxidEsales\EshopCommunity\Application\Model\VariantHandler::genVariantFromSell	(		$aSels,
			$oArticle
	)

Generate variants from selection lists

Parameters

array	$aSels	ids of selection list
object	$oArticle	parent article

init()

OxidEsales\EshopCommunity\Application\Model\VariantHandler::init

(

$oArticles

)

Sets internal variant name array from article list.

Parameters

array

$oArticles

Variant list

isMdVariant()

OxidEsales\EshopCommunity\Application\Model\VariantHandler::isMdVariant

(

$oArticle

)

Check if variant is multidimensional

Parameters

\OxidEsales\Eshop\Application\Model\Article

$oArticle

Article object

Returns

bool

Member Data Documentation

$_oArticles

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

protected

$_oMdVariants

OxidEsales\EshopCommunity\Application\Model\VariantHandler::$_oMdVariants = null

protected

$_sMdSeparator

OxidEsales\EshopCommunity\Application\Model\VariantHandler::$_sMdSeparator = " | "

protected

---

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

• /oxideshop-ce/source/Application/Model/VariantHandler.php