Details Class Reference

Inheritance diagram for Details:

Inheritance graph
[legend]
Collaboration diagram for Details:

Collaboration graph
[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 9 of file details.php.


Public Member Functions

 loadVariantInformation ()
 getViewId ()
 init ()
 render ()
 canRate ()
 saveReview ()
 showLogin ()
 addToRecomm ()
 addTags ()
 editTags ()
 getAttributes ()
 getEditTags ()
 getTags ()
 getTagCloud ()
 getLoginFormAnchor ()
 getProduct ()
 getVariantList ()
 getCaptcha ()
 getMediaFiles ()
 getLastProducts ()
 getVendor ()
 getManufacturer ()
 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)
 _prepareMetaDescription ($sMeta, $iLength=200, $blDescTag=false)
 _prepareMetaKeyword ($sKeywords)
 _getSeoObjectId ()
 _setLinkType ($oProduct, $iListType=null)
 _getSubject ()

Protected Attributes

 $_aVariantList = null
 $_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
 $_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

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

Details.getViewId (  ) 

Returns prefix ID used by template engine.

Returns:
string $this->_sViewID view id

Reimplemented from oxUBase.

Definition at line 260 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 279 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 314 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 category path
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 407 of file details.php.

Details._prepareMetaKeyword ( $  sKeywords  )  [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 data to use as keywords
Returns:
string

Reimplemented from oxUBase.

Definition at line 429 of file details.php.

Details.canRate (  ) 

Checks if rating runctionality is on and allwed to user

Returns:
bool

Definition at line 449 of file details.php.

Details.saveReview (  ) 

Saves user ratings and review text (oxreview object)

Returns:
null

Definition at line 471 of file details.php.

Details.showLogin (  ) 

Show login template

Returns:
null

Definition at line 517 of file details.php.

Details.addToRecomm (  ) 

Adds article to selected recommlist

Returns:
null

Definition at line 530 of file details.php.

Details.addTags (  ) 

Adds tag from parameter

Returns:
null;

Definition at line 548 of file details.php.

Details.editTags (  ) 

Sets tags editing mode

Returns:
null

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

Details.getAttributes (  ) 

loading full list of attributes

Returns:
array $_aAttributes

Definition at line 590 of file details.php.

Details.getEditTags (  ) 

Returns if tags will be edit

Returns:
bool

Reimplemented from oxUBase.

Definition at line 616 of file details.php.

Details.getTags (  ) 

Returns all tags

Returns:
array

Definition at line 626 of file details.php.

Details.getTagCloud (  ) 

Returns tag cloud

Returns:
string

Definition at line 636 of file details.php.

Details.getLoginFormAnchor (  ) 

Returns login form anchor

Returns:
array

Definition at line 652 of file details.php.

Details.getProduct (  ) 

Returns current product

Returns:
oxarticle

Reimplemented from oxUBase.

Definition at line 662 of file details.php.

Details._setLinkType ( $  oProduct,
$  iListType = null 
) [protected]

Sets link type for product

Parameters:
oxarticle $oProduct product to set link type
int $iListType list type [optional]
Returns:
null

Definition at line 707 of file details.php.

Details.getVariantList (  ) 

Returns variant lists of current product

Returns:
array

Definition at line 726 of file details.php.

Details.getCaptcha (  ) 

Template variable getter. Returns object of handling CAPTCHA image

Returns:
object

Definition at line 736 of file details.php.

Details.getMediaFiles (  ) 

Template variable getter. Returns media files of current product

Returns:
array

Definition at line 749 of file details.php.

Details.getLastProducts (  ) 

Template variable getter. Returns last seen products

Returns:
array

Definition at line 763 of file details.php.

Details.getVendor (  ) 

Template variable getter. Returns product's vendor

Returns:
object

Definition at line 782 of file details.php.

Details.getManufacturer (  ) 

Template variable getter. Returns product's vendor

Returns:
object

Definition at line 795 of file details.php.

Details.getCategory (  ) 

Template variable getter. Returns product's root category

Returns:
object

Definition at line 808 of file details.php.

Details.drawParentUrl (  ) 

Template variable getter. Returns if draw parent url

Returns:
bool

Definition at line 821 of file details.php.

Details.getParentName (  ) 

Template variable getter. Returns parent article name

Returns:
string

Definition at line 835 of file details.php.

Details.getParentUrl (  ) 

Template variable getter. Returns parent article name

Returns:
string

Definition at line 851 of file details.php.

Details.getPictureGallery (  ) 

Template variable getter. Returns picture galery of current article

Returns:
array

Definition at line 867 of file details.php.

Details.getActPictureId (  ) 

Template variable getter. Returns id of active picture

Returns:
string

Definition at line 881 of file details.php.

Details.getActPicture (  ) 

Template variable getter. Returns active picture

Returns:
object

Definition at line 892 of file details.php.

Details.morePics (  ) 

Template variable getter. Returns true if there more pictures

Returns:
bool

Definition at line 903 of file details.php.

Details.getPictures (  ) 

Template variable getter. Returns pictures of current article

Returns:
array

Definition at line 914 of file details.php.

Details.getArtPic ( $  sPicNr  ) 

Template variable getter. Returns selected picture

Parameters:
string $sPicNr picture number
Returns:
string

Definition at line 927 of file details.php.

Details.getIcons (  ) 

Template variable getter. Returns icons of current article

Returns:
array

Definition at line 938 of file details.php.

Details.showZoomPics (  ) 

Template variable getter. Returns if to show zoom pictures

Returns:
bool

Definition at line 949 of file details.php.

Details.getZoomPics (  ) 

Template variable getter. Returns zoom pictures

Returns:
array

Definition at line 960 of file details.php.

Details.getActZoomPic (  ) 

Template variable getter. Returns active zoom picture id

Returns:
array

Definition at line 971 of file details.php.

Details.getSelectLists (  ) 

Template variable getter. Returns selectlists of current article

Returns:
array

Definition at line 981 of file details.php.

Details.getReviews (  ) 

Template variable getter. Returns reviews of current article

Returns:
array

Definition at line 997 of file details.php.

Details.getCrossSelling (  ) 

Template variable getter. Returns crosssellings

Returns:
object

Reimplemented from oxUBase.

Definition at line 1013 of file details.php.

Details.getSimilarProducts (  ) 

Template variable getter. Returns similar article list

Returns:
object

Reimplemented from oxUBase.

Definition at line 1029 of file details.php.

Details.getSimilarRecommLists (  ) 

Template variable getter. Returns recommlists

Returns:
object

Reimplemented from oxUBase.

Definition at line 1045 of file details.php.

Details.getAccessoires (  ) 

Template variable getter. Returns accessoires of article

Returns:
object

Reimplemented from oxUBase.

Definition at line 1062 of file details.php.

Details.getAlsoBoughtThiesProducts (  ) 

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

Returns:
object

Reimplemented from oxUBase.

Definition at line 1078 of file details.php.

Details.isPriceAlarm (  ) 

Template variable getter. Returns if pricealarm is disabled

Returns:
object

Definition at line 1094 of file details.php.

Details._getSubject (  )  [protected]

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

Returns:
object

Reimplemented from oxUBase.

Definition at line 1110 of file details.php.

Details.getSearchTitle (  ) 

Returns search title. It will be setted in oxlocator

Returns:
string

Definition at line 1120 of file details.php.

Details.setSearchTitle ( $  sTitle  ) 

Returns search title setter

Parameters:
string $sTitle search title
Returns:
null

Definition at line 1132 of file details.php.

Details.setCatTreePath ( $  sActCatPath  ) 

active category path setter

Parameters:
string $sActCatPath category tree path
Returns:
string

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

Details.getTitle (  ) 

Returns current view title. Default is null

Returns:
null

Reimplemented from oxUBase.

Definition at line 1169 of file details.php.

Member Data Documentation

Details.$_aVariantList = null [protected]

Definition at line 16 of file details.php.

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

Reimplemented from oxView.

Reimplemented in RecommAdd.

Definition at line 23 of file details.php.

Details.$_oParent = null [protected]

Reimplemented from oxView.

Definition at line 30 of file details.php.

Details.$_blCanRate = null [protected]

Definition at line 37 of file details.php.

Details.$_blShowSorting = true [protected]

Reimplemented from oxUBase.

Definition at line 43 of file details.php.

Details.$_blEditTags = null [protected]

Definition at line 49 of file details.php.

Details.$_aTags = null [protected]

Definition at line 55 of file details.php.

Details.$_sTagCloud = 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.$_sLoginFormAnchor = null [protected]

Definition at line 73 of file details.php.

Details.$_oCaptcha = null [protected]

Definition at line 79 of file details.php.

Details.$_aMediaFiles = null [protected]

Definition at line 85 of file details.php.

Details.$_aLastProducts = null [protected]

Definition at line 91 of file details.php.

Details.$_oVendor = null [protected]

Definition at line 97 of file details.php.

Details.$_oManufacturer = null [protected]

Definition at line 103 of file details.php.

Details.$_oCategory = null [protected]

Definition at line 109 of file details.php.

Details.$_aAttributes = null [protected]

Definition at line 115 of file details.php.

Details.$_sParentName = null [protected]

Definition at line 121 of file details.php.

Details.$_sParentUrl = null [protected]

Definition at line 127 of file details.php.

Details.$_aPicGallery = null [protected]

Definition at line 133 of file details.php.

Details.$_aSelectLists = null [protected]

Definition at line 139 of file details.php.

Details.$_aReviews = null [protected]

Definition at line 145 of file details.php.

Details.$_oCrossSelling = null [protected]

Definition at line 151 of file details.php.

Details.$_oSimilarProducts = null [protected]

Definition at line 157 of file details.php.

Details.$_oRecommList = null [protected]

Definition at line 163 of file details.php.

Details.$_oAccessoires = null [protected]

Definition at line 169 of file details.php.

Details.$_aAlsoBoughtArts = null [protected]

Definition at line 175 of file details.php.

Details.$_sSearchTitle = null [protected]

Definition at line 181 of file details.php.

Details.$_blIsInitialized = false [protected]

Definition at line 188 of file details.php.

The documentation for this class was generated from the following file:
Generated on Wed Apr 22 12:28:21 2009 for OXID eShop CE by  doxygen 1.5.5