Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/module-catalog/Model/Product/Option/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Catalog\Model\Product\Option;
use Magento\Catalog\Api\Data\ProductInterface;
use Magento\Framework\Exception\CouldNotSaveException;
use Magento\Framework\Exception\NoSuchEntityException;
use Magento\Framework\EntityManager\MetadataPool;
use Magento\Framework\EntityManager\HydratorPool;
use Magento\Framework\App\ObjectManager;
/**
* Product custom options repository
*
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class Repository implements \Magento\Catalog\Api\ProductCustomOptionRepositoryInterface
{
/**
* @var \Magento\Catalog\Model\ResourceModel\Product\Option\CollectionFactory
*/
protected $collectionFactory;
/**
* @var \Magento\Catalog\Model\Product\OptionFactory
*/
protected $optionFactory;
/**
* @var \Magento\Catalog\Api\ProductRepositoryInterface
*/
protected $productRepository;
/**
* @var \Magento\Catalog\Model\ResourceModel\Product\Option
*/
protected $optionResource;
/**
* @var MetadataPool
*/
protected $metadataPool;
/**
* @var HydratorPool
*/
protected $hydratorPool;
/**
* @var Converter
*/
protected $converter;
/**
* Constructor
*
* @param \Magento\Catalog\Api\ProductRepositoryInterface $productRepository
* @param \Magento\Catalog\Model\ResourceModel\Product\Option $optionResource
* @param Converter $converter
* @param \Magento\Catalog\Model\ResourceModel\Product\Option\CollectionFactory|null $collectionFactory
* @param \Magento\Catalog\Model\Product\OptionFactory|null $optionFactory
* @param \Magento\Framework\EntityManager\MetadataPool|null $metadataPool
*/
public function __construct(
\Magento\Catalog\Api\ProductRepositoryInterface $productRepository,
\Magento\Catalog\Model\ResourceModel\Product\Option $optionResource,
\Magento\Catalog\Model\Product\Option\Converter $converter,
\Magento\Catalog\Model\ResourceModel\Product\Option\CollectionFactory $collectionFactory = null,
\Magento\Catalog\Model\Product\OptionFactory $optionFactory = null,
\Magento\Framework\EntityManager\MetadataPool $metadataPool = null
) {
$this->productRepository = $productRepository;
$this->optionResource = $optionResource;
$this->converter = $converter;
$this->collectionFactory = $collectionFactory ?: ObjectManager::getInstance()
->get(\Magento\Catalog\Model\ResourceModel\Product\Option\CollectionFactory::class);
$this->optionFactory = $optionFactory ?: ObjectManager::getInstance()
->get(\Magento\Catalog\Model\Product\OptionFactory::class);
$this->metadataPool = $metadataPool ?: ObjectManager::getInstance()
->get(\Magento\Framework\EntityManager\MetadataPool::class);
}
/**
* @inheritdoc
*/
public function getList($sku)
{
$product = $this->productRepository->get($sku, true);
return $product->getOptions() ?: [];
}
/**
* @inheritdoc
*/
public function getProductOptions(ProductInterface $product, $requiredOnly = false)
{
return $this->collectionFactory->create()->getProductOptions(
$product->getEntityId(),
$product->getStoreId(),
$requiredOnly
);
}
/**
* @inheritdoc
*/
public function get($sku, $optionId)
{
$product = $this->productRepository->get($sku);
$option = $product->getOptionById($optionId);
if ($option === null) {
throw NoSuchEntityException::singleField('optionId', $optionId);
}
return $option;
}
/**
* @inheritdoc
*/
public function delete(\Magento\Catalog\Api\Data\ProductCustomOptionInterface $entity)
{
$this->optionResource->delete($entity);
return true;
}
/**
* @inheritdoc
*/
public function duplicate(
\Magento\Catalog\Api\Data\ProductInterface $product,
\Magento\Catalog\Api\Data\ProductInterface $duplicate
) {
$hydrator = $this->getHydratorPool()->getHydrator(ProductInterface::class);
$metadata = $this->metadataPool->getMetadata(ProductInterface::class);
return $this->optionResource->duplicate(
$this->optionFactory->create([]),
$hydrator->extract($product)[$metadata->getLinkField()],
$hydrator->extract($duplicate)[$metadata->getLinkField()]
);
}
/**
* @inheritdoc
*/
public function save(\Magento\Catalog\Api\Data\ProductCustomOptionInterface $option)
{
$productSku = $option->getProductSku();
if (!$productSku) {
throw new CouldNotSaveException(__('The ProductSku is empty. Set the ProductSku and try again.'));
}
/** @var \Magento\Catalog\Model\Product $product */
$product = $this->productRepository->get($productSku);
$metadata = $this->metadataPool->getMetadata(ProductInterface::class);
$option->setData('product_id', $product->getData($metadata->getLinkField()));
$option->setData('store_id', $product->getStoreId());
$backedOptions = $option->getValues();
if ($option->getOptionId()) {
$options = $product->getOptions();
if (!$options) {
$options = $this->getProductOptions($product);
}
$persistedOption = array_filter($options, function ($iOption) use ($option) {
return $option->getOptionId() == $iOption->getOptionId();
});
$persistedOption = reset($persistedOption);
if (!$persistedOption) {
throw new NoSuchEntityException();
}
$originalValues = $persistedOption->getValues();
$newValues = $option->getData('values');
if (!$newValues) {
$newValues = $this->getOptionValues($option);
}
if ($newValues) {
if (isset($originalValues)) {
$newValues = $this->markRemovedValues($newValues, $originalValues);
}
$option->setData('values', $newValues);
}
}
$option->save();
// Required for API response data consistency
$option->setValues($backedOptions);
return $option;
}
/**
* @inheritdoc
*/
public function deleteByIdentifier($sku, $optionId)
{
$product = $this->productRepository->get($sku, true);
$options = $product->getOptions();
$option = $product->getOptionById($optionId);
if ($option === null) {
throw NoSuchEntityException::singleField('optionId', $optionId);
}
unset($options[$optionId]);
try {
$this->delete($option);
if (empty($options)) {
$this->productRepository->save($product);
}
} catch (\Exception $e) {
throw new CouldNotSaveException(__("The custom option couldn't be removed."));
}
return true;
}
/**
* Mark original values for removal if they are absent among new values
*
* @param array $newValues
* @param \Magento\Catalog\Model\Product\Option\Value[] $originalValues
* @return array
*/
protected function markRemovedValues($newValues, $originalValues)
{
$existingValuesIds = [];
foreach ($newValues as $newValue) {
if (array_key_exists('option_type_id', $newValue)) {
$existingValuesIds[] = $newValue['option_type_id'];
}
}
/** @var $originalValue \Magento\Catalog\Model\Product\Option\Value */
foreach ($originalValues as $originalValue) {
if (!in_array($originalValue->getData('option_type_id'), $existingValuesIds)) {
$originalValue->setData('is_delete', 1);
$newValues[] = $originalValue->getData();
}
}
return $newValues;
}
/**
* Get hydrator pool
*
* @return \Magento\Framework\EntityManager\HydratorPool
* @deprecated 101.0.0
*/
private function getHydratorPool()
{
if (null === $this->hydratorPool) {
$this->hydratorPool = \Magento\Framework\App\ObjectManager::getInstance()
->get(\Magento\Framework\EntityManager\HydratorPool::class);
}
return $this->hydratorPool;
}
/**
* Get Option values from property
*
* Gets Option values stored in property, modifies for needed format and clears the property
*
* @param \Magento\Catalog\Api\Data\ProductCustomOptionInterface $option
* @return array|null
*/
private function getOptionValues(\Magento\Catalog\Api\Data\ProductCustomOptionInterface $option): ?array
{
if ($option->getValues() === null) {
return null;
}
$optionValues = [];
foreach ($option->getValues() as $optionValue) {
$optionValues[] = $optionValue->getData();
}
$option->setValues(null);
return $optionValues;
}
}