OxidEsales\EshopCommunity\Application\Model\NewsSubscribed Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Model\NewsSubscribed:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Model\NewsSubscribed:

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

Protected Member Functions
	getSubscribedUserIdByEmail ($email)
	_insert ()
	_update ()

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

Detailed Description

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

Constructor & Destructor Documentation

__construct()

OxidEsales\EshopCommunity\Application\Model\NewsSubscribed::__construct

(

)

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

Member Function Documentation

_insert()

OxidEsales\EshopCommunity\Application\Model\NewsSubscribed::_insert ( )

protected

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

Returns

mixed oxid on success or false on failure

_update()

OxidEsales\EshopCommunity\Application\Model\NewsSubscribed::_update ( )

protected

We need to check if we unsubscribe here

Returns

mixed oxid on success or false on failure

getOptInEmailStatus()

OxidEsales\EshopCommunity\Application\Model\NewsSubscribed::getOptInEmailStatus

(

)

Newsletter subscription email sending status getter

Returns

int

getOptInStatus()

OxidEsales\EshopCommunity\Application\Model\NewsSubscribed::getOptInStatus

(

)

Newsletter subscription status getter

Returns

int

getSubscribedUserIdByEmail()

OxidEsales\EshopCommunity\Application\Model\NewsSubscribed::getSubscribedUserIdByEmail (   $email )

protected

Get subscribed user id by email.

Parameters

string

$email

Returns

string

load()

OxidEsales\EshopCommunity\Application\Model\NewsSubscribed::load

(

$oxId

)

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

Parameters

string

$oxId

oxnewssubscribed ID

Returns

bool

loadFromEmail()

OxidEsales\EshopCommunity\Application\Model\NewsSubscribed::loadFromEmail

(

$sEmailAddress

)

Loader which loads news subscription according to subscribers email address

Parameters

string

$sEmailAddress

subscribers email address

Returns

bool

loadFromUserId()

OxidEsales\EshopCommunity\Application\Model\NewsSubscribed::loadFromUserId

(

$sOxUserId

)

Loader which loads news subscription according to subscribers oxid

Parameters

string

$sOxUserId

subscribers oxid

Returns

bool

setOptInEmailStatus()

OxidEsales\EshopCommunity\Application\Model\NewsSubscribed::setOptInEmailStatus

(

$iStatus

)

Newsletter subscription email sending status setter

Parameters

int

$iStatus

subscription status

setOptInStatus()

OxidEsales\EshopCommunity\Application\Model\NewsSubscribed::setOptInStatus

(

$iStatus

)

Newsletter subscription status setter

Parameters

int

$iStatus

subscription status

updateSubscription()

OxidEsales\EshopCommunity\Application\Model\NewsSubscribed::updateSubscription

(

$oUser

)

This method is called from \OxidEsales\Eshop\Application\Model\User::update. Currently it updates user information kept in db

Parameters

\OxidEsales\Eshop\Application\Model\User

$oUser

subscription user object

Returns

bool

wasUnsubscribed()

OxidEsales\EshopCommunity\Application\Model\NewsSubscribed::wasUnsubscribed

(

)

Check if was ever unsubscribed by unsubscribed field.

Returns

bool

Member Data Documentation

$_blWasPreSubscribed

OxidEsales\EshopCommunity\Application\Model\NewsSubscribed::$_blWasPreSubscribed = false

protected

$_blWasSubscribed

OxidEsales\EshopCommunity\Application\Model\NewsSubscribed::$_blWasSubscribed = false

protected

$_sClassName

OxidEsales\EshopCommunity\Application\Model\NewsSubscribed::$_sClassName = 'oxnewssubscribed'

protected

---

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

• /oxideshop-ce/source/Application/Model/NewsSubscribed.php