Inheritance diagram for Message:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Catalog\Api\ProductRepositoryInterface $productRepository, \Magento\Framework\View\LayoutFactory $layoutFactory, \Magento\GiftMessage\Model\MessageFactory $giftMessageFactory, \Magento\Framework\Escaper $escaper, $skipMessageCheck=[])

	getInline ($type, \Magento\Framework\DataObject $entity, $dontDisplayContainer=false)

	isMessagesAllowed ($type, \Magento\Framework\DataObject $entity, $store=null)

	getEscapedGiftMessage (\Magento\Framework\DataObject $entity)

	getGiftMessageForEntity (\Magento\Framework\DataObject $entity)

	getCached ($key)

	isCached ($key)

	setCached ($key, $value)

	getAvailableForQuoteItems ($quote, $store=null)

	getAvailableForAddressItems ($items, $store=null)

	getGiftMessage ($messageId=null)

Public Member Functions inherited from AbstractHelper
	__construct (Context $context)

	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	XPATH_CONFIG_GIFT_MESSAGE_ALLOW_ITEMS = 'sales/gift_options/allow_items'

const	XPATH_CONFIG_GIFT_MESSAGE_ALLOW_ORDER = 'sales/gift_options/allow_order'

Protected Member Functions
	skipPage ($pageType)

	_getDependenceFromStoreConfig ($productConfig, $store=null)

Protected Member Functions inherited from AbstractHelper
	_getRequest ()

	_getModuleName ()

	_getUrl ($route, $params=[])

Protected Attributes
	$_nextId = 0

	$_innerCache = []

	$productRepository

	$_layoutFactory

	$_giftMessageFactory

	$_escaper

	$skipMessageCheck = []

Protected Attributes inherited from AbstractHelper
	$_moduleName

	$_request

	$_moduleManager

	$_logger

	$_urlBuilder

	$_httpHeader

	$_eventManager

	$_remoteAddress

	$urlEncoder

	$urlDecoder

	$scopeConfig

	$_cacheConfig

Detailed Description

Gift Message helper @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 15 of file Message.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository,
		\Magento\Framework\View\LayoutFactory	$layoutFactory,
		\Magento\GiftMessage\Model\MessageFactory	$giftMessageFactory,
		\Magento\Framework\Escaper	$escaper,
			$skipMessageCheck = `[]`
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository
\Magento\Framework\View\LayoutFactory	$layoutFactory
\Magento\GiftMessage\Model\MessageFactory	$giftMessageFactory
\Magento\Framework\Escaper	$escaper
array	$skipMessageCheck	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 81 of file Message.php.

       {
         $this->_escaper = $escaper;
         $this->productRepository = $productRepository;
         $this->_layoutFactory = $layoutFactory;
         $this->_giftMessageFactory = $giftMessageFactory;
         $this->skipMessageCheck = $skipMessageCheck;
         $this->_storeManager = $storeManager;
 
         parent::__construct(
             $context
         );
     }

Member Function Documentation

◆ _getDependenceFromStoreConfig()

_getDependenceFromStoreConfig	(	$productConfig,
		$store = `null`
	)

protected

Check availablity of gift messages from store config if flag eq 2.

Parameters

bool	$productConfig
\Magento\Store\Model\Store \| int \| null	$store

Returns: bool|string|null

Definition at line 200 of file Message.php.

     {
         $result = $this->scopeConfig->getValue(
             self::XPATH_CONFIG_GIFT_MESSAGE_ALLOW_ITEMS,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
         if ($productConfig === null || '' === $productConfig || $productConfig == Boolean::VALUE_USE_CONFIG) {
             return $result;
         } else {
             return $productConfig;
         }
     }

◆ getAvailableForAddressItems()

getAvailableForAddressItems	(	$items,
		$store = `null`
	)

Check availability for multishipping checkout items

Parameters

array	$items
\Magento\Store\Model\Store \| int \| null	$store

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 310 of file Message.php.

     {
         foreach ($items as $item) {
             if ($this->isMessagesAllowed('address_item', $item, $store)) {
                 return true;
             }
         }
         return false;
     }

◆ getAvailableForQuoteItems()

getAvailableForQuoteItems	(	$quote,
		$store = `null`
	)

Check availability for onepage checkout items

Parameters

array	$quote
\Magento\Store\Model\Store \| int \| null	$store

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 292 of file Message.php.

     {
         foreach ($quote->getAllItems() as $item) {
             if ($this->isMessagesAllowed('item', $item, $store)) {
                 return true;
             }
         }
         return false;
     }

◆ getCached()

getCached ( $key )

Retrieve internal cached data with specified key.

If cached data not found return null.

Parameters

string $key

Returns: mixed

Definition at line 252 of file Message.php.

     {
         if ($this->isCached($key)) {
             return $this->_innerCache[$key];
         }
         return null;
     }

◆ getEscapedGiftMessage()

getEscapedGiftMessage ( \Magento\Framework\DataObject $entity )

Retrieve escaped and preformated gift message text for specified entity

Parameters

\Magento\Framework\DataObject $entity

Returns: string|null

Definition at line 220 of file Message.php.

     {
         $message = $this->getGiftMessageForEntity($entity);
         if ($message) {
             return nl2br($this->_escaper->escapeHtml($message->getMessage()));
         }
         return null;
     }

◆ getGiftMessage()

getGiftMessage ( $messageId = null )

Retrieve gift message with specified id

Parameters

int $messageId

Returns: \Magento\GiftMessage\Model\Message

Definition at line 326 of file Message.php.

     {
         $message = $this->_giftMessageFactory->create();
         if ($messageId !== null) {
             $message->load($messageId);
         }
         return $message;
     }

◆ getGiftMessageForEntity()

getGiftMessageForEntity ( \Magento\Framework\DataObject $entity )

Retrieve gift message for entity. If message not exists return null

Parameters

\Magento\Framework\DataObject $entity

Returns: \Magento\GiftMessage\Model\Message

Definition at line 235 of file Message.php.

     {
         if ($entity->getGiftMessageId() && !$entity->getGiftMessage()) {
             $message = $this->getGiftMessage($entity->getGiftMessageId());
             $entity->setGiftMessage($message);
         }
         return $entity->getGiftMessage();
     }

◆ getInline()

getInline	(		$type,
		\Magento\Framework\DataObject	$entity,
			$dontDisplayContainer = `false`
	)

Retrieve inline giftmessage edit form for specified entity

Parameters

string	$type
\Magento\Framework\DataObject	$entity
bool	$dontDisplayContainer

Returns: string

Definition at line 110 of file Message.php.

     {
         if (!$this->skipPage($type) && !$this->isMessagesAllowed($type, $entity)) {
             return '';
         }
         return $this->_layoutFactory->create()->createBlock(\Magento\GiftMessage\Block\Message\Inline::class)
             ->setId('giftmessage_form_' . $this->_nextId++)
             ->setDontDisplayContainer($dontDisplayContainer)
             ->setEntity($entity)
             ->setCheckoutType($type)->toHtml();
     }

◆ isCached()

isCached ( $key )

Check availability for internal cached data with specified key

Parameters

string $key

Returns: bool

Definition at line 266 of file Message.php.

     {
         return isset($this->_innerCache[$key]);
     }

◆ isMessagesAllowed()

isMessagesAllowed	(		$type,
		\Magento\Framework\DataObject	$entity,
			$store = `null`
	)

Check if giftmessages is allowed for specified entity.

Parameters

string	$type
\Magento\Framework\DataObject	$entity
\Magento\Store\Model\Store \| int \| null	$store

Returns: bool|string|null @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 140 of file Message.php.

     {
         if ($type == 'items') {
             $items = $entity->getAllItems();
             if (!is_array($items) || empty($items)) {
                 return $this->scopeConfig->getValue(
                     self::XPATH_CONFIG_GIFT_MESSAGE_ALLOW_ITEMS,
                     \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
                     $store
                 );
             }
             if ($entity instanceof \Magento\Quote\Model\Quote) {
                 $_type = $entity->getIsMultiShipping() ? 'address_item' : 'item';
             } else {
                 $_type = 'order_item';
             }
             foreach ($items as $item) {
                 if ($item->getParentItem()) {
                     continue;
                 }
                 if ($this->isMessagesAllowed($_type, $item, $store)) {
                     return true;
                 }
             }
         } elseif ($type == 'item') {
             return $this->_getDependenceFromStoreConfig($entity->getProduct()->getGiftMessageAvailable(), $store);
         } elseif ($type == 'order_item') {
             return $this->_getDependenceFromStoreConfig($entity->getGiftMessageAvailable(), $store);
         } elseif ($type == 'address_item') {
             $storeId = is_numeric($store) ? $store : $this->_storeManager->getStore($store)->getId();
             if (!$this->isCached('address_item_' . $entity->getProductId())) {
                 try {
                     $giftMessageAvailable = $this->productRepository->getById($entity->getProductId(), false, $storeId)
                         ->getGiftMessageAvailable();
                 } catch (\Magento\Framework\Exception\NoSuchEntityException $noEntityException) {
                     $giftMessageAvailable = null;
                 }
                 $this->setCached('address_item_' . $entity->getProductId(), $giftMessageAvailable);
             }
             return $this->_getDependenceFromStoreConfig(
                 $this->getCached('address_item_' . $entity->getProductId()),
                 $store
             );
         } else {
             return $this->scopeConfig->getValue(
                 self::XPATH_CONFIG_GIFT_MESSAGE_ALLOW_ORDER,
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
                 $store
             );
         }
         return false;
     }

◆ setCached()

setCached	(	$key,
		$value
	)

Set internal cache data with specified key

Parameters

string	$key
mixed	$value

Returns: $this

Definition at line 278 of file Message.php.

     {
         $this->_innerCache[$key] = $value;
         return $this;
     }

◆ skipPage()

skipPage ( $pageType )

protected

Parameters

string $pageType

Returns: bool

Definition at line 126 of file Message.php.

     {
         return in_array($pageType, $this->skipMessageCheck);
     }

Field Documentation

◆ $_escaper

$_escaper

protected

Definition at line 57 of file Message.php.

◆ $_giftMessageFactory

$_giftMessageFactory

protected

Definition at line 52 of file Message.php.

◆ $_innerCache

$_innerCache = []

protected

Definition at line 37 of file Message.php.

◆ $_layoutFactory

$_layoutFactory

protected

Definition at line 47 of file Message.php.

◆ $_nextId

$_nextId = 0

protected

Definition at line 30 of file Message.php.

◆ $productRepository

$productRepository

protected

Definition at line 42 of file Message.php.

◆ $skipMessageCheck

$skipMessageCheck = []

protected

Definition at line 64 of file Message.php.

◆ XPATH_CONFIG_GIFT_MESSAGE_ALLOW_ITEMS

const XPATH_CONFIG_GIFT_MESSAGE_ALLOW_ITEMS = 'sales/gift_options/allow_items'

Gift messages allow section in configuration

Definition at line 21 of file Message.php.

◆ XPATH_CONFIG_GIFT_MESSAGE_ALLOW_ORDER

const XPATH_CONFIG_GIFT_MESSAGE_ALLOW_ORDER = 'sales/gift_options/allow_order'

Definition at line 23 of file Message.php.

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

vendor/magento/module-gift-message/Helper/Message.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getDependenceFromStoreConfig()

◆ getAvailableForAddressItems()

◆ getAvailableForQuoteItems()

◆ getCached()

◆ getEscapedGiftMessage()

◆ getGiftMessage()

◆ getGiftMessageForEntity()

◆ getInline()

◆ isCached()

◆ isMessagesAllowed()

◆ setCached()

◆ skipPage()

Field Documentation

◆ $_escaper

◆ $_giftMessageFactory

◆ $_innerCache

◆ $_layoutFactory

◆ $_nextId

◆ $productRepository

◆ $skipMessageCheck

◆ XPATH_CONFIG_GIFT_MESSAGE_ALLOW_ITEMS

◆ XPATH_CONFIG_GIFT_MESSAGE_ALLOW_ORDER