OXID eShop CE  4.9.6
 All Classes Files Functions Variables Pages
oxNewsSubscribed Class Reference
+ Inheritance diagram for oxNewsSubscribed:
+ Collaboration diagram for oxNewsSubscribed:

Public Member Functions

 __construct ()
 load ($oxId)
 loadFromEmail ($sEmailAddress)
 loadFromUserId ($sOxUserId)
 getOptInStatus ()
 setOptInStatus ($iStatus)
 getOptInEmailStatus ()
 setOptInEmailStatus ($iStatus)
 wasUnsubscribed ()
 updateSubscription ($oUser)
- 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 ()
 isLoaded ()
 buildSelectString ($aWhere=null)
 assignRecord ($sSelect)
 getFieldData ($sFieldName)
 getSelectFields ($blForceCoreTableUsage=null)
 delete ($sOxId=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

 _insert ()
 _update ()
- 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)
 _setFieldData ($sFieldName, $sValue, $iDataType=oxField::T_TEXT)
 _canFieldBeNull ($sFieldName)
 _getFieldDefaultValue ($sFieldName)
 _getUpdateFieldValue ($sFieldName, $oField)
 _getUpdateFields ($blUseSkipSaveFields=true)
 _isDisabledFieldCache ()
 _addSkippedSaveFieldsForMapping ()
 _disableLazyLoadingForCaching ()

Protected Attributes

 $_blWasSubscribed = false
 $_blWasPreSubscribed = false
 $_sClassName = 'oxnewssubscribed'
- 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 Subscriptions manager Performs user managing function information, deletion and other.

Definition at line 9 of file oxnewssubscribed.php.

Constructor & Destructor Documentation

oxNewsSubscribed::__construct ( )

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

Reimplemented from oxBase.

Definition at line 37 of file oxnewssubscribed.php.

Member Function Documentation

oxNewsSubscribed::_insert ( )
protected

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

Returns
mixed oxid on success or false on failure

Reimplemented from oxBase.

Definition at line 102 of file oxnewssubscribed.php.

oxNewsSubscribed::_update ( )
protected

We need to check if we unsubscribe here

Returns
mixed oxid on success or false on failure

Definition at line 115 of file oxnewssubscribed.php.

oxNewsSubscribed::getOptInEmailStatus ( )

Newsletter subscription email sending status getter

Returns
int

Definition at line 161 of file oxnewssubscribed.php.

oxNewsSubscribed::getOptInStatus ( )

Newsletter subscription status getter

Returns
int

Definition at line 140 of file oxnewssubscribed.php.

oxNewsSubscribed::load (   $oxId)

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

Parameters
string$oxIdoxnewssubscribed ID
Returns
bool

Reimplemented from oxBase.

Definition at line 53 of file oxnewssubscribed.php.

oxNewsSubscribed::loadFromEmail (   $sEmailAddress)

Loader which loads news subscription according to subscribers email address

Parameters
string$sEmailAddresssubscribers email address
Returns
bool

Definition at line 73 of file oxnewssubscribed.php.

oxNewsSubscribed::loadFromUserId (   $sOxUserId)

Loader which loads news subscription according to subscribers oxid

Parameters
string$sOxUserIdsubscribers oxid
Returns
bool

Definition at line 89 of file oxnewssubscribed.php.

oxNewsSubscribed::setOptInEmailStatus (   $iStatus)

Newsletter subscription email sending status setter

Parameters
int$iStatussubscription status

Definition at line 171 of file oxnewssubscribed.php.

oxNewsSubscribed::setOptInStatus (   $iStatus)

Newsletter subscription status setter

Parameters
int$iStatussubscription status

Definition at line 150 of file oxnewssubscribed.php.

oxNewsSubscribed::updateSubscription (   $oUser)

This method is called from oxuser::update. Currently it updates user information kept in db

Parameters
oxuser$oUsersubscription user object
Returns
bool

Definition at line 199 of file oxnewssubscribed.php.

oxNewsSubscribed::wasUnsubscribed ( )

Check if was ever unsubscribed by unsubscribed field.

Returns
bool

Definition at line 182 of file oxnewssubscribed.php.

Member Data Documentation

oxNewsSubscribed::$_blWasPreSubscribed = false
protected

Definition at line 24 of file oxnewssubscribed.php.

oxNewsSubscribed::$_blWasSubscribed = false
protected

Definition at line 17 of file oxnewssubscribed.php.

oxNewsSubscribed::$_sClassName = 'oxnewssubscribed'
protected

Definition at line 31 of file oxnewssubscribed.php.


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