Inheritance diagram for Subscriber:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Newsletter\Helper\Data $newsletterData, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Framework\Mail\Template\TransportBuilder $transportBuilder, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Customer\Model\Session $customerSession, CustomerRepositoryInterface $customerRepository, AccountManagementInterface $customerAccountManagement, \Magento\Framework\Translate\Inline\StateInterface $inlineTranslation, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[], \Magento\Framework\Stdlib\DateTime\DateTime $dateTime=null, CustomerInterfaceFactory $customerFactory=null, DataObjectHelper $dataObjectHelper=null)

	getId ()

	setId ($value)

	getCode ()

	getConfirmationLink ()

	getUnsubscriptionLink ()

	setCode ($value)

	getStatus ()

	setStatus ($value)

	setMessagesScope ($scope)

	getEmail ()

	setEmail ($value)

	setStatusChanged ($value)

	isStatusChanged ()

	isSubscribed ()

	loadByCustomerId ($customerId)

	randomSequence ($length=32)

	subscribe ($email)

	unsubscribe ()

	subscribeCustomerById ($customerId)

	unsubscribeCustomerById ($customerId)

	updateSubscription ($customerId)

	confirm ($code)

	received (\Magento\Newsletter\Model\Queue $queue)

	sendConfirmationRequestEmail ()

	sendConfirmationSuccessEmail ()

	sendUnsubscriptionEmail ()

	getSubscriberFullName ()

	beforeSave ()

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Data Fields
const	STATUS_SUBSCRIBED = 1

const	STATUS_NOT_ACTIVE = 2

const	STATUS_UNSUBSCRIBED = 3

const	STATUS_UNCONFIRMED = 4

const	XML_PATH_CONFIRM_EMAIL_TEMPLATE = 'newsletter/subscription/confirm_email_template'

const	XML_PATH_CONFIRM_EMAIL_IDENTITY = 'newsletter/subscription/confirm_email_identity'

const	XML_PATH_SUCCESS_EMAIL_TEMPLATE = 'newsletter/subscription/success_email_template'

const	XML_PATH_SUCCESS_EMAIL_IDENTITY = 'newsletter/subscription/success_email_identity'

const	XML_PATH_UNSUBSCRIBE_EMAIL_TEMPLATE = 'newsletter/subscription/un_email_template'

const	XML_PATH_UNSUBSCRIBE_EMAIL_IDENTITY = 'newsletter/subscription/un_email_identity'

const	XML_PATH_CONFIRMATION_FLAG = 'newsletter/subscription/confirm'

const	XML_PATH_ALLOW_GUEST_SUBSCRIBE_FLAG = 'newsletter/subscription/allow_guest_subscribe'

Protected Member Functions
	_construct ()

	_updateCustomerSubscription ($customerId, $subscribe)

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_eventPrefix = 'newsletter_subscriber'

	$_eventObject = 'subscriber'

	$_isStatusChanged = false

	$_newsletterData = null

	$_scopeConfig

	$_customerSession

	$_storeManager

	$customerRepository

	$customerAccountManagement

	$_transportBuilder

	$inlineTranslation

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Subscriber model

@method int getStoreId() @method $this setStoreId(int $value) @method string getChangeStatusAt() @method $this setChangeStatusAt(string $value) @method int getCustomerId() @method $this setCustomerId(int $value) @method string getSubscriberEmail() @method $this setSubscriberEmail(string $value) @method int getSubscriberStatus() @method $this setSubscriberStatus(int $value) @method string getSubscriberConfirmCode() @method $this setSubscriberConfirmCode(string $value) @method int getSubscriberId() @method Subscriber setSubscriberId(int $value)

@SuppressWarnings(PHPMD.CouplingBetweenObjects) @SuppressWarnings(PHPMD.CyclomaticComplexity)

@api

Since: 100.0.2

Definition at line 40 of file Subscriber.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Newsletter\Helper\Data	$newsletterData,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Framework\Mail\Template\TransportBuilder	$transportBuilder,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Customer\Model\Session	$customerSession,
		CustomerRepositoryInterface	$customerRepository,
		AccountManagementInterface	$customerAccountManagement,
		\Magento\Framework\Translate\Inline\StateInterface	$inlineTranslation,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`,
		\Magento\Framework\Stdlib\DateTime\DateTime	$dateTime = `null`,
		CustomerInterfaceFactory	$customerFactory = `null`,
		DataObjectHelper	$dataObjectHelper = `null`
	)

Initialize dependencies.

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Newsletter\Helper\Data	$newsletterData
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Framework\Mail\Template\TransportBuilder	$transportBuilder
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Customer\Model\Session	$customerSession
CustomerRepositoryInterface	$customerRepository
AccountManagementInterface	$customerAccountManagement
\Magento\Framework\Translate\Inline\StateInterface	$inlineTranslation
\Magento\Framework\Model\ResourceModel\AbstractResource \| null	$resource
\Magento\Framework\Data\Collection\AbstractDb \| null	$resourceCollection
array	$data
\Magento\Framework\Stdlib\DateTime\DateTime \| null	$dateTime
CustomerInterfaceFactory \| null	$customerFactory
DataObjectHelper \| null	$dataObjectHelper	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 164 of file Subscriber.php.

       {
         $this->_newsletterData = $newsletterData;
         $this->_scopeConfig = $scopeConfig;
         $this->_transportBuilder = $transportBuilder;
         $this->_storeManager = $storeManager;
         $this->_customerSession = $customerSession;
         $this->dateTime = $dateTime ?: \Magento\Framework\App\ObjectManager::getInstance()->get(
             \Magento\Framework\Stdlib\DateTime\DateTime::class
         );
         $this->customerFactory = $customerFactory ?: ObjectManager::getInstance()
             ->get(CustomerInterfaceFactory::class);
         $this->dataObjectHelper = $dataObjectHelper ?: ObjectManager::getInstance()
             ->get(DataObjectHelper::class);
         $this->customerRepository = $customerRepository;
         $this->customerAccountManagement = $customerAccountManagement;
         $this->inlineTranslation = $inlineTranslation;
         parent::__construct($context, $registry, $resource, $resourceCollection, $data);
     }

Member Function Documentation

◆ _construct()

_construct ( )

protected

Initialize resource model

Returns: void

Definition at line 205 of file Subscriber.php.

     {
         $this->_init(\Magento\Newsletter\Model\ResourceModel\Subscriber::class);
     }

◆ _updateCustomerSubscription()

_updateCustomerSubscription	(	$customerId,
		$subscribe
	)

protected

Saving customer subscription status

Parameters

int	$customerId
bool	$subscribe	indicates whether the customer should be subscribed or unsubscribed

Returns: $this

@SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

If subscription status has been changed then send email to the customer

Definition at line 564 of file Subscriber.php.

     {
         try {
             $customerData = $this->customerRepository->getById($customerId);
         } catch (NoSuchEntityException $e) {
             return $this;
         }
 
         $this->loadByCustomerId($customerId);
         if (!$subscribe && !$this->getId()) {
             return $this;
         }
 
         if (!$this->getId()) {
             $this->setSubscriberConfirmCode($this->randomSequence());
         }
 
         $sendInformationEmail = false;
         $status = self::STATUS_SUBSCRIBED;
         $isConfirmNeed = $this->_scopeConfig->getValue(
             self::XML_PATH_CONFIRMATION_FLAG,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         ) == 1 ? true : false;
         if ($subscribe) {
             if (AccountManagementInterface::ACCOUNT_CONFIRMATION_REQUIRED
                 == $this->customerAccountManagement->getConfirmationStatus($customerId)
             ) {
                 $status = self::STATUS_UNCONFIRMED;
             } elseif ($isConfirmNeed) {
                 if ($this->getStatus() != self::STATUS_SUBSCRIBED) {
                     $status = self::STATUS_NOT_ACTIVE;
                 }
             }
         } elseif (($this->getStatus() == self::STATUS_UNCONFIRMED) && ($customerData->getConfirmation() === null)) {
             $status = self::STATUS_SUBSCRIBED;
             $sendInformationEmail = true;
         } else {
             $status = self::STATUS_UNSUBSCRIBED;
         }
         if ($status != self::STATUS_UNCONFIRMED && $status != $this->getStatus()) {
             $sendInformationEmail = true;
         }
 
         if ($status != $this->getStatus()) {
             $this->setStatusChanged(true);
         }
 
         $this->setStatus($status);
 
         if (!$this->getId()) {
             $storeId = $customerData->getStoreId();
             if ($customerData->getStoreId() == 0) {
                 $storeId = $this->_storeManager->getWebsite($customerData->getWebsiteId())->getDefaultStore()->getId();
             }
             $this->setStoreId($storeId)
                 ->setCustomerId($customerData->getId())
                 ->setEmail($customerData->getEmail());
         } else {
             $this->setStoreId($customerData->getStoreId())
                 ->setEmail($customerData->getEmail());
         }
 
         $this->save();
         $sendSubscription = $sendInformationEmail;
         if ($sendSubscription === null xor $sendSubscription && $this->isStatusChanged()) {
             try {
                 switch ($status) {
                     case self::STATUS_UNSUBSCRIBED:
                         $this->sendUnsubscriptionEmail();
                         break;
                     case self::STATUS_SUBSCRIBED:
                         $this->sendConfirmationSuccessEmail();
                         break;
                     case self::STATUS_NOT_ACTIVE:
                         if ($isConfirmNeed) {
                             $this->sendConfirmationRequestEmail();
                         }
                         break;
                 }
             } catch (MailException $e) {
                 // If we are not able to send a new account email, this should be ignored
                 $this->_logger->critical($e);
             }
         }
         return $this;
     }

◆ beforeSave()

beforeSave ( )

Set date of last changed status

Returns: $this

Since: 100.2.1

Definition at line 864 of file Subscriber.php.

     {
         parent::beforeSave();
         if ($this->dataHasChangedFor('subscriber_status')) {
             $this->setChangeStatusAt($this->dateTime->gmtDate());
         }
         return $this;
     }

◆ confirm()

confirm ( $code )

Confirms subscriber newsletter

Parameters

string $code

Returns: boolean

Definition at line 660 of file Subscriber.php.

     {
         if ($this->getCode() == $code) {
             $this->setStatus(self::STATUS_SUBSCRIBED)
                 ->setStatusChanged(true)
                 ->save();
 
             $this->sendConfirmationSuccessEmail();
             return true;
         }
 
         return false;
     }

◆ getCode()

getCode ( )

Alias for getSubscriberConfirmCode()

Returns: string

Definition at line 236 of file Subscriber.php.

     {
         return $this->getSubscriberConfirmCode();
     }

◆ getConfirmationLink()

getConfirmationLink ( )

Return link for confirmation of subscription

Returns: string

Definition at line 246 of file Subscriber.php.

     {
         return $this->_newsletterData->getConfirmationUrl($this);
     }

◆ getEmail()

getEmail ( )

Alias for getSubscriberEmail()

Returns: string

Definition at line 310 of file Subscriber.php.

     {
         return $this->getSubscriberEmail();
     }

◆ getId()

getId ( )

Alias for getSubscriberId()

Returns: int

Definition at line 215 of file Subscriber.php.

     {
         return $this->getSubscriberId();
     }

◆ getStatus()

getStatus ( )

Alias for getSubscriberStatus()

Returns: int

Definition at line 277 of file Subscriber.php.

     {
         return $this->getSubscriberStatus();
     }

◆ getSubscriberFullName()

getSubscriberFullName ( )

Retrieve Subscribers Full Name if it was set

Returns: string|null

Definition at line 849 of file Subscriber.php.

     {
         $name = null;
         if ($this->hasFirstname() || $this->hasLastname()) {
             $name = $this->getFirstname() . ' ' . $this->getLastname();
         }
         return $name;
     }

◆ getUnsubscriptionLink()

getUnsubscriptionLink ( )

Returns Unsubscribe url

Returns: string

Definition at line 256 of file Subscriber.php.

     {
         return $this->_newsletterData->getUnsubscribeUrl($this);
     }

◆ isStatusChanged()

isStatusChanged ( )

Return status change flag value

Returns: boolean

Definition at line 343 of file Subscriber.php.

     {
         return $this->_isStatusChanged;
     }

◆ isSubscribed()

isSubscribed ( )

Return customer subscription status

Returns: bool

Definition at line 353 of file Subscriber.php.

     {
         if ($this->getId() && $this->getStatus() == self::STATUS_SUBSCRIBED) {
             return true;
         }
 
         return false;
     }

◆ loadByCustomerId()

loadByCustomerId ( $customerId )

Load subscriber info by customerId

Parameters

int $customerId

Returns: $this

Definition at line 390 of file Subscriber.php.

     {
         try {
             $customerData = $this->customerRepository->getById($customerId);
             $customerData->setStoreId($this->_storeManager->getStore()->getId());
             $data = $this->getResource()->loadByCustomerData($customerData);
             $this->addData($data);
             if (!empty($data) && $customerData->getId() && !$this->getCustomerId()) {
                 $this->setCustomerId($customerData->getId());
                 $this->setSubscriberConfirmCode($this->randomSequence());
                 $this->save();
             }
         } catch (NoSuchEntityException $e) {
         }
         return $this;
     }

◆ randomSequence()

randomSequence ( $length = 32 )

Returns string of random chars

Parameters

int $length

Returns: string

Definition at line 413 of file Subscriber.php.

     {
         $id = '';
         $par = [];
         $char = array_merge(range('a', 'z'), range(0, 9));
         $charLen = count($char) - 1;
         for ($i = 0; $i < $length; $i++) {
             $disc = \Magento\Framework\Math\Random::getRandomNumber(0, $charLen);
             $par[$i] = $char[$disc];
             $id = $id . $char[$disc];
         }
         return $id;
     }

◆ received()

received ( \Magento\Newsletter\Model\Queue $queue )

Mark receiving subscriber of queue newsletter

Parameters

\Magento\Newsletter\Model\Queue $queue

Returns: boolean

Definition at line 680 of file Subscriber.php.

     {
         $this->getResource()->received($this, $queue);
         return $this;
     }

◆ sendConfirmationRequestEmail()

sendConfirmationRequestEmail ( )

Sends out confirmation email

Returns: $this

Definition at line 691 of file Subscriber.php.

     {
         if ($this->getImportMode()) {
             return $this;
         }
 
         if (!$this->_scopeConfig->getValue(
             self::XML_PATH_CONFIRM_EMAIL_TEMPLATE,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         ) || !$this->_scopeConfig->getValue(
             self::XML_PATH_CONFIRM_EMAIL_IDENTITY,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         )
         ) {
             return $this;
         }
 
         $this->inlineTranslation->suspend();
 
         $this->_transportBuilder->setTemplateIdentifier(
             $this->_scopeConfig->getValue(
                 self::XML_PATH_CONFIRM_EMAIL_TEMPLATE,
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE
             )
         )->setTemplateOptions(
             [
                 'area' => \Magento\Framework\App\Area::AREA_FRONTEND,
                 'store' => $this->_storeManager->getStore()->getId(),
             ]
         )->setTemplateVars(
             ['subscriber' => $this, 'store' => $this->_storeManager->getStore()]
         )->setFrom(
             $this->_scopeConfig->getValue(
                 self::XML_PATH_CONFIRM_EMAIL_IDENTITY,
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE
             )
         )->addTo(
             $this->getEmail(),
             $this->getName()
         );
         $transport = $this->_transportBuilder->getTransport();
         $transport->sendMessage();
 
         $this->inlineTranslation->resume();
 
         return $this;
     }

◆ sendConfirmationSuccessEmail()

sendConfirmationSuccessEmail ( )

Sends out confirmation success email

Returns: $this

Definition at line 744 of file Subscriber.php.

     {
         if ($this->getImportMode()) {
             return $this;
         }
 
         if (!$this->_scopeConfig->getValue(
             self::XML_PATH_SUCCESS_EMAIL_TEMPLATE,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         ) || !$this->_scopeConfig->getValue(
             self::XML_PATH_SUCCESS_EMAIL_IDENTITY,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         )
         ) {
             return $this;
         }
 
         $this->inlineTranslation->suspend();
 
         $this->_transportBuilder->setTemplateIdentifier(
             $this->_scopeConfig->getValue(
                 self::XML_PATH_SUCCESS_EMAIL_TEMPLATE,
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE
             )
         )->setTemplateOptions(
             [
                 'area' => \Magento\Framework\App\Area::AREA_FRONTEND,
                 'store' => $this->_storeManager->getStore()->getId(),
             ]
         )->setTemplateVars(
             ['subscriber' => $this]
         )->setFrom(
             $this->_scopeConfig->getValue(
                 self::XML_PATH_SUCCESS_EMAIL_IDENTITY,
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE
             )
         )->addTo(
             $this->getEmail(),
             $this->getName()
         );
         $transport = $this->_transportBuilder->getTransport();
         $transport->sendMessage();
 
         $this->inlineTranslation->resume();
 
         return $this;
     }

◆ sendUnsubscriptionEmail()

sendUnsubscriptionEmail ( )

Sends out unsubscription email

Returns: $this

Definition at line 797 of file Subscriber.php.

     {
         if ($this->getImportMode()) {
             return $this;
         }
         if (!$this->_scopeConfig->getValue(
             self::XML_PATH_UNSUBSCRIBE_EMAIL_TEMPLATE,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         ) || !$this->_scopeConfig->getValue(
             self::XML_PATH_UNSUBSCRIBE_EMAIL_IDENTITY,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         )
         ) {
             return $this;
         }
 
         $this->inlineTranslation->suspend();
 
         $this->_transportBuilder->setTemplateIdentifier(
             $this->_scopeConfig->getValue(
                 self::XML_PATH_UNSUBSCRIBE_EMAIL_TEMPLATE,
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE
             )
         )->setTemplateOptions(
             [
                 'area' => \Magento\Framework\App\Area::AREA_FRONTEND,
                 'store' => $this->_storeManager->getStore()->getId(),
             ]
         )->setTemplateVars(
             ['subscriber' => $this]
         )->setFrom(
             $this->_scopeConfig->getValue(
                 self::XML_PATH_UNSUBSCRIBE_EMAIL_IDENTITY,
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE
             )
         )->addTo(
             $this->getEmail(),
             $this->getName()
         );
         $transport = $this->_transportBuilder->getTransport();
         $transport->sendMessage();
 
         $this->inlineTranslation->resume();
 
         return $this;
     }

◆ setCode()

setCode ( $value )

Alias for setSubscriberConfirmCode()

Parameters

string $value

Returns: $this

Definition at line 267 of file Subscriber.php.

     {
         return $this->setSubscriberConfirmCode($value);
     }

◆ setEmail()

setEmail ( $value )

Alias for setSubscriberEmail()

Parameters

string $value

Returns: $this

Definition at line 321 of file Subscriber.php.

     {
         return $this->setSubscriberEmail($value);
     }

◆ setId()

setId ( $value )

Alias for setSubscriberId()

Parameters

int $value

Returns: $this

Definition at line 226 of file Subscriber.php.

     {
         return $this->setSubscriberId($value);
     }

◆ setMessagesScope()

setMessagesScope ( $scope )

Set the error messages scope for subscription

Parameters

boolean $scope

Returns: $this

Definition at line 299 of file Subscriber.php.

     {
         $this->getResource()->setMessagesScope($scope);
         return $this;
     }

◆ setStatus()

setStatus ( $value )

Alias for setSubscriberStatus()

Parameters

int $value

Returns: $this

Definition at line 288 of file Subscriber.php.

     {
         return $this->setSubscriberStatus($value);
     }

◆ setStatusChanged()

setStatusChanged ( $value )

Set for status change flag

Parameters

boolean $value

Returns: $this

Definition at line 332 of file Subscriber.php.

     {
         $this->_isStatusChanged = (boolean) $value;
         return $this;
     }

◆ subscribe()

subscribe ( $email )

Subscribes by email

Parameters

string $email

Exceptions

Definition at line 437 of file Subscriber.php.

     {
         $this->loadByEmail($email);
 
         if ($this->getId() && $this->getStatus() == self::STATUS_SUBSCRIBED) {
             return $this->getStatus();
         }
 
         if (!$this->getId()) {
             $this->setSubscriberConfirmCode($this->randomSequence());
         }
 
         $isConfirmNeed = $this->_scopeConfig->getValue(
             self::XML_PATH_CONFIRMATION_FLAG,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         ) == 1 ? true : false;
 
         $isSubscribeOwnEmail = $this->_customerSession->isLoggedIn()
             && $this->_customerSession->getCustomerDataObject()->getEmail() == $email;
 
         if (!$this->getId() || $this->getStatus() == self::STATUS_UNSUBSCRIBED
             || $this->getStatus() == self::STATUS_NOT_ACTIVE
         ) {
             if ($isConfirmNeed === true) {
                 $this->setStatus(self::STATUS_NOT_ACTIVE);
             } else {
                 $this->setStatus(self::STATUS_SUBSCRIBED);
             }
             $this->setSubscriberEmail($email);
         }
 
         if ($isSubscribeOwnEmail) {
             try {
                 $customer = $this->customerRepository->getById($this->_customerSession->getCustomerId());
                 $this->setStoreId($customer->getStoreId());
                 $this->setCustomerId($customer->getId());
             } catch (NoSuchEntityException $e) {
                 $this->setStoreId($this->_storeManager->getStore()->getId());
                 $this->setCustomerId(0);
             }
         } else {
             $this->setStoreId($this->_storeManager->getStore()->getId());
             $this->setCustomerId(0);
         }
 
         $this->setStatusChanged(true);
 
         try {
             /* Save model before sending out email */
             $this->save();
             if ($isConfirmNeed === true) {
                 $this->sendConfirmationRequestEmail();
             } else {
                 $this->sendConfirmationSuccessEmail();
             }
             return $this->getStatus();
         } catch (\Exception $e) {
             throw new \Exception($e->getMessage());
         }
     }

◆ subscribeCustomerById()

subscribeCustomerById ( $customerId )

Subscribe the customer with the id provided

Parameters

int $customerId

Returns: $this

Definition at line 525 of file Subscriber.php.

     {
         return $this->_updateCustomerSubscription($customerId, true);
     }

◆ unsubscribe()

unsubscribe ( )

Unsubscribes loaded subscription

Exceptions

Definition at line 504 of file Subscriber.php.

     {
         if ($this->hasCheckCode() && $this->getCode() != $this->getCheckCode()) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __('This is an invalid subscription confirmation code.')
             );
         }
 
         if ($this->getSubscriberStatus() != self::STATUS_UNSUBSCRIBED) {
             $this->setSubscriberStatus(self::STATUS_UNSUBSCRIBED)->save();
             $this->sendUnsubscriptionEmail();
         }
         return $this;
     }

◆ unsubscribeCustomerById()

unsubscribeCustomerById ( $customerId )

Unsubscribe the customer with the id provided

Parameters

int $customerId

Returns: $this

Definition at line 536 of file Subscriber.php.

     {
         return $this->_updateCustomerSubscription($customerId, false);
     }

◆ updateSubscription()

updateSubscription ( $customerId )

Update the subscription based on latest information of associated customer.

Parameters

int $customerId

Returns: $this

Definition at line 547 of file Subscriber.php.

     {
         $this->loadByCustomerId($customerId);
         $this->_updateCustomerSubscription($customerId, $this->isSubscribed());
         return $this;
     }

Field Documentation

◆ $_customerSession

$_customerSession

protected

Definition at line 98 of file Subscriber.php.

◆ $_eventObject

$_eventObject = 'subscriber'

protected

Definition at line 70 of file Subscriber.php.

◆ $_eventPrefix

$_eventPrefix = 'newsletter_subscriber'

protected

Definition at line 61 of file Subscriber.php.

◆ $_isStatusChanged

$_isStatusChanged = false

protected

Definition at line 77 of file Subscriber.php.

◆ $_newsletterData

$_newsletterData = null

protected

Definition at line 84 of file Subscriber.php.

◆ $_scopeConfig

$_scopeConfig

protected

Definition at line 91 of file Subscriber.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 111 of file Subscriber.php.

◆ $_transportBuilder

$_transportBuilder

protected

Definition at line 126 of file Subscriber.php.

◆ $customerAccountManagement

$customerAccountManagement

protected

Definition at line 121 of file Subscriber.php.

◆ $customerRepository

$customerRepository

protected

Definition at line 116 of file Subscriber.php.

◆ $inlineTranslation

$inlineTranslation

protected

Definition at line 131 of file Subscriber.php.

◆ STATUS_NOT_ACTIVE

const STATUS_NOT_ACTIVE = 2

Definition at line 43 of file Subscriber.php.

◆ STATUS_SUBSCRIBED

const STATUS_SUBSCRIBED = 1

Definition at line 42 of file Subscriber.php.

◆ STATUS_UNCONFIRMED

const STATUS_UNCONFIRMED = 4

Definition at line 45 of file Subscriber.php.

◆ STATUS_UNSUBSCRIBED

const STATUS_UNSUBSCRIBED = 3

Definition at line 44 of file Subscriber.php.

◆ XML_PATH_ALLOW_GUEST_SUBSCRIBE_FLAG

const XML_PATH_ALLOW_GUEST_SUBSCRIBE_FLAG = 'newsletter/subscription/allow_guest_subscribe'

Definition at line 54 of file Subscriber.php.

◆ XML_PATH_CONFIRM_EMAIL_IDENTITY

const XML_PATH_CONFIRM_EMAIL_IDENTITY = 'newsletter/subscription/confirm_email_identity'

Definition at line 48 of file Subscriber.php.

◆ XML_PATH_CONFIRM_EMAIL_TEMPLATE

const XML_PATH_CONFIRM_EMAIL_TEMPLATE = 'newsletter/subscription/confirm_email_template'

Definition at line 47 of file Subscriber.php.

◆ XML_PATH_CONFIRMATION_FLAG

const XML_PATH_CONFIRMATION_FLAG = 'newsletter/subscription/confirm'

Definition at line 53 of file Subscriber.php.

◆ XML_PATH_SUCCESS_EMAIL_IDENTITY

const XML_PATH_SUCCESS_EMAIL_IDENTITY = 'newsletter/subscription/success_email_identity'

Definition at line 50 of file Subscriber.php.

◆ XML_PATH_SUCCESS_EMAIL_TEMPLATE

const XML_PATH_SUCCESS_EMAIL_TEMPLATE = 'newsletter/subscription/success_email_template'

Definition at line 49 of file Subscriber.php.

◆ XML_PATH_UNSUBSCRIBE_EMAIL_IDENTITY

const XML_PATH_UNSUBSCRIBE_EMAIL_IDENTITY = 'newsletter/subscription/un_email_identity'

Definition at line 52 of file Subscriber.php.

◆ XML_PATH_UNSUBSCRIBE_EMAIL_TEMPLATE

const XML_PATH_UNSUBSCRIBE_EMAIL_TEMPLATE = 'newsletter/subscription/un_email_template'

Definition at line 51 of file Subscriber.php.

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

vendor/magento/module-newsletter/Model/Subscriber.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ _updateCustomerSubscription()

◆ beforeSave()

◆ confirm()

◆ getCode()

◆ getConfirmationLink()

◆ getEmail()

◆ getId()

◆ getStatus()

◆ getSubscriberFullName()

◆ getUnsubscriptionLink()

◆ isStatusChanged()

◆ isSubscribed()

◆ loadByCustomerId()

◆ randomSequence()

◆ received()

◆ sendConfirmationRequestEmail()

◆ sendConfirmationSuccessEmail()

◆ sendUnsubscriptionEmail()

◆ setCode()

◆ setEmail()

◆ setId()

◆ setMessagesScope()

◆ setStatus()

◆ setStatusChanged()

◆ subscribe()

◆ subscribeCustomerById()

◆ unsubscribe()

◆ unsubscribeCustomerById()

◆ updateSubscription()

Field Documentation

◆ $_customerSession

◆ $_eventObject

◆ $_eventPrefix

◆ $_isStatusChanged

◆ $_newsletterData

◆ $_scopeConfig

◆ $_storeManager

◆ $_transportBuilder

◆ $customerAccountManagement

◆ $customerRepository

◆ $inlineTranslation

◆ STATUS_NOT_ACTIVE

◆ STATUS_SUBSCRIBED

◆ STATUS_UNCONFIRMED

◆ STATUS_UNSUBSCRIBED

◆ XML_PATH_ALLOW_GUEST_SUBSCRIBE_FLAG

◆ XML_PATH_CONFIRM_EMAIL_IDENTITY

◆ XML_PATH_CONFIRM_EMAIL_TEMPLATE

◆ XML_PATH_CONFIRMATION_FLAG

◆ XML_PATH_SUCCESS_EMAIL_IDENTITY

◆ XML_PATH_SUCCESS_EMAIL_TEMPLATE

◆ XML_PATH_UNSUBSCRIBE_EMAIL_IDENTITY

◆ XML_PATH_UNSUBSCRIBE_EMAIL_TEMPLATE