OxidEsales\EshopCommunity\Application\Model\MdVariant Class Reference

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

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

Public Member Functions
	setId ($sId)
	getId ()
	setParentId ($sParentId)
	getParentId ()
	setMdSubvariants ($aSubvariants)
	getMdSubvariants ()
	getFirstMdSubvariant ()
	getMdSubvariantByName ($sName)
	getLink ()
	setName ($sName)
	getName ()
	getDPrice ()
	getMinDPrice ()
	getMaxDepth ()
	getFPrice ()
	addNames ($sArtId, $aNames, $dPrice, $sUrl)
	getArticleId ()
	hasArticleId ($sArtId)

Protected Member Functions
	_addMdSubvariant ($oSubvariant)
	_isFixedPrice ()

Protected Attributes
	$_sId
	$_sParentId
	$_sArticleId
	$_sName
	$_sUrl
	$_dPrice = null
	$_sFPrice
	$_aSubvariants = []

Detailed Description

Defines an element of multidimentional variant name tree structure. Contains article id, variant name, URL, price, price text, and a subset of MD variants.

Member Function Documentation

_addMdSubvariant()

OxidEsales\EshopCommunity\Application\Model\MdVariant::_addMdSubvariant (   $oSubvariant )

protected

Adds one subvariant to subvariant set

Parameters

\OxidEsales\Eshop\Application\Model\MdVariant

$oSubvariant

Subvariant

_isFixedPrice()

OxidEsales\EshopCommunity\Application\Model\MdVariant::_isFixedPrice ( )

protected

Checks if variant price is fixed or not ("from" price)

Returns

bool

addNames()

OxidEsales\EshopCommunity\Application\Model\MdVariant::addNames	(		$sArtId,
			$aNames,
			$dPrice,
			$sUrl
	)

Inits MD variant by name. In case $aNames parameter has more than one element addNames recursively adds names for subvariants.

Parameters

string	$sArtId	Article ID
array	$aNames	Expected array of $sKey=>$sName pairs.
double	$dPrice	Price as double
string	$sUrl	Article URL

getArticleId()

OxidEsales\EshopCommunity\Application\Model\MdVariant::getArticleId

(

)

Returns corresponding article id or recusively first variant id from subvariant set

Returns

string

getDPrice()

OxidEsales\EshopCommunity\Application\Model\MdVariant::getDPrice

(

)

Returns price

Returns

double

getFirstMdSubvariant()

OxidEsales\EshopCommunity\Application\Model\MdVariant::getFirstMdSubvariant

(

)

Returns first MD subvariant from subvariant set or null in case variant has no subvariants.

Returns

\OxidEsales\Eshop\Application\Model\MdVariant

getFPrice()

OxidEsales\EshopCommunity\Application\Model\MdVariant::getFPrice

(

)

Returns MD variant price as a text.

Returns

string

getId()

OxidEsales\EshopCommunity\Application\Model\MdVariant::getId

(

)

Returns MD variant identifier

Returns

string

getLink()

OxidEsales\EshopCommunity\Application\Model\MdVariant::getLink

(

)

Returns corresponding article URL or recusively first variant URL from subvariant set

Returns

string

getMaxDepth()

OxidEsales\EshopCommunity\Application\Model\MdVariant::getMaxDepth

(

)

Gets max subvariant depth. 0 means no deeper subvariants.

Returns

int

getMdSubvariantByName()

OxidEsales\EshopCommunity\Application\Model\MdVariant::getMdSubvariantByName

(

$sName

)

Checks for existing MD subvariant by name. Returns existing one or in case $sName has not been found creates an empty OxMdVariant instance.

Parameters

string

$sName

Subvariant name

Returns

\OxidEsales\Eshop\Application\Model\MdVariant

getMdSubvariants()

OxidEsales\EshopCommunity\Application\Model\MdVariant::getMdSubvariants

(

)

Returns full array of subvariants

Returns

array[string]OxMdSubvariants

getMinDPrice()

OxidEsales\EshopCommunity\Application\Model\MdVariant::getMinDPrice

(

)

Returns min price recursively selected from full subvariant tree.

Returns

double

getName()

OxidEsales\EshopCommunity\Application\Model\MdVariant::getName

(

)

Returns MD variant name

Returns

string

getParentId()

OxidEsales\EshopCommunity\Application\Model\MdVariant::getParentId

(

)

Returns parent id

Returns

string

hasArticleId()

OxidEsales\EshopCommunity\Application\Model\MdVariant::hasArticleId

(

$sArtId

)

Checks whether $sArtId is one of subtree article ids.

Parameters

string

$sArtId

Article ID

Returns

bool

setId()

OxidEsales\EshopCommunity\Application\Model\MdVariant::setId

(

$sId

)

Sets MD variant identifier

Parameters

string

$sId

New id

setMdSubvariants()

OxidEsales\EshopCommunity\Application\Model\MdVariant::setMdSubvariants

(

$aSubvariants

)

Sets MD subvariants

Parameters

setName()

OxidEsales\EshopCommunity\Application\Model\MdVariant::setName

(

$sName

)

Name setter

Parameters

string

$sName

New name

setParentId()

OxidEsales\EshopCommunity\Application\Model\MdVariant::setParentId

(

$sParentId

)

Sets parent id

Parameters

string

$sParentId

Parent id

Member Data Documentation

$_aSubvariants

OxidEsales\EshopCommunity\Application\Model\MdVariant::$_aSubvariants = []

protected

$_dPrice

OxidEsales\EshopCommunity\Application\Model\MdVariant::$_dPrice = null

protected

$_sArticleId

OxidEsales\EshopCommunity\Application\Model\MdVariant::$_sArticleId

protected

$_sFPrice

OxidEsales\EshopCommunity\Application\Model\MdVariant::$_sFPrice

protected

$_sId

OxidEsales\EshopCommunity\Application\Model\MdVariant::$_sId

protected

$_sName

OxidEsales\EshopCommunity\Application\Model\MdVariant::$_sName

protected

$_sParentId

OxidEsales\EshopCommunity\Application\Model\MdVariant::$_sParentId

protected

$_sUrl

OxidEsales\EshopCommunity\Application\Model\MdVariant::$_sUrl

protected

---

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

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