OXID eShop CE  4.9.6
 All Classes Files Functions Variables Pages
Compare Class Reference
+ Inheritance diagram for Compare:
+ Collaboration diagram for Compare:

Public Member Functions

 moveLeft ()
 moveRight ()
 inPopup ()
 setCompareItemsCnt ($iCount)
 getCompareItemsCnt ()
 getCompareItems ()
 setCompareItems ($aItems)
 setNoPaging ()
 getCompArtList ()
 getAttributeList ()
 getSimilarRecommListIds ()
 getPageNavigation ()
 getOrderCnt ()
 getBreadCrumb ()
- Public Member Functions inherited from oxUBase
 init ()
 getViewId ()
 showSorting ()
 setComponents ($aComponents=null)
 getComponents ()
 getComponent ($sName)
 setIsOrderStep ($blIsOrderStep=null)
 getIsOrderStep ()
 setActiveCategory ($oCategory)
 getActiveCategory ()
 getListType ()
 getListDisplayType ()
 getCustomListDisplayType ()
 setListType ($sType)
 loadCurrency ()
 dontShowEmptyCategories ()
 showCategoryArticlesCount ()
 isLanguageLoaded ()
 getTopNavigationCatCnt ()
 addRssFeed ($sTitle, $sUrl, $key=null)
 getSortOrderByParameterName ()
 getSortOrderParameterName ()
 getSortIdent ()
 getDefaultSorting ()
 getUserSelectedSorting ()
 getSavedSorting ($sSortIdent)
 setListOrderBy ($sColumn)
 setListOrderDirection ($sDirection)
 getListOrderBy ()
 getListOrderDirection ()
 setMetaDescription ($sDescription)
 setMetaKeywords ($sKeywords)
 getMetaKeywords ()
 getMetaDescription ()
 getActCurrency ()
 setActCurrency ($oCur)
 getCompareItemCount ()
 noIndex ()
 getMenueList ()
 setMenueList ($aMenu)
 getNavigationParams ()
 setItemSorting ($sSortIdent, $sSortBy, $sSortDir=null)
 getSorting ($sSortIdent)
 getSortingSql ($sIdent)
 getTitleSuffix ()
 getTitlePageSuffix ()
 getTitlePrefix ()
 getPageTitle ()
 getDynUrlParams ()
 getBaseLink ($iLang=null)
 getLink ($iLang=null)
 getCanonicalUrl ()
 getSearchParamForHtml ()
 showSearch ()
 getRssLinks ()
 getSortColumns ()
 setSortColumns ($aSortColumns)
 getEditTags ()
 getRecommSearch ()
 getPaymentList ()
 getActiveRecommList ()
 getAccessoires ()
 getCrossSelling ()
 getSimilarProducts ()
 getAlsoBoughtTheseProducts ()
 getArticleId ()
 getTitle ()
 getActiveLangAbbr ()
 addGlobalParams ($oShop=null)
 getAdditionalParams ()
 generatePageNavigationUrl ()
 getPageNavigationLimitedTop ($iPositionCount=7)
 getPageNavigationLimitedBottom ($iPositionCount=11)
 generatePageNavigation ($iPositionCount=0)
 render ()
 getViewProduct ()
 setViewProduct ($oProduct)
 getViewProductList ()
 getActPage ()
 getActTag ()
 getActVendor ()
 getActManufacturer ()
 setActVendor ($oVendor)
 setActManufacturer ($oManufacturer)
 getActSearch ()
 getCategoryTree ()
 setCategoryTree ($oCatTree)
 getManufacturerTree ()
 setManufacturerTree ($oManufacturerTree)
 getAddUrlParams ()
 getTop5ArticleList ($iCount=null)
 getBargainArticleList ()
 isLowOrderPrice ()
 getMinOrderPrice ()
 getNewsRealStatus ()
 getProduct ()
 getManufacturerlist ()
 setManufacturerlist ($aList)
 setRootVendor ($oVendor)
 getRootVendor ()
 setRootManufacturer ($oManufacturer)
 getRootManufacturer ()
 getVendorId ()
 getManufacturerId ()
 getCatMoreUrl ()
 getCatTreePath ()
 getContentByIdent ($sIdent)
 getContentCategory ()
 getMustFillFields ()
 isFieldRequired ($sField)
 getFormId ()
 canAcceptFormData ()
 getPromoFinishedList ()
 getPromoCurrentList ()
 getPromoFutureList ()
 getShowPromotionList ()
 isEnabledPrivateSales ()
 getFieldValidationErrors ()
 setRootCatChanged ($blRootCatChanged)
 isRootCatChanged ()
 getInvoiceAddress ()
 getDeliveryAddress ()
 setDeliveryAddress ($aDeliveryAddress)
 setInvoiceAddress ($aAddress)
 getActiveUsername ()
 getWishlistUserId ()
 getSearchCatId ()
 getSearchVendor ()
 getSearchManufacturer ()
 getLastProducts ()
 getNewBasketItemMsgType ()
 isActive ($sName)
 isFbWidgetVisible ()
 isEnabledDownloadableFiles ()
 showRememberMe ()
 isVatIncluded ()
 isPriceCalculated ()
 showTags ()
 getWishlistName ()
 getWidgetLink ()
- Public Member Functions inherited from oxView
 setViewParameters ($aParams=null)
 getViewParameter ($sKey)
 setIsCallForCache ($blIsCallForCache=null)
 getIsCallForCache ()
 addTplParam ($sPara, $sValue)
 getBelboonParam ()
 getViewConfig ()
 getTemplateName ()
 setTemplateName ($sTemplate)
 setClassName ($sClassName)
 getClassName ()
 setFncName ($sFncName)
 getFncName ()
 setViewData ($aViewData=null)
 getViewData ()
 getViewDataElement ($sParamId=null)
 setClassLocation ($sClassLocation=null)
 getClassLocation ()
 setThisAction ($sThisAction=null)
 getThisAction ()
 setParent ($oParent=null)
 getParent ()
 setIsComponent ($blIsComponent=null)
 getIsComponent ()
 getTrustedShopId ()
 getTSExcellenceId ()
 getCharSet ()
 getShopVersion ()
 getShopEdition ()
 getRevision ()
 getPackageInfo ()
 getShopFullEdition ()
 isDemoVersion ()
 isBetaVersion ()
 isRCVersion ()
 showBetaNote ()
 isDemoShop ()
 showNewsletter ()
 setShowNewsletter ($blShow)
 getShopLogo ()
 setShopLogo ($sLogo)
 getActCategory ()
 setActCategory ($oCategory)
 getCategoryId ()
 setCategoryId ($sCategoryId)
 getErrorDestination ()
 getActionClassName ()
 isConnectedWithFb ()
 getFbUserId ()
 showFbConnectToAccountMsg ()
 isMall ()
 showRdfa ()
 getSidForWidget ()
- Public Member Functions inherited from oxSuperCfg
 __call ($sMethod, $aArgs)
 __construct ()
 getConfig ()
 setConfig ($oConfig)
 getSession ()
 setSession ($oSession)
 getUser ()
 setUser ($oUser)
 isAdmin ()
 setAdminMode ($blAdmin)

Protected Member Functions

 _setArticlesPerPage ($iNumber)
 _removeArticlesFromPage ($aItems, $oList)
 _changeArtListOrder ($aItems, $oList)
- Protected Member Functions inherited from oxUBase
 _getComponentNames ()
 _processRequest ()
 _getMetaFromSeo ($sDataType)
 _getMetaFromContent ($sMetaIdent)
 _forceNoIndex ()
 _setNrOfArtPerPage ()
 _getSeoObjectId ()
 _prepareMetaDescription ($sMeta, $iLength=1024, $blRemoveDuplicatedWords=false)
 _prepareMetaKeyword ($sKeywords, $blRemoveDuplicatedWords=true)
 _removeDuplicatedWords ($aInput, $aSkipTags=array())
 _getSubject ($iLang)
 _getRequestParams ($blAddPageNr=true)
 _getSeoRequestParams ()
 _addPageNrParam ($sUrl, $iPage, $iLang=null)
 _canRedirect ()
- Protected Member Functions inherited from oxView
 _executeNewAction ($sNewAction)

Protected Attributes

 $_iCntPages = 1
 $_iOrderCnt = null
 $_iArticlesPerPage = 3
 $_iCompItemsCnt = null
 $_aCompItems = null
 $_oArtList = null
 $_oAttributeList = null
 $_oRecommList = null
 $_oPageNavigation = null
 $_blBargainAction = true
 $_blShowTagCloud = false
 $_sThisTemplate = 'page/compare/compare.tpl'
 $_aSimilarRecommListIds = null
- Protected Attributes inherited from oxUBase
 $_blFbWidgetsOn = null
 $_sRemoveMetaChars = '.\+*?[^]$(){}=!<>|:&'
 $_oaComponents = array()
 $_blIsOrderStep = false
 $_sListType = null
 $_aListDisplayTypes = array('grid', 'line', 'infogrid')
 $_sListDisplayType = null
 $_sCustomListDisplayType = null
 $_oActCategory = null
 $_oActManufacturer = null
 $_oActVendor = null
 $_oActiveRecommList = null
 $_oActSearch = null
 $_blShowSorting = false
 $_blLoadCurrency = null
 $_blLoadManufacturerTree = null
 $_blDontShowEmptyCats = null
 $_blLoadLanguage = null
 $_iTopCatNavItmCnt = null
 $_aRssLinks = null
 $_sListOrderBy = null
 $_sListOrderDir = null
 $_sMetaDescription = null
 $_sMetaKeywords = null
 $_sMetaDescriptionIdent = null
 $_sMetaKeywordsIdent = null
 $_sAdditionalParams = null
 $_oActCurrency = null
 $_blEnabledPrivateSales = null
 $_blCommonAdded = false
 $_iViewIndexState = VIEW_INDEXSTATE_INDEX
 $_blForceNoIndex = false
 $_iCompItemsCnt = null
 $_sContentId = null
 $_oContent = null
 $_sViewResetID = null
 $_aMenueList = null
 $_aComponentNames
 $_aUserComponentNames = array()
 $_oProduct = null
 $_iActPage = null
 $_aArticleList = null
 $_oManufacturerTree = null
 $_oCategoryTree = null
 $_aTop5ArticleList = null
 $_aBargainArticleList = null
 $_blLowOrderPrice = null
 $_sMinOrderPrice = null
 $_iNewsRealStatus = null
 $_aBlockRedirectParams = array('fnc', 'stoken', 'force_sid', 'force_admin_sid')
 $_oRootVendor = null
 $_sVendorId = null
 $_aManufacturerlist = null
 $_oRootManufacturer = null
 $_sManufacturerId = null
 $_blNewsSubscribed = null
 $_oDelAddress = null
 $_sCatTreePath = null
 $_aContents = array()
 $_blTop5Action = false
 $_blBargainAction = false
 $_aMustFillFields = null
 $_blShowTagCloud = true
 $_blRootCatChanged = false
 $_aInvoiceAddress = null
 $_aDeliveryAddress = null
 $_sActiveUsername = null
 $_blLoadComponents = true
 $_aSortColumns = null
- Protected Attributes inherited from oxView
 $_aViewData = array()
 $_sClassLocation = null
 $_sThisAction = null
 $_oParent = null
 $_blIsComponent = false
 $_sThisTemplate = null
 $_sViewId = null
 $_sClass = null
 $_sFnc = null
 $_sTrustedShopId = null
 $_sTSExcellenceId = null
 $_sCharSet = null
 $_sVersion = null
 $_blDemoVersion = null
 $_blDemoShop = null
 $_iNewsStatus = null
 $_sShopLogo = null
 $_sCategoryId = null
 $_oClickCat = null
 $_blIsCallForCache = false
 $_oViewConf = null

Additional Inherited Members

- Static Protected Attributes inherited from oxUBase
static $_aCollectedComponentNames = null

Detailed Description

Comparing Products. Takes a few products and show attribute values to compare them.

Definition at line 7 of file compare.php.

Member Function Documentation

Compare::_changeArtListOrder (   $aItems,
  $oList 
)
protected

Changes order of list elements

Parameters
array$aItemsarticle array
object$oListarticle list array
Returns
array $oNewList

Definition at line 373 of file compare.php.

Compare::_removeArticlesFromPage (   $aItems,
  $oList 
)
protected

Cuts page articles

Parameters
array$aItemsarticle array
object$oListarticle list array
Returns
array $aNewItems

Definition at line 346 of file compare.php.

Compare::_setArticlesPerPage (   $iNumber)
protected

$_iArticlesPerPage setter

Parameters
int$iNumberarticle count in compare page

Definition at line 246 of file compare.php.

Compare::getAttributeList ( )

Template variable getter. Returns attribute list

Returns
object

Definition at line 292 of file compare.php.

Compare::getBreadCrumb ( )

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

Returns
array

Reimplemented from oxUBase.

Definition at line 427 of file compare.php.

Compare::getCompareItems ( )

Compare item $_aCompItems getter

Returns
null

Definition at line 218 of file compare.php.

Compare::getCompareItemsCnt ( )

Template variable getter. Returns article list count in comparison

Returns
integer

Definition at line 201 of file compare.php.

Compare::getCompArtList ( )

Template variable getter. Returns comparison's article list in order per page

Returns
object

Definition at line 266 of file compare.php.

Compare::getOrderCnt ( )

changes default template for compare in popup

Returns
null

Definition at line 410 of file compare.php.

Compare::getPageNavigation ( )

Template variable getter. Returns page navigation

Returns
object

Reimplemented from oxUBase.

Definition at line 328 of file compare.php.

Compare::getSimilarRecommListIds ( )

Return array of id to form recommend list.

Returns
array

Reimplemented from oxUBase.

Definition at line 310 of file compare.php.

Compare::inPopup ( )

changes default template for compare in popup

Definition at line 180 of file compare.php.

Compare::moveLeft ( )

moves current article to the left in compare items array

Definition at line 106 of file compare.php.

Compare::moveRight ( )

moves current article to the right in compare items array

Definition at line 143 of file compare.php.

Compare::setCompareItems (   $aItems)

Compare item $_aCompItems setter

Parameters
array$aItemscompare items i new order

Definition at line 235 of file compare.php.

Compare::setCompareItemsCnt (   $iCount)

Articlelist count in comparison setter

Parameters
integer$iCountcompare items count

Definition at line 191 of file compare.php.

Compare::setNoPaging ( )

turn off paging

Definition at line 254 of file compare.php.

Member Data Documentation

Compare::$_aCompItems = null
protected

Definition at line 43 of file compare.php.

Compare::$_aSimilarRecommListIds = null
protected

Definition at line 100 of file compare.php.

Compare::$_blBargainAction = true
protected

Definition at line 78 of file compare.php.

Compare::$_blShowTagCloud = false
protected

Definition at line 85 of file compare.php.

Compare::$_iArticlesPerPage = 3
protected

Definition at line 29 of file compare.php.

Compare::$_iCntPages = 1
protected

Definition at line 15 of file compare.php.

Compare::$_iCompItemsCnt = null
protected

Definition at line 36 of file compare.php.

Compare::$_iOrderCnt = null
protected

Definition at line 22 of file compare.php.

Compare::$_oArtList = null
protected

Definition at line 50 of file compare.php.

Compare::$_oAttributeList = null
protected

Definition at line 57 of file compare.php.

Compare::$_oPageNavigation = null
protected

Definition at line 71 of file compare.php.

Compare::$_oRecommList = null
protected

Definition at line 64 of file compare.php.

Compare::$_sThisTemplate = 'page/compare/compare.tpl'
protected

Definition at line 93 of file compare.php.


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