Public Member Functions | Protected Member Functions | Protected Attributes

Details Class Reference

Inheritance diagram for Details:
Collaboration diagram for Details:

List of all members.

Public Member Functions

 loadVariantInformation ()
 getViewId ()
 render ()
 ratingIsActive ()
 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 ()
 getSimilarRecommListIds ()
 getAccessoires ()
 getAlsoBoughtTheseProducts ()
 isPriceAlarm ()
 getSearchTitle ()
 setSearchTitle ($sTitle)
 setCatTreePath ($sActCatPath)
 noIndex ()
 getTitle ()
 getTag ()
 getCanonicalUrl ()
 isMdVariantView ()
 isPersParam ()
 getTagSeparator ()
 getRatingValue ()
 isReviewActive ()
 getRatingCount ()
 getBreadCrumb ()
 addme ()
 getPriceAlarmStatus ()
 getBidPrice ()
 getVariantSelections ()
 getPicturesProduct ()
 getSearchParamForHtml ()
 showRdfa ()
 getRDFaNormalizedRating ()
 getRDFaValidityPeriod ($sShopConfVar)
 getRDFaBusinessFnc ()
 getRDFaCustomers ()
 getRDFaVAT ()
 getRDFaGenericCondition ()
 getBundleArticle ()
 getRDFaPaymentMethods ()
 getRDFaDeliverySetMethods ()
 getProductsDeliveryList ()
 getRDFaDeliveryChargeSpecLoc ()
 getRDFaPaymentChargeSpecLoc ()
 getRDFaBusinessEntityLoc ()
 showRDFaProductStock ()
 getDefaultSorting ()

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
 $_sBidPrice = null
 $_iPriceAlarmStatus = null
 $_sSearchParamForHtml = null
 $_aSimilarRecommListIds = 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 301 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 243 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 665 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 1244 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 404 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 432 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 315 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 1510 of file details.php.

Details.addTags (  ) 

Adds tags from parameter

Returns:
null;

Definition at line 568 of file details.php.

Details.addToRecomm (  ) 

Adds article to selected recommendation list

Returns:
null

Definition at line 546 of file details.php.

Details.cancelTags (  ) 

Cancels tags editing mode

Returns:
null

Definition at line 641 of file details.php.

Details.canChangeTags (  ) 

Checks if rating functionality is on and allowed to user

Returns:
bool

Definition at line 491 of file details.php.

Details.canRate (  ) 

Checks if rating functionality is on and allowed to user

Returns:
bool

Reimplemented in Review.

Definition at line 470 of file details.php.

Details.drawParentUrl (  ) 

Template variable getter. Returns if draw parent url

Returns:
bool

Definition at line 957 of file details.php.

Details.editTags (  ) 

Sets tags editing mode

Returns:
null

Definition at line 614 of file details.php.

Details.getAccessoires (  ) 

Template variable getter. Returns accessories of article

Returns:
object

Reimplemented from oxUBase.

Definition at line 1194 of file details.php.

Details.getActPicture (  ) 

Template variable getter. Returns active picture

Returns:
object

Definition at line 1024 of file details.php.

Details.getActPictureId (  ) 

Template variable getter. Returns id of active picture

Returns:
string

Reimplemented in MoreDetails.

Definition at line 1013 of file details.php.

Details.getActZoomPic (  ) 

Template variable getter. Returns active zoom picture id

Returns:
array

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

Details.getArtPic ( $  sPicNr  ) 

Template variable getter. Returns selected picture

Parameters:
string $sPicNr picture number
Returns:
string

Definition at line 1059 of file details.php.

Details.getAttributes (  ) 

loading full list of attributes

Returns:
array $_aAttributes

Definition at line 677 of file details.php.

Details.getBidPrice (  ) 

Template variable getter. Returns bid price

Returns:
string

Definition at line 1566 of file details.php.

Details.getBreadCrumb (  ) 

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

Returns:
array

Reimplemented from oxUBase.

Definition at line 1432 of file details.php.

Details.getBundleArticle (  ) 

Returns bundle product

Returns:
object

Definition at line 1723 of file details.php.

Details.getCanonicalUrl (  ) 

Returns view canonical url

Returns:
string

Reimplemented from oxUBase.

Definition at line 1326 of file details.php.

Details.getCaptcha (  ) 

Template variable getter. Returns object of handling CAPTCHA image

Returns:
object

Definition at line 870 of file details.php.

Details.getCategory (  ) 

Template variable getter. Returns product's root category

Returns:
object

Definition at line 944 of file details.php.

Details.getCrossSelling (  ) 

Template variable getter. Returns crosssellings

Returns:
object

Reimplemented from oxUBase.

Definition at line 1145 of file details.php.

Details.getDefaultSorting (  ) 

Returns default category sorting for selected category

Returns:
array

Reimplemented from oxUBase.

Definition at line 1817 of file details.php.

Details.getEditTags (  ) 

Returns if tags will be edit

Returns:
bool

Reimplemented from oxUBase.

Definition at line 703 of file details.php.

Details.getIcons (  ) 

Template variable getter. Returns icons of current article

Returns:
array

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

Details.getLinkType (  ) 

Returns current view link type

Returns:
int

Definition at line 810 of file details.php.

Details.getManufacturer (  ) 

Template variable getter. Returns product's vendor

Returns:
object

Definition at line 931 of file details.php.

Details.getMediaFiles (  ) 

Template variable getter. Returns media files of current product

Returns:
array

Definition at line 883 of file details.php.

Details.getParentName (  ) 

Template variable getter. Returns parent article name

Returns:
string

Definition at line 967 of file details.php.

Details.getParentUrl (  ) 

Template variable getter. Returns parent article name

Returns:
string

Definition at line 983 of file details.php.

Details.getPictureGallery (  ) 

Template variable getter. Returns picture gallery of current article

Returns:
array

Definition at line 999 of file details.php.

Details.getPictures (  ) 

Template variable getter. Returns pictures of current article

Returns:
array

Definition at line 1046 of file details.php.

Details.getPicturesProduct (  ) 

Returns pictures product object

Returns:
oxArticle

Definition at line 1600 of file details.php.

Details.getPriceAlarmStatus (  ) 

Return price alarm status (if it was send)

Returns:
integer

Definition at line 1556 of file details.php.

Details.getProduct (  ) 

Returns current product

Returns:
oxarticle

Reimplemented from oxUBase.

Reimplemented in MoreDetails.

Definition at line 753 of file details.php.

Details.getProductsDeliveryList (  ) 

Template variable getter. Returns delivery list for current product

Returns:
object

Definition at line 1764 of file details.php.

Details.getRatingCount (  ) 

Template variable getter. Returns rating count

Returns:
integer

Definition at line 1416 of file details.php.

Details.getRatingValue (  ) 

Template variable getter. Returns rating value

Returns:
double

Definition at line 1388 of file details.php.

Details.getRDFaBusinessEntityLoc (  ) 

Gets content id of company info page (About Us)

Returns:
string

Definition at line 1797 of file details.php.

Details.getRDFaBusinessFnc (  ) 

Gets business function of the gr:Offering

Returns:
string

Definition at line 1683 of file details.php.

Details.getRDFaCustomers (  ) 

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

Returns:
array

Definition at line 1693 of file details.php.

Details.getRDFaDeliveryChargeSpecLoc (  ) 

Gets content id of delivery information page

Returns:
string

Definition at line 1777 of file details.php.

Details.getRDFaDeliverySetMethods (  ) 

Returns delivery methods with assigned deliverysets.

Returns:
object

Definition at line 1752 of file details.php.

Details.getRDFaGenericCondition (  ) 

Gets a generic description of product condition

Returns:
string

Definition at line 1713 of file details.php.

Details.getRDFaNormalizedRating (  ) 

Sets normalized rating

Returns:
array

Definition at line 1637 of file details.php.

Details.getRDFaPaymentChargeSpecLoc (  ) 

Gets content id of payments

Returns:
string

Definition at line 1787 of file details.php.

Details.getRDFaPaymentMethods (  ) 

Gets accepted payment methods

Returns:
array

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

Details.getRDFaVAT (  ) 

Gets information whether prices include vat

Returns:
int

Definition at line 1703 of file details.php.

Details.getReviews (  ) 

Template variable getter. Returns reviews of current article

Returns:
array

Reimplemented in Review.

Definition at line 1129 of file details.php.

Details.getSearchParamForHtml (  ) 

Template variable getter. Returns search parameter for Html

Returns:
string

Reimplemented from oxUBase.

Definition at line 1614 of file details.php.

Details.getSearchTitle (  ) 

Returns search title. It will be setted in oxLocator

Returns:
string

Definition at line 1254 of file details.php.

Details.getSelectLists (  ) 

Template variable getter. Returns selectlists of current article

Returns:
array

Definition at line 1113 of file details.php.

Details.getSimilarProducts (  ) 

Template variable getter. Returns similar article list

Returns:
object

Reimplemented from oxUBase.

Definition at line 1161 of file details.php.

Details.getSimilarRecommListIds (  ) 

Return array of id to form recommend list.

Returns:
array

Reimplemented from oxUBase.

Definition at line 1177 of file details.php.

Details.getTag (  ) 

Template variable getter. Returns current tag

Returns:
string

Definition at line 1316 of file details.php.

Details.getTagCloudManager (  ) 

Returns tag cloud manager class

Returns:
oxTagCloud

Definition at line 723 of file details.php.

Details.getTags (  ) 

Returns all tags

Returns:
array

Definition at line 713 of file details.php.

Details.getTagSeparator (  ) 

Returns tag separator

Returns:
string

Definition at line 1377 of file details.php.

Details.getTitle (  ) 

Returns current view title. Default is null

Returns:
null

Reimplemented from oxUBase.

Definition at line 1303 of file details.php.

Details.getVariantList (  ) 

Returns variant lists of current product

Returns:
array

Definition at line 840 of file details.php.

Details.getVariantListExceptCurrent (  ) 

Returns variant lists of current product excludes currently viewed product

Returns:
array

Definition at line 851 of file details.php.

Details.getVariantSelections (  ) 

Returns variant selection

Returns:
oxVariantSelectList

Definition at line 1584 of file details.php.

Details.getVendor (  ) 

Template variable getter. Returns product's vendor

Returns:
object

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

Details.getZoomPics (  ) 

Template variable getter. Returns zoom pictures

Returns:
array

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

Details.isMdVariantView (  ) 

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

Returns:
bool

Definition at line 1348 of file details.php.

Details.isPersParam (  ) 

Checks should persistent parameter input field be displayed

Returns:
bool

Definition at line 1366 of file details.php.

Details.isPriceAlarm (  ) 

Template variable getter. Returns if price alarm is disabled

Returns:
object

Definition at line 1226 of file details.php.

Details.isReviewActive (  ) 

Template variable getter. Returns if review module is on

Returns:
bool

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

Details.morePics (  ) 

Template variable getter. Returns true if there more pictures

Returns:
bool

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

Details.ratingIsActive (  ) 

Checks if rating functionality is active

Returns:
bool

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

Details.saveReview (  ) 

Saves user ratings and review text (oxReview object)

Returns:
null

Reimplemented in Review.

Definition at line 505 of file details.php.

Details.setCatTreePath ( $  sActCatPath  ) 

active category path setter

Parameters:
string $sActCatPath category tree path
Returns:
string

Definition at line 1278 of file details.php.

Details.setSearchTitle ( $  sTitle  ) 

Returns search title setter

Parameters:
string $sTitle search title
Returns:
null

Definition at line 1266 of file details.php.

Details.showRdfa (  ) 

Returns if page has rdfa

Returns:
bool

Reimplemented from oxView.

Definition at line 1627 of file details.php.

Details.showRDFaProductStock (  ) 

Returns if to show products left stock

Returns:
string

Definition at line 1807 of file details.php.

Details.showZoomPics (  ) 

Template variable getter. Returns if to show zoom pictures

Returns:
bool

Definition at line 1081 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.$_aSimilarRecommListIds = null [protected]

Definition at line 233 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.$_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 220 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 214 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 226 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 MoreDetails, RecommAdd, and Review.

Definition at line 23 of file details.php.

The documentation for this class was generated from the following file:
Generated by  doxygen 1.7.1