Details Class Reference

Inheritance diagram for Details:

[legend]

Collaboration diagram for Details:

[legend]

List of all members.

---

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 10 of file details.php.

Public Member Functions
	loadVariantInformation ()
	getViewId ()
	getViewResetId ()
	init ()
	render ()
	canRate ()
	saveReview ()
	showLogin ()
	addToRecomm ()
	addTags ()
	editTags ()
	getAttributes ()
	getEditTags ()
	getTags ()
	getTagCloud ()
	getLoginFormAnchor ()
	getProduct ()
	getVariantList ()
	getCaptcha ()
	getMediaFiles ()
	getLastProducts ()
	getVendor ()
	getCategory ()
	drawParentUrl ()
	getParentName ()
	getParentUrl ()
	getPictureGallery ()
	getActPictureId ()
	getActPicture ()
	morePics ()
	getPictures ()
	getArtPic ($sPicNr)
	getIcons ()
	showZoomPics ()
	getZoomPics ()
	getActZoomPic ()
	getSelectLists ()
	getReviews ()
	getCrossSelling ()
	getSimilarProducts ()
	getSimilarRecommLists ()
	getAccessoires ()
	getAlsoBoughtThiesProducts ()
	isPriceAlarm ()
	getSearchTitle ()
	setSearchTitle ($sTitle)
	setCatTreePath ($sActCatPath)
	noIndex ()
	getTitle ()
Protected Member Functions
	_getParentProduct ($sParentId)
	_getSeoObjectId ()
	getSubject ()
Protected Attributes
	$_aVariantList = array()
	$_sThisTemplate = 'details.tpl'
	$_oParent = null
	$_blCanRate = null
	$_blShowSorting = true
	$_blEditTags = null
	$_aTags = null
	$_sTagCloud = null
	$_aUserRecommList = null
	$_sLoginFormAnchor = null
	$_oCaptcha = null
	$_aMediaFiles = null
	$_aLastProducts = null
	$_oVendor = 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

---

Member Function Documentation

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 185 of file details.php.

Details.loadVariantInformation

(

)

loading full list of variants, if we are child and do not have any variants then please load all parent variants as ours

Returns:

null

Definition at line 203 of file details.php.

Details.getViewId

(

)

Returns prefix ID used by template engine.

Returns:

string $this->_sViewID view id

Reimplemented from oxView.

Definition at line 239 of file details.php.

Details.getViewResetId

(

)

Returns view reset id

Returns:

string

Reimplemented from oxView.

Definition at line 256 of file details.php.

Details.init

(

)

Executes parent method parent.init() and newly loads article object if users language was changed.

Returns:

null

Reimplemented from oxUBase.

Definition at line 273 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

Template variables: product, ispricealarm, reviews, crossselllist, accessoirelist, similarlist, customerwho, variants, amountprice, selectlist, sugsucc, meta_description, meta_keywords, blMorePic, parent_url, draw_parent_url, parentname, sBackUrl, allartattr, sSearchTitle

Returns:

string $this->_sThisTemplate current template file name

Reimplemented from oxUBase.

Reimplemented in RecommAdd.

Definition at line 344 of file details.php.

Details.canRate

(

)

Checks if rating runctionality is on and allwed to user

Returns:

bool

Definition at line 438 of file details.php.

Details.saveReview

(

)

Saves user ratings and review text (oxreview object)

Returns:

null

Definition at line 460 of file details.php.

Details.showLogin

(

)

Show login template

Returns:

null

Definition at line 504 of file details.php.

Details.addToRecomm

(

)

Adds article to selected recommlist

Returns:

null

Definition at line 518 of file details.php.

Details.addTags

(

)

Adds tag from parameter

Returns:

null;

Definition at line 536 of file details.php.

Details.editTags

(

)

Definition at line 548 of file details.php.

Details._getSeoObjectId

(

)

[protected]

Returns active product id to load its seo meta info

Returns:

string

Reimplemented from oxView.

Definition at line 560 of file details.php.

Details.getAttributes

(

)

loading full list of attributes

Returns:

array $_aAttributes

Definition at line 572 of file details.php.

Details.getEditTags

(

)

Returns if tags will be edit

Returns:

bool

Reimplemented from oxView.

Definition at line 598 of file details.php.

Details.getTags

(

)

Returns all tags

Returns:

array

Definition at line 608 of file details.php.

Details.getTagCloud

(

)

Returns tag cloud

Returns:

string

Definition at line 618 of file details.php.

Details.getLoginFormAnchor

(

)

Returns login form anchor

Returns:

array

Definition at line 634 of file details.php.

Details.getProduct

(

)

Returns current product

Returns:

object

Reimplemented from oxUBase.

Definition at line 644 of file details.php.

Details.getVariantList

(

)

Returns variant lists of current product

Returns:

array

Definition at line 654 of file details.php.

Details.getCaptcha

(

)

Template variable getter. Returns object of handling CAPTCHA image

Returns:

object

Definition at line 664 of file details.php.

Details.getMediaFiles

(

)

Template variable getter. Returns media files of current product

Returns:

array

Definition at line 677 of file details.php.

Details.getLastProducts

(

)

Template variable getter. Returns last seen products

Returns:

array

Definition at line 691 of file details.php.

Details.getVendor

(

)

Template variable getter. Returns product's vendor

Returns:

object

Definition at line 709 of file details.php.

Details.getCategory

(

)

Template variable getter. Returns product's root category

Returns:

object

Definition at line 726 of file details.php.

Details.drawParentUrl

(

)

Template variable getter. Returns if draw parent url

Returns:

bool

Definition at line 740 of file details.php.

Details.getParentName

(

)

Template variable getter. Returns parent article name

Returns:

string

Definition at line 754 of file details.php.

Details.getParentUrl

(

)

Template variable getter. Returns parent article name

Returns:

string

Definition at line 770 of file details.php.

Details.getPictureGallery

(

)

Template variable getter. Returns picture galery of current article

Returns:

array

Definition at line 786 of file details.php.

Details.getActPictureId

(

)

Template variable getter. Returns id of active picture

Returns:

string

Definition at line 801 of file details.php.

Details.getActPicture

(

)

Template variable getter. Returns active picture

Returns:

object

Definition at line 812 of file details.php.

Details.morePics

(

)

Template variable getter. Returns true if there more pictures

Returns:

bool

Definition at line 823 of file details.php.

Details.getPictures

(

)

Template variable getter. Returns pictures of current article

Returns:

array

Definition at line 834 of file details.php.

Details.getArtPic

(

$

sPicNr

)

Template variable getter. Returns selected picture

Parameters:

string

$sPicNr

Returns:

string

Definition at line 847 of file details.php.

Details.getIcons

(

)

Template variable getter. Returns icons of current article

Returns:

array

Definition at line 858 of file details.php.

Details.showZoomPics

(

)

Template variable getter. Returns if to show zoom pictures

Returns:

bool

Definition at line 869 of file details.php.

Details.getZoomPics

(

)

Template variable getter. Returns zoom pictures

Returns:

array

Definition at line 880 of file details.php.

Details.getActZoomPic

(

)

Template variable getter. Returns active zoom picture id

Returns:

array

Definition at line 891 of file details.php.

Details.getSelectLists

(

)

Template variable getter. Returns selectlists of current article

Returns:

array

Definition at line 901 of file details.php.

Details.getReviews

(

)

Template variable getter. Returns reviews of current article

Returns:

array

Definition at line 917 of file details.php.

Details.getCrossSelling

(

)

Template variable getter. Returns crosssellings

Returns:

object

Reimplemented from oxView.

Definition at line 934 of file details.php.

Details.getSimilarProducts

(

)

Template variable getter. Returns similar article list

Returns:

object

Reimplemented from oxView.

Definition at line 950 of file details.php.

Details.getSimilarRecommLists

(

)

Template variable getter. Returns recommlists

Returns:

object

Reimplemented from oxView.

Definition at line 966 of file details.php.

Details.getAccessoires

(

)

Template variable getter. Returns accessoires of article

Returns:

object

Reimplemented from oxView.

Definition at line 983 of file details.php.

Details.getAlsoBoughtThiesProducts

(

)

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

Returns:

object

Reimplemented from oxView.

Definition at line 999 of file details.php.

Details.isPriceAlarm

(

)

Template variable getter. Returns if pricealarm is disabled

Returns:

object

Definition at line 1015 of file details.php.

Details.getSubject

(

)

[protected]

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

Returns:

object

Reimplemented from oxView.

Definition at line 1030 of file details.php.

Details.getSearchTitle

(

)

Returns search title. It will be setted in oxlocator

Returns:

string

Definition at line 1040 of file details.php.

Details.setSearchTitle

(

$

sTitle

)

Returns search title setter

Parameters:

string

$sTitle

Returns:

null

Definition at line 1052 of file details.php.

Details.setCatTreePath

(

$

sActCatPath

)

active category path setter

Parameters:

string

$sActCatPath

Returns:

string

Definition at line 1064 of file details.php.

Details.noIndex

(

)

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

Returns:

int

Reimplemented from oxView.

Definition at line 1075 of file details.php.

Details.getTitle

(

)

Returns current view title. Default is null

Returns:

null

Reimplemented from oxView.

Definition at line 1088 of file details.php.

---

Member Data Documentation

Details.$_aVariantList = array() [protected]

Definition at line 17 of file details.php.

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

Reimplemented from oxView.

Reimplemented in RecommAdd.

Definition at line 24 of file details.php.

Details.$_oParent = null [protected]

Reimplemented from oxView.

Definition at line 31 of file details.php.

Details.$_blCanRate = null [protected]

Definition at line 38 of file details.php.

Details.$_blShowSorting = true [protected]

Reimplemented from oxView.

Definition at line 44 of file details.php.

Details.$_blEditTags = null [protected]

Definition at line 50 of file details.php.

Details.$_aTags = null [protected]

Definition at line 56 of file details.php.

Details.$_sTagCloud = null [protected]

Definition at line 62 of file details.php.

Details.$_aUserRecommList = null [protected]

Reimplemented in RecommAdd.

Definition at line 68 of file details.php.

Details.$_sLoginFormAnchor = null [protected]

Definition at line 74 of file details.php.

Details.$_oCaptcha = null [protected]

Definition at line 80 of file details.php.

Details.$_aMediaFiles = null [protected]

Definition at line 86 of file details.php.

Details.$_aLastProducts = null [protected]

Definition at line 92 of file details.php.

Details.$_oVendor = null [protected]

Definition at line 98 of file details.php.

Details.$_oCategory = null [protected]

Definition at line 104 of file details.php.

Details.$_aAttributes = null [protected]

Definition at line 110 of file details.php.

Details.$_sParentName = null [protected]

Definition at line 116 of file details.php.

Details.$_sParentUrl = null [protected]

Definition at line 122 of file details.php.

Details.$_aPicGallery = null [protected]

Definition at line 128 of file details.php.

Details.$_aSelectLists = null [protected]

Definition at line 134 of file details.php.

Details.$_aReviews = null [protected]

Definition at line 140 of file details.php.

Details.$_oCrossSelling = null [protected]

Definition at line 146 of file details.php.

Details.$_oSimilarProducts = null [protected]

Definition at line 152 of file details.php.

Details.$_oRecommList = null [protected]

Definition at line 158 of file details.php.

Details.$_oAccessoires = null [protected]

Definition at line 164 of file details.php.

Details.$_aAlsoBoughtArts = null [protected]

Definition at line 170 of file details.php.

Details.$_sSearchTitle = null [protected]

Definition at line 176 of file details.php.

---

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

• views/details.php