OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox:

Public Member Functions
	getActiveCategory ()
	render ()
	setProduct ($oArticle)
	getProduct ()
	getLink ($iLang=null)
	isVatIncluded ()
	getWishId ()
	getRemoveFunction ()
	getToBasketFunction ()
	getDisableToCart ()
	getIndex ()
	getRecommId ()
	getIteration ()
	getRSSLinks ()
	getShowMainLink ()
	getAltProduct ()

Protected Member Functions
	_addDynParamsToLink ($sAddDynParams, $oArticle)
	_getArticleById ($sArticleId)
	updateDynamicParameters ($dynamicParameters)

Protected Attributes
	$_aComponentNames = ['oxcmp_user' => 1, 'oxcmp_basket' => 1, 'oxcmp_cur' => 1]
	$_sTemplate = 'widget/product/boxproduct.tpl'
	$_oArticle = null

Detailed Description

Article box widget

Member Function Documentation

_addDynParamsToLink()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::_addDynParamsToLink (   $sAddDynParams,   $oArticle  )

protected

Appends dyn params to url.

Parameters

string	$sAddDynParams	Dyn params
\OxidEsales\Eshop\Application\Model\Article	$oArticle	Article

Returns

bool

_getArticleById()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::_getArticleById (   $sArticleId )

protected

Returns prepared article by id.

Parameters

string

$sArticleId

Article id

Returns

\OxidEsales\Eshop\Application\Model\Article

getActiveCategory()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::getActiveCategory

(

)

Returns active category

Returns

null|oxCategory

getAltProduct()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::getAltProduct

(

)

Returns if alternate product exists

Returns

bool

getDisableToCart()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::getDisableToCart

(

)

Returns if toCart must be disabled

Returns

bool

getIndex()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::getIndex

(

)

Returns list item id with identifier

Returns

string

getIteration()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::getIteration

(

)

Returns iteration number

Returns

string

getLink()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::getLink

(

$iLang = null

)

get link of current top view

Parameters

int

$iLang

requested language

Returns

string

getProduct()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::getProduct

(

)

Get product article

Returns

\OxidEsales\Eshop\Application\Model\Article

getRecommId()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::getRecommId

(

)

Returns recommendation id

Deprecated:

since v5.3 (2016-06-17); Listmania will be moved to an own module.

Returns

string

getRemoveFunction()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::getRemoveFunction

(

)

Returns remove function

Returns

string

getRSSLinks()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::getRSSLinks

(

)

Returns RSS links

Returns

array|null

getShowMainLink()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::getShowMainLink

(

)

Returns the answer if main link must be showed

Returns

bool

getToBasketFunction()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::getToBasketFunction

(

)

Returns toBasket function

Returns

string

getWishId()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::getWishId

(

)

Returns wish list id

Returns

string

isVatIncluded()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::isVatIncluded

(

)

Returns if VAT is included in price

Returns

bool

render()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::render

(

)

Renders template based on widget type or just use directly passed path of template

Returns

string

setProduct()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::setProduct

(

$oArticle

)

Sets box product

Parameters

\OxidEsales\Eshop\Application\Model\Article

$oArticle

Box product

updateDynamicParameters()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::updateDynamicParameters (   $dynamicParameters )

protected

Parameters

string

$dynamicParameters

Returns

string

Member Data Documentation

$_aComponentNames

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::$_aComponentNames = ['oxcmp_user' => 1, 'oxcmp_basket' => 1, 'oxcmp_cur' => 1]

protected

$_oArticle

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::$_oArticle = null

protected

$_sTemplate

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleBox::$_sTemplate = 'widget/product/boxproduct.tpl'

protected

---

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

• /oxideshop-ce/source/Application/Component/Widget/ArticleBox.php