Details Class Reference

Inheritance diagram for Details:

Collaboration diagram for Details:

List of all members.

Public Member Functions
	loadVariantInformation ()
	getViewId ()
	render ()
	canRate ()
	canChangeTags ()
	saveReview ()
	addToRecomm ()
	addTags ()
	editTags ()
	cancelTags ()
	getAttributes ()
	getEditTags ()
	getTags ()
	getTagCloudManager ()
	isEditableTags ()
	getProduct ()
	getLinkType ()
	getVariantList ()
	getVariantListExceptCurrent ()
	getCaptcha ()
	getMediaFiles ()
	getLastProducts ($iCnt=4)
	getVendor ()
	getManufacturer ()
	getCategory ()
	drawParentUrl ()
	getParentName ()
	getParentUrl ()
	getPictureGallery ()
	getActPictureId ()
	getActPicture ()
	morePics ()
	getPictures ()
	getArtPic ($sPicNr)
	getIcons ()
	showZoomPics ()
	getZoomPics ()
	getActZoomPic ()
	getSelectLists ()
	getReviews ()
	getCrossSelling ()
	getSimilarProducts ()
	getSimilarRecommLists ()
	getAccessoires ()
	getAlsoBoughtTheseProducts ()
	isPriceAlarm ()
	getSearchTitle ()
	setSearchTitle ($sTitle)
	setCatTreePath ($sActCatPath)
	noIndex ()
	getTitle ()
	getTag ()
	getCanonicalUrl ()
	isMdVariantView ()
	isPersParam ()
	getTagSeparator ()
	getRatingValue ()
	isReviewActive ()
	getRatingCount ()
	getBreadCrumb ()
	addme ()
	getPriceAlarmStatus ()
	getBidPrice ()
	getVariantSelections ()
	getPicturesProduct ()
	isMoreTagsVisible ()
	getSearchParamForHtml ()
Protected Member Functions
	_getParentProduct ($sParentId)
	_getAddUrlParams ()
	_processProduct ($oProduct)
	_prepareMetaDescription ($sMeta, $iLength=200, $blDescTag=false)
	_prepareMetaKeyword ($sKeywords, $blRemoveDuplicatedWords=true)
	_getSeoObjectId ()
	_getSubject ($iLang)
Protected Attributes
	$_aVariantList = null
	$_sThisTemplate = 'page/details/details.tpl'
	$_oParentProd = null
	$_blCanRate = null
	$_blShowSorting = true
	$_blEditTags = null
	$_blCanEditTags = null
	$_aTags = null
	$_aUserRecommList = null
	$_oCaptcha = null
	$_aMediaFiles = null
	$_aLastProducts = null
	$_oVendor = null
	$_oManufacturer = null
	$_oCategory = null
	$_aAttributes = null
	$_sParentName = null
	$_sParentUrl = null
	$_aPicGallery = null
	$_aSelectLists = null
	$_aReviews = null
	$_oCrossSelling = null
	$_oSimilarProducts = null
	$_oRecommList = null
	$_oAccessoires = null
	$_aAlsoBoughtArts = null
	$_sSearchTitle = null
	$_blIsInitialized = false
	$_iLinkType = null
	$_blMdView = null
	$_dRatingValue = null
	$_iRatingCnt = null
	$_blTop5Action = false
	$_sBidPrice = null
	$_iPriceAlarmStatus = null
	$_sSearchParamForHtml = null

---

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._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 297 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 241 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 642 of file details.php.

Details._getSubject

(

$

iLang

)

[protected]

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

Parameters:

int

$iLang language id

Returns:

object

Reimplemented from oxUBase.

Definition at line 1226 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 403 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 426 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

Returns:

null

Definition at line 311 of file details.php.

Details.addme

(

)

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

Returns:

bool false on error

Definition at line 1472 of file details.php.

Details.addTags

(

)

Adds tag from parameter

Returns:

null;

Definition at line 557 of file details.php.

Details.addToRecomm

(

)

Adds article to selected recommlist

Returns:

null

Definition at line 535 of file details.php.

Details.cancelTags

(

)

Cancels tags editing mode

Returns:

null

Definition at line 620 of file details.php.

Details.canChangeTags

(

)

Checks if rating runctionality is on and allwed to user

Returns:

bool

Definition at line 480 of file details.php.

Details.canRate

(

)

Checks if rating runctionality is on and allwed to user

Returns:

bool

Reimplemented in Review.

Definition at line 458 of file details.php.

Details.drawParentUrl

(

)

Template variable getter. Returns if draw parent url

Returns:

bool

Definition at line 935 of file details.php.

Details.editTags

(

)

Sets tags editing mode

Returns:

null

Definition at line 595 of file details.php.

Details.getAccessoires

(

)

Template variable getter. Returns accessoires of article

Returns:

object

Reimplemented from oxUBase.

Definition at line 1176 of file details.php.

Details.getActPicture

(

)

Template variable getter. Returns active picture

Returns:

object

Definition at line 1002 of file details.php.

Details.getActPictureId

(

)

Template variable getter. Returns id of active picture

Returns:

string

Definition at line 991 of file details.php.

Details.getActZoomPic

(

)

Template variable getter. Returns active zoom picture id

Returns:

array

Definition at line 1081 of file details.php.

Details.getAlsoBoughtTheseProducts

(

)

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

Returns:

object

Reimplemented from oxUBase.

Definition at line 1192 of file details.php.

Details.getArtPic

(

$

sPicNr

)

Template variable getter. Returns selected picture

Parameters:

string

$sPicNr picture number

Returns:

string

Definition at line 1037 of file details.php.

Details.getAttributes

(

)

loading full list of attributes

Returns:

array $_aAttributes

Definition at line 654 of file details.php.

Details.getBidPrice

(

)

Template variable getter. Returns bid price

Returns:

string

Definition at line 1528 of file details.php.

Details.getBreadCrumb

(

)

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

Returns:

array

Reimplemented from oxUBase.

Definition at line 1410 of file details.php.

Details.getCanonicalUrl

(

)

Returns view canonical url

Returns:

string

Reimplemented from oxUBase.

Definition at line 1308 of file details.php.

Details.getCaptcha

(

)

Template variable getter. Returns object of handling CAPTCHA image

Returns:

object

Definition at line 848 of file details.php.

Details.getCategory

(

)

Template variable getter. Returns product's root category

Returns:

object

Definition at line 922 of file details.php.

Details.getCrossSelling

(

)

Template variable getter. Returns crosssellings

Returns:

object

Reimplemented from oxUBase.

Definition at line 1123 of file details.php.

Details.getEditTags

(

)

Returns if tags will be edit

Returns:

bool

Reimplemented from oxUBase.

Definition at line 680 of file details.php.

Details.getIcons

(

)

Template variable getter. Returns icons of current article

Returns:

array

Definition at line 1048 of file details.php.

Details.getLastProducts

(

$

iCnt = 4

)

Template variable getter. Returns last seen products

Parameters:

int

$iCnt product count

Returns:

array

Definition at line 877 of file details.php.

Details.getLinkType

(

)

Returns current view link type

Returns:

int

Definition at line 788 of file details.php.

Details.getManufacturer

(

)

Template variable getter. Returns product's vendor

Returns:

object

Definition at line 909 of file details.php.

Details.getMediaFiles

(

)

Template variable getter. Returns media files of current product

Returns:

array

Definition at line 861 of file details.php.

Details.getParentName

(

)

Template variable getter. Returns parent article name

Returns:

string

Definition at line 945 of file details.php.

Details.getParentUrl

(

)

Template variable getter. Returns parent article name

Returns:

string

Definition at line 961 of file details.php.

Details.getPictureGallery

(

)

Template variable getter. Returns picture galery of current article

Returns:

array

Definition at line 977 of file details.php.

Details.getPictures

(

)

Template variable getter. Returns pictures of current article

Returns:

array

Definition at line 1024 of file details.php.

Details.getPicturesProduct

(

)

Returns pictures product object

Returns:

oxarticle

Definition at line 1562 of file details.php.

Details.getPriceAlarmStatus

(

)

Return pricealarm status (if it was send)

Returns:

integer

Definition at line 1518 of file details.php.

Details.getProduct

(

)

Returns current product

Returns:

oxarticle

Reimplemented from oxUBase.

Definition at line 730 of file details.php.

Details.getRatingCount

(

)

Template variable getter. Returns rating count

Returns:

integer

Definition at line 1394 of file details.php.

Details.getRatingValue

(

)

Template variable getter. Returns rating value

Returns:

double

Definition at line 1366 of file details.php.

Details.getReviews

(

)

Template variable getter. Returns reviews of current article

Returns:

array

Reimplemented in Review.

Definition at line 1107 of file details.php.

Details.getSearchParamForHtml

(

)

Template variable getter. Returns search parameter for Html

Returns:

string

Reimplemented from oxUBase.

Definition at line 1587 of file details.php.

Details.getSearchTitle

(

)

Returns search title. It will be setted in oxlocator

Returns:

string

Definition at line 1236 of file details.php.

Details.getSelectLists

(

)

Template variable getter. Returns selectlists of current article

Returns:

array

Definition at line 1091 of file details.php.

Details.getSimilarProducts

(

)

Template variable getter. Returns similar article list

Returns:

object

Reimplemented from oxUBase.

Definition at line 1139 of file details.php.

Details.getSimilarRecommLists

(

)

Template variable getter. Returns recommlists

Returns:

object

Reimplemented from oxUBase.

Definition at line 1155 of file details.php.

Details.getTag

(

)

Template variable getter. Returns current tag

Returns:

string

Definition at line 1298 of file details.php.

Details.getTagCloudManager

(

)

Returns tag cloud manager class

Returns:

oxTagCloud

Reimplemented from oxUBase.

Definition at line 700 of file details.php.

Details.getTags

(

)

Returns all tags

Returns:

array

Definition at line 690 of file details.php.

Details.getTagSeparator

(

)

Returns tag separator

Returns:

string

Definition at line 1355 of file details.php.

Details.getTitle

(

)

Returns current view title. Default is null

Returns:

null

Reimplemented from oxUBase.

Definition at line 1285 of file details.php.

Details.getVariantList

(

)

Returns variant lists of current product

Returns:

array

Definition at line 818 of file details.php.

Details.getVariantListExceptCurrent

(

)

Returns variant lists of current product excludes currently viewed product

Returns:

array

Definition at line 829 of file details.php.

Details.getVariantSelections

(

)

Returns variant selection

Returns:

oxVariantSelectList

Definition at line 1546 of file details.php.

Details.getVendor

(

)

Template variable getter. Returns product's vendor

Returns:

object

Definition at line 896 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 324 of file details.php.

Details.getZoomPics

(

)

Template variable getter. Returns zoom pictures

Returns:

array

Definition at line 1070 of file details.php.

Details.isEditableTags

(

)

Returns if tags can be changed, if user is loggen in and product exists.

Returns:

bool

Definition at line 714 of file details.php.

Details.isMdVariantView

(

)

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

Returns:

bool

Definition at line 1326 of file details.php.

Details.isMoreTagsVisible

(

)

Should "More tags" link be visible.

Returns:

bool

Reimplemented from oxUBase.

Definition at line 1577 of file details.php.

Details.isPersParam

(

)

Checks should persistent parametere input field be displayed

Returns:

bool

Definition at line 1344 of file details.php.

Details.isPriceAlarm

(

)

Template variable getter. Returns if pricealarm is disabled

Returns:

object

Definition at line 1208 of file details.php.

Details.isReviewActive

(

)

Template variable getter. Returns if review modul is on

Returns:

bool

Definition at line 1384 of file details.php.

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

null

Definition at line 259 of file details.php.

Details.morePics

(

)

Template variable getter. Returns true if there more pictures

Returns:

bool

Definition at line 1013 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 1271 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 selectlists (oxarticle.GetSelectLists()), prerares 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 348 of file details.php.

Details.saveReview

(

)

Saves user ratings and review text (oxreview object)

Returns:

null

Reimplemented in Review.

Definition at line 494 of file details.php.

Details.setCatTreePath

(

$

sActCatPath

)

active category path setter

Parameters:

string

$sActCatPath category tree path

Returns:

string

Definition at line 1260 of file details.php.

Details.setSearchTitle

(

$

sTitle

)

Returns search title setter

Parameters:

string

$sTitle search title

Returns:

null

Definition at line 1248 of file details.php.

Details.showZoomPics

(

)

Template variable getter. Returns if to show zoom pictures

Returns:

bool

Definition at line 1059 of file details.php.

---

Member Data Documentation

Details.$_aAlsoBoughtArts = null [protected]

Definition at line 169 of file details.php.

Details.$_aAttributes = null [protected]

Definition at line 109 of file details.php.

Details.$_aLastProducts = null [protected]

Definition at line 85 of file details.php.

Details.$_aMediaFiles = null [protected]

Definition at line 79 of file details.php.

Details.$_aPicGallery = null [protected]

Definition at line 127 of file details.php.

Details.$_aReviews = null [protected]

Reimplemented in Review.

Definition at line 139 of file details.php.

Details.$_aSelectLists = null [protected]

Definition at line 133 of file details.php.

Details.$_aTags = null [protected]

Definition at line 61 of file details.php.

Details.$_aUserRecommList = null [protected]

Reimplemented in RecommAdd.

Definition at line 67 of file details.php.

Details.$_aVariantList = null [protected]

Definition at line 16 of file details.php.

Details.$_blCanEditTags = null [protected]

Definition at line 55 of file details.php.

Details.$_blCanRate = null [protected]

Definition at line 37 of file details.php.

Details.$_blEditTags = null [protected]

Definition at line 49 of file details.php.

Details.$_blIsInitialized = false [protected]

Definition at line 182 of file details.php.

Details.$_blMdView = null [protected]

Definition at line 196 of file details.php.

Details.$_blShowSorting = true [protected]

Reimplemented from oxUBase.

Definition at line 43 of file details.php.

Details.$_blTop5Action = false [protected]

Reimplemented from oxUBase.

Definition at line 214 of file details.php.

Details.$_dRatingValue = null [protected]

Definition at line 202 of file details.php.

Details.$_iLinkType = null [protected]

Definition at line 189 of file details.php.

Details.$_iPriceAlarmStatus = null [protected]

Definition at line 226 of file details.php.

Details.$_iRatingCnt = null [protected]

Definition at line 208 of file details.php.

Details.$_oAccessoires = null [protected]

Definition at line 163 of file details.php.

Details.$_oCaptcha = null [protected]

Definition at line 73 of file details.php.

Details.$_oCategory = null [protected]

Definition at line 103 of file details.php.

Details.$_oCrossSelling = null [protected]

Reimplemented in Review.

Definition at line 145 of file details.php.

Details.$_oManufacturer = null [protected]

Definition at line 97 of file details.php.

Details.$_oParentProd = null [protected]

Definition at line 30 of file details.php.

Details.$_oRecommList = null [protected]

Reimplemented in Review.

Definition at line 157 of file details.php.

Details.$_oSimilarProducts = null [protected]

Reimplemented in Review.

Definition at line 151 of file details.php.

Details.$_oVendor = null [protected]

Definition at line 91 of file details.php.

Details.$_sBidPrice = null [protected]

Definition at line 220 of file details.php.

Details.$_sParentName = null [protected]

Definition at line 115 of file details.php.

Details.$_sParentUrl = null [protected]

Definition at line 121 of file details.php.

Details.$_sSearchParamForHtml = null [protected]

Definition at line 232 of file details.php.

Details.$_sSearchTitle = null [protected]

Definition at line 175 of file details.php.

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

Reimplemented from oxView.

Reimplemented in RecommAdd, and Review.

Definition at line 23 of file details.php.

---

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

• views/details.php