oxNewsletter Class Reference

Inheritance diagram for oxNewsletter:

[legend]

Collaboration diagram for oxNewsletter:

[legend]

List of all members.

---

Detailed Description

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

Public Member Functions
	__construct ()
	delete ($sOxId=null)
	getGroups ()
	getHtmlText ()
	getPlainText ()
	prepare ($sUserid, $blPerfLoadAktion=false)
	send ()
Protected Member Functions
	_setParams ($oShop, $oCurrency, $blPerfLoadAktion=false)
	_setUser ($sUserid)
	_assignProducts ($blPerfLoadAktion=false)
	_setFieldData ($sFieldName, $sValue, $iDataType=oxField::T_TEXT)
Protected Attributes
	$_oSmarty = null
	$_sHtmlText = null
	$_sPlainText = null
	$_oGroups = null
	$_oUser = null
	$_sClassName = 'oxnewsletter'

---

Constructor & Destructor Documentation

oxNewsletter.__construct

(

)

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

Reimplemented from oxBase.

---

Member Function Documentation

oxNewsletter.delete

(

$

sOxId = null

)

Deletes object information from DB, returns true on success.

Parameters:

string

$sOxId object ID (default null)

Returns:

bool

Reimplemented from oxBase.

oxNewsletter.getGroups

(

)

Returns assigned user groups list object

Returns:

object $_oGroups

oxNewsletter.getHtmlText

(

)

Returns assigned HTML text

Returns:

string

oxNewsletter.getPlainText

(

)

Returns assigned plain text

Returns:

string

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

Returns:

null

oxNewsletter.send

(

)

Creates oxemail object, calls mail sending function (oxEMail.sendNewsletterMail()), returns true on success (if mailing function was unable to complete, sets emailing to user failure status in DB).

Returns:

bool

oxNewsletter._setParams	(	$	oShop,
		$	oCurrency,
		$	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:

	object	$oShop Shop object
	object	$oCurrency Currency object
	bool	$blPerfLoadAktion perform option load actions

Returns:

null

oxNewsletter._setUser

(

$

sUserid

)

[protected]

Creates oxuser object (user ID passed to method),

Parameters:

string

$sUserid User ID or OBJECT

Returns:

null

oxNewsletter._assignProducts

(

$

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:

bool

$blPerfLoadAktion perform option load actions

Returns:

null

oxNewsletter._setFieldData	(	$	sFieldName,
		$	sValue,
		$	iDataType = oxField::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	field type

Returns:

null

Reimplemented from oxBase.

---

Member Data Documentation

oxNewsletter.$_oSmarty = null [protected]

oxNewsletter.$_sHtmlText = null [protected]

oxNewsletter.$_sPlainText = null [protected]

oxNewsletter.$_oGroups = null [protected]

oxNewsletter.$_oUser = null [protected]

oxNewsletter.$_sClassName = 'oxnewsletter' [protected]

Reimplemented from oxBase.

---

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

• core/oxnewsletter.php