Details Class Reference

Inheritance diagram for Details:

Collaboration diagram for Details:

List of all members.

Public Member Functions
	getNavigationParams ()
	getViewId ()
	render ()
	saveReview ()
	addToRecomm ()
	addTags ()
	editTags ()
	cancelTags ()
	getEditTags ()
	getTags ()
	getProduct ()
	getLinkType ()
	drawParentUrl ()
	getParentName ()
	getParentUrl ()
	getPictureGallery ()
	getActPictureId ()
	getActPicture ()
	getPictures ()
	getArtPic ($sPicNr)
	getSelectLists ()
	getReviews ()
	getCrossSelling ()
	getSimilarProducts ()
	getSimilarRecommListIds ()
	getAccessoires ()
	getAlsoBoughtTheseProducts ()
	isPriceAlarm ()
	getSearchTitle ()
	setSearchTitle ($sTitle)
	setCatTreePath ($sActCatPath)
	noIndex ()
	getTitle ()
	getMetaDescription ()
	getTag ()
	getCanonicalUrl ()
	getBreadCrumb ()
	getCaptcha ()
	addme ()
	getPriceAlarmStatus ()
	getBidPrice ()
	getVariantSelections ()
	getPicturesProduct ()
	getSearchParamForHtml ()
	showRdfa ()
	getRDFaNormalizedRating ()
	getRDFaValidityPeriod ($sShopConfVar)
	getRDFaBusinessFnc ()
	getRDFaCustomers ()
	getRDFaVAT ()
	getRDFaGenericCondition ()
	getBundleArticle ()
	getRDFaPaymentMethods ()
	getRDFaDeliverySetMethods ()
	getProductsDeliveryList ()
	getRDFaDeliveryChargeSpecLoc ()
	getRDFaPaymentChargeSpecLoc ()
	getRDFaBusinessEntityLoc ()
	showRDFaProductStock ()
	canChangeTags ()
	showZoomPics ()
	isReviewActive ()
	getDefaultSorting ()
	getSortingParameters ()
Protected Member Functions
	_getParentProduct ($sParentId)
	_getAddUrlParams ()
	_processProduct ($oProduct)
	_prepareMetaDescription ($sMeta, $iLength=200, $blDescTag=false)
	_prepareMetaKeyword ($sKeywords, $blRemoveDuplicatedWords=true)
	_addTagsToList ($oArticleTagList, $aTags, $aAddedTags)
	_getSeoObjectId ()
	_additionalChecksForArticle ()
	_getSubject ($iLang)
	_getVendorBreadCrumb ()
	_getRecommendationListBredCrumb ()
	_getTagBreadCrumb ()
	_getSearchBreadCrumb ()
	_getCategoryBreadCrumb ()
Protected Attributes
	$_sThisTemplate = 'page/details/details.tpl'
	$_oParentProd = null
	$_blEditTags = null
	$_aTags = null
	$_oCaptcha = 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).

Definition at line 9 of file details.php.

---

Member Function Documentation

Details._additionalChecksForArticle

(

)

[protected]

Runs additional checks for article.

Definition at line 662 of file details.php.

Details._addTagsToList	(	$	oArticleTagList,
		$	aTags,
		$	aAddedTags
	)			[protected]

Adds tags to passed oxArticleTagList object

Parameters:

	oxArticleTagList	$oArticleTagList article tags list object
	array	$aTags tags array to add to list
	array	$aAddedTags tags, which are already added to list

Returns:

array

Definition at line 510 of file details.php.

Details._getAddUrlParams

(

)

[protected]

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

Returns:

string | null

Definition at line 194 of file details.php.

Details._getCategoryBreadCrumb

(

)

[protected]

Category bread crumb

Returns:

array

Definition at line 1642 of file details.php.

Details._getParentProduct

(

$

sParentId

)

[protected]

Returns current product parent article object if it is available

Parameters:

string

$sParentId parent product id

Returns:

oxArticle

Definition at line 175 of file details.php.

Details._getRecommendationListBredCrumb

(

)

[protected]

Recommendation list bread crumb

Returns:

array

Definition at line 1575 of file details.php.

Details._getSearchBreadCrumb

(

)

[protected]

Search bread crumb

Returns:

array

Definition at line 1618 of file details.php.

Details._getSeoObjectId

(

)

[protected]

Returns active product id to load its seo meta info

Returns:

string

Reimplemented from oxUBase.

Definition at line 591 of file details.php.

Details._getSubject

(

$

iLang

)

[protected]

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

Parameters:

int

$iLang language id

Returns:

object

Reimplemented from oxUBase.

Definition at line 973 of file details.php.

Details._getTagBreadCrumb

(

)

[protected]

Tag bread crumb

Returns:

array

Definition at line 1591 of file details.php.

Details._getVendorBreadCrumb

(

)

[protected]

Vendor bread crumb

Returns:

array

Definition at line 1550 of file details.php.

Details._prepareMetaDescription	(	$	sMeta,
		$	iLength = 200,
		$	blDescTag = false
	)			[protected]

Returns current view meta data If $sMeta 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	$sMeta user defined description, description content or empty value
	int	$iLength max length of result, -1 for no truncation
	bool	$blDescTag if true - performs additional dublicate cleaning

Returns:

string

Reimplemented from oxUBase.

Definition at line 331 of file details.php.

Details._prepareMetaKeyword	(	$	sKeywords,
		$	blRemoveDuplicatedWords = true
	)			[protected]

Returns current view keywords seperated by comma If $sKeywords 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	$sKeywords user defined keywords, keywords content or empty value
	bool	$blRemoveDuplicatedWords remove dublicated words

Returns:

string

Reimplemented from oxUBase.

Definition at line 360 of file details.php.

Details._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

Definition at line 240 of file details.php.

Details.addme

(

)

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

Returns:

bool false on error

Definition at line 1137 of file details.php.

Details.addTags

(

)

Adds tags from parameter

Returns:

null;

Definition at line 460 of file details.php.

Details.addToRecomm

(

)

Adds article to selected recommendation list

Returns:

null

Definition at line 434 of file details.php.

Details.cancelTags

(

)

Cancels tags editing mode

Definition at line 564 of file details.php.

Details.canChangeTags

(

)

Checks if rating functionality is on and allowed to user

Returns:

bool

Definition at line 1460 of file details.php.

Details.drawParentUrl

(

)

Template variable getter. Returns if draw parent url

Returns:

bool

Definition at line 721 of file details.php.

Details.editTags

(

)

Sets tags editing mode

Returns:

null

Definition at line 536 of file details.php.

Details.getAccessoires

(

)

Template variable getter. Returns accessories of article

Returns:

object

Reimplemented from oxUBase.

Definition at line 920 of file details.php.

Details.getActPicture

(

)

Template variable getter. Returns active picture

Returns:

object

Definition at line 796 of file details.php.

Details.getActPictureId

(

)

Template variable getter. Returns id of active picture

Returns:

string

Reimplemented in MoreDetails.

Definition at line 784 of file details.php.

Details.getAlsoBoughtTheseProducts

(

)

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

Returns:

object

Reimplemented from oxUBase.

Definition at line 937 of file details.php.

Details.getArtPic

(

$

sPicNr

)

Template variable getter. Returns selected picture

Parameters:

string

$sPicNr picture number

Returns:

string

Definition at line 822 of file details.php.

Details.getBidPrice

(

)

Template variable getter. Returns bid price

Returns:

string

Definition at line 1195 of file details.php.

Details.getBreadCrumb

(

)

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

Returns:

array

Reimplemented from oxUBase.

Definition at line 1097 of file details.php.

Details.getBundleArticle

(

)

Returns bundle product

Returns:

object

Definition at line 1360 of file details.php.

Details.getCanonicalUrl

(

)

Returns view canonical url

Returns:

string

Reimplemented from oxUBase.

Definition at line 1074 of file details.php.

Details.getCaptcha

(

)

Template variable getter. Returns object of handling CAPTCHA image

Returns:

object

Definition at line 1119 of file details.php.

Details.getCrossSelling

(

)

Template variable getter. Returns cross selling

Returns:

object

Reimplemented from oxUBase.

Definition at line 868 of file details.php.

Details.getDefaultSorting

(

)

Returns default category sorting for selected category

Returns:

array

Reimplemented from oxUBase.

Definition at line 1515 of file details.php.

Details.getEditTags

(

)

Returns if tags will be edit

Returns:

bool

Reimplemented from oxUBase.

Definition at line 603 of file details.php.

Details.getLinkType

(

)

Returns current view link type

Returns:

int

Definition at line 691 of file details.php.

Details.getMetaDescription

(

)

Template variable getter. Returns meta description

Returns:

string

Reimplemented from oxUBase.

Definition at line 1048 of file details.php.

Details.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

Reimplemented from oxUBase.

Definition at line 209 of file details.php.

Details.getParentName

(

)

Template variable getter. Returns parent article name

Deprecated:

since v5.1.0 (2013-08-06); not used code anymore

Returns:

string

Definition at line 733 of file details.php.

Details.getParentUrl

(

)

Template variable getter. Returns parent article name

Deprecated:

since v5.1.0 (2013-08-06); not used code anymore

Returns:

string

Definition at line 752 of file details.php.

Details.getPictureGallery

(

)

Template variable getter. Returns picture gallery of current article

Returns:

array

Definition at line 769 of file details.php.

Details.getPictures

(

)

Template variable getter. Returns pictures of current article

Returns:

array

Definition at line 808 of file details.php.

Details.getPicturesProduct

(

)

Returns pictures product object

Returns:

oxArticle

Definition at line 1232 of file details.php.

Details.getPriceAlarmStatus

(

)

Return price alarm status (if it was send)

Returns:

integer

Definition at line 1185 of file details.php.

Details.getProduct

(

)

Returns current product

Returns:

oxArticle

Reimplemented from oxUBase.

Reimplemented in MoreDetails.

Definition at line 623 of file details.php.

Details.getProductsDeliveryList

(

)

Template variable getter. Returns delivery list for current product

Returns:

object

Definition at line 1406 of file details.php.

Details.getRDFaBusinessEntityLoc

(

)

Gets content id of company info page (About Us)

Returns:

string

Definition at line 1440 of file details.php.

Details.getRDFaBusinessFnc

(

)

Gets business function of the gr:Offering

Returns:

string

Definition at line 1320 of file details.php.

Details.getRDFaCustomers

(

)

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

Returns:

array

Definition at line 1330 of file details.php.

Details.getRDFaDeliveryChargeSpecLoc

(

)

Gets content id of delivery information page

Returns:

string

Definition at line 1420 of file details.php.

Details.getRDFaDeliverySetMethods

(

)

Returns delivery methods with assigned delivery sets.

Returns:

object

Definition at line 1393 of file details.php.

Details.getRDFaGenericCondition

(

)

Gets a generic description of product condition

Returns:

string

Definition at line 1350 of file details.php.

Details.getRDFaNormalizedRating

(

)

Sets normalized rating

Returns:

array

Definition at line 1271 of file details.php.

Details.getRDFaPaymentChargeSpecLoc

(

)

Gets content id of payments

Returns:

string

Definition at line 1430 of file details.php.

Details.getRDFaPaymentMethods

(

)

Gets accepted payment methods

Returns:

array

Definition at line 1379 of file details.php.

Details.getRDFaValidityPeriod

(

$

sShopConfVar

)

Sets and returns validity period of given object

Parameters:

string

$sShopConfVar object name

Returns:

array

Definition at line 1298 of file details.php.

Details.getRDFaVAT

(

)

Gets information whether prices include vat

Returns:

int

Definition at line 1340 of file details.php.

Details.getReviews

(

)

Template variable getter. Returns reviews of current article

Returns:

array

Reimplemented in Review.

Definition at line 851 of file details.php.

Details.getSearchParamForHtml

(

)

Template variable getter. Returns search parameter for Html

Returns:

string

Reimplemented from oxUBase.

Definition at line 1247 of file details.php.

Details.getSearchTitle

(

)

Returns search title. It will be set in oxLocator

Returns:

string

Definition at line 983 of file details.php.

Details.getSelectLists

(

)

Template variable getter. Returns selectlists of current article

Returns:

array

Definition at line 834 of file details.php.

Details.getSimilarProducts

(

)

Template variable getter. Returns similar article list

Returns:

object

Reimplemented from oxUBase.

Definition at line 885 of file details.php.

Details.getSimilarRecommListIds

(

)

Return array of id to form recommend list.

Returns:

array

Reimplemented from oxUBase.

Definition at line 902 of file details.php.

Details.getSortingParameters

(

)

Returns sorting parameters separated by "|"

Returns:

string

Definition at line 1535 of file details.php.

Details.getTag

(

)

Template variable getter. Returns current tag

Returns:

string

Definition at line 1064 of file details.php.

Details.getTags

(

)

Returns all tags

Returns:

array

Definition at line 613 of file details.php.

Details.getTitle

(

)

Returns current view title. Default is null

Returns:

null

Reimplemented from oxUBase.

Reimplemented in RecommAdd.

Definition at line 1029 of file details.php.

Details.getVariantSelections

(

)

Returns variant selection

Returns:

oxVariantSelectList

Definition at line 1214 of file details.php.

Details.getViewId

(

)

Returns prefix ID used by template engine.

Returns:

string $this->_sViewID view id

Reimplemented from oxUBase.

Reimplemented in Review.

Definition at line 253 of file details.php.

Details.isPriceAlarm

(

)

Template variable getter. Returns if price alarm is disabled

Returns:

object

Definition at line 954 of file details.php.

Details.isReviewActive

(

)

Template variable getter. Returns if review module is on

Returns:

bool

Definition at line 1505 of file details.php.

Details.noIndex

(

)

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

Returns:

int

Reimplemented from oxUBase.

Definition at line 1014 of file details.php.

Details.render

(

)

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

Returns:

string $this->_sThisTemplate current template file name

Reimplemented from oxUBase.

Reimplemented in RecommAdd, and Review.

Definition at line 277 of file details.php.

Details.saveReview

(

)

Saves user ratings and review text (oxReview object)

Returns:

null

Reimplemented in Review.

Definition at line 388 of file details.php.

Details.setCatTreePath

(

$

sActCatPath

)

active category path setter

Parameters:

string

$sActCatPath category tree path

Definition at line 1003 of file details.php.

Details.setSearchTitle

(

$

sTitle

)

Returns search title setter

Parameters:

string

$sTitle search title

Definition at line 993 of file details.php.

Details.showRdfa

(

)

Returns if page has rdfa

Returns:

bool

Reimplemented from oxView.

Definition at line 1261 of file details.php.

Details.showRDFaProductStock

(

)

Returns if to show products left stock

Returns:

string

Definition at line 1450 of file details.php.

Details.showZoomPics

(

)

Template variable getter. Returns if to show zoom pictures

Returns:

bool

Definition at line 1493 of file details.php.

---

Member Data Documentation

Details.$_aAlsoBoughtArts = null [protected]

Definition at line 108 of file details.php.

Details.$_aPicGallery = null [protected]

Definition at line 66 of file details.php.

Details.$_aReviews = null [protected]

Reimplemented in Review.

Definition at line 80 of file details.php.

Details.$_aSelectLists = null [protected]

Definition at line 73 of file details.php.

Details.$_aSimilarRecommListIds = null [protected]

Definition at line 158 of file details.php.

Details.$_aTags = null [protected]

Definition at line 38 of file details.php.

Details.$_blEditTags = null [protected]

Definition at line 31 of file details.php.

Details.$_blIsInitialized = false [protected]

Definition at line 123 of file details.php.

Details.$_blShowSorting = true [protected]

Reimplemented from oxUBase.

Definition at line 166 of file details.php.

Details.$_iLinkType = null [protected]

Definition at line 130 of file details.php.

Details.$_iPriceAlarmStatus = null [protected]

Definition at line 144 of file details.php.

Details.$_oAccessoires = null [protected]

Definition at line 101 of file details.php.

Details.$_oCaptcha = null [protected]

Definition at line 45 of file details.php.

Details.$_oCrossSelling = null [protected]

Reimplemented in Review.

Definition at line 87 of file details.php.

Details.$_oParentProd = null [protected]

Definition at line 24 of file details.php.

Details.$_oSimilarProducts = null [protected]

Reimplemented in Review.

Definition at line 94 of file details.php.

Details.$_sBidPrice = null [protected]

Definition at line 137 of file details.php.

Details.$_sParentName = null [protected]

Definition at line 52 of file details.php.

Details.$_sParentUrl = null [protected]

Definition at line 59 of file details.php.

Details.$_sSearchParamForHtml = null [protected]

Definition at line 151 of file details.php.

Details.$_sSearchTitle = null [protected]

Definition at line 115 of file details.php.

Details.$_sThisTemplate = 'page/details/details.tpl' [protected]

Reimplemented from oxView.

Reimplemented in MoreDetails, RecommAdd, and Review.

Definition at line 17 of file details.php.

---

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

• application/controllers/details.php