Inheritance diagram for OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController:

Public Member Functions
	getNavigationParams ()

	render ()

	saveReview ()

	addToRecomm ()

	getProduct ()

	getLinkType ()

	drawParentUrl ()

	getPictureGallery ()

	getActPictureId ()

	getActPicture ()

	getPictures ()

	getArtPic ($pictureNumber)

	getSelectLists ()

	getReviews ()

	getCrossSelling ()

	getSimilarProducts ()

	getSimilarRecommListIds ()

	getAccessoires ()

	getAlsoBoughtTheseProducts ()

	isPriceAlarm ()

	getSearchTitle ()

	setSearchTitle ($title)

	setCatTreePath ($activeCategoryPath)

	noIndex ()

	getTitle ()

	getCanonicalUrl ()

	getBreadCrumb ()

	addMe ()

	getPriceAlarmStatus ()

	getBidPrice ()

	getVariantSelections ()

	getPicturesProduct ()

	getSearchParamForHtml ()

	showRdfa ()

	getRDFaNormalizedRating ()

	getRDFaValidityPeriod ($configVariableName)

	getRDFaBusinessFnc ()

	getRDFaCustomers ()

	getRDFaVAT ()

	getRDFaGenericCondition ()

	getBundleArticle ()

	getRDFaPaymentMethods ()

	getRDFaDeliverySetMethods ()

	getProductsDeliveryList ()

	getRDFaDeliveryChargeSpecLoc ()

	getRDFaPaymentChargeSpecLoc ()

	getRDFaBusinessEntityLoc ()

	showRDFaProductStock ()

	showZoomPics ()

	isReviewActive ()

	getDefaultSorting ()

	getSortingParameters ()

Protected Member Functions
	_getParentProduct ($parentId)

	_getAddUrlParams ()

	_processProduct ($article)

	generateViewId ()

	_prepareMetaDescription ($meta, $length=200, $descriptionTag=false)

	_prepareMetaKeyword ($keywords, $removeDuplicatedWords=true)

	_getSeoObjectId ()

	_additionalChecksForArticle ()

	_getSubject ($languageId)

	_getVendorBreadCrumb ()

	_getRecommendationListBredCrumb ()

	_getSearchBreadCrumb ()

	_getCategoryBreadCrumb ()

Protected Attributes
	$_sThisTemplate = 'page/details/details.tpl'

	$_oParentProd = null

	$_sParentName = null

	$_sParentUrl = null

	$_aPicGallery = null

	$_aSelectLists = null

	$_aReviews = null

	$_oCrossSelling = null

	$_oSimilarProducts = null

	$_oAccessoires = null

	$_aAlsoBoughtArts = null

	$_sSearchTitle = null

	$_blIsInitialized = false

	$_iLinkType = null

	$_sBidPrice = null

	$_iPriceAlarmStatus = null

	$_sSearchParamForHtml = null

	$_aSimilarRecommListIds = null

	$_blShowSorting = true

Detailed Description

Article details information page. Collects detailed article information, possible variants, such information as crosselling, similarlist, picture gallery list, etc. OXID eShop -> (Any chosen product).

Member Function Documentation

◆ _additionalChecksForArticle()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::_additionalChecksForArticle ( )

protected

Runs additional checks for article.

◆ _getAddUrlParams()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::_getAddUrlParams ( )

protected

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

Returns: string | null

◆ _getCategoryBreadCrumb()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::_getCategoryBreadCrumb ( )

protected

Category bread crumb

Returns: array

◆ _getParentProduct()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::_getParentProduct ( $parentId )

protected

Returns current product parent article object if it is available

Parameters

string $parentId parent product id

Returns: \OxidEsales\Eshop\Application\Model\Article

◆ _getRecommendationListBredCrumb()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::_getRecommendationListBredCrumb ( )

protected

Recommendation list bread crumb

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

Returns: array

◆ _getSearchBreadCrumb()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::_getSearchBreadCrumb ( )

protected

Search bread crumb

Returns: array

◆ _getSeoObjectId()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::_getSeoObjectId ( )

protected

Returns active product id to load its seo meta info

Returns: string

◆ _getSubject()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::_getSubject ( $languageId )

protected

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

Parameters

int $languageId language id

Returns: \OxidEsales\Eshop\Application\Model\Article

◆ _getVendorBreadCrumb()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::_getVendorBreadCrumb ( )

protected

Vendor bread crumb

Returns: array

◆ _prepareMetaDescription()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::_prepareMetaDescription	(	$meta,
		$length = `200`,
		$descriptionTag = `false`
	)

protected

Returns current view meta data If $meta parameter comes empty, sets to it article title and description. It happens if current view has no meta data defined in oxcontent table

Parameters

string	$meta	User defined description, description content or empty value
int	$length	Max length of result, -1 for no truncation
bool	$descriptionTag	If true - performs additional duplicate cleaning

Returns: string

◆ _prepareMetaKeyword()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::_prepareMetaKeyword	(	$keywords,
		$removeDuplicatedWords = `true`
	)

protected

Returns current view keywords seperated by comma If $keywords parameter comes empty, sets to it article title and description. It happens if current view has no meta data defined in oxcontent table

Parameters

string	$keywords	User defined keywords, keywords content or empty value
bool	$removeDuplicatedWords	Remove duplicated words

Returns: string

◆ _processProduct()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::_processProduct ( $article )

protected

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

Parameters

\OxidEsales\Eshop\Application\Model\Article $article Product to process

◆ addMe()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::addMe ( )

Validates email address. If email address is OK - creates price alarm object and saves it (oxPriceAlarm::save()). If email is wrong - returns false. Sends price alarm notification mail to shop owner.

Returns: null

◆ addToRecomm()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::addToRecomm ( )

Adds article to selected recommendation list

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

Returns: null

◆ drawParentUrl()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::drawParentUrl ( )

Template variable getter. Returns if draw parent url

Returns: bool

◆ generateViewId()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::generateViewId ( )

protected

Generates current view id.

Returns: string

◆ getAccessoires()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getAccessoires ( )

Template variable getter. Returns accessories of article

Returns: object

◆ getActPicture()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getActPicture ( )

Template variable getter. Returns active picture

Returns: object

◆ getActPictureId()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getActPictureId ( )

Template variable getter. Returns id of active picture

Returns: string

◆ getAlsoBoughtTheseProducts()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getAlsoBoughtTheseProducts ( )

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

Returns: oxArticleList|null

◆ getArtPic()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getArtPic ( $pictureNumber )

Template variable getter. Returns selected picture

Parameters

string $pictureNumber

Returns: string

◆ getBidPrice()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getBidPrice ( )

Template variable getter. Returns bid price

Returns: string

◆ getBreadCrumb()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getBreadCrumb ( )

Returns Bread Crumb - you are here page1/page2/page3...

Returns: array

◆ getBundleArticle()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getBundleArticle ( )

Returns bundle product

Returns: \OxidEsales\Eshop\Application\Model\Article|false

◆ getCanonicalUrl()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getCanonicalUrl ( )

Returns view canonical url

Returns: string

◆ getCrossSelling()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getCrossSelling ( )

Template variable getter. Returns cross selling

Returns: object

◆ getDefaultSorting()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getDefaultSorting ( )

Returns default category sorting for selected category

Returns: array

◆ getLinkType()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getLinkType ( )

Returns current view link type

Returns: int

◆ getNavigationParams()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getNavigationParams ( )

Returns array of params => values which are used in hidden forms and as additional url params. NOTICE: this method SHOULD return raw (non encoded into entities) parameters, because values are processed by htmlentities() to avoid security and broken templates problems This exact fix is added for article details to parse variant selection properly for widgets.

Returns: array

◆ getPictureGallery()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getPictureGallery ( )

Template variable getter. Returns picture gallery of current article

Returns: array

◆ getPictures()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getPictures ( )

Template variable getter. Returns pictures of current article

Returns: array

◆ getPicturesProduct()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getPicturesProduct ( )

Returns pictures product object

Returns: \OxidEsales\Eshop\Application\Model\Article

◆ getPriceAlarmStatus()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getPriceAlarmStatus ( )

Return price alarm status (if it was send)

Returns: integer

◆ getProduct()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getProduct ( )

Returns current product

Returns: \OxidEsales\Eshop\Application\Model\Article

◆ getProductsDeliveryList()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getProductsDeliveryList ( )

Template variable getter. Returns delivery list for current product

Returns: oxDeliveryList

◆ getRDFaBusinessEntityLoc()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getRDFaBusinessEntityLoc ( )

Gets content id of company info page (About Us)

Returns: string

◆ getRDFaBusinessFnc()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getRDFaBusinessFnc ( )

Gets business function of the gr:Offering

Returns: string

◆ getRDFaCustomers()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getRDFaCustomers ( )

Gets the types of customers for which the given gr:Offering is valid

Returns: array

◆ getRDFaDeliveryChargeSpecLoc()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getRDFaDeliveryChargeSpecLoc ( )

Gets content id of delivery information page

Returns: string

◆ getRDFaDeliverySetMethods()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getRDFaDeliverySetMethods ( )

Returns delivery methods with assigned delivery sets.

Returns: oxDeliverySetList

◆ getRDFaGenericCondition()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getRDFaGenericCondition ( )

Gets a generic description of product condition

Returns: string

◆ getRDFaNormalizedRating()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getRDFaNormalizedRating ( )

Sets normalized rating

Returns: array

◆ getRDFaPaymentChargeSpecLoc()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getRDFaPaymentChargeSpecLoc ( )

Gets content id of payments

Returns: string

◆ getRDFaPaymentMethods()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getRDFaPaymentMethods ( )

Gets accepted payment methods

Returns: oxPaymentList

◆ getRDFaValidityPeriod()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getRDFaValidityPeriod ( $configVariableName )

Sets and returns validity period of given object

Parameters

string $configVariableName object name

Returns: array

◆ getRDFaVAT()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getRDFaVAT ( )

Gets information whether prices include vat

Returns: int

◆ getReviews()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getReviews ( )

Template variable getter. Returns reviews of current article

Returns: array

◆ getSearchParamForHtml()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getSearchParamForHtml ( )

Template variable getter. Returns search parameter for Html

Returns: string

◆ getSearchTitle()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getSearchTitle ( )

Returns search title. It will be set in oxLocator

Returns: string

◆ getSelectLists()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getSelectLists ( )

Template variable getter. Returns selectLists of current article

Returns: array

◆ getSimilarProducts()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getSimilarProducts ( )

Template variable getter. Returns similar article list

Returns: object

◆ getSimilarRecommListIds()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::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

◆ getSortingParameters()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getSortingParameters ( )

Returns sorting parameters separated by "|"

Returns: string

◆ getTitle()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getTitle ( )

Returns current view title. Default is null

Returns: null

◆ getVariantSelections()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::getVariantSelections ( )

Returns variant selection

Returns: oxVariantSelectList

◆ isPriceAlarm()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::isPriceAlarm ( )

Template variable getter. Returns if price alarm is enabled

Returns: bool

◆ isReviewActive()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::isReviewActive ( )

Template variable getter. Returns if review module is on

Returns: bool

◆ noIndex()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::noIndex ( )

If product details are accessed by vendor url view must not be indexable

Returns: int

◆ render()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::render ( )

If possible loads additional article info (\OxidEsales\Eshop\Application\Model\Article::getCrossSelling(), \OxidEsales\Eshop\Application\Model\Article::getAccessoires(), \OxidEsales\Eshop\Application\Model\Article::getReviews(), \OxidEsales\Eshop\Application\Model\Article::GetSimilarProducts(), \OxidEsales\Eshop\Application\Model\Article::GetCustomerAlsoBoughtThisProducts()), forms variants details navigation URLs loads select lists (\OxidEsales\Eshop\Application\Model\Article::GetSelectLists()), prepares HTML meta data (details::_convertForMetaTags()). Returns name of template file details::_sThisTemplate

Returns: string $this->_sThisTemplate current template file name

◆ saveReview()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::saveReview ( )

Saves user ratings and review text (oxReview object)

Returns: null

◆ setCatTreePath()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::setCatTreePath ( $activeCategoryPath )

Active category path setter.

Parameters

string $activeCategoryPath Category tree path

◆ setSearchTitle()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::setSearchTitle ( $title )

Returns search title setter

Parameters

string $title search title

◆ showRdfa()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::showRdfa ( )

Returns if page has rdfa

Returns: bool

◆ showRDFaProductStock()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::showRDFaProductStock ( )

Returns if to show products left stock

Returns: string

◆ showZoomPics()

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::showZoomPics ( )

Template variable getter. Returns if to show zoom pictures

Returns: bool

Member Data Documentation

◆ $_aAlsoBoughtArts

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::$_aAlsoBoughtArts = null

protected

◆ $_aPicGallery

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::$_aPicGallery = null

protected

◆ $_aReviews

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::$_aReviews = null

protected

◆ $_aSelectLists

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::$_aSelectLists = null

protected

◆ $_aSimilarRecommListIds

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::$_aSimilarRecommListIds = null

protected

◆ $_blIsInitialized

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::$_blIsInitialized = false

protected

◆ $_blShowSorting

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::$_blShowSorting = true

protected

◆ $_iLinkType

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::$_iLinkType = null

protected

◆ $_iPriceAlarmStatus

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::$_iPriceAlarmStatus = null

protected

◆ $_oAccessoires

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::$_oAccessoires = null

protected

◆ $_oCrossSelling

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::$_oCrossSelling = null

protected

◆ $_oParentProd

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::$_oParentProd = null

protected

◆ $_oSimilarProducts

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::$_oSimilarProducts = null

protected

◆ $_sBidPrice

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::$_sBidPrice = null

protected

◆ $_sParentName

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::$_sParentName = null

protected

◆ $_sParentUrl

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::$_sParentUrl = null

protected

◆ $_sSearchParamForHtml

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::$_sSearchParamForHtml = null

protected

◆ $_sSearchTitle

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::$_sSearchTitle = null

protected

◆ $_sThisTemplate

OxidEsales\EshopCommunity\Application\Controller\ArticleDetailsController::$_sThisTemplate = 'page/details/details.tpl'

protected

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

/oxideshop-ce/source/Application/Controller/ArticleDetailsController.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ _additionalChecksForArticle()

◆ _getAddUrlParams()

◆ _getCategoryBreadCrumb()

◆ _getParentProduct()

◆ _getRecommendationListBredCrumb()

◆ _getSearchBreadCrumb()

◆ _getSeoObjectId()

◆ _getSubject()

◆ _getVendorBreadCrumb()

◆ _prepareMetaDescription()

◆ _prepareMetaKeyword()

◆ _processProduct()

◆ addMe()

◆ addToRecomm()

◆ drawParentUrl()

◆ generateViewId()

◆ getAccessoires()

◆ getActPicture()

◆ getActPictureId()

◆ getAlsoBoughtTheseProducts()

◆ getArtPic()

◆ getBidPrice()

◆ getBreadCrumb()

◆ getBundleArticle()

◆ getCanonicalUrl()

◆ getCrossSelling()

◆ getDefaultSorting()

◆ getLinkType()

◆ getNavigationParams()

◆ getPictureGallery()

◆ getPictures()

◆ getPicturesProduct()

◆ getPriceAlarmStatus()

◆ getProduct()

◆ getProductsDeliveryList()

◆ getRDFaBusinessEntityLoc()

◆ getRDFaBusinessFnc()

◆ getRDFaCustomers()

◆ getRDFaDeliveryChargeSpecLoc()

◆ getRDFaDeliverySetMethods()

◆ getRDFaGenericCondition()

◆ getRDFaNormalizedRating()

◆ getRDFaPaymentChargeSpecLoc()

◆ getRDFaPaymentMethods()

◆ getRDFaValidityPeriod()

◆ getRDFaVAT()

◆ getReviews()

◆ getSearchParamForHtml()

◆ getSearchTitle()

◆ getSelectLists()

◆ getSimilarProducts()

◆ getSimilarRecommListIds()

◆ getSortingParameters()

◆ getTitle()

◆ getVariantSelections()

◆ isPriceAlarm()

◆ isReviewActive()

◆ noIndex()

◆ render()

◆ saveReview()

◆ setCatTreePath()

◆ setSearchTitle()

◆ showRdfa()

◆ showRDFaProductStock()

◆ showZoomPics()

Member Data Documentation

◆ $_aAlsoBoughtArts

◆ $_aPicGallery

◆ $_aReviews

◆ $_aSelectLists

◆ $_aSimilarRecommListIds

◆ $_blIsInitialized

◆ $_blShowSorting

◆ $_iLinkType

◆ $_iPriceAlarmStatus