OXID eShop CE  4.10.2
 All Classes Namespaces Files Functions Variables Pages
Account Class Reference
+ Inheritance diagram for Account:
+ Collaboration diagram for Account:

Public Member Functions

 render ()
 confirmTerms ()
 getNavigationParams ()
 redirectAfterLogin ()
 getOrderCnt ()
 getArticleId ()
 getSearchParamForHtml ()
 getSearchParam ()
 getListType ()
 getBreadCrumb ()
 getCompareItemsCnt ()
 getTitle ()
- Public Member Functions inherited from oxUBase
 init ()
 getViewId ()
 showSorting ()
 setComponents ($aComponents=null)
 getComponents ()
 getComponent ($sName)
 setIsOrderStep ($blIsOrderStep=null)
 getIsOrderStep ()
 setActiveCategory ($oCategory)
 getActiveCategory ()
 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)
 setItemSorting ($sSortIdent, $sSortBy, $sSortDir=null)
 getSorting ($sSortIdent)
 getSortingSql ($sIdent)
 getTitleSuffix ()
 getTitlePageSuffix ()
 getTitlePrefix ()
 getPageTitle ()
 getDynUrlParams ()
 getBaseLink ($iLang=null)
 getLink ($iLang=null)
 getCanonicalUrl ()
 getSimilarRecommListIds ()
 showSearch ()
 getRssLinks ()
 getSortColumns ()
 setSortColumns ($aSortColumns)
 getEditTags ()
 getRecommSearch ()
 getPaymentList ()
 getActiveRecommList ()
 getAccessoires ()
 getCrossSelling ()
 getSimilarProducts ()
 getAlsoBoughtTheseProducts ()
 getActiveLangAbbr ()
 addGlobalParams ($oShop=null)
 getAdditionalParams ()
 generatePageNavigationUrl ()
 getPageNavigation ()
 getPageNavigationLimitedTop ($iPositionCount=7)
 getPageNavigationLimitedBottom ($iPositionCount=11)
 generatePageNavigation ($iPositionCount=0)
 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 ()
 executeFunction ($sFunction)
 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

 _getLoginTemplate ()
- 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

 $_iOrderCnt = null
 $_sArticleId = null
 $_sSearchParamForHtml = null
 $_sSearchParam = null
 $_sListType = null
 $_sThisTemplate = 'page/account/dashboard.tpl'
 $_sThisLoginTemplate = 'page/account/login.tpl'
 $_sThisAltLoginTemplate = 'page/privatesales/login.tpl'
 $_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW
 $_sMetaDescriptionIdent = 'oxstartmetadescription'
 $_sMetaKeywordsIdent = 'oxstartmetakeywords'
 $_blBargainAction = true
 $_blShowTagCloud = false
- 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

Current user "My account" window. When user is logged in arranges "My account" window, by creating links to user details, order review, notice list, wish list. There is a link for logging out. Template includes Topoffer , bargain boxes. OXID eShop -> MY ACCOUNT.

Definition at line 12 of file account.php.

Member Function Documentation

Account::_getLoginTemplate ( )
protected

Returns login template name:

  • if "login" feature is on returns $this->_sThisAltLoginTemplate
  • else returns $this->_sThisLoginTemplate
Returns
string

Definition at line 141 of file account.php.

Account::confirmTerms ( )

Confirms term agreement. Returns value of confirmed term

Returns
string | bool

Definition at line 151 of file account.php.

Account::getArticleId ( )

Return the active article id

Returns
string | bool

Reimplemented from oxUBase.

Definition at line 243 of file account.php.

Account::getBreadCrumb ( )

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

Returns
array

Reimplemented from oxUBase.

Reimplemented in Account_Wishlist, Account_Recommlist, Account_Noticelist, Account_Order, Account_Password, Account_Newsletter, Account_User, and Account_Downloads.

Definition at line 312 of file account.php.

Account::getCompareItemsCnt ( )

Template variable getter. Returns article list count in comparison

Returns
integer

Definition at line 337 of file account.php.

Account::getListType ( )

Template variable getter. Returns list type

Returns
string

Reimplemented from oxUBase.

Definition at line 294 of file account.php.

Account::getNavigationParams ( )

Returns array from parent::getNavigationParams(). If current request contains "sourcecl" and "anid" parameters - appends array with this data. Array is used to fill forms and append shop urls with actual state parameters

Returns
array

Reimplemented from oxUBase.

Reimplemented in Account_Recommlist, and Account_Noticelist.

Definition at line 172 of file account.php.

Account::getOrderCnt ( )

changes default template for compare in popup

Returns
null

Definition at line 226 of file account.php.

Account::getSearchParam ( )

Template variable getter. Returns search parameter

Returns
string

Definition at line 277 of file account.php.

Account::getSearchParamForHtml ( )

Template variable getter. Returns search parameter for Html

Returns
string

Reimplemented from oxUBase.

Definition at line 260 of file account.php.

Account::getTitle ( )

Page Title

Returns
string

Reimplemented from oxUBase.

Definition at line 350 of file account.php.

Account::redirectAfterLogin ( )

For some user actions (like writing guestbook entry or product review) user must be logged in. So e.g. in product details page there is a link leading to current view. Link contains parameter "sourcecl", which tells where to redirect after successfull login. If this parameter is defined and oxcmp_user::getLoginStatus() == USER_LOGIN_SUCCESS (means user has just logged in) then user is redirected back to source view.

Returns
null

Definition at line 199 of file account.php.

Account::render ( )

Loads action articles. If user is logged and returns name of template to render account::_sThisTemplate

Returns
string $_sThisTemplate current template file name

Reimplemented from oxUBase.

Reimplemented in Account_Wishlist, Account_Recommlist, Account_Noticelist, Account_Order, Account_Newsletter, Account_Password, and Account_User.

Definition at line 115 of file account.php.

Member Data Documentation

Account::$_blBargainAction = true
protected

Definition at line 97 of file account.php.

Account::$_blShowTagCloud = false
protected

Definition at line 106 of file account.php.

Account::$_iOrderCnt = null
protected

Definition at line 20 of file account.php.

Account::$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW
protected

Definition at line 76 of file account.php.

Account::$_sArticleId = null
protected

Definition at line 27 of file account.php.

Account::$_sListType = null
protected

Definition at line 48 of file account.php.

Account::$_sMetaDescriptionIdent = 'oxstartmetadescription'
protected

Definition at line 83 of file account.php.

Account::$_sMetaKeywordsIdent = 'oxstartmetakeywords'
protected

Definition at line 90 of file account.php.

Account::$_sSearchParam = null
protected

Definition at line 41 of file account.php.

Account::$_sSearchParamForHtml = null
protected

Definition at line 34 of file account.php.

Account::$_sThisAltLoginTemplate = 'page/privatesales/login.tpl'
protected

Definition at line 69 of file account.php.

Account::$_sThisLoginTemplate = 'page/account/login.tpl'
protected

Definition at line 62 of file account.php.

Account::$_sThisTemplate = 'page/account/dashboard.tpl'
protected

Definition at line 55 of file account.php.


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