Public Member Functions | Protected Member Functions | Protected Attributes

oxNewsSubscribed Class Reference

Inheritance diagram for oxNewsSubscribed:
Collaboration diagram for oxNewsSubscribed:

List of all members.

Public Member Functions

 __construct ()
 load ($oxId)
 loadFromEmail ($sEmailAddress)
 loadFromUserId ($sOxUserId)
 getOptInStatus ()
 setOptInStatus ($iStatus)
 getOptInEmailStatus ()
 setOptInEmailStatus ($iStatus)
 wasUnsubscribed ()
 updateSubscription ($oUser)

Protected Member Functions

 _insert ()
 _update ()

Protected Attributes

 $_blWasSubscribed = false
 $_blWasPreSubscribed = false
 $_sClassName = 'oxnewssubscribed'

Detailed Description

Newsletter Subscriptions manager Performs user managing function information, deletion and other.

Definition at line 9 of file oxnewssubscribed.php.


Constructor & Destructor Documentation

oxNewsSubscribed.__construct (  ) 

Class constructor, initiates parent constructor (parent.oxBase()).

Reimplemented from oxBase.

Definition at line 36 of file oxnewssubscribed.php.


Member Function Documentation

oxNewsSubscribed._insert (  )  [protected]

Inserts nbews object data to DB. Returns true on success.

Returns:
mixed oxid on success or false on failure

Reimplemented from oxBase.

Definition at line 100 of file oxnewssubscribed.php.

oxNewsSubscribed._update (  )  [protected]

We need to check if we unsubscribe here

Returns:
mixed oxid on success or false on failure

Reimplemented from oxBase.

Definition at line 112 of file oxnewssubscribed.php.

oxNewsSubscribed.getOptInEmailStatus (  ) 

Newsletter subscription email sending status getter

Returns:
int

Definition at line 160 of file oxnewssubscribed.php.

oxNewsSubscribed.getOptInStatus (  ) 

Newsletter subscription status getter

Returns:
int

Definition at line 137 of file oxnewssubscribed.php.

oxNewsSubscribed.load ( oxId  ) 

Loads object (newssubscription) details from DB. Returns true on success.

Parameters:
string $oxId oxnewssubscribed ID
Returns:
bool

Reimplemented from oxBase.

Definition at line 52 of file oxnewssubscribed.php.

oxNewsSubscribed.loadFromEmail ( sEmailAddress  ) 

Loader which loads news subscription according to subscribers email address

Parameters:
string $sEmailAddress subscribers email address
Returns:
bool

Definition at line 72 of file oxnewssubscribed.php.

oxNewsSubscribed.loadFromUserId ( sOxUserId  ) 

Loader which loads news subscription according to subscribers oxid

Parameters:
string $sOxUserId subscribers oxid
Returns:
bool

Definition at line 88 of file oxnewssubscribed.php.

oxNewsSubscribed.setOptInEmailStatus ( iStatus  ) 

Newsletter subscription email sending status setter

Parameters:
int $iStatus subscription status
Returns:
null

Definition at line 172 of file oxnewssubscribed.php.

oxNewsSubscribed.setOptInStatus ( iStatus  ) 

Newsletter subscription status setter

Parameters:
int $iStatus subscription status
Returns:
null

Definition at line 149 of file oxnewssubscribed.php.

oxNewsSubscribed.updateSubscription ( oUser  ) 

This method is called from oxuser.update. Currently it updates user information kept in db

Parameters:
oxuser $oUser subscription user object
Returns:
bool

Definition at line 199 of file oxnewssubscribed.php.

oxNewsSubscribed.wasUnsubscribed (  ) 

Check if was ever unsubscribed by unsubscribed field.

Returns:
bool

Definition at line 183 of file oxnewssubscribed.php.


Member Data Documentation

oxNewsSubscribed.$_blWasPreSubscribed = false [protected]

Definition at line 23 of file oxnewssubscribed.php.

oxNewsSubscribed.$_blWasSubscribed = false [protected]

Definition at line 16 of file oxnewssubscribed.php.

oxNewsSubscribed.$_sClassName = 'oxnewssubscribed' [protected]

Reimplemented from oxBase.

Definition at line 30 of file oxnewssubscribed.php.


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