Type Class Reference

Inheritance diagram for Type:

Public Member Functions
	__construct (\Magento\Catalog\Model\Product\Option $catalogProductOption, \Magento\Eav\Model\Config $eavConfig, \Magento\Catalog\Model\Product\Type $catalogProductType, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\MediaStorage\Helper\File\Storage\Database $fileStorageDb, \Magento\Framework\Filesystem $filesystem, \Magento\Framework\Registry $coreRegistry, \Psr\Log\LoggerInterface $logger, ProductRepositoryInterface $productRepository, \Magento\Downloadable\Model\ResourceModel\SampleFactory $sampleResFactory, \Magento\Downloadable\Model\ResourceModel\Link $linkResource, \Magento\Downloadable\Model\ResourceModel\Link\CollectionFactory $linksFactory, \Magento\Downloadable\Model\ResourceModel\Sample\CollectionFactory $samplesFactory, \Magento\Downloadable\Model\SampleFactory $sampleFactory, \Magento\Downloadable\Model\LinkFactory $linkFactory, \Magento\Downloadable\Model\Product\TypeHandler\TypeHandlerInterface $typeHandler, JoinProcessorInterface $extensionAttributesJoinProcessor, \Magento\Framework\Serialize\Serializer\Json $serializer=null)
	hasLinks ($product)
	hasOptions ($product)
	hasRequiredOptions ($product)
	getLinkSelectionRequired ($product)
	getSamples ($product)
	hasSamples ($product)
	checkProductBuyState ($product)
	getOrderOptions ($product)
	getSearchableData ($product)
	isSalable ($product)
	processBuyRequest ($product, $buyRequest)
	canConfigure ($product)
	hasWeight ()
	deleteTypeSpecificData (\Magento\Catalog\Model\Product $product)
Public Member Functions inherited from Virtual
	isVirtual ($product)
	hasWeight ()
	deleteTypeSpecificData (\Magento\Catalog\Model\Product $product)
Public Member Functions inherited from AbstractType
	deleteTypeSpecificData (\Magento\Catalog\Model\Product $product)
	__construct (\Magento\Catalog\Model\Product\Option $catalogProductOption, \Magento\Eav\Model\Config $eavConfig, \Magento\Catalog\Model\Product\Type $catalogProductType, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\MediaStorage\Helper\File\Storage\Database $fileStorageDb, \Magento\Framework\Filesystem $filesystem, \Magento\Framework\Registry $coreRegistry, \Psr\Log\LoggerInterface $logger, ProductRepositoryInterface $productRepository, \Magento\Framework\Serialize\Serializer\Json $serializer=null)
	setTypeId ($typeId)
	getRelationInfo ()
	getChildrenIds ($parentId, $required=true)
	getParentIdsByChild ($childId)
	getSetAttributes ($product)
	attributesCompare ($attributeOne, $attributeTwo)
	getEditableAttributes ($product)
	getAttributeById ($attributeId, $product)
	isVirtual ($product)
	isSalable ($product)
	processConfiguration (\Magento\Framework\DataObject $buyRequest, $product, $processMode=self::PROCESS_MODE_LITE)
	prepareForCartAdvanced (\Magento\Framework\DataObject $buyRequest, $product, $processMode=null)
	prepareForCart (\Magento\Framework\DataObject $buyRequest, $product)
	addFileQueue ($queueOptions)
	getSpecifyOptionMessage ()
	checkProductBuyState ($product)
	getOrderOptions ($product)
	save ($product)
	beforeSave ($product)
	isComposite ($product)
	canConfigure ($product)
	canUseQtyDecimals ()
	getSku ($product)
	getOptionSku ($product, $sku='')
	getWeight ($product)
	hasOptions ($product)
	updateQtyOption ($options, \Magento\Framework\DataObject $option, $value, $product)
	hasRequiredOptions ($product)
	getStoreFilter ($product)
	setStoreFilter ($store, $product)
	getForceChildItemQtyChanges ($product)
	prepareQuoteItemQty ($qty, $product)
	assignProductToOption ($optionProduct, $option, $product)
	setConfig ($config)
	getSearchableData ($product)
	getProductsToPurchaseByReqGroups ($product)
	processBuyRequest ($product, $buyRequest)
	checkProductConfiguration ($product, $buyRequest)
	hasWeight ()
	setImageFromChildProduct (\Magento\Catalog\Model\Product $product)
	getIdentities (\Magento\Catalog\Model\Product $product)
	getAssociatedProducts ($product)
	isPossibleBuyFromList ($product)

Data Fields
const	TYPE_DOWNLOADABLE = 'downloadable'
Data Fields inherited from AbstractType
const	CALCULATE_CHILD = 0
const	CALCULATE_PARENT = 1
const	SHIPMENT_SEPARATELY = 1
const	SHIPMENT_TOGETHER = 0
const	PROCESS_MODE_FULL = 'full'
const	PROCESS_MODE_LITE = 'lite'
const	OPTION_PREFIX = 'option_'

Protected Member Functions
	_prepareProduct (\Magento\Framework\DataObject $buyRequest, $product, $processMode)
	_createLink ()
	_createSample ()
Protected Member Functions inherited from AbstractType
	_isStrictProcessMode ($processMode)
	_prepareOptions (\Magento\Framework\DataObject $buyRequest, $product, $processMode)
	_removeNotApplicableAttributes ($product)

Protected Attributes
	$_downloadableFile = null
	$_sampleResFactory
	$_linkResource
	$_linksFactory
	$_samplesFactory
	$_sampleFactory
	$_linkFactory
Protected Attributes inherited from AbstractType
	$_typeId
	$_editableAttributes
	$_isComposite = false
	$_canConfigure = false
	$_canUseQtyDecimals = true
	$_fileQueue = []
	$_filesystem
	$_fileStorageDb
	$_cacheProductSetAttributes = '_cache_instance_product_set_attributes'
	$_coreRegistry
	$_eventManager
	$_logger
	$_catalogProductType
	$_eavConfig
	$_catalogProductOption
	$productRepository
	$serializer

Detailed Description

Downloadable product type model

@api @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since

100.0.2

Definition at line 18 of file Type.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Catalog\Model\Product\Option	$catalogProductOption,
		\Magento\Eav\Model\Config	$eavConfig,
		\Magento\Catalog\Model\Product\Type	$catalogProductType,
		\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\MediaStorage\Helper\File\Storage\Database	$fileStorageDb,
		\Magento\Framework\Filesystem	$filesystem,
		\Magento\Framework\Registry	$coreRegistry,
		\Psr\Log\LoggerInterface	$logger,
		ProductRepositoryInterface	$productRepository,
		\Magento\Downloadable\Model\ResourceModel\SampleFactory	$sampleResFactory,
		\Magento\Downloadable\Model\ResourceModel\Link	$linkResource,
		\Magento\Downloadable\Model\ResourceModel\Link\CollectionFactory	$linksFactory,
		\Magento\Downloadable\Model\ResourceModel\Sample\CollectionFactory	$samplesFactory,
		\Magento\Downloadable\Model\SampleFactory	$sampleFactory,
		\Magento\Downloadable\Model\LinkFactory	$linkFactory,
		\Magento\Downloadable\Model\Product\TypeHandler\TypeHandlerInterface	$typeHandler,
		JoinProcessorInterface	$extensionAttributesJoinProcessor,
		\Magento\Framework\Serialize\Serializer\Json	$serializer = null
	)

Construct

Parameters

\Magento\Catalog\Model\Product\Option	$catalogProductOption
\Magento\Eav\Model\Config	$eavConfig
\Magento\Catalog\Model\Product\Type	$catalogProductType
\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\MediaStorage\Helper\File\Storage\Database	$fileStorageDb
\Magento\Framework\Filesystem	$filesystem
\Magento\Framework\Registry	$coreRegistry
\Psr\Log\LoggerInterface	$logger
ProductRepositoryInterface	$productRepository
\Magento\Downloadable\Model\ResourceModel\SampleFactory	$sampleResFactory
\Magento\Downloadable\Model\ResourceModel\Link	$linkResource
\Magento\Downloadable\Model\ResourceModel\Link\CollectionFactory	$linksFactory
\Magento\Downloadable\Model\ResourceModel\Sample\CollectionFactory	$samplesFactory
\Magento\Downloadable\Model\SampleFactory	$sampleFactory
\Magento\Downloadable\Model\LinkFactory	$linkFactory
TypeHandler\TypeHandlerInterface	$typeHandler
JoinProcessorInterface	$extensionAttributesJoinProcessor
\Magento\Framework\Serialize\Serializer\Json | null	$serializer	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 92 of file Type.php.

      {
        $this->_sampleResFactory = $sampleResFactory;
        $this->_linkResource = $linkResource;
        $this->_linksFactory = $linksFactory;
        $this->_samplesFactory = $samplesFactory;
        $this->_sampleFactory = $sampleFactory;
        $this->_linkFactory = $linkFactory;
        $this->typeHandler = $typeHandler;
        $this->extensionAttributesJoinProcessor = $extensionAttributesJoinProcessor;
        parent::__construct(
            $catalogProductOption,
            $eavConfig,
            $catalogProductType,
            $eventManager,
            $fileStorageDb,
            $filesystem,
            $coreRegistry,
            $logger,
            $productRepository,
            $serializer
        );
    }

Member Function Documentation

_createLink()

_createLink ( )

protected

Returns

\Magento\Downloadable\Model\Link

Definition at line 461 of file Type.php.

    {
        return $this->_linkFactory->create();
    }

_createSample()

_createSample ( )

protected

Returns

\Magento\Downloadable\Model\Sample

Definition at line 469 of file Type.php.

    {
        return $this->_sampleFactory->create();
    }

_prepareProduct()

_prepareProduct ( \Magento\Framework\DataObject  $buyRequest,   $product,   $processMode  )

protected

Prepare product and its configuration to be added to some products list. Perform standard preparation process and then prepare options for downloadable links.

Parameters

\Magento\Framework\DataObject	$buyRequest
\Magento\Catalog\Model\Product	$product
string	$processMode

Returns

\Magento\Framework\Phrase|array|string @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 418 of file Type.php.

    {
        $result = parent::_prepareProduct($buyRequest, $product, $processMode);

        if (is_string($result)) {
            return $result;
        }
        // if adding product from admin area we add all links to product
        $originalLinksPurchasedSeparately = null;
        if ($product->getSkipCheckRequiredOption()) {
            $originalLinksPurchasedSeparately = $product->getLinksPurchasedSeparately();
            $product->setLinksPurchasedSeparately(false);
        }
        $preparedLinks = [];
        if ($product->getLinksPurchasedSeparately()) {
            if ($links = $buyRequest->getLinks()) {
                foreach ($this->getLinks($product) as $link) {
                    if (in_array($link->getId(), $links)) {
                        $preparedLinks[] = $link->getId();
                    }
                }
            }
        } else {
            foreach ($this->getLinks($product) as $link) {
                $preparedLinks[] = $link->getId();
            }
        }
        if (null !== $originalLinksPurchasedSeparately) {
            $product->setLinksPurchasedSeparately($originalLinksPurchasedSeparately);
        }
        if ($preparedLinks) {
            $product->addCustomOption('downloadable_link_ids', implode(',', $preparedLinks));
            return $result;
        }
        if ($this->getLinkSelectionRequired($product) && $this->_isStrictProcessMode($processMode)) {
            return __('Please specify product link(s).')->render();
        }
        return $result;
    }

canConfigure()

canConfigure

(

$product

)

Check if downloadable product has links and they can be purchased separately

Parameters

\Magento\Catalog\Model\Product

$product

Returns

bool

Definition at line 361 of file Type.php.

    {
        return $this->hasLinks($product) && $product->getLinksPurchasedSeparately();
    }

checkProductBuyState()

checkProductBuyState

(

$product

)

Check if product can be bought

Parameters

\Magento\Catalog\Model\Product

$product

Returns

$this

Exceptions

Definition at line 251 of file Type.php.

    {
        parent::checkProductBuyState($product);
        $option = $product->getCustomOption('info_buyRequest');
        if ($option instanceof \Magento\Quote\Model\Quote\Item\Option) {
            $buyRequest = new \Magento\Framework\DataObject($this->serializer->unserialize($option->getValue()));
            if (!$buyRequest->hasLinks()) {
                if (!$product->getLinksPurchasedSeparately()) {
                    $allLinksIds = $this->_linksFactory->create()->addProductToFilter(
                        $product->getEntityId()
                    )->getAllIds();
                    $buyRequest->setLinks($allLinksIds);
                    $product->addCustomOption(
                        'info_buyRequest',
                        $this->serializer->serialize($buyRequest->getData())
                    );
                } else {
                    throw new \Magento\Framework\Exception\LocalizedException(__('Please specify product link(s).'));
                }
            }
        }
        return $this;
    }

deleteTypeSpecificData()

deleteTypeSpecificData

(

\Magento\Catalog\Model\Product

$product

)

Delete data specific for Downloadable product type

Parameters

\Magento\Catalog\Model\Product

$product

Returns

void

Definition at line 382 of file Type.php.

    {
        if ($product->getOrigData('type_id') === \Magento\Downloadable\Model\Product\Type::TYPE_DOWNLOADABLE) {
            $downloadableData = $product->getDownloadableData();
            $sampleItems = [];
            if (isset($downloadableData['sample'])) {
                foreach ($downloadableData['sample'] as $sample) {
                    $sampleItems[] = $sample['sample_id'];
                }
            }
            if ($sampleItems) {
                $this->_sampleResFactory->create()->deleteItems($sampleItems);
            }
            $linkItems = [];
            if (isset($downloadableData['link'])) {
                foreach ($downloadableData['link'] as $link) {
                    $linkItems[] = $link['link_id'];
                }
            }
            if ($linkItems) {
                $this->_linkResource->deleteItems($linkItems);
            }
        }
    }

getLinkSelectionRequired()

getLinkSelectionRequired

(

$product

)

Check if product cannot be purchased with no links selected

Parameters

\Magento\Catalog\Model\Product

$product

Returns

boolean @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 207 of file Type.php.

    {
        return $product->getLinksPurchasedSeparately();
    }

getOrderOptions()

getOrderOptions

(

$product

)

Prepare additional options/information for order item which will be created from this product

Parameters

\Magento\Catalog\Model\Product

$product

Returns

array

Definition at line 282 of file Type.php.

    {
        $options = parent::getOrderOptions($product);
        if ($linkIds = $product->getCustomOption('downloadable_link_ids')) {
            $linkOptions = [];
            $links = $this->getLinks($product);
            foreach (explode(',', $linkIds->getValue()) as $linkId) {
                if (isset($links[$linkId])) {
                    $linkOptions[] = $linkId;
                }
            }
            $options = array_merge($options, ['links' => $linkOptions]);
        }
        $options = array_merge(
            $options,
            ['is_downloadable' => true, 'real_product_type' => self::TYPE_DOWNLOADABLE]
        );
        return $options;
    }

getSamples()

getSamples

(

$product

)

Get downloadable product samples

Parameters

\Magento\Catalog\Model\Product

$product

Returns

\Magento\Downloadable\Model\ResourceModel\Sample\Collection

Definition at line 218 of file Type.php.

    {
        if ($product->getDownloadableSamples() === null) {
            $sampleCollection = $this->_samplesFactory->create()->addProductToFilter(
                $product->getEntityId()
            )->addTitleToResult(
                $product->getStoreId()
            );
            $this->extensionAttributesJoinProcessor->process($sampleCollection);
            $product->setDownloadableSamples($sampleCollection);
        }

        return $product->getDownloadableSamples();
    }

getSearchableData()

getSearchableData

(

$product

)

Retrieve additional searchable data from type instance Using based on product id and store_id data

Parameters

\Magento\Catalog\Model\Product

$product

Returns

array

Definition at line 309 of file Type.php.

    {
        $searchData = parent::getSearchableData($product);

        $linkSearchData = $this->_createLink()->getSearchableData($product->getEntityId(), $product->getStoreId());
        if ($linkSearchData) {
            $searchData = array_merge($searchData, $linkSearchData);
        }

        $sampleSearchData = $this->_createSample()->getSearchableData($product->getEntityId(), $product->getStoreId());
        if ($sampleSearchData) {
            $searchData = array_merge($searchData, $sampleSearchData);
        }

        return $searchData;
    }

hasLinks()

hasLinks

(

$product

)

Check if product has links

Parameters

\Magento\Catalog\Model\Product

$product

Returns

boolean

Definition at line 169 of file Type.php.

    {
        $hasLinks = $product->getData('links_exist');
        if (null === $hasLinks) {
            $hasLinks = (count($this->getLinks($product)) > 0);
        }
        return $hasLinks;
    }

hasOptions()

hasOptions

(

$product

)

Check if product has options

Parameters

\Magento\Catalog\Model\Product

$product

Returns

boolean

Definition at line 184 of file Type.php.

    {
        return parent::hasOptions($product) || $this->hasLinks($product);
    }

hasRequiredOptions()

hasRequiredOptions

(

$product

)

Check if product has required options

Parameters

\Magento\Catalog\Model\Product

$product

Returns

bool

Definition at line 195 of file Type.php.

    {
        return (parent::hasRequiredOptions($product) || $product->getLinksPurchasedSeparately());
    }

hasSamples()

hasSamples

(

$product

)

Check if product has samples

Parameters

\Magento\Catalog\Model\Product

$product

Returns

boolean

Definition at line 239 of file Type.php.

    {
        return count($this->getSamples($product)) > 0;
    }

hasWeight()

hasWeight

(

)

Check that product of this type has weight

Returns

bool

Definition at line 371 of file Type.php.

    {
        return false;
    }

isSalable()

isSalable

(

$product

)

Check is product available for sale

Parameters

\Magento\Catalog\Model\Product

$product

Returns

bool

Definition at line 332 of file Type.php.

    {
        return $this->hasLinks($product) && parent::isSalable($product);
    }

processBuyRequest()

processBuyRequest	(		$product,
			$buyRequest
	)

Prepare selected options for downloadable product

Parameters

\Magento\Catalog\Model\Product	$product
\Magento\Framework\DataObject	$buyRequest

Returns

array @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 345 of file Type.php.

    {
        $links = $buyRequest->getLinks();
        $links = is_array($links) ? array_filter($links, 'intval') : [];

        $options = ['links' => $links];

        return $options;
    }

Field Documentation

$_downloadableFile

$_downloadableFile = null

protected

Definition at line 27 of file Type.php.

$_linkFactory

$_linkFactory

protected

Definition at line 57 of file Type.php.

$_linkResource

$_linkResource

protected

Definition at line 37 of file Type.php.

$_linksFactory

$_linksFactory

protected

Definition at line 42 of file Type.php.

$_sampleFactory

$_sampleFactory

protected

Definition at line 52 of file Type.php.

$_sampleResFactory

$_sampleResFactory

protected

Definition at line 32 of file Type.php.

$_samplesFactory

$_samplesFactory

protected

Definition at line 47 of file Type.php.

TYPE_DOWNLOADABLE

const TYPE_DOWNLOADABLE = 'downloadable'

Definition at line 20 of file Type.php.

---

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

• vendor/magento/module-downloadable/Model/Product/Type.php