Class Mage_Newsletter_Model_Subscriber

Subscriber model

Varien_Object

Mage_Newsletter_Model_Subscriber

Package: Mage\Newsletter
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Newsletter/Model/Subscriber.php

Methods summary
`protected`	# `_construct( )` Initialize resource model Initialize resource model
`public integer`	# `getId( )` Alias for getSubscriberId() Alias for getSubscriberId() Returns `integer` Overrides `Mage_Core_Model_Abstract::getId()`
`public Mage_Core_Model_Abstract`	# `setId( integer $value )` Alias for setSubscriberId() Alias for setSubscriberId() Parameters `$value` `integer` $value Returns `Mage_Core_Model_Abstract` Overrides `Mage_Core_Model_Abstract::setId()`
`public string`	# `getCode( )` Alias for getSubscriberConfirmCode() Alias for getSubscriberConfirmCode() Returns `string`
`public string`	# `getConfirmationLink( )` Return link for confirmation of subscription Return link for confirmation of subscription Returns `string`
`public string`	# `getUnsubscriptionLink( )` Returns Insubscribe url Returns Insubscribe url Returns `string`
`public`	# `setCode( string $value )` Alias for setSubscriberConfirmCode() Alias for setSubscriberConfirmCode() Parameters `$value` `string` $value
`public integer`	# `getStatus( )` Alias for getSubscriberStatus() Alias for getSubscriberStatus() Returns `integer`
`public`	# `setStatus( integer $value )` Alias for setSubscriberStatus() Alias for setSubscriberStatus() Parameters `$value` `integer`
`public Mage_Newsletter_Model_Subscriber`	# `setMessagesScope( boolean $scope )` Set the error messages scope for subscription Set the error messages scope for subscription Parameters `$scope` `boolean` $scope Returns `Mage_Newsletter_Model_Subscriber`
`public string`	# `getEmail( )` Alias for getSubscriberEmail() Alias for getSubscriberEmail() Returns `string`
`public`	# `setEmail( string $value )` Alias for setSubscriberEmail() Alias for setSubscriberEmail() Parameters `$value` `string` $value
`public`	# `setIsStatusChanged( boolean $value )` Set for status change flag Set for status change flag Parameters `$value` `boolean` $value
`public boolean`	# `getIsStatusChanged( )` Return status change flag value Return status change flag value Returns `boolean`
`public boolean`	# `isSubscribed( )` Return customer subscription status Return customer subscription status Returns `boolean`
`public`	# `loadByEmail( integer $subscriberEmail )` Load subscriber data from resource model by email Load subscriber data from resource model by email Parameters `$subscriberEmail` `integer` $subscriberId
`public Mage_Newsletter_Model_Subscriber`	# `loadByCustomer( Mage_Customer_Model_Customer $customer )` Load subscriber info by customer Load subscriber info by customer Parameters `$customer` `Mage_Customer_Model_Customer` $customer Returns `Mage_Newsletter_Model_Subscriber`
`public string`	# `randomSequence( integer $length = 32 )` Returns sting of random chars Returns sting of random chars Parameters `$length` `integer` $length Returns `string`
`public integer`	# `subscribe( string $email )` Subscribes by email Subscribes by email Parameters `$email` `string` $email Returns `integer` Throws `Exception`
`public`	# `unsubscribe( )` Unsubscribes loaded subscription Unsubscribes loaded subscription
`public Mage_Newsletter_Model_Subscriber`	# `subscribeCustomer( Mage_Customer_Model_Customer $customer )` Saving customer subscription status Saving customer subscription status Parameters `$customer` `Mage_Customer_Model_Customer` $customer Returns `Mage_Newsletter_Model_Subscriber`
`public boolean`	# `confirm( string $code )` Confirms subscriber newsletter Confirms subscriber newsletter Parameters `$code` `string` $code Returns `boolean`
`public boolean`	# `received( Mage_Newsletter_Model_Queue $queue )` Mark receiving subscriber of queue newsletter Mark receiving subscriber of queue newsletter Parameters `$queue` `Mage_Newsletter_Model_Queue` $queue Returns `boolean`
`public Mage_Newsletter_Model_Subscriber`	# `sendConfirmationRequestEmail( )` Sends out confirmation email Sends out confirmation email Returns `Mage_Newsletter_Model_Subscriber`
`public Mage_Newsletter_Model_Subscriber`	# `sendConfirmationSuccessEmail( )` Sends out confirmation success email Sends out confirmation success email Returns `Mage_Newsletter_Model_Subscriber`
`public Mage_Newsletter_Model_Subscriber`	# `sendUnsubscriptionEmail( )` Sends out unsubsciption email Sends out unsubsciption email Returns `Mage_Newsletter_Model_Subscriber`
`public string\|null`	# `getSubscriberFullName( )` Retrieve Subscribers Full Name if it was set Retrieve Subscribers Full Name if it was set Returns `string\|null`

Methods inherited from Mage_Core_Model_Abstract
_afterDelete(), _afterDeleteCommit(), _afterLoad(), _afterSave(), _beforeDelete(), _beforeLoad(), _beforeSave(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _hasModelChanged(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), save()

Constants summary
`integer`	`STATUS_SUBSCRIBED`	`1`	#
`integer`	`STATUS_NOT_ACTIVE`	`2`	#
`integer`	`STATUS_UNSUBSCRIBED`	`3`	#
`integer`	`STATUS_UNCONFIRMED`	`4`	#
`string`	`XML_PATH_CONFIRM_EMAIL_TEMPLATE`	`'newsletter/subscription/confirm_email_template'`	#
`string`	`XML_PATH_CONFIRM_EMAIL_IDENTITY`	`'newsletter/subscription/confirm_email_identity'`	#
`string`	`XML_PATH_SUCCESS_EMAIL_TEMPLATE`	`'newsletter/subscription/success_email_template'`	#
`string`	`XML_PATH_SUCCESS_EMAIL_IDENTITY`	`'newsletter/subscription/success_email_identity'`	#
`string`	`XML_PATH_UNSUBSCRIBE_EMAIL_TEMPLATE`	`'newsletter/subscription/un_email_template'`	#
`string`	`XML_PATH_UNSUBSCRIBE_EMAIL_IDENTITY`	`'newsletter/subscription/un_email_identity'`	#
`string`	`XML_PATH_CONFIRMATION_FLAG`	`'newsletter/subscription/confirm'`	#
`string`	`XML_PATH_ALLOW_GUEST_SUBSCRIBE_FLAG`	`'newsletter/subscription/allow_guest_subscribe'`	#

Properties summary
`protected string`	`$_eventPrefix`	`'newsletter_subscriber'`	# Prefix of model events names Prefix of model events names
`protected string`	`$_eventObject`	`'subscriber'`	# Parameter name in event Parameter name in event In observe method you can use $observer->getEvent()->getObject() in this case
`protected boolean`	`$_isStatusChanged`	`false`	# True if data changed True if data changed

Properties inherited from Mage_Core_Model_Abstract
`$_cacheTag, $_dataSaveAllowed, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName`

Packages

Classes

Class Mage_Newsletter_Model_Subscriber

Returns

Overrides

Parameters

Returns

Overrides

Returns

Returns

Returns

Parameters

Returns

Parameters

Parameters

Returns

Returns

Parameters

Parameters

Returns

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns