Newsletter Class Reference

Inheritance diagram for Newsletter:

[legend]

Collaboration diagram for Newsletter:

[legend]

List of all members.

---

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.

Public Member Functions
	render ()
	fill ()
	send ()
	addme ()
	removeme ()
	getTopStartActionArticles ()
	getTopStartArticle ()
	getHomeCountryId ()
	getNewsletterStatus ()
	getRegParams ()
Protected Attributes
	$_oActionArticles = null
	$_oTopArticle = null
	$_sHomeCountryId = null
	$_iNewsletterStatus = null
	$_aRegParams = null
	$_sThisTemplate = 'newsletter.tpl'
	$_iViewIndexState = 1

---

Member Function Documentation

Newsletter.render

(

)

Executes parent.render(), loads action articles and returns name of template file to render newsletter._sThisTemplate.

Template variables: toparticle, homecountryid, toparticlelist

Returns:

string $this->_sThisTemplate current template file name

Reimplemented from oxUBase.

Definition at line 65 of file newsletter.php.

Newsletter.fill

(

)

Only loads newsletter subscriber data.

Template variables: aRegParams

Returns:

bool

Definition at line 92 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 108 of file newsletter.php.

Newsletter.addme

(

)

Loads user and Adds him to newsletter group.

Template variables: success

Returns:

null

Definition at line 171 of file newsletter.php.

Newsletter.removeme

(

)

Loads user and removes him from newsletter group.

Template variables: success

Returns:

null

Definition at line 190 of file newsletter.php.

Newsletter.getTopStartActionArticles

(

)

Template variable getter. Returns action articlelist

Returns:

object

Definition at line 211 of file newsletter.php.

Newsletter.getTopStartArticle

(

)

Template variable getter. Returns top start article

Returns:

object

Definition at line 232 of file newsletter.php.

Newsletter.getHomeCountryId

(

)

Template variable getter. Returns country id

Returns:

string

Definition at line 248 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.

---

Member Data Documentation

Newsletter.$_oActionArticles = null [protected]

Definition at line 15 of file newsletter.php.

Newsletter.$_oTopArticle = null [protected]

Definition at line 21 of file newsletter.php.

Newsletter.$_sHomeCountryId = null [protected]

Definition at line 27 of file newsletter.php.

Newsletter.$_iNewsletterStatus = null [protected]

Definition at line 33 of file newsletter.php.

Newsletter.$_aRegParams = null [protected]

Definition at line 39 of file newsletter.php.

Newsletter.$_sThisTemplate = 'newsletter.tpl' [protected]

Reimplemented from oxView.

Definition at line 45 of file newsletter.php.

Newsletter.$_iViewIndexState = 1 [protected]

Current view search engine indexing state: 0 - index without limitations 1 - no index / no follow 2 - no index / follow

Reimplemented from oxView.

Definition at line 53 of file newsletter.php.

---

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

• views/newsletter.php