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.

Definition at line 9 of file oxnewsletter.php.


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.

Definition at line 57 of file oxnewsletter.php.


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.

Definition at line 74 of file oxnewsletter.php.

oxNewsletter.getGroups (  ) 

Returns assigned user groups list object

Returns:
object $_oGroups

Definition at line 98 of file oxnewsletter.php.

oxNewsletter.getHtmlText (  ) 

Returns assigned HTML text

Returns:
string

Definition at line 121 of file oxnewsletter.php.

oxNewsletter.getPlainText (  ) 

Returns assigned plain text

Returns:
string

Definition at line 131 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
Returns:
null

Definition at line 145 of file oxnewsletter.php.

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

Definition at line 173 of file oxnewsletter.php.

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

Definition at line 197 of file oxnewsletter.php.

oxNewsletter._setUser ( sUserid  )  [protected]

Creates oxuser object (user ID passed to method),

Parameters:
string $sUserid User ID or OBJECT
Returns:
null

Definition at line 223 of file oxnewsletter.php.

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

Definition at line 242 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 296 of file oxnewsletter.php.


Member Data Documentation

oxNewsletter.$_oSmarty = null [protected]

Definition at line 16 of file oxnewsletter.php.

oxNewsletter.$_sHtmlText = null [protected]

Definition at line 23 of file oxnewsletter.php.

oxNewsletter.$_sPlainText = null [protected]

Definition at line 30 of file oxnewsletter.php.

oxNewsletter.$_oGroups = null [protected]

Definition at line 37 of file oxnewsletter.php.

oxNewsletter.$_oUser = null [protected]

Definition at line 44 of file oxnewsletter.php.

oxNewsletter.$_sClassName = 'oxnewsletter' [protected]

Reimplemented from oxBase.

Definition at line 51 of file oxnewsletter.php.


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

Generated on Thu Dec 4 12:05:28 2008 for OXID eShop CE by  doxygen 1.5.5