Public Member Functions | Protected Attributes

Newsletter Class Reference

Inheritance diagram for Newsletter:
Collaboration diagram for Newsletter:

List of all members.

Public Member Functions

 fill ()
 send ()
 addme ()
 removeme ()
 rmvm ()
 getTopStartActionArticles ()
 getTopStartArticle ()
 getHomeCountryId ()
 getNewsletterStatus ()
 getRegParams ()
 getBreadCrumb ()

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

Definition at line 9 of file newsletter.php.


Member Function Documentation

Newsletter.addme (  ) 

Loads user and Adds him to newsletter group.

Template variables: success

Returns:
null

Definition at line 158 of file newsletter.php.

Newsletter.fill (  ) 

Only loads newsletter subscriber data.

Template variables: aRegParams

Returns:
bool

Definition at line 62 of file newsletter.php.

Newsletter.getBreadCrumb (  ) 

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

Returns:
array

Reimplemented from oxUBase.

Definition at line 279 of file newsletter.php.

Newsletter.getHomeCountryId (  ) 

Template variable getter. Returns country id

Returns:
string

Definition at line 242 of file newsletter.php.

Newsletter.getNewsletterStatus (  ) 

Template variable getter. Returns newsletter subscription status

Returns:
integer

Definition at line 259 of file newsletter.php.

Newsletter.getRegParams (  ) 

Template variable getter. Returns user newsletter registration data

Returns:
array

Definition at line 269 of file newsletter.php.

Newsletter.getTopStartActionArticles (  ) 

Template variable getter. Returns action articlelist

Returns:
object

Definition at line 205 of file newsletter.php.

Newsletter.getTopStartArticle (  ) 

Template variable getter. Returns top start article

Returns:
object

Definition at line 226 of file newsletter.php.

Newsletter.removeme (  ) 

Loads user and removes him from newsletter group.

Returns:
null

Definition at line 174 of file newsletter.php.

Newsletter.rmvm (  ) 

simlink to function removeme bug fix #0002894

Returns:
null

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


Member Data Documentation

Newsletter.$_aRegParams = null [protected]

Definition at line 39 of file newsletter.php.

Newsletter.$_iNewsletterStatus = null [protected]

Definition at line 33 of file newsletter.php.

Newsletter.$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW [protected]

Current view search engine indexing state: VIEW_INDEXSTATE_INDEX - index without limitations VIEW_INDEXSTATE_NOINDEXNOFOLLOW - no index / no follow VIEW_INDEXSTATE_NOINDEXFOLLOW - no index / follow

Reimplemented from oxUBase.

Definition at line 52 of file newsletter.php.

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.$_sThisTemplate = 'page/info/newsletter.tpl' [protected]

Reimplemented from oxView.

Definition at line 45 of file newsletter.php.


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