Class Mage_Newsletter_Model_Subscriber

Description

Subscriber model

Located in /Newsletter/Model/Subscriber.php (line 34)

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Newsletter_Model_Subscriber
Class Constant Summary
XML_PATH_ALLOW_GUEST_SUBSCRIBE_FLAG = 'newsletter/subscription/allow_guest_subscribe'
XML_PATH_CONFIRMATION_FLAG = 'newsletter/subscription/confirm'
XML_PATH_CONFIRM_EMAIL_IDENTITY = 'newsletter/subscription/confirm_email_identity'
XML_PATH_CONFIRM_EMAIL_TEMPLATE = 'newsletter/subscription/confirm_email_template'
XML_PATH_SENDING_SET_RETURN_PATH = Mage_Core_Model_Email_Template::XML_PATH_SENDING_SET_RETURN_PATH
XML_PATH_SUCCESS_EMAIL_IDENTITY = 'newsletter/subscription/success_email_identity'
XML_PATH_SUCCESS_EMAIL_TEMPLATE = 'newsletter/subscription/success_email_template'
XML_PATH_UNSUBSCRIBE_EMAIL_IDENTITY = 'newsletter/subscription/un_email_identity'
XML_PATH_UNSUBSCRIBE_EMAIL_TEMPLATE = 'newsletter/subscription/un_email_template'
Variable Summary
Method Summary
boolean confirm (string $code)
string getCode ()
string getEmail ()
int getId ()
boolean getIsStatusChanged ()
int getStatus ()
string|null getSubscriberFullName ()
bool isSubscribed ()
void loadByEmail ( $subscriberEmail, int $subscriberId)
void randomSequence ([ $length = 32])
void setCode (string $value)
void setEmail (string $value)
void setId (int $value)
void setIsStatusChanged (boolean $value)
unknown setMessagesScope (boolean $scope)
void setStatus (int $value)
void subscribe ( $email)
void unsubscribe ()
void _construct ()
Variables
string $_eventObject = 'subscriber' (line 69)

Parameter name in event

In observe method you can use $observer->getEvent()->getObject() in this case

  • access: protected

Redefinition of:
Mage_Core_Model_Abstract::$_eventObject
Parameter name in event
string $_eventPrefix = 'newsletter_subscriber' (line 60)

Prefix of model events names

  • access: protected

Redefinition of:
Mage_Core_Model_Abstract::$_eventPrefix
Prefix of model events names
mixed $_isStatusChanged = false (line 72)
  • access: protected

Inherited Variables

Inherited from Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::$_cacheTag
Mage_Core_Model_Abstract::$_dataSaveAllowed
Mage_Core_Model_Abstract::$_isObjectNew
Mage_Core_Model_Abstract::$_resource
Mage_Core_Model_Abstract::$_resourceCollectionName
Mage_Core_Model_Abstract::$_resourceName
Methods
confirm (line 423)

Confirms subscriber newsletter

  • access: public
boolean confirm (string $code)
  • string $code
getCode (line 107)

Alias for getSubscriberConfirmCode()

  • access: public
string getCode ()
getConfirmationLink (line 117)

Return link for confirmation of subscription

  • access: public
string getConfirmationLink ()
getEmail (line 174)

Alias for getSubscriberEmail()

  • access: public
string getEmail ()
getId (line 87)

Alias for getSubscriberId()

  • access: public
int getId ()

Redefinition of:
Mage_Core_Model_Abstract::getId()
Retrieve model object identifier
getIsStatusChanged (line 205)

Return status change flag value

  • access: public
boolean getIsStatusChanged ()
getStatus (line 141)

Alias for getSubscriberStatus()

  • access: public
int getStatus ()
getSubscriberFullName (line 538)

Retrieve Subscribers Full Name if it was set

  • access: public
string|null getSubscriberFullName ()
getUnsubscriptionLink (line 121)
  • access: public
void getUnsubscriptionLink ()
isSubscribed (line 215)

Return customer subscription status

  • access: public
bool isSubscribed ()
loadByCustomer (line 242)

Load subscriber info by customer

  • access: public
Mage_Newsletter_Model_Subscriber loadByCustomer ( $customer)
loadByEmail (line 230)

Load subscriber data from resource model by email

  • access: public
void loadByEmail ( $subscriberEmail, int $subscriberId)
  • int $subscriberId
  • $subscriberEmail
randomSequence (line 258)
  • access: public
void randomSequence ([ $length = 32])
  • $length
received (line 441)

Mark receiving subscriber of queue newsletter

  • access: public
boolean received (Mage_Newsletter_Model_Queue $queue)
sendConfirmationRequestEmail (line 447)
  • access: public
void sendConfirmationRequestEmail ()
sendConfirmationSuccessEmail (line 476)
  • access: public
void sendConfirmationSuccessEmail ()
sendUnsubscriptionEmail (line 505)
  • access: public
void sendUnsubscriptionEmail ()
setCode (line 131)

Alias for setSubscriberConfirmCode()

  • access: public
void setCode (string $value)
  • string $value
setEmail (line 184)

Alias for setSubscriberEmail()

  • access: public
void setEmail (string $value)
  • string $value
setId (line 97)

Alias for setSubscriberId()

  • access: public
void setId (int $value)
  • int $value

Redefinition of:
Mage_Core_Model_Abstract::setId()
Declare model object identifier value
setIsStatusChanged (line 194)

Set for status change flag

  • access: public
void setIsStatusChanged (boolean $value)
  • boolean $value
setMessagesScope (line 163)

Set the error messages scope for subscription

  • access: public
unknown setMessagesScope (boolean $scope)
  • boolean $scope
setStatus (line 151)

Alias for setSubscriberStatus()

  • access: public
void setStatus (int $value)
  • int $value
subscribe (line 272)
  • access: public
void subscribe ( $email)
  • $email
subscribeCustomer (line 349)

Saving customer subscription status

  • access: public
unsubscribe (line 331)
  • access: public
void unsubscribe ()
_construct (line 77)

Initialize resource model

  • access: protected
void _construct ()

Inherited Methods

Inherited From Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::afterCommitCallback()
Mage_Core_Model_Abstract::afterLoad()
Mage_Core_Model_Abstract::cleanModelCache()
Mage_Core_Model_Abstract::clearInstance()
Mage_Core_Model_Abstract::delete()
Mage_Core_Model_Abstract::getCacheIdTags()
Mage_Core_Model_Abstract::getCacheTags()
Mage_Core_Model_Abstract::getCollection()
Mage_Core_Model_Abstract::getEntityId()
Mage_Core_Model_Abstract::getId()
Mage_Core_Model_Abstract::getIdFieldName()
Mage_Core_Model_Abstract::getResource()
Mage_Core_Model_Abstract::getResourceCollection()
Mage_Core_Model_Abstract::getResourceName()
Mage_Core_Model_Abstract::isObjectNew()
Mage_Core_Model_Abstract::load()
Mage_Core_Model_Abstract::save()
Mage_Core_Model_Abstract::setId()
Mage_Core_Model_Abstract::_afterDelete()
Mage_Core_Model_Abstract::_afterDeleteCommit()
Mage_Core_Model_Abstract::_afterLoad()
Mage_Core_Model_Abstract::_afterSave()
Mage_Core_Model_Abstract::_afterSaveCommit()
Mage_Core_Model_Abstract::_beforeDelete()
Mage_Core_Model_Abstract::_beforeLoad()
Mage_Core_Model_Abstract::_beforeSave()
Mage_Core_Model_Abstract::_clearData()
Mage_Core_Model_Abstract::_clearReferences()
Mage_Core_Model_Abstract::_getEventData()
Mage_Core_Model_Abstract::_getResource()
Mage_Core_Model_Abstract::_hasModelChanged()
Mage_Core_Model_Abstract::_init()
Mage_Core_Model_Abstract::_protectFromNonAdmin()
Mage_Core_Model_Abstract::_setResourceModel()
Class Constants
STATUS_NOT_ACTIVE = 2 (line 37)
STATUS_SUBSCRIBED = 1 (line 36)
STATUS_UNCONFIRMED = 4 (line 39)
STATUS_UNSUBSCRIBED = 3 (line 38)
XML_PATH_ALLOW_GUEST_SUBSCRIBE_FLAG = 'newsletter/subscription/allow_guest_subscribe' (line 48)
XML_PATH_CONFIRMATION_FLAG = 'newsletter/subscription/confirm' (line 47)
XML_PATH_CONFIRM_EMAIL_IDENTITY = 'newsletter/subscription/confirm_email_identity' (line 42)
XML_PATH_CONFIRM_EMAIL_TEMPLATE = 'newsletter/subscription/confirm_email_template' (line 41)
XML_PATH_SENDING_SET_RETURN_PATH = Mage_Core_Model_Email_Template::XML_PATH_SENDING_SET_RETURN_PATH (line 53)
  • deprecated: since 1.4.0.1
XML_PATH_SUCCESS_EMAIL_IDENTITY = 'newsletter/subscription/success_email_identity' (line 44)
XML_PATH_SUCCESS_EMAIL_TEMPLATE = 'newsletter/subscription/success_email_template' (line 43)
XML_PATH_UNSUBSCRIBE_EMAIL_IDENTITY = 'newsletter/subscription/un_email_identity' (line 46)
XML_PATH_UNSUBSCRIBE_EMAIL_TEMPLATE = 'newsletter/subscription/un_email_template' (line 45)

Documentation generated on Fri, 11 Feb 2011 17:13:37 +0200 by phpDocumentor 1.4.3