oxNewsletter Class Reference

Inheritance diagram for oxNewsletter:

Collaboration diagram for oxNewsletter:

Public Member Functions
	__construct ()
	delete ($sOxId=null)
	getGroups ()
	getHtmlText ()
	getPlainText ()
	prepare ($sUserid, $blPerfLoadAktion=false)
	send ()
Public Member Functions inherited from oxBase
	getUseSkipSaveFields ()
	setUseSkipSaveFields ($blUseSkipSaveFields)
	__set ($sName, $sValue)
	__get ($sName)
	__isset ($mVar)
	__clone ()
	oxClone ($oObject)
	getUpdateSeo ()
	setUpdateSeo ($blUpdateSeo)
	init ($sTableName=null, $blForceAllFields=false)
	assign ($dbRecord)
	getClassName ()
	getCoreTableName ()
	getId ()
	setId ($sOXID=null)
	setShopId ($iShopId)
	getShopId ()
	getViewName ($blForceCoreTableUsage=null)
	modifyCacheKey ($sCacheKey, $blOverride=false)
	disableLazyLoading ()
	isDerived ()
	setIsDerived ($blVal)
	isMultilang ()
	load ($sOXID)
	isLoaded ()
	buildSelectString ($aWhere=null)
	assignRecord ($sSelect)
	getFieldData ($sFieldName)
	getSelectFields ($blForceCoreTableUsage=null)
	save ()
	allowDerivedUpdate ()
	allowDerivedDelete ()
	exists ($sOXID=null)
	getSqlActiveSnippet ($blForceCoreTable=null)
	beforeUpdate ($sOXID=null)
	onChange ($iAction=null, $sOXID=null)
	setInList ()
	isOx ()
	isReadOnly ()
	setReadOnly ($blReadOnly)
	getFieldNames ()
	addFieldName ($sName)
	getLanguage ()
Public Member Functions inherited from oxSuperCfg
	__call ($sMethod, $aArgs)
	getConfig ()
	setConfig ($oConfig)
	getSession ()
	setSession ($oSession)
	getUser ()
	setUser ($oUser)
	isAdmin ()
	setAdminMode ($blAdmin)

Protected Member Functions
	_setParams ($blPerfLoadAktion=false)
	_setUser ($sUserid)
	_assignProducts ($oView, $blPerfLoadAktion=false)
	_setFieldData ($sFieldName, $sValue, $iDataType=oxField::T_TEXT)
Protected Member Functions inherited from oxBase
	_setUpdateSeoOnFieldChange ($sField)
	_removeElement2ShopRelations ($sOxId)
	_isInList ()
	_getObjectViewName ($sTable, $sShopID=null)
	_getTableFields ($sTable, $blReturnSimple=false)
	_getAllFields ($blReturnSimple=false)
	_initDataStructure ($blForceFullStructure=false)
	_getNonCachedFieldNames ($blForceFullStructure=false)
	_getFieldStatus ($sFieldName)
	_addField ($sName, $iStatus, $sType=null, $sLength=null)
	_getFieldLongName ($sFieldName)
	_canFieldBeNull ($sFieldName)
	_getFieldDefaultValue ($sFieldName)
	_getUpdateFieldValue ($sFieldName, $oField)
	_getUpdateFields ($blUseSkipSaveFields=true)
	_insert ()
	_isDisabledFieldCache ()
	_addSkippedSaveFieldsForMapping ()
	_disableLazyLoadingForCaching ()

Protected Attributes
	$_sHtmlText = null
	$_sPlainText = null
	$_oGroups = null
	$_oUser = null
	$_sClassName = 'oxnewsletter'
Protected Attributes inherited from oxBase
	$_sOXID = null
	$_iShopId = null
	$_blIsSimplyClonable = true
	$_sClassName = 'oxbase'
	$_sCoreTable = null
	$_sViewTable = null
	$_aFieldNames = array('oxid' => 0)
	$_sCacheKey = null
	$_blUseLazyLoading = false
	$_aSkipSaveFields = array('oxtimestamp')
	$_blUseSkipSaveFields = true
	$_sExistKey = 'oxid'
	$_blIsDerived = null
	$_blIsSeoObject = false
	$_blUpdateSeo = true
	$_blReadOnly = false
	$_blIsInList = false
	$_isLoaded = false
	$_aInnerLazyCache = null
	$_blEmployMultilanguage = false

Additional Inherited Members
Static Protected Attributes inherited from oxBase
static	$_blDisableFieldCaching = array()

Detailed Description

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

Definition at line 9 of file oxnewsletter.php.

Constructor & Destructor Documentation

oxNewsletter::__construct

(

)

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

Reimplemented from oxBase.

Definition at line 51 of file oxnewsletter.php.

Member Function Documentation

oxNewsletter::_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

oxview	$oView	view object to store view data
bool	$blPerfLoadAktion	perform option load actions

Definition at line 222 of file oxnewsletter.php.

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	$iDataType	field type

Returns

null

Reimplemented from oxBase.

Definition at line 263 of file oxnewsletter.php.

oxNewsletter::_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

Definition at line 171 of file oxnewsletter.php.

oxNewsletter::_setUser (   $sUserid )

protected

Creates oxuser object (user ID passed to method),

Parameters

string

$sUserid

User ID or OBJECT

Definition at line 203 of file oxnewsletter.php.

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.

Definition at line 64 of file oxnewsletter.php.

oxNewsletter::getGroups

(

)

Returns assigned user groups list object

Returns

object $_oGroups

Definition at line 89 of file oxnewsletter.php.

oxNewsletter::getHtmlText

(

)

Returns assigned HTML text

Returns

string

Definition at line 113 of file oxnewsletter.php.

oxNewsletter::getPlainText

(

)

Returns assigned plain text

Returns

string

Definition at line 123 of file oxnewsletter.php.

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

Definition at line 135 of file oxnewsletter.php.

oxNewsletter::send

(

)

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

Returns

bool

Definition at line 156 of file oxnewsletter.php.

Member Data Documentation

oxNewsletter::$_oGroups = null

protected

Definition at line 31 of file oxnewsletter.php.

oxNewsletter::$_oUser = null

protected

Definition at line 38 of file oxnewsletter.php.

oxNewsletter::$_sClassName = 'oxnewsletter'

protected

Definition at line 45 of file oxnewsletter.php.

oxNewsletter::$_sHtmlText = null

protected

Definition at line 17 of file oxnewsletter.php.

oxNewsletter::$_sPlainText = null

protected

Definition at line 24 of file oxnewsletter.php.

---

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

• application/models/oxnewsletter.php