Inheritance diagram for SendFriend:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\Mail\Template\TransportBuilder $transportBuilder, \Magento\Catalog\Helper\Image $catalogImage, \Magento\SendFriend\Helper\Data $sendfriendData, \Magento\Framework\Escaper $escaper, \Magento\Framework\HTTP\PhpEnvironment\RemoteAddress $remoteAddress, \Magento\Framework\Stdlib\CookieManagerInterface $cookieManager, \Magento\Framework\Translate\Inline\StateInterface $inlineTranslation, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	send ()

	validate ()

	setRecipients ($recipients)

	getRecipients ()

	setProduct ($product)

	getProduct ()

	setSender ($sender)

	getSender ()

	getMaxSendsToFriend ()

	getMaxRecipients ()

	canEmailToFriend ()

	isExceedLimit ()

	getSentCount ($useCache=true)

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)

Protected Member Functions
	_construct ()

	_incrementSentCount ()

	_sentCountByCookies ($increment=false)

	_sentCountByIp ($increment=false)

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
	$_names = []

	$_emails = []

	$_sender = []

	$_product

	$_sentCount

	$_lastCookieValue = []

	$_sendfriendData = null

	$_catalogImage = null

	$_transportBuilder

	$_storeManager

	$_escaper

	$inlineTranslation

	$cookieManager

	$remoteAddress

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

SendFriend Log

@method int getIp() @method \Magento\SendFriend\Model\SendFriend setIp(int $value) @method int getTime() @method \Magento\SendFriend\Model\SendFriend setTime(int $value)

Author: Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m @SuppressWarnings(PHPMD.CouplingBetweenObjects)

@api

Since: 100.0.2

Definition at line 24 of file SendFriend.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\Mail\Template\TransportBuilder	$transportBuilder,
		\Magento\Catalog\Helper\Image	$catalogImage,
		\Magento\SendFriend\Helper\Data	$sendfriendData,
		\Magento\Framework\Escaper	$escaper,
		\Magento\Framework\HTTP\PhpEnvironment\RemoteAddress	$remoteAddress,
		\Magento\Framework\Stdlib\CookieManagerInterface	$cookieManager,
		\Magento\Framework\Translate\Inline\StateInterface	$inlineTranslation,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\Mail\Template\TransportBuilder	$transportBuilder
\Magento\Catalog\Helper\Image	$catalogImage
\Magento\SendFriend\Helper\Data	$sendfriendData
\Magento\Framework\Escaper	$escaper
\Magento\Framework\HTTP\PhpEnvironment\RemoteAddress	$remoteAddress
\Magento\Framework\Stdlib\CookieManagerInterface	$cookieManager
\Magento\Framework\Translate\Inline\StateInterface	$inlineTranslation
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 128 of file SendFriend.php.

       {
         $this->_storeManager = $storeManager;
         $this->_transportBuilder = $transportBuilder;
         $this->_catalogImage = $catalogImage;
         $this->_sendfriendData = $sendfriendData;
         $this->_escaper = $escaper;
         $this->remoteAddress = $remoteAddress;
         $this->cookieManager = $cookieManager;
         $this->inlineTranslation = $inlineTranslation;
         parent::__construct($context, $registry, $resource, $resourceCollection, $data);
     }

Member Function Documentation

◆ _construct()

_construct ( )

protected

Initialize resource model

Returns: void

Definition at line 159 of file SendFriend.php.

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

◆ _incrementSentCount()

_incrementSentCount ( )

protected

Increase count of sent

Returns: int

Definition at line 456 of file SendFriend.php.

     {
         switch ($this->_sendfriendData->getLimitBy()) {
             case \Magento\SendFriend\Helper\Data::CHECK_COOKIE:
                 return $this->_sentCount = $this->_sentCountByCookies(true);
             case \Magento\SendFriend\Helper\Data::CHECK_IP:
                 return $this->_sentCount = $this->_sentCountByIp(true);
             default:
                 return 0;
         }
     }

◆ _sentCountByCookies()

_sentCountByCookies ( $increment = false )

protected

Return count of sent in last period by cookie

Parameters

bool $increment - flag, increase count before return value

Returns: int

Definition at line 474 of file SendFriend.php.

     {
         $cookieName = $this->_sendfriendData->getCookieName();
         $time = time();
         $newTimes = [];
 
         if (isset($this->_lastCookieValue[$cookieName])) {
             $oldTimes = $this->_lastCookieValue[$cookieName];
         } else {
             $oldTimes = $this->cookieManager->getCookie($cookieName);
         }
 
         if ($oldTimes) {
             $oldTimes = explode(',', $oldTimes);
             foreach ($oldTimes as $oldTime) {
                 $periodTime = $time - $this->_sendfriendData->getPeriod();
                 if (is_numeric($oldTime) and $oldTime >= $periodTime) {
                     $newTimes[] = $oldTime;
                 }
             }
         }
 
         if ($increment) {
             $newTimes[] = $time;
             $newValue = implode(',', $newTimes);
             $this->cookieManager->setSensitiveCookie($cookieName, $newValue);
             $this->_lastCookieValue[$cookieName] = $newValue;
         }
 
         return count($newTimes);
     }

◆ _sentCountByIp()

_sentCountByIp ( $increment = false )

protected

Return count of sent in last period by IP address

Parameters

bool $increment - flag, increase count before return value

Returns: int

Definition at line 512 of file SendFriend.php.

     {
         $time = time();
         $period = $this->_sendfriendData->getPeriod();
         $websiteId = $this->_storeManager->getStore()->getWebsiteId();
 
         if ($increment) {
             // delete expired logs
             $this->_getResource()->deleteLogsBefore($time - $period);
             // add new item
             $this->_getResource()->addSendItem($this->remoteAddress->getRemoteAddress(true), $time, $websiteId);
         }
 
         return $this->_getResource()->getSendCount(
             $this,
             $this->remoteAddress->getRemoteAddress(true),
             time() - $period,
             $websiteId
         );
     }

◆ canEmailToFriend()

canEmailToFriend ( )

Check if user is allowed to email product to a friend

Returns: boolean

Definition at line 414 of file SendFriend.php.

     {
         return $this->_sendfriendData->isEnabled();
     }

◆ getMaxRecipients()

getMaxRecipients ( )

Get max allowed recipients for "Send to a Friend" function

Returns: integer

Definition at line 404 of file SendFriend.php.

     {
         return $this->_sendfriendData->getMaxRecipients();
     }

◆ getMaxSendsToFriend()

getMaxSendsToFriend ( )

Get max allowed uses of "Send to Friend" function per hour

Returns: integer

Definition at line 394 of file SendFriend.php.

     {
         return $this->_sendfriendData->getMaxEmailPerPeriod();
     }

◆ getProduct()

getProduct ( )

Retrieve Product instance

Exceptions

Definition at line 348 of file SendFriend.php.

     {
         $product = $this->_getData('_product');
         if (!$product instanceof \Magento\Catalog\Model\Product) {
             throw new \Magento\Framework\Exception\LocalizedException(__('Please define a correct product instance.'));
         }
         return $product;
     }

◆ getRecipients()

getRecipients ( )

Retrieve Recipients object

Returns: \Magento\Framework\DataObject

Definition at line 321 of file SendFriend.php.

     {
         $recipients = $this->_getData('_recipients');
         if (!$recipients instanceof \Magento\Framework\DataObject) {
             $recipients = new \Magento\Framework\DataObject(['emails' => [], 'names' => []]);
             $this->setData('_recipients', $recipients);
         }
         return $recipients;
     }

◆ getSender()

getSender ( )

Retrieve Sender Information Object

Exceptions

Definition at line 378 of file SendFriend.php.

     {
         $sender = $this->_getData('_sender');
         if (!$sender instanceof \Magento\Framework\DataObject) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __('Please define the correct sender information.')
             );
         }
         return $sender;
     }

◆ getSentCount()

getSentCount ( $useCache = true )

Return count of sent in last period

Parameters

bool $useCache - flag, is allow to use value of attribute of model if it is processed last time

Returns: int

Definition at line 435 of file SendFriend.php.

     {
         if ($useCache && $this->_sentCount !== null) {
             return $this->_sentCount;
         }
 
         switch ($this->_sendfriendData->getLimitBy()) {
             case \Magento\SendFriend\Helper\Data::CHECK_COOKIE:
                 return $this->_sentCount = $this->_sentCountByCookies(false);
             case \Magento\SendFriend\Helper\Data::CHECK_IP:
                 return $this->_sentCount = $this->_sentCountByIp(false);
             default:
                 return 0;
         }
     }

◆ isExceedLimit()

isExceedLimit ( )

Check if user is exceed limit

Returns: boolean

Definition at line 424 of file SendFriend.php.

     {
         return $this->getSentCount() >= $this->getMaxSendsToFriend();
     }

◆ send()

send ( )

Returns: $this

Exceptions

CoreException

Definition at line 168 of file SendFriend.php.

     {
         if ($this->isExceedLimit()) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __('You\'ve met your limit of %1 sends in an hour.', $this->getMaxSendsToFriend())
             );
         }
 
         $this->inlineTranslation->suspend();
 
         $message = nl2br(htmlspecialchars($this->getSender()->getMessage()));
         $sender = [
             'name' => $this->_escaper->escapeHtml($this->getSender()->getName()),
             'email' => $this->_escaper->escapeHtml($this->getSender()->getEmail()),
         ];
 
         foreach ($this->getRecipients()->getEmails() as $k => $email) {
             $name = $this->getRecipients()->getNames($k);
             $this->_transportBuilder->setTemplateIdentifier(
                 $this->_sendfriendData->getEmailTemplate()
             )->setTemplateOptions(
                 [
                     'area' => \Magento\Framework\App\Area::AREA_FRONTEND,
                     'store' => $this->_storeManager->getStore()->getId(),
                 ]
             )->setFrom(
                 $sender
             )->setTemplateVars(
                 [
                     'name' => $name,
                     'email' => $email,
                     'product_name' => $this->getProduct()->getName(),
                     'product_url' => $this->getProduct()->getUrlInStore(),
                     'message' => $message,
                     'sender_name' => $sender['name'],
                     'sender_email' => $sender['email'],
                     'product_image' => $this->_catalogImage->init($this->getProduct(), 'sendfriend_small_image')
                         ->getUrl(),
                 ]
             )->addTo(
                 $email,
                 $name
             );
             $transport = $this->_transportBuilder->getTransport();
             $transport->sendMessage();
         }
 
         $this->inlineTranslation->resume();
 
         $this->_incrementSentCount();
 
         return $this;
     }

◆ setProduct()

setProduct ( $product )

Set product instance

Parameters

\Magento\Catalog\Model\Product $product

Returns: $this

Definition at line 337 of file SendFriend.php.

     {
         return $this->setData('_product', $product);
     }

◆ setRecipients()

setRecipients ( $recipients )

Set Recipients

Parameters

array $recipients

Returns: $this @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 279 of file SendFriend.php.

     {
         // validate array
         if (!is_array(
             $recipients
         ) or !isset(
             $recipients['email']
         ) or !isset(
             $recipients['name']
         ) or !is_array(
             $recipients['email']
         ) or !is_array(
             $recipients['name']
         )
         ) {
             return $this;
         }
 
         $emails = [];
         $names = [];
         foreach ($recipients['email'] as $k => $email) {
             if (!isset($emails[$email]) && isset($recipients['name'][$k])) {
                 $emails[$email] = true;
                 $names[] = $recipients['name'][$k];
             }
         }
 
         if ($emails) {
             $emails = array_keys($emails);
         }
 
         return $this->setData(
             '_recipients',
             new \Magento\Framework\DataObject(['emails' => $emails, 'names' => $names])
         );
     }

◆ setSender()

setSender ( $sender )

Set Sender Information array

Parameters

array $sender

Returns: $this

Definition at line 363 of file SendFriend.php.

     {
         if (!is_array($sender)) {
             __('Invalid Sender Information');
         }
 
         return $this->setData('_sender', new \Magento\Framework\DataObject($sender));
     }

◆ validate()

validate ( )

Validate Form data

Returns: bool|string[] @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 229 of file SendFriend.php.

     {
         $errors = [];
 
         $name = $this->getSender()->getName();
         if (empty($name)) {
             $errors[] = __('Please enter a sender name.');
         }
 
         $email = $this->getSender()->getEmail();
         if (empty($email) or !\Zend_Validate::is($email, \Magento\Framework\Validator\EmailAddress::class)) {
             $errors[] = __('Invalid Sender Email');
         }
 
         $message = $this->getSender()->getMessage();
         if (empty($message)) {
             $errors[] = __('Please enter a message.');
         }
 
         if (!$this->getRecipients()->getEmails()) {
             $errors[] = __('Please specify at least one recipient.');
         }
 
         // validate recipients email addresses
         foreach ($this->getRecipients()->getEmails() as $email) {
             if (!\Zend_Validate::is($email, \Magento\Framework\Validator\EmailAddress::class)) {
                 $errors[] = __('Please enter a correct recipient email address.');
                 break;
             }
         }
 
         $maxRecipients = $this->getMaxRecipients();
         if (count($this->getRecipients()->getEmails()) > $maxRecipients) {
             $errors[] = __('No more than %1 emails can be sent at a time.', $this->getMaxRecipients());
         }
 
         if (empty($errors)) {
             return true;
         }
 
         return $errors;
     }

Field Documentation

◆ $_catalogImage

$_catalogImage = null

protected

Definition at line 80 of file SendFriend.php.

◆ $_emails

$_emails = []

protected

Definition at line 38 of file SendFriend.php.

◆ $_escaper

$_escaper

protected

Definition at line 95 of file SendFriend.php.

◆ $_lastCookieValue

$_lastCookieValue = []

protected

Definition at line 66 of file SendFriend.php.

◆ $_names

$_names = []

protected

Definition at line 31 of file SendFriend.php.

◆ $_product

$_product

protected

Definition at line 52 of file SendFriend.php.

◆ $_sender

$_sender = []

protected

Definition at line 45 of file SendFriend.php.

◆ $_sendfriendData

$_sendfriendData = null

protected

Definition at line 73 of file SendFriend.php.

◆ $_sentCount

$_sentCount

protected

Definition at line 59 of file SendFriend.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 90 of file SendFriend.php.

◆ $_transportBuilder

$_transportBuilder

protected

Definition at line 85 of file SendFriend.php.

◆ $cookieManager

$cookieManager

protected

Definition at line 105 of file SendFriend.php.

◆ $inlineTranslation

$inlineTranslation

protected

Definition at line 100 of file SendFriend.php.

◆ $remoteAddress

$remoteAddress

protected

Definition at line 110 of file SendFriend.php.

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

vendor/magento/module-send-friend/Model/SendFriend.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ _incrementSentCount()

◆ _sentCountByCookies()

◆ _sentCountByIp()

◆ canEmailToFriend()

◆ getMaxRecipients()

◆ getMaxSendsToFriend()

◆ getProduct()

◆ getRecipients()

◆ getSender()

◆ getSentCount()

◆ isExceedLimit()

◆ send()

◆ setProduct()

◆ setRecipients()

◆ setSender()

◆ validate()

Field Documentation

◆ $_catalogImage

◆ $_emails

◆ $_escaper

◆ $_lastCookieValue

◆ $_names

◆ $_product

◆ $_sender

◆ $_sendfriendData

◆ $_sentCount

◆ $_storeManager

◆ $_transportBuilder

◆ $cookieManager

◆ $inlineTranslation

◆ $remoteAddress