Details Class Reference
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._getParentProduct | ( | $ | sParentId | ) | [protected] |
Returns current product parent article object if it is available
- Parameters:
-
string $sParentId parent product id
- Returns:
- oxarticle
Definition at line 211 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 229 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 275 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
- Returns:
- null
Definition at line 289 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 302 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 321 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 356 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 449 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 472 of file details.php.
| Details.canRate | ( | ) |
Checks if rating runctionality is on and allwed to user
- Returns:
- bool
Definition at line 504 of file details.php.
| Details.saveReview | ( | ) |
Saves user ratings and review text (oxreview object)
- Returns:
- null
Definition at line 526 of file details.php.
| Details.showLogin | ( | ) |
Show login template
- Deprecated:
- use link to account page instead (e.g. "cl=account&sourcecl=details"+required parameters)
- Returns:
- null
Definition at line 574 of file details.php.
| Details.addToRecomm | ( | ) |
| Details.addTags | ( | ) |
| Details.editTags | ( | ) |
| Details._getSeoObjectId | ( | ) | [protected] |
Returns active product id to load its seo meta info
- Returns:
- string
Reimplemented from oxUBase.
Definition at line 635 of file details.php.
| Details.getAttributes | ( | ) |
loading full list of attributes
- Returns:
- array $_aAttributes
Definition at line 647 of file details.php.
| Details.getEditTags | ( | ) |
Returns if tags will be edit
- Returns:
- bool
Reimplemented from oxUBase.
Definition at line 673 of file details.php.
| Details.getTags | ( | ) |
| Details.getTagCloud | ( | ) |
| Details.getLoginFormAnchor | ( | ) |
| Details.getProduct | ( | ) |
Returns current product
- Returns:
- oxarticle
Reimplemented from oxUBase.
Definition at line 719 of file details.php.
| Details.getLinkType | ( | ) |
| Details.getVariantList | ( | ) |
| Details.getCaptcha | ( | ) |
Template variable getter. Returns object of handling CAPTCHA image
- Returns:
- object
Definition at line 799 of file details.php.
| Details.getMediaFiles | ( | ) |
Template variable getter. Returns media files of current product
- Returns:
- array
Definition at line 812 of file details.php.
| Details.getLastProducts | ( | ) |
Template variable getter. Returns last seen products
- Returns:
- array
Definition at line 826 of file details.php.
| Details.getVendor | ( | ) |
Template variable getter. Returns product's vendor
- Returns:
- object
Definition at line 845 of file details.php.
| Details.getManufacturer | ( | ) |
Template variable getter. Returns product's vendor
- Returns:
- object
Definition at line 858 of file details.php.
| Details.getCategory | ( | ) |
Template variable getter. Returns product's root category
- Returns:
- object
Definition at line 871 of file details.php.
| Details.drawParentUrl | ( | ) |
Template variable getter. Returns if draw parent url
- Returns:
- bool
Definition at line 884 of file details.php.
| Details.getParentName | ( | ) |
Template variable getter. Returns parent article name
- Returns:
- string
Definition at line 894 of file details.php.
| Details.getParentUrl | ( | ) |
Template variable getter. Returns parent article name
- Returns:
- string
Definition at line 910 of file details.php.
| Details.getPictureGallery | ( | ) |
Template variable getter. Returns picture galery of current article
- Returns:
- array
Definition at line 926 of file details.php.
| Details.getActPictureId | ( | ) |
Template variable getter. Returns id of active picture
- Returns:
- string
Definition at line 940 of file details.php.
| Details.getActPicture | ( | ) |
Template variable getter. Returns active picture
- Returns:
- object
Definition at line 951 of file details.php.
| Details.morePics | ( | ) |
Template variable getter. Returns true if there more pictures
- Returns:
- bool
Definition at line 962 of file details.php.
| Details.getPictures | ( | ) |
Template variable getter. Returns pictures of current article
- Returns:
- array
Definition at line 973 of file details.php.
| Details.getArtPic | ( | $ | sPicNr | ) |
Template variable getter. Returns selected picture
- Parameters:
-
string $sPicNr picture number
- Returns:
- string
Definition at line 986 of file details.php.
| Details.getIcons | ( | ) |
Template variable getter. Returns icons of current article
- Returns:
- array
Definition at line 997 of file details.php.
| Details.showZoomPics | ( | ) |
Template variable getter. Returns if to show zoom pictures
- Returns:
- bool
Definition at line 1008 of file details.php.
| Details.getZoomPics | ( | ) |
Template variable getter. Returns zoom pictures
- Returns:
- array
Definition at line 1019 of file details.php.
| Details.getActZoomPic | ( | ) |
Template variable getter. Returns active zoom picture id
- Returns:
- array
Definition at line 1030 of file details.php.
| Details.getSelectLists | ( | ) |
Template variable getter. Returns selectlists of current article
- Returns:
- array
Definition at line 1040 of file details.php.
| Details.getReviews | ( | ) |
Template variable getter. Returns reviews of current article
- Returns:
- array
Definition at line 1056 of file details.php.
| Details.getCrossSelling | ( | ) |
Template variable getter. Returns crosssellings
- Returns:
- object
Reimplemented from oxUBase.
Definition at line 1072 of file details.php.
| Details.getSimilarProducts | ( | ) |
Template variable getter. Returns similar article list
- Returns:
- object
Reimplemented from oxUBase.
Definition at line 1088 of file details.php.
| Details.getSimilarRecommLists | ( | ) |
Template variable getter. Returns recommlists
- Returns:
- object
Reimplemented from oxUBase.
Definition at line 1104 of file details.php.
| Details.getAccessoires | ( | ) |
Template variable getter. Returns accessoires of article
- Returns:
- object
Reimplemented from oxUBase.
Definition at line 1121 of file details.php.
| Details.getAlsoBoughtThiesProducts | ( | ) |
Template variable getter. Returns list of customer also bought thies products
- Deprecated:
- use thankyou.getAlsoBoughtTheseProducts()
- Returns:
- object
Reimplemented from oxUBase.
Definition at line 1139 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 1149 of file details.php.
| Details.isPriceAlarm | ( | ) |
Template variable getter. Returns if pricealarm is disabled
- Returns:
- object
Definition at line 1165 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 1183 of file details.php.
| Details.getSearchTitle | ( | ) |
Returns search title. It will be setted in oxlocator
- Returns:
- string
Definition at line 1193 of file details.php.
| Details.setSearchTitle | ( | $ | sTitle | ) |
Returns search title setter
- Parameters:
-
string $sTitle search title
- Returns:
- null
Definition at line 1205 of file details.php.
| Details.setCatTreePath | ( | $ | sActCatPath | ) |
active category path setter
- Parameters:
-
string $sActCatPath category tree path
- Returns:
- string
Definition at line 1217 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 1228 of file details.php.
| Details.getTitle | ( | ) |
Returns current view title. Default is null
- Returns:
- null
Reimplemented from oxUBase.
Definition at line 1242 of file details.php.
| Details.getTag | ( | ) |
Template variable getter. Returns current tag
- Returns:
- string
Definition at line 1255 of file details.php.
| Details.getCanonicalUrl | ( | ) |
Returns view canonical url
- Returns:
- string
Reimplemented from oxUBase.
Definition at line 1265 of file details.php.
| Details.isMdVariantView | ( | ) |
Should we show MD variant selection? - Not for 1 dimension variants.
- Returns:
- bool
Definition at line 1277 of file details.php.
Member Data Documentation
Details.$_aVariantList = null [protected] |
Definition at line 16 of file details.php.
Details.$_sThisTemplate = 'details.tpl' [protected] |
Details.$_oParent = null [protected] |
Details.$_blCanRate = null [protected] |
Definition at line 37 of file details.php.
Details.$_blShowSorting = true [protected] |
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] |
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.
Details.$_iLinkType = null [protected] |
Definition at line 195 of file details.php.
Details.$_blMdView = null [protected] |
Definition at line 202 of file details.php.
The documentation for this class was generated from the following file:
- views/details.php
