SampleRepository Class Reference

Inheritance diagram for SampleRepository:

Public Member Functions
	__construct (ProductRepositoryInterface $productRepository, Type $downloadableType, SampleInterfaceFactory $sampleDataObjectFactory, ContentValidator $contentValidator, ContentUploaderInterface $fileContentUploader, EncoderInterface $jsonEncoder, SampleFactory $sampleFactory)
	save ( $sku, SampleInterface $sample, $isGlobalScopeContent=true)
Public Member Functions inherited from SampleRepositoryInterface
	getList ($sku)
	getSamplesByProduct (\Magento\Catalog\Api\Data\ProductInterface $product)
	delete ($id)

Protected Member Functions
	buildSample ($resourceData)
	setBasicFields ($resourceData, $dataObject)
	saveSample (\Magento\Catalog\Api\Data\ProductInterface $product, SampleInterface $sample, $isGlobalScopeContent)

Protected Attributes
	$productRepository
	$contentValidator
	$downloadableType
	$sampleFactory
	$sampleDataObjectFactory
	$fileContentUploader
	$jsonEncoder

Detailed Description

Class SampleRepository @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 28 of file SampleRepository.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ProductRepositoryInterface	$productRepository,
		Type	$downloadableType,
		SampleInterfaceFactory	$sampleDataObjectFactory,
		ContentValidator	$contentValidator,
		ContentUploaderInterface	$fileContentUploader,
		EncoderInterface	$jsonEncoder,
		SampleFactory	$sampleFactory
	)

Parameters

ProductRepositoryInterface	$productRepository
Type	$downloadableType
SampleInterfaceFactory	$sampleDataObjectFactory
ContentValidator	$contentValidator
ContentUploaderInterface	$fileContentUploader
EncoderInterface	$jsonEncoder
SampleFactory	$sampleFactory

Definition at line 84 of file SampleRepository.php.

      {
        $this->productRepository = $productRepository;
        $this->downloadableType = $downloadableType;
        $this->contentValidator = $contentValidator;
        $this->fileContentUploader = $fileContentUploader;
        $this->jsonEncoder = $jsonEncoder;
        $this->sampleFactory = $sampleFactory;
        $this->sampleDataObjectFactory = $sampleDataObjectFactory;
    }

Member Function Documentation

buildSample()

buildSample (   $resourceData )

protected

Build a sample data object

Parameters

\Magento\Downloadable\Model\Sample

$resourceData

Returns

\Magento\Downloadable\Model\Sample

Definition at line 118 of file SampleRepository.php.

    {
        $sample = $this->sampleDataObjectFactory->create();
        $this->setBasicFields($resourceData, $sample);
        return $sample;
    }

save()

save	(		$sku,
		SampleInterface	$sample,
			$isGlobalScopeContent = true
	)

Update downloadable sample of the given product

Parameters

string	$sku
\Magento\Downloadable\Api\Data\SampleInterface	$sample
bool	$isGlobalScopeContent

Returns

int

Exceptions

InputException
NoSuchEntityException

Implements SampleRepositoryInterface.

Definition at line 175 of file SampleRepository.php.

      {
        $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.')
                );
            }
            $validateSampleContent = !($sample->getSampleType() === 'file' && $sample->getSampleFile());
            if (!$this->contentValidator->isValid($sample, $validateSampleContent)) {
                throw new InputException(
                    __('The sample information is invalid. Verify the information and try again.')
                );
            }

            if (!in_array($sample->getSampleType(), ['url', 'file'], true)) {
                throw new InputException(__('The sample type is invalid. Verify the sample type 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);
        }
    }

saveSample()

saveSample ( \Magento\Catalog\Api\Data\ProductInterface  $product, SampleInterface  $sample,   $isGlobalScopeContent  )

protected

Parameters

\Magento\Catalog\Api\Data\ProductInterface	$product
SampleInterface	$sample
bool	$isGlobalScopeContent

Returns

int

Definition at line 217 of file SampleRepository.php.

      {
        $sampleData = [
            'sample_id' => (int)$sample->getId(),
            'is_delete' => 0,
            'type' => $sample->getSampleType(),
            'sort_order' => $sample->getSortOrder(),
            'title' => $sample->getTitle(),
        ];

        if ($sample->getSampleType() === 'file' && $sample->getSampleFile() === 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();
    }

setBasicFields()

setBasicFields (   $resourceData,   $dataObject  )

protected

Subroutine for buildLink and buildSample

Parameters

\Magento\Downloadable\Model\Link | \Magento\Downloadable\Model\Sample	$resourceData
\Magento\Downloadable\Api\Data\LinkInterface | \Magento\Downloadable\Api\Data\SampleInterface	$dataObject

Returns

null

Definition at line 132 of file SampleRepository.php.

    {
        $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());
    }

Field Documentation

$contentValidator

$contentValidator

protected

Definition at line 38 of file SampleRepository.php.

$downloadableType

$downloadableType

protected

Definition at line 43 of file SampleRepository.php.

$fileContentUploader

$fileContentUploader

protected

Definition at line 58 of file SampleRepository.php.

$jsonEncoder

$jsonEncoder

protected

Definition at line 63 of file SampleRepository.php.

$productRepository

$productRepository

protected

Definition at line 33 of file SampleRepository.php.

$sampleDataObjectFactory

$sampleDataObjectFactory

protected

Definition at line 53 of file SampleRepository.php.

$sampleFactory

$sampleFactory

protected

Definition at line 48 of file SampleRepository.php.

---

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

• vendor/magento/module-downloadable/Model/SampleRepository.php