Save Class Reference

Inheritance diagram for Save:

Public Member Functions
	__construct (\Magento\Catalog\Api\ProductRepositoryInterface $productRepository, \Magento\GiftMessage\Model\MessageFactory $messageFactory, \Magento\Backend\Model\Session\Quote $session, \Magento\GiftMessage\Helper\Message $giftMessageMessage)
	saveAllInQuote ()
	getSaved ()
	saveAllInOrder ()
	setAllowQuoteItems ($items)
	addAllowQuoteItem ($item)
	getAllowQuoteItems ()
	getAllowQuoteItemsProducts ()
	getIsAllowedQuoteItem ($item)
	isGiftMessagesAvailable ($item)
	importAllowQuoteItemsFromProducts ($products)
	importAllowQuoteItemsFromItems ($items)
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
	_saveOne ($entityId, $giftmessage, $entityType)
	_deleteOne ($entityModel, $giftmessageModel=null)
	getMappedType ($type)
	_getQuote ()
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)

Protected Attributes
	$_saved = false
	$_giftMessageMessage = null
	$_session
	$_messageFactory
	$productRepository
Protected Attributes inherited from DataObject
	$_data = []

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

Detailed Description

Adminhtml giftmessage save model

Author

Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m

Definition at line 13 of file Save.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository,
		\Magento\GiftMessage\Model\MessageFactory	$messageFactory,
		\Magento\Backend\Model\Session\Quote	$session,
		\Magento\GiftMessage\Helper\Message	$giftMessageMessage
	)

Parameters

\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository
\Magento\GiftMessage\Model\MessageFactory	$messageFactory
\Magento\Backend\Model\Session\Quote	$session
\Magento\GiftMessage\Helper\Message	$giftMessageMessage

Definition at line 48 of file Save.php.

      {
        $this->productRepository = $productRepository;
        $this->_messageFactory = $messageFactory;
        $this->_session = $session;
        $this->_giftMessageMessage = $giftMessageMessage;
    }

Member Function Documentation

_deleteOne()

_deleteOne (   $entityModel,   $giftmessageModel = null  )

protected

Delete a single gift message from entity

Parameters

\Magento\Framework\DataObject	$entityModel
\Magento\GiftMessage\Model\Message | null	$giftmessageModel

Returns

$this

Definition at line 170 of file Save.php.

    {
        if ($giftmessageModel === null) {
            $giftmessageModel = $this->_messageFactory->create()->load($entityModel->getGiftMessageId());
        }
        $giftmessageModel->delete();
        $entityModel->setGiftMessageId(0)->save();
        return $this;
    }

_getQuote()

_getQuote ( )

protected

Retrieve quote object

Returns

\Magento\Quote\Model\Quote @codeCoverageIgnore

Definition at line 359 of file Save.php.

    {
        return $this->_session->getQuote();
    }

_saveOne()

_saveOne (   $entityId,   $giftmessage,   $entityType  )

protected

Save a single gift message

Parameters

int	$entityId
array	$giftmessage
string	$entityType

Returns

$this

Definition at line 118 of file Save.php.

    {
        /* @var $giftmessageModel \Magento\GiftMessage\Model\Message */
        $giftmessageModel = $this->_messageFactory->create();

        switch ($entityType) {
            case 'quote':
                $entityModel = $this->_getQuote();
                break;

            case 'quote_item':
                $entityModel = $this->_getQuote()->getItemById($entityId);
                break;

            default:
                $entityModel = $giftmessageModel->getEntityModelByType($entityType)->load($entityId);
                break;
        }

        if (!$entityModel) {
            return $this;
        }

        if ($entityModel->getGiftMessageId()) {
            $giftmessageModel->load($entityModel->getGiftMessageId());
        }

        $giftmessageModel->addData($giftmessage);

        if ($giftmessageModel->isMessageEmpty() && $giftmessageModel->getId()) {
            // remove empty giftmessage
            $this->_deleteOne($entityModel, $giftmessageModel);
            $this->_saved = false;
        } elseif (!$giftmessageModel->isMessageEmpty()) {
            $giftmessageModel->save();
            $entityModel->setGiftMessageId($giftmessageModel->getId());
            if ($entityType != 'quote') {
                $entityModel->save();
            }
            $this->_saved = true;
        }

        return $this;
    }

addAllowQuoteItem()

addAllowQuoteItem

(

$item

)

Add allowed quote item for gift messages

Parameters

int

$item

Returns

$this

Definition at line 198 of file Save.php.

    {
        $items = $this->getAllowQuoteItems();
        if (!in_array($item, $items)) {
            $items[] = $item;
        }
        $this->setAllowQuoteItems($items);

        return $this;
    }

getAllowQuoteItems()

getAllowQuoteItems

(

)

Retrieve allowed quote items for gift messages

Returns

array

Definition at line 214 of file Save.php.

    {
        if (!is_array($this->_session->getAllowQuoteItemsGiftMessage())) {
            $this->setAllowQuoteItems([]);
        }

        return $this->_session->getAllowQuoteItemsGiftMessage();
    }

getAllowQuoteItemsProducts()

getAllowQuoteItemsProducts

(

)

Retrieve allowed quote items products for gift messages

Returns

array

Definition at line 228 of file Save.php.

    {
        $result = [];
        foreach ($this->getAllowQuoteItems() as $itemId) {
            $item = $this->_getQuote()->getItemById($itemId);
            if (!$item) {
                continue;
            }
            $result[] = $item->getProduct()->getId();
        }
        return $result;
    }

getIsAllowedQuoteItem()

getIsAllowedQuoteItem

(

$item

)

Checks allowed quote item for gift messages

Parameters

\Magento\Framework\DataObject

$item

Returns

bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 248 of file Save.php.

    {
        if (!in_array($item->getId(), $this->getAllowQuoteItems())) {
            if ($item->getGiftMessageId() && $this->isGiftMessagesAvailable($item)) {
                $this->addAllowQuoteItem($item->getId());
                return true;
            }
            return false;
        }

        return true;
    }

getMappedType()

getMappedType (   $type )

protected

Retrieve mapped type for entity

Parameters

string

$type

Returns

string|null

Definition at line 338 of file Save.php.

    {
        $map = [
            'main' => 'quote',
            'item' => 'quote_item',
            'order' => 'order',
            'order_item' => 'order_item',
        ];

        if (isset($map[$type])) {
            return $map[$type];
        }
        return null;
    }

getSaved()

getSaved

(

)

Returns

bool @SuppressWarnings(PHPMD.BooleanGetMethodName) @codeCoverageIgnore

Definition at line 86 of file Save.php.

    {
        return $this->_saved;
    }

importAllowQuoteItemsFromItems()

importAllowQuoteItemsFromItems

(

$items

)

Parameters

mixed

$items

Returns

$this

Definition at line 307 of file Save.php.

    {
        $allowedItems = $this->getAllowQuoteItems();
        $deleteAllowedItems = [];
        foreach ($items as $itemId => $data) {
            $item = $this->_getQuote()->getItemById($itemId);

            if (!$item) {
                // Clean not exists items
                $deleteAllowedItems[] = $itemId;
                continue;
            }

            if (in_array($item->getId(), $allowedItems) && !isset($data['giftmessage'])) {
                $deleteAllowedItems[] = $item->getId();
            } elseif (!in_array($item->getId(), $allowedItems) && isset($data['giftmessage'])) {
                $allowedItems[] = $item->getId();
            }
        }

        $allowedItems = array_diff($allowedItems, $deleteAllowedItems);
        $this->setAllowQuoteItems($allowedItems);
        return $this;
    }

importAllowQuoteItemsFromProducts()

importAllowQuoteItemsFromProducts

(

$products

)

Imports quote items for gift messages from products data

Parameters

mixed

$products

Returns

$this

Definition at line 278 of file Save.php.

    {
        $allowedItems = $this->getAllowQuoteItems();
        $deleteAllowedItems = [];
        foreach ($products as $productId => $data) {
            $product = $this->productRepository->getById($productId, false, $this->_session->getStore()->getId());
            $item = $this->_getQuote()->getItemByProduct($product);

            if (!$item) {
                continue;
            }

            if (in_array($item->getId(), $allowedItems) && !isset($data['giftmessage'])) {
                $deleteAllowedItems[] = $item->getId();
            } elseif (!in_array($item->getId(), $allowedItems) && isset($data['giftmessage'])) {
                $allowedItems[] = $item->getId();
            }
        }

        $allowedItems = array_diff($allowedItems, $deleteAllowedItems);

        $this->setAllowQuoteItems($allowedItems);
        return $this;
    }

isGiftMessagesAvailable()

isGiftMessagesAvailable

(

$item

)

Retrieve is gift message available for item (product)

Parameters

\Magento\Framework\DataObject

$item

Returns

bool

Definition at line 267 of file Save.php.

    {
        return $this->_giftMessageMessage->isMessagesAllowed('item', $item, $item->getStore());
    }

saveAllInOrder()

saveAllInOrder

(

)

Returns

$this

Definition at line 94 of file Save.php.

    {
        $giftMessages = $this->getGiftmessages();

        if (!is_array($giftMessages)) {
            return $this;
        }

        foreach ($giftMessages as $entityId => $giftMessage) {
            $entityType = $this->getMappedType($giftMessage['type']);
            $this->_saveOne($entityId, $giftMessage, $entityType);
        }

        return $this;
    }

saveAllInQuote()

saveAllInQuote

(

)

Save all seted giftmessages

Returns

$this

Definition at line 65 of file Save.php.

    {
        $giftmessages = $this->getGiftmessages();

        if (!is_array($giftmessages)) {
            return $this;
        }

        foreach ($giftmessages as $entityId => $giftmessage) {
            $entityType = $this->getMappedType($giftmessage['type']);
            $this->_saveOne($entityId, $giftmessage, $entityType);
        }

        return $this;
    }

setAllowQuoteItems()

setAllowQuoteItems

(

$items

)

Set allowed quote items for gift messages

Parameters

array

$items

Returns

$this

Definition at line 186 of file Save.php.

    {
        $this->_session->setAllowQuoteItemsGiftMessage($items);
        return $this;
    }

Field Documentation

$_giftMessageMessage

$_giftMessageMessage = null

protected

Definition at line 25 of file Save.php.

$_messageFactory

$_messageFactory

protected

Definition at line 35 of file Save.php.

$_saved

$_saved = false

protected

Definition at line 18 of file Save.php.

$_session

$_session

protected

Definition at line 30 of file Save.php.

$productRepository

$productRepository

protected

Definition at line 40 of file Save.php.

---

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

• vendor/magento/module-gift-message/Model/Save.php