mirror of
https://github.com/bdnugget/magento2.git
synced 2026-11-07 09:17:35 +00:00
Fixing resetState methods so that the object's state is the same as it was when first constructed
186 lines
5.7 KiB
PHP
186 lines
5.7 KiB
PHP
<?php
|
|
/**
|
|
*
|
|
* Copyright © Magento, Inc. All rights reserved.
|
|
* See COPYING.txt for license details.
|
|
*/
|
|
|
|
namespace Magento\GiftMessage\Model;
|
|
|
|
use Magento\Framework\Exception\CouldNotSaveException;
|
|
use Magento\Framework\Exception\NoSuchEntityException;
|
|
use Magento\Framework\Exception\State\InvalidTransitionException;
|
|
use Magento\Framework\ObjectManager\ResetAfterRequestInterface;
|
|
|
|
/**
|
|
* Order item gift message repository object.
|
|
*/
|
|
class OrderItemRepository implements \Magento\GiftMessage\Api\OrderItemRepositoryInterface, ResetAfterRequestInterface
|
|
{
|
|
/**
|
|
* Factory for Order instances.
|
|
*
|
|
* @var \Magento\Sales\Model\OrderFactory
|
|
*/
|
|
protected $orderFactory;
|
|
|
|
/**
|
|
* Cached orders data.
|
|
*
|
|
* @var \Magento\Sales\Api\Data\OrderInterface[]
|
|
*/
|
|
private $orders;
|
|
|
|
/**
|
|
* Store manager interface.
|
|
*
|
|
* @var \Magento\Store\Model\StoreManagerInterface
|
|
*/
|
|
protected $storeManager;
|
|
|
|
/**
|
|
* Model for Gift message save.
|
|
*
|
|
* @var \Magento\GiftMessage\Model\Save
|
|
*/
|
|
protected $giftMessageSaveModel;
|
|
|
|
/**
|
|
* Message helper.
|
|
*
|
|
* @var \Magento\GiftMessage\Helper\Message
|
|
*/
|
|
protected $helper;
|
|
|
|
/**
|
|
* @var \Magento\GiftMessage\Model\MessageFactory
|
|
*/
|
|
protected $messageFactory;
|
|
|
|
/**
|
|
* @param \Magento\Sales\Model\OrderFactory $orderFactory
|
|
* @param \Magento\Store\Model\StoreManagerInterface $storeManager
|
|
* @param \Magento\GiftMessage\Model\Save $giftMessageSaveModel
|
|
* @param \Magento\GiftMessage\Helper\Message $helper
|
|
* @param MessageFactory $messageFactory
|
|
*/
|
|
public function __construct(
|
|
\Magento\Sales\Model\OrderFactory $orderFactory,
|
|
\Magento\Store\Model\StoreManagerInterface $storeManager,
|
|
\Magento\GiftMessage\Model\Save $giftMessageSaveModel,
|
|
\Magento\GiftMessage\Helper\Message $helper,
|
|
\Magento\GiftMessage\Model\MessageFactory $messageFactory
|
|
) {
|
|
$this->orderFactory = $orderFactory;
|
|
$this->giftMessageSaveModel = $giftMessageSaveModel;
|
|
$this->storeManager = $storeManager;
|
|
$this->helper = $helper;
|
|
$this->messageFactory = $messageFactory;
|
|
}
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
public function get($orderId, $orderItemId)
|
|
{
|
|
/** @var \Magento\Sales\Api\Data\OrderItemInterface $orderItem */
|
|
if (!$orderItem = $this->getItemById($orderId, $orderItemId)) {
|
|
throw new NoSuchEntityException(
|
|
__('No item with the provided ID was found in the Order. Verify the ID and try again.')
|
|
);
|
|
}
|
|
|
|
if (!$this->helper->isMessagesAllowed('order_item', $orderItem, $this->storeManager->getStore())) {
|
|
throw new NoSuchEntityException(
|
|
__(
|
|
"No item with the provided ID was found in the Order, or a gift message isn't allowed. "
|
|
. "Verify and try again."
|
|
)
|
|
);
|
|
}
|
|
|
|
$messageId = $orderItem->getGiftMessageId();
|
|
if (!$messageId) {
|
|
throw new NoSuchEntityException(
|
|
__('No item with the provided ID was found in the Order. Verify the ID and try again.')
|
|
);
|
|
}
|
|
|
|
return $this->messageFactory->create()->load($messageId);
|
|
}
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
public function save($orderId, $orderItemId, \Magento\GiftMessage\Api\Data\MessageInterface $giftMessage)
|
|
{
|
|
/** @var \Magento\Sales\Api\Data\OrderInterface $order */
|
|
$order = $this->orderFactory->create()->load($orderId);
|
|
|
|
/** @var \Magento\Sales\Api\Data\OrderItemInterface $orderItem */
|
|
if (!$orderItem = $this->getItemById($orderId, $orderItemId)) {
|
|
throw new NoSuchEntityException(
|
|
__('No item with the provided ID was found in the Order. Verify the ID and try again.')
|
|
);
|
|
}
|
|
|
|
if ($order->getIsVirtual()) {
|
|
throw new InvalidTransitionException(__("Gift messages can't be used for virtual products."));
|
|
}
|
|
if (!$this->helper->isMessagesAllowed('order_item', $orderItem, $this->storeManager->getStore())) {
|
|
throw new CouldNotSaveException(__("The gift message isn't available."));
|
|
}
|
|
|
|
$message = [];
|
|
$message[$orderItemId] = [
|
|
'type' => 'order_item',
|
|
'sender' => $giftMessage->getSender(),
|
|
'recipient' => $giftMessage->getRecipient(),
|
|
'message' => $giftMessage->getMessage(),
|
|
];
|
|
|
|
$this->giftMessageSaveModel->setGiftmessages($message);
|
|
try {
|
|
$this->giftMessageSaveModel->saveAllInOrder();
|
|
unset($this->orders[$orderId]);
|
|
} catch (\Exception $e) {
|
|
throw new CouldNotSaveException(
|
|
__('The gift message couldn\'t be added to the "%1" order.', $e->getMessage()),
|
|
$e
|
|
);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Get order item by id
|
|
*
|
|
* @param int $orderId
|
|
* @param int $orderItemId
|
|
* @return \Magento\Sales\Api\Data\OrderItemInterface|bool
|
|
*/
|
|
protected function getItemById($orderId, $orderItemId)
|
|
{
|
|
if (!isset($this->orders[$orderId])) {
|
|
$this->orders[$orderId] = $this->orderFactory->create()->load($orderId);
|
|
}
|
|
/** @var \Magento\Sales\Api\Data\OrderInterface $item */
|
|
$order = $this->orders[$orderId];
|
|
/** @var \Magento\Sales\Api\Data\OrderItemInterface $item */
|
|
$item = $order->getItemById($orderItemId);
|
|
|
|
if ($item !== null) {
|
|
return $item;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function _resetState(): void
|
|
{
|
|
$this->orders = null;
|
|
}
|
|
}
|