OxidEsales\EshopCommunity\Application\Controller\NewsletterController Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Controller\NewsletterController:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Controller\NewsletterController:

Public Member Functions
	fill ()
	send ()
	addme ()
	removeme ()
	rmvm ()
	getTopStartActionArticles ()
	getTopStartArticle ()
	getHomeCountryId ()
	getNewsletterStatus ()
	getRegParams ()
	getBreadCrumb ()
	getTitle ()

Protected Attributes
	$_oActionArticles = null
	$_oTopArticle = null
	$_sHomeCountryId = null
	$_iNewsletterStatus = null
	$_aRegParams = null
	$_sThisTemplate = 'page/info/newsletter.tpl'
	$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW

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).

Member Function Documentation

addme()

OxidEsales\EshopCommunity\Application\Controller\NewsletterController::addme

(

)

Loads user and Adds him to newsletter group.

Template variables: success

fill()

OxidEsales\EshopCommunity\Application\Controller\NewsletterController::fill

(

)

Only loads newsletter subscriber data.

Template variables: aRegParams

getBreadCrumb()

OxidEsales\EshopCommunity\Application\Controller\NewsletterController::getBreadCrumb

(

)

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

Returns

array

getHomeCountryId()

OxidEsales\EshopCommunity\Application\Controller\NewsletterController::getHomeCountryId

(

)

Template variable getter. Returns country id

Returns

string

getNewsletterStatus()

OxidEsales\EshopCommunity\Application\Controller\NewsletterController::getNewsletterStatus

(

)

Template variable getter. Returns newsletter subscription status

Returns

integer

getRegParams()

OxidEsales\EshopCommunity\Application\Controller\NewsletterController::getRegParams

(

)

Template variable getter. Returns user newsletter registration data

Returns

array

getTitle()

OxidEsales\EshopCommunity\Application\Controller\NewsletterController::getTitle

(

)

Page title

Returns

string

getTopStartActionArticles()

OxidEsales\EshopCommunity\Application\Controller\NewsletterController::getTopStartActionArticles

(

)

Template variable getter. Returns action articlelist

Returns

object

getTopStartArticle()

OxidEsales\EshopCommunity\Application\Controller\NewsletterController::getTopStartArticle

(

)

Template variable getter. Returns top start article

Returns

object

removeme()

OxidEsales\EshopCommunity\Application\Controller\NewsletterController::removeme

(

)

Loads user and removes him from newsletter group.

rmvm()

OxidEsales\EshopCommunity\Application\Controller\NewsletterController::rmvm

(

)

simlink to function removeme bug fix #0002894

send()

OxidEsales\EshopCommunity\Application\Controller\NewsletterController::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

Member Data Documentation

$_aRegParams

OxidEsales\EshopCommunity\Application\Controller\NewsletterController::$_aRegParams = null

protected

$_iNewsletterStatus

OxidEsales\EshopCommunity\Application\Controller\NewsletterController::$_iNewsletterStatus = null

protected

$_iViewIndexState

OxidEsales\EshopCommunity\Application\Controller\NewsletterController::$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW

protected

$_oActionArticles

OxidEsales\EshopCommunity\Application\Controller\NewsletterController::$_oActionArticles = null

protected

$_oTopArticle

OxidEsales\EshopCommunity\Application\Controller\NewsletterController::$_oTopArticle = null

protected

$_sHomeCountryId

OxidEsales\EshopCommunity\Application\Controller\NewsletterController::$_sHomeCountryId = null

protected

$_sThisTemplate

OxidEsales\EshopCommunity\Application\Controller\NewsletterController::$_sThisTemplate = 'page/info/newsletter.tpl'

protected

---

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

• /oxideshop-ce/source/Application/Controller/NewsletterController.php