Your IP : 216.73.216.97
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Downloadable\Model;
use Magento\Catalog\Api\Data\ProductInterface;
use Magento\Catalog\Api\ProductRepositoryInterface;
use Magento\Downloadable\Api\Data\SampleInterfaceFactory;
use Magento\Downloadable\Model\Product\Type;
use Magento\Downloadable\Api\Data\File\ContentUploaderInterface;
use Magento\Downloadable\Api\Data\SampleInterface;
use Magento\Downloadable\Model\Product\TypeHandler\Sample as SampleHandler;
use Magento\Downloadable\Model\Sample\ContentValidator;
use Magento\Framework\EntityManager\MetadataPool;
use Magento\Framework\Exception\InputException;
use Magento\Framework\Exception\NoSuchEntityException;
use Magento\Framework\Exception\StateException;
use Magento\Framework\Json\EncoderInterface;
use Magento\Framework\App\ObjectManager;
/**
* Class SampleRepository
*
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class SampleRepository implements \Magento\Downloadable\Api\SampleRepositoryInterface
{
/**
* @var \Magento\Catalog\Api\ProductRepositoryInterface
*/
protected $productRepository;
/**
* @var ContentValidator
*/
protected $contentValidator;
/**
* @var Type
*/
protected $downloadableType;
/**
* @var SampleFactory
*/
protected $sampleFactory;
/**
* @var SampleInterfaceFactory
*/
protected $sampleDataObjectFactory;
/**
* @var ContentUploaderInterface
*/
protected $fileContentUploader;
/**
* @var EncoderInterface
*/
protected $jsonEncoder;
/**
* @var SampleHandler
*/
private $sampleTypeHandler;
/**
* @var MetadataPool
*/
private $metadataPool;
/**
* @param ProductRepositoryInterface $productRepository
* @param Type $downloadableType
* @param SampleInterfaceFactory $sampleDataObjectFactory
* @param ContentValidator $contentValidator
* @param ContentUploaderInterface $fileContentUploader
* @param EncoderInterface $jsonEncoder
* @param SampleFactory $sampleFactory
*/
public function __construct(
ProductRepositoryInterface $productRepository,
Type $downloadableType,
SampleInterfaceFactory $sampleDataObjectFactory,
ContentValidator $contentValidator,
ContentUploaderInterface $fileContentUploader,
EncoderInterface $jsonEncoder,
SampleFactory $sampleFactory
) {
$this->productRepository = $productRepository;
$this->downloadableType = $downloadableType;
$this->contentValidator = $contentValidator;
$this->fileContentUploader = $fileContentUploader;
$this->jsonEncoder = $jsonEncoder;
$this->sampleFactory = $sampleFactory;
$this->sampleDataObjectFactory = $sampleDataObjectFactory;
}
/**
* @inheritdoc
*/
public function getList($sku)
{
/** @var \Magento\Catalog\Model\Product $product */
$product = $this->productRepository->get($sku);
return $this->getSamplesByProduct($product);
}
/**
* Build a sample data object
*
* @param \Magento\Downloadable\Model\Sample $resourceData
* @return \Magento\Downloadable\Model\Sample
*/
protected function buildSample($resourceData)
{
$sample = $this->sampleDataObjectFactory->create();
$this->setBasicFields($resourceData, $sample);
return $sample;
}
/**
* Subroutine for buildLink and buildSample
*
* @param \Magento\Downloadable\Model\Link|\Magento\Downloadable\Model\Sample $resourceData
* @param \Magento\Downloadable\Api\Data\LinkInterface|\Magento\Downloadable\Api\Data\SampleInterface $dataObject
* @return null
*/
protected function setBasicFields($resourceData, $dataObject)
{
$dataObject->setId($resourceData->getId());
$storeTitle = $resourceData->getStoreTitle();
$title = $resourceData->getTitle();
if (!empty($storeTitle)) {
$dataObject->setTitle($storeTitle);
} else {
$dataObject->setTitle($title);
}
$dataObject->setSortOrder($resourceData->getSortOrder());
$dataObject->setSampleType($resourceData->getSampleType());
$dataObject->setSampleFile($resourceData->getSampleFile());
$dataObject->setSampleUrl($resourceData->getSampleUrl());
}
/**
* List of links with associated samples
*
* @param \Magento\Catalog\Api\Data\ProductInterface $product
* @return \Magento\Downloadable\Api\Data\SampleInterface[]
*/
public function getSamplesByProduct(\Magento\Catalog\Api\Data\ProductInterface $product)
{
$sampleList = [];
$samples = $this->downloadableType->getSamples($product);
/** @var \Magento\Downloadable\Model\Sample $sample */
foreach ($samples as $sample) {
$sampleList[] = $this->buildSample($sample);
}
return $sampleList;
}
/**
* Update downloadable sample of the given product
*
* @param string $sku
* @param \Magento\Downloadable\Api\Data\SampleInterface $sample
* @param bool $isGlobalScopeContent
* @return int
* @throws InputException
* @throws NoSuchEntityException
*/
public function save(
$sku,
SampleInterface $sample,
$isGlobalScopeContent = true
) {
$product = $this->productRepository->get($sku, true);
$sampleId = $sample->getId();
if ($sampleId) {
return $this->updateSample($product, $sample, $isGlobalScopeContent);
} else {
if ($product->getTypeId() !== Type::TYPE_DOWNLOADABLE) {
throw new InputException(
__('The product needs to be the downloadable type. Verify the product and try again.')
);
}
$this->validateSampleType($sample);
if (!$this->contentValidator->isValid($sample, true)) {
throw new InputException(
__('The sample information is invalid. Verify the information and try again.')
);
}
$title = $sample->getTitle();
if (empty($title)) {
throw new InputException(__('The sample title is empty. Enter the title and try again.'));
}
return $this->saveSample($product, $sample, $isGlobalScopeContent);
}
}
/**
* Save sample.
*
* @param \Magento\Catalog\Api\Data\ProductInterface $product
* @param SampleInterface $sample
* @param bool $isGlobalScopeContent
* @return int
*/
protected function saveSample(
\Magento\Catalog\Api\Data\ProductInterface $product,
SampleInterface $sample,
$isGlobalScopeContent
) {
$sampleData = [
'sample_id' => (int)$sample->getId(),
'is_delete' => 0,
'type' => $sample->getSampleType(),
'sort_order' => $sample->getSortOrder(),
'title' => $sample->getTitle(),
];
if ($sample->getSampleType() === 'file' && $sample->getSampleFileContent() !== null) {
$sampleData['file'] = $this->jsonEncoder->encode(
[
$this->fileContentUploader->upload($sample->getSampleFileContent(), 'sample'),
]
);
} elseif ($sample->getSampleType() === 'url') {
$sampleData['sample_url'] = $sample->getSampleUrl();
} else {
//existing file
$sampleData['file'] = $this->jsonEncoder->encode(
[
[
'file' => $sample->getSampleFile(),
'status' => 'old',
],
]
);
}
$downloadableData = ['sample' => [$sampleData]];
if ($isGlobalScopeContent) {
$product->setStoreId(0);
}
$this->getSampleTypeHandler()->save($product, $downloadableData);
return $product->getLastAddedSampleId();
}
/**
* Update sample.
*
* @param \Magento\Catalog\Api\Data\ProductInterface $product
* @param SampleInterface $sample
* @param bool $isGlobalScopeContent
* @return int
* @throws InputException
* @throws NoSuchEntityException
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.NPathComplexity)
*/
protected function updateSample(
\Magento\Catalog\Api\Data\ProductInterface $product,
SampleInterface $sample,
$isGlobalScopeContent
) {
$sampleId = $sample->getId();
/** @var $existingSample \Magento\Downloadable\Model\Sample */
$existingSample = $this->sampleFactory->create()->load($sampleId);
if (!$existingSample->getId()) {
throw new NoSuchEntityException(
__('No downloadable sample with the provided ID was found. Verify the ID and try again.')
);
}
$linkFieldValue = $product->getData(
$this->getMetadataPool()->getMetadata(ProductInterface::class)->getLinkField()
);
if ($existingSample->getProductId() != $linkFieldValue) {
throw new InputException(
__("The downloadable sample isn't related to the product. Verify the link and try again.")
);
}
$this->validateSampleType($sample);
if (!$this->contentValidator->isValid($sample, true)) {
throw new InputException(__('The sample information is invalid. Verify the information and try again.'));
}
if ($isGlobalScopeContent) {
$product->setStoreId(0);
}
$title = $sample->getTitle();
if (empty($title)) {
if ($isGlobalScopeContent) {
throw new InputException(__('The sample title is empty. Enter the title and try again.'));
}
// use title from GLOBAL scope
$existingSample->setTitle(null);
} else {
$existingSample->setTitle($sample->getTitle());
}
$this->saveSample($product, $sample, $isGlobalScopeContent);
return $existingSample->getId();
}
/**
* @inheritdoc
*/
public function delete($id)
{
/** @var $sample \Magento\Downloadable\Model\Sample */
$sample = $this->sampleFactory->create()->load($id);
if (!$sample->getId()) {
throw new NoSuchEntityException(
__('No downloadable sample with the provided ID was found. Verify the ID and try again.')
);
}
try {
$sample->delete();
} catch (\Exception $exception) {
throw new StateException(__('The sample with "%1" ID can\'t be deleted.', $sample->getId()), $exception);
}
return true;
}
/**
* Check that Sample type exist.
*
* @param SampleInterface $sample
* @throws InputException
* @return void
*/
private function validateSampleType(SampleInterface $sample): void
{
if (!in_array($sample->getSampleType(), ['url', 'file'], true)) {
throw new InputException(__('The sample type is invalid. Verify the sample type and try again.'));
}
}
/**
* Get MetadataPool instance
*
* @deprecated 100.1.0
* @return MetadataPool
*/
private function getMetadataPool()
{
if (!$this->metadataPool) {
$this->metadataPool = ObjectManager::getInstance()->get(MetadataPool::class);
}
return $this->metadataPool;
}
/**
* Get SampleTypeHandler Instance
*
* @deprecated 100.1.0
* @return SampleHandler
*/
private function getSampleTypeHandler()
{
if (!$this->sampleTypeHandler) {
$this->sampleTypeHandler = ObjectManager::getInstance()->get(SampleHandler::class);
}
return $this->sampleTypeHandler;
}
}