OxidEsales\EshopCommunity\Application\Model\Newsletter Class Reference

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

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

Public Member Functions
	__construct ()
	delete ($sOxId=null)
	getGroups ()
	getHtmlText ()
	getPlainText ()
	prepare ($sUserid, $blPerfLoadAktion=false)
	send ()

Protected Member Functions
	_setParams ($blPerfLoadAktion=false)
	_setUser ($sUserid)
	_assignProducts ($oView, $blPerfLoadAktion=false)
	_setFieldData ($sFieldName, $sValue, $iDataType=\OxidEsales\Eshop\Core\Field::T_TEXT)

Protected Attributes
	$_sHtmlText = null
	$_sPlainText = null
	$_oGroups = null
	$_oUser = null
	$_sClassName = 'oxnewsletter'

Detailed Description

Newsletter manager. Performs creation of newsletter text, assign newsletter to user groups, deletes and etc.

Constructor & Destructor Documentation

__construct()

OxidEsales\EshopCommunity\Application\Model\Newsletter::__construct

(

)

Class constructor, initiates Smarty engine object, parent constructor (parent::oxBase()).

Member Function Documentation

_assignProducts()

OxidEsales\EshopCommunity\Application\Model\Newsletter::_assignProducts (   $oView,   $blPerfLoadAktion = false  )

protected

Add newsletter products (#559 only if we have user we can assign this info), adds products which fit to the last order of assigned user.

Parameters

\OxidEsales\Eshop\Core\Controller\BaseController	$oView	view object to store view data
bool	$blPerfLoadAktion	perform option load actions

_setFieldData()

OxidEsales\EshopCommunity\Application\Model\Newsletter::_setFieldData (   $sFieldName,   $sValue,   $iDataType = \OxidEsales\Eshop\Core\Field::T_TEXT  )

protected

Sets data field value

Parameters

string	$sFieldName	index OR name (eg. 'oxarticles__oxtitle') of a data field to set
string	$sValue	value of data field
int	$iDataType	field type

Returns

null

_setParams()

OxidEsales\EshopCommunity\Application\Model\Newsletter::_setParams (   $blPerfLoadAktion = false )

protected

Assigns to Smarty oxuser object, add newsletter products, adds products which fit to the last order of this user, generates HTML and plaintext format newsletters.

Parameters

bool

$blPerfLoadAktion

perform option load actions

_setUser()

OxidEsales\EshopCommunity\Application\Model\Newsletter::_setUser (   $sUserid )

protected

Creates oxuser object (user ID passed to method),

Parameters

string

$sUserid

User ID or OBJECT

delete()

OxidEsales\EshopCommunity\Application\Model\Newsletter::delete

(

$sOxId = null

)

Deletes object information from DB, returns true on success.

Parameters

string

$sOxId

object ID (default null)

Returns

bool

getGroups()

OxidEsales\EshopCommunity\Application\Model\Newsletter::getGroups

(

)

Returns assigned user groups list object

Returns

object $_oGroups

getHtmlText()

OxidEsales\EshopCommunity\Application\Model\Newsletter::getHtmlText

(

)

Returns assigned HTML text

Returns

string

getPlainText()

OxidEsales\EshopCommunity\Application\Model\Newsletter::getPlainText

(

)

Returns assigned plain text

Returns

string

prepare()

OxidEsales\EshopCommunity\Application\Model\Newsletter::prepare	(		$sUserid,
			$blPerfLoadAktion = false
	)

Creates oxshop object and sets base parameters (such as currency and language).

Parameters

string	$sUserid	User ID or OBJECT
bool	$blPerfLoadAktion	perform option load actions

send()

OxidEsales\EshopCommunity\Application\Model\Newsletter::send

(

)

Creates oxemail object, calls mail sending function (oxEMail::sendNewsletterMail() (#2542 added subject field)), returns true on success.

Returns

bool

Member Data Documentation

$_oGroups

OxidEsales\EshopCommunity\Application\Model\Newsletter::$_oGroups = null

protected

$_oUser

OxidEsales\EshopCommunity\Application\Model\Newsletter::$_oUser = null

protected

$_sClassName

OxidEsales\EshopCommunity\Application\Model\Newsletter::$_sClassName = 'oxnewsletter'

protected

$_sHtmlText

OxidEsales\EshopCommunity\Application\Model\Newsletter::$_sHtmlText = null

protected

$_sPlainText

OxidEsales\EshopCommunity\Application\Model\Newsletter::$_sPlainText = null

protected

---

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

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