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

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

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

Public Member Functions
	getActZoomPic ()
	ratingIsActive ()
	canRate ()
	getAttributes ()
	getLinkType ()
	getVariantListExceptCurrent ()
	loadVariantInformation ()
	getVariantList ()
	getMediaFiles ()
	getLastProducts ($iCnt=4)
	getManufacturer ()
	getVendor ()
	getCategory ()
	getPictureGallery ()
	getActPicture ()
	morePics ()
	getIcons ()
	showZoomPics ()
	getZoomPics ()
	getReviews ()
	getCrossSelling ()
	getSimilarProducts ()
	getSimilarRecommListIds ()
	getAccessoires ()
	getAlsoBoughtTheseProducts ()
	isPriceAlarm ()
	getSearchTitle ()
	setSearchTitle ($sTitle)
	setCatTreePath ($sActCatPath)
	isPersParam ()
	getRatingValue ()
	isReviewActive ()
	getRatingCount ()
	getPriceAlarmStatus ()
	getBidPrice ()
	getVariantSelections ()
	getPicturesProduct ()
	getProduct ()
	render ()
	isMdVariantView ()
	getDefaultSorting ()

Protected Member Functions
	_getParentProduct ($sParentId)
	_getAddUrlParams ()
	_processProduct ($oProduct)
	_getSubject ($iLang)
	_setSortingParameters ()
	_additionalChecksForArticle ($myUtils, $myConfig)

Protected Attributes
	$_aVariantList = null
	$_aComponentNames = ['oxcmp_cur' => 1, 'oxcmp_shop' => 1, 'oxcmp_basket' => 1, 'oxcmp_user' => 1]
	$_sThisTemplate = 'widget/product/details.tpl'
	$_oParentProd = null
	$_blCanRate = null
	$_aMediaFiles = null
	$_aLastProducts = null
	$_oVendor = null
	$_oManufacturer = null
	$_oCategory = null
	$_aAttributes = null
	$_aPicGallery = null
	$_aReviews = null
	$_oCrossSelling = null
	$_oSimilarProducts = null
	$_oAccessoires = null
	$_aAlsoBoughtArts = null
	$_sSearchTitle = null
	$_blIsInitialized = false
	$_iLinkType = null
	$_blMdView = null
	$_dRatingValue = null
	$_iRatingCnt = null
	$_sBidPrice = null
	$_blShowSorting = true
	$_aSimilarRecommListIds = null

Detailed Description

Article detailed information widget.

Member Function Documentation

_additionalChecksForArticle()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::_additionalChecksForArticle (   $myUtils,   $myConfig  )

protected

Runs additional checks for article.

Parameters

Utils	$myUtils	General utils.
Config	$myConfig	Main shop configuration.

_getAddUrlParams()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::_getAddUrlParams ( )

protected

In case list type is "search" returns search parameters which will be added to product details link.

Returns

string|null

_getParentProduct()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::_getParentProduct (   $sParentId )

protected

Returns current product parent article object if it is available.

Parameters

string

$sParentId

parent product id

Returns

Article

_getSubject()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::_getSubject (   $iLang )

protected

returns object, associated with current view. (the object that is shown in frontend)

Parameters

int

$iLang

language id

Returns

object

_processProduct()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::_processProduct (   $oProduct )

protected

Processes product by setting link type and in case list type is search adds search parameters to details link.

Parameters

object

$oProduct

Product to process.

_setSortingParameters()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::_setSortingParameters ( )

protected

Set item sorting for widget based of retrieved parameters.

canRate()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::canRate

(

)

Checks if rating functionality is on and allowed to user.

Returns

bool

getAccessoires()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getAccessoires

(

)

Template variable getter. Returns accessories of article.

Returns

object

getActPicture()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getActPicture

(

)

Template variable getter. Returns active picture.

Returns

object

getActZoomPic()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getActZoomPic

(

)

Template variable getter. Returns active zoom picture id.

Returns

int

getAlsoBoughtTheseProducts()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getAlsoBoughtTheseProducts

(

)

Template variable getter. Returns list of customer also bought these products.

Returns

object

getAttributes()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getAttributes

(

)

Loading full list of attributes.

Returns

array

getBidPrice()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getBidPrice

(

)

Template variable getter. Returns bid price.

Returns

string

getCategory()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getCategory

(

)

Template variable getter. Returns product's root category.

Returns

object

getCrossSelling()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getCrossSelling

(

)

Template variable getter. Returns cross selling.

Returns

object

getDefaultSorting()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getDefaultSorting

(

)

Returns default category sorting for selected category.

Returns

array

getIcons()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getIcons

(

)

Template variable getter. Returns icons of current article.

Returns

array

getLastProducts()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getLastProducts

(

$iCnt = 4

)

Template variable getter. Returns last seen products.

Parameters

int

$iCnt

product count

Returns

array

getLinkType()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getLinkType

(

)

Returns current view link type.

Returns

int

getManufacturer()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getManufacturer

(

)

Template variable getter. Returns product's vendor.

Returns

object

getMediaFiles()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getMediaFiles

(

)

Template variable getter. Returns media files of current product.

Returns

array

getPictureGallery()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getPictureGallery

(

)

Template variable getter. Returns picture gallery of current article.

Returns

array

getPicturesProduct()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getPicturesProduct

(

)

Returns pictures product object.

Returns

ArticleList

getPriceAlarmStatus()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getPriceAlarmStatus

(

)

Return price alarm status (if it was send).

Returns

integer

getProduct()

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

(

)

Get product.

Returns

Article

getRatingCount()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getRatingCount

(

)

Template variable getter. Returns rating count.

Returns

integer

getRatingValue()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getRatingValue

(

)

Template variable getter. Returns rating value.

Returns

double

getReviews()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getReviews

(

)

Template variable getter. Returns reviews of current article.

Returns

array

getSearchTitle()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getSearchTitle

(

)

Returns search title. It will be set in Locator.

Returns

string

getSimilarProducts()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getSimilarProducts

(

)

Template variable getter. Returns similar article list.

Returns

object

getSimilarRecommListIds()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getSimilarRecommListIds

(

)

Return array of id to form recommend list.

Deprecated:

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

Returns

array

getVariantList()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getVariantList

(

)

Returns variant lists of current product.

Returns

array|SimpleVariantList|ArticleList

getVariantListExceptCurrent()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getVariantListExceptCurrent

(

)

Returns variant lists of current product excludes currently viewed product.

Returns

array|SimpleVariantList|ArticleList

getVariantSelections()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getVariantSelections

(

)

Returns variant selection.

Returns

array

getVendor()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getVendor

(

)

Template variable getter. Returns product's vendor.

Returns

object

getZoomPics()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::getZoomPics

(

)

Template variable getter. Returns zoom pictures.

Returns

array

isMdVariantView()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::isMdVariantView

(

)

Should we show MD variant selection? - Not for 1 dimension variants.

Returns

bool

isPersParam()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::isPersParam

(

)

Checks should persistent parameter input field be displayed.

Returns

bool

isPriceAlarm()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::isPriceAlarm

(

)

Template variable getter. Returns if price alarm is enabled.

Returns

bool

isReviewActive()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::isReviewActive

(

)

Template variable getter. Returns if review module is on.

Returns

bool

loadVariantInformation()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::loadVariantInformation

(

)

Loading full list of variants, if we are child and do not have any variants then let's load all parent variants as ours.

Returns

array|SimpleVariantList|ArticleList

morePics()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::morePics

(

)

Template variable getter. Returns true if there more pictures.

Returns

bool

ratingIsActive()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::ratingIsActive

(

)

Checks if rating functionality is active.

Returns

bool

render()

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

(

)

Executes parent::render(). Returns name of template file to render.

Returns

string $this->_sThisTemplate current template file name

setCatTreePath()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::setCatTreePath

(

$sActCatPath

)

active category path setter

Parameters

string

$sActCatPath

category tree path.

setSearchTitle()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::setSearchTitle

(

$sTitle

)

Returns search title setter.

Parameters

string

$sTitle

search title

showZoomPics()

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::showZoomPics

(

)

Template variable getter. Returns if to show zoom pictures.

Returns

bool

Member Data Documentation

$_aAlsoBoughtArts

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_aAlsoBoughtArts = null

protected

$_aAttributes

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_aAttributes = null

protected

$_aComponentNames

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

protected

$_aLastProducts

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_aLastProducts = null

protected

$_aMediaFiles

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_aMediaFiles = null

protected

$_aPicGallery

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_aPicGallery = null

protected

$_aReviews

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_aReviews = null

protected

$_aSimilarRecommListIds

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_aSimilarRecommListIds = null

protected

$_aVariantList

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_aVariantList = null

protected

$_blCanRate

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_blCanRate = null

protected

$_blIsInitialized

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_blIsInitialized = false

protected

$_blMdView

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_blMdView = null

protected

$_blShowSorting

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_blShowSorting = true

protected

$_dRatingValue

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_dRatingValue = null

protected

$_iLinkType

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_iLinkType = null

protected

$_iRatingCnt

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_iRatingCnt = null

protected

$_oAccessoires

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_oAccessoires = null

protected

$_oCategory

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_oCategory = null

protected

$_oCrossSelling

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_oCrossSelling = null

protected

$_oManufacturer

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_oManufacturer = null

protected

$_oParentProd

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_oParentProd = null

protected

$_oSimilarProducts

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_oSimilarProducts = null

protected

$_oVendor

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_oVendor = null

protected

$_sBidPrice

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_sBidPrice = null

protected

$_sSearchTitle

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_sSearchTitle = null

protected

$_sThisTemplate

OxidEsales\EshopCommunity\Application\Component\Widget\ArticleDetails::$_sThisTemplate = 'widget/product/details.tpl'

protected

---

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

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