Inheritance diagram for Newsletter:

Collaboration diagram for Newsletter:

Public Member Functions
	fill ()
	send ()
	addme ()
	removeme ()
	rmvm ()
	getTopStartActionArticles ()
	getTopStartArticle ()
	getHomeCountryId ()
	getNewsletterStatus ()
	getRegParams ()
	getBreadCrumb ()
	getTitle ()
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 ()
	getSimilarRecommListIds ()
	getSearchParamForHtml ()
	showSearch ()
	getRssLinks ()
	getSortColumns ()
	setSortColumns ($aSortColumns)
	getEditTags ()
	getRecommSearch ()
	getPaymentList ()
	getActiveRecommList ()
	getAccessoires ()
	getCrossSelling ()
	getSimilarProducts ()
	getAlsoBoughtTheseProducts ()
	getArticleId ()
	getActiveLangAbbr ()
	addGlobalParams ($oShop=null)
	getAdditionalParams ()
	generatePageNavigationUrl ()
	getPageNavigation ()
	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 Attributes
	$_oActionArticles = null
	$_oTopArticle = null
	$_sHomeCountryId = null
	$_iNewsletterStatus = null
	$_aRegParams = null
	$_sThisTemplate = 'page/info/newsletter.tpl'
	$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW
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
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 ()
Static Protected Attributes inherited from oxUBase
static	$_aCollectedComponentNames = null

Detailed Description

Newsletter opt-in/out. Arranges newsletter opt-in form, have some methods to confirm user opt-in or remove user from newsletter list. OXID eShop -> (Newsletter).

Definition at line 9 of file newsletter.php.

Member Function Documentation

Newsletter::addme ( )

Loads user and Adds him to newsletter group.

Template variables: success

Definition at line 163 of file newsletter.php.

Newsletter::fill ( )

Only loads newsletter subscriber data.

Template variables: aRegParams

Definition at line 67 of file newsletter.php.

Newsletter::getBreadCrumb ( )

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

Returns: array

Reimplemented from oxUBase.

Definition at line 285 of file newsletter.php.

Newsletter::getHomeCountryId ( )

Template variable getter. Returns country id

Returns: string

Definition at line 247 of file newsletter.php.

Newsletter::getNewsletterStatus ( )

Template variable getter. Returns newsletter subscription status

Returns: integer

Definition at line 265 of file newsletter.php.

Newsletter::getRegParams ( )

Template variable getter. Returns user newsletter registration data

Returns: array

Definition at line 275 of file newsletter.php.

Newsletter::getTitle ( )

Page title

Returns: string

Reimplemented from oxUBase.

Definition at line 303 of file newsletter.php.

Newsletter::getTopStartActionArticles ( )

Template variable getter. Returns action articlelist

Returns: object

Definition at line 208 of file newsletter.php.

Newsletter::getTopStartArticle ( )

Template variable getter. Returns top start article

Returns: object

Definition at line 230 of file newsletter.php.

Newsletter::removeme ( )

Loads user and removes him from newsletter group.

Definition at line 181 of file newsletter.php.

Newsletter::rmvm ( )

simlink to function removeme bug fix #0002894

Definition at line 198 of file newsletter.php.

Newsletter::send ( )

Checks for newsletter subscriber data, if OK - creates new user as subscriber or assigns existing user to newsletter group and sends confirmation email.

Template variables: success, error, aRegParams

Returns: bool

Definition at line 83 of file newsletter.php.

Member Data Documentation

Newsletter::$_aRegParams = null

protected

Definition at line 45 of file newsletter.php.

Newsletter::$_iNewsletterStatus = null

protected

Definition at line 38 of file newsletter.php.

Newsletter::$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW

protected

Definition at line 59 of file newsletter.php.

Newsletter::$_oActionArticles = null

protected

Definition at line 17 of file newsletter.php.

Newsletter::$_oTopArticle = null

protected

Definition at line 24 of file newsletter.php.

Newsletter::$_sHomeCountryId = null

protected

Definition at line 31 of file newsletter.php.

Newsletter::$_sThisTemplate = 'page/info/newsletter.tpl'

protected

Definition at line 52 of file newsletter.php.

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

application/controllers/newsletter.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation