Inheritance diagram for Product:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Catalog\Model\Session $catalogSession, \Magento\Framework\View\Asset\Repository $assetRepo, \Magento\Framework\Registry $coreRegistry, \Magento\Catalog\Model\Attribute\Config $attributeConfig, $reindexPriceIndexerData, $reindexProductCategoryIndexerData, ProductRepositoryInterface $productRepository, CategoryRepositoryInterface $categoryRepository)

	isDataForPriceIndexerWasChanged ($data)

	isDataForProductCategoryIndexerWasChanged (\Magento\Catalog\Model\Product $data)

	getProductUrl ($product)

	getPrice ($product)

	getFinalPrice ($product)

	getImageUrl ($product)

	getSmallImageUrl ($product)

	getThumbnailUrl ($product)

	getEmailToFriendUrl ($product)

	getStatuses ()

	canShow ($product, $where='catalog')

	canUseCanonicalTag ($store=null)

	getAttributeInputTypes ($inputType=null)

	getAttributeBackendModelByInputType ($inputType)

	getAttributeSourceModelByInputType ($inputType)

	initProduct ($productId, $controller, $params=null)

	prepareProductOptions ($product, $buyRequest)

	addParamsToBuyRequest ($buyRequest, $params)

	setSkipSaleableCheck ($skipSaleableCheck=false)

	getSkipSaleableCheck ()

	getFieldsAutogenerationMasks ()

	getAttributesAllowedForAutogeneration ()

Public Member Functions inherited from Data
	getCurrentBase64Url ()

	getEncodedUrl ($url=null)

	addRequestParam ($url, $param)

	removeRequestParam ($url, $paramKey, $caseSensitive=false)

Public Member Functions inherited from AbstractHelper
	__construct (Context $context)

	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	XML_PATH_PRODUCT_URL_USE_CATEGORY = 'catalog/seo/product_use_categories'

const	XML_PATH_USE_PRODUCT_CANONICAL_TAG = 'catalog/seo/product_canonical_tag'

const	XML_PATH_AUTO_GENERATE_MASK = 'catalog/fields_masks'

Protected Attributes
	$_skipSaleableCheck = false

	$_statuses

	$_priceBlock

	$_assetRepo

	$_coreRegistry

	$_attributeConfig

	$_catalogSession

	$_reindexProductCategoryIndexerData

	$_reindexPriceIndexerData

	$productRepository

	$categoryRepository

	$_storeManager

Protected Attributes inherited from AbstractHelper
	$_moduleName

	$_request

	$_moduleManager

	$_logger

	$_urlBuilder

	$_httpHeader

	$_eventManager

	$_remoteAddress

	$urlEncoder

	$urlDecoder

	$scopeConfig

	$_cacheConfig

Additional Inherited Members
Protected Member Functions inherited from AbstractHelper
	_getRequest ()

	_getModuleName ()

	_getUrl ($route, $params=[])

Detailed Description

Catalog category helper @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 18 of file Product.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Catalog\Model\Session	$catalogSession,
		\Magento\Framework\View\Asset\Repository	$assetRepo,
		\Magento\Framework\Registry	$coreRegistry,
		\Magento\Catalog\Model\Attribute\Config	$attributeConfig,
			$reindexPriceIndexerData,
			$reindexProductCategoryIndexerData,
		ProductRepositoryInterface	$productRepository,
		CategoryRepositoryInterface	$categoryRepository
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Catalog\Model\Session	$catalogSession
\Magento\Framework\View\Asset\Repository	$assetRepo
\Magento\Framework\Registry	$coreRegistry
\Magento\Catalog\Model\Attribute\Config	$attributeConfig
array	$reindexPriceIndexerData
array	$reindexProductCategoryIndexerData
ProductRepositoryInterface	$productRepository
CategoryRepositoryInterface	$categoryRepository	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 109 of file Product.php.

       {
         $this->_catalogSession = $catalogSession;
         $this->_attributeConfig = $attributeConfig;
         $this->_coreRegistry = $coreRegistry;
         $this->_assetRepo = $assetRepo;
         $this->_reindexPriceIndexerData = $reindexPriceIndexerData;
         $this->productRepository = $productRepository;
         $this->categoryRepository = $categoryRepository;
         $this->_reindexProductCategoryIndexerData = $reindexProductCategoryIndexerData;
         $this->_storeManager = $storeManager;
         parent::__construct($context);
     }

Member Function Documentation

◆ addParamsToBuyRequest()

addParamsToBuyRequest	(	$buyRequest,
		$params
	)

Process $buyRequest and sets its options before saving configuration to some product item. This method is used to attach additional parameters to processed buyRequest.

$params holds parameters of what operation must be performed:

'current_config', \Magento\Framework\DataObject or array - current buyRequest that configures product in this item, used to restore currently attached files
'files_prefix': string[a-z0-9_] - prefix that was added at frontend to names of file inputs, so they won't intersect with other submitted options

Parameters

\Magento\Framework\DataObject \| array	$buyRequest
\Magento\Framework\DataObject \| array	$params

Returns: \Magento\Framework\DataObject

Definition at line 508 of file Product.php.

     {
         if (is_array($buyRequest)) {
             $buyRequest = new \Magento\Framework\DataObject($buyRequest);
         }
         if (is_array($params)) {
             $params = new \Magento\Framework\DataObject($params);
         }
 
         // Ensure that currentConfig goes as \Magento\Framework\DataObject - for easier work with it later
         $currentConfig = $params->getCurrentConfig();
         if ($currentConfig) {
             if (is_array($currentConfig)) {
                 $params->setCurrentConfig(new \Magento\Framework\DataObject($currentConfig));
             } elseif (!$currentConfig instanceof \Magento\Framework\DataObject) {
                 $params->unsCurrentConfig();
             }
         }
 
         /*
          * Notice that '_processing_params' must always be object to protect processing forged requests
          * where '_processing_params' comes in $buyRequest as array from user input
          */
         $processingParams = $buyRequest->getData('_processing_params');
         if (!$processingParams || !$processingParams instanceof \Magento\Framework\DataObject) {
             $processingParams = new \Magento\Framework\DataObject();
             $buyRequest->setData('_processing_params', $processingParams);
         }
         $processingParams->addData($params->getData());
 
         return $buyRequest;
     }

◆ canShow()

canShow	(	$product,
		$where = `'catalog'`
	)

Check if a product can be shown

Parameters

ModelProduct \| int	$product
string	$where

Returns: bool @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 304 of file Product.php.

     {
         if (is_int($product)) {
             try {
                 $product = $this->productRepository->getById($product);
             } catch (NoSuchEntityException $e) {
                 return false;
             }
         } else {
             if (!$product->getId()) {
                 return false;
             }
         }
         return $product->isVisibleInCatalog() && $product->isVisibleInSiteVisibility();
     }

◆ canUseCanonicalTag()

canUseCanonicalTag ( $store = null )

Check if <link rel="canonical"> can be used for product

Parameters

null | string | bool | int | Store $store

Returns: bool

Definition at line 326 of file Product.php.

     {
         return $this->scopeConfig->getValue(
             self::XML_PATH_USE_PRODUCT_CANONICAL_TAG,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

◆ getAttributeBackendModelByInputType()

getAttributeBackendModelByInputType ( $inputType )

Return default attribute backend model by input type

Parameters

string $inputType

Returns: string|null

Definition at line 369 of file Product.php.

     {
         $inputTypes = $this->getAttributeInputTypes();
         if (!empty($inputTypes[$inputType]['backend_model'])) {
             return $inputTypes[$inputType]['backend_model'];
         }
         return null;
     }

◆ getAttributeInputTypes()

getAttributeInputTypes ( $inputType = null )

Return information array of product attribute input types Only a small number of settings returned, so we won't break anything in current data flow As soon as development process goes on we need to add there all possible settings

Parameters

string $inputType

Returns: array

Todo:: specify there all relations for properties depending on input type

Definition at line 343 of file Product.php.

     {
         $inputTypes = [
             'multiselect' => ['backend_model' => \Magento\Eav\Model\Entity\Attribute\Backend\ArrayBackend::class],
             'boolean' => ['source_model' => \Magento\Eav\Model\Entity\Attribute\Source\Boolean::class],
         ];
 
         if ($inputType === null) {
             return $inputTypes;
         } else {
             if (isset($inputTypes[$inputType])) {
                 return $inputTypes[$inputType];
             }
         }
         return [];
     }

◆ getAttributesAllowedForAutogeneration()

getAttributesAllowedForAutogeneration ( )

Retrieve list of attributes that allowed for autogeneration

Returns: array

Definition at line 581 of file Product.php.

     {
         return $this->_attributeConfig->getAttributeNames('used_in_autogeneration');
     }

◆ getAttributeSourceModelByInputType()

getAttributeSourceModelByInputType ( $inputType )

Return default attribute source model by input type

Parameters

string $inputType

Returns: string|null

Definition at line 384 of file Product.php.

     {
         $inputTypes = $this->getAttributeInputTypes();
         if (!empty($inputTypes[$inputType]['source_model'])) {
             return $inputTypes[$inputType]['source_model'];
         }
         return null;
     }

◆ getEmailToFriendUrl()

getEmailToFriendUrl ( $product )

Parameters

ModelProduct $product

Returns: string

Definition at line 274 of file Product.php.

     {
         $categoryId = null;
         $category = $this->_coreRegistry->registry('current_category');
         if ($category) {
             $categoryId = $category->getId();
         }
         return $this->_getUrl('sendfriend/product/send', ['id' => $product->getId(), 'cat_id' => $categoryId]);
     }

◆ getFieldsAutogenerationMasks()

getFieldsAutogenerationMasks ( )

Get masks for auto generation of fields

Returns: mixed

Definition at line 571 of file Product.php.

     {
         return $this->scopeConfig->getValue(Product::XML_PATH_AUTO_GENERATE_MASK, 'default');
     }

◆ getFinalPrice()

getFinalPrice ( $product )

Retrieve product final price

Parameters

ModelProduct $product

Returns: float

Definition at line 211 of file Product.php.

     {
         return $product->getFinalPrice();
     }

◆ getImageUrl()

getImageUrl ( $product )

Retrieve base image url

Parameters

ModelProduct | \Magento\Framework\DataObject $product

Returns: string|bool

Definition at line 222 of file Product.php.

     {
         $url = false;
         $attribute = $product->getResource()->getAttribute('image');
         if (!$product->getImage()) {
             $url = $this->_assetRepo->getUrl('Magento_Catalog::images/product/placeholder/image.jpg');
         } elseif ($attribute) {
             $url = $attribute->getFrontend()->getUrl($product);
         }
         return $url;
     }

◆ getPrice()

getPrice ( $product )

Retrieve product price

Parameters

ModelProduct $product

Returns: float

Definition at line 200 of file Product.php.

     {
         return $product->getPrice();
     }

◆ getProductUrl()

getProductUrl ( $product )

Retrieve product view page url

Parameters

int | ModelProduct $product

Returns: string|bool

Definition at line 184 of file Product.php.

     {
         if ($product instanceof ModelProduct) {
             return $product->getProductUrl();
         } elseif (is_numeric($product)) {
             return $this->productRepository->getById($product)->getProductUrl();
         }
         return false;
     }

◆ getSkipSaleableCheck()

getSkipSaleableCheck ( )

Get flag that shows if Magento has to check product to be saleable (enabled and/or inStock)

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 561 of file Product.php.

     {
         return $this->_skipSaleableCheck;
     }

◆ getSmallImageUrl()

getSmallImageUrl ( $product )

Retrieve small image url

Parameters

ModelProduct | \Magento\Framework\DataObject $product

Returns: string|bool

Definition at line 240 of file Product.php.

     {
         $url = false;
         $attribute = $product->getResource()->getAttribute('small_image');
         if (!$product->getSmallImage()) {
             $url = $this->_assetRepo->getUrl('Magento_Catalog::images/product/placeholder/small_image.jpg');
         } elseif ($attribute) {
             $url = $attribute->getFrontend()->getUrl($product);
         }
         return $url;
     }

◆ getStatuses()

getStatuses ( )

Returns: array

Definition at line 287 of file Product.php.

     {
         if (null === $this->_statuses) {
             $this->_statuses = [];
         }
 
         return $this->_statuses;
     }

◆ getThumbnailUrl()

getThumbnailUrl ( $product )

Retrieve thumbnail image url

Parameters

ModelProduct | \Magento\Framework\DataObject $product

Returns: string|bool

Definition at line 258 of file Product.php.

     {
         $url = false;
         $attribute = $product->getResource()->getAttribute('thumbnail');
         if (!$product->getThumbnail()) {
             $url = $this->_assetRepo->getUrl('Magento_Catalog::images/product/placeholder/thumbnail.jpg');
         } elseif ($attribute) {
             $url = $attribute->getFrontend()->getUrl($product);
         }
         return $url;
     }

◆ initProduct()

initProduct	(	$productId,
		$controller,
		$params = `null`
	)

Inits product to be used for product controller actions and layouts $params can have following data: 'category_id' - id of category to check and append to product as current. If empty (except FALSE) - will be guessed (e.g. from last visited) to load as current.

Parameters

int	$productId
\Magento\Framework\App\Action\Action	$controller
\Magento\Framework\DataObject	$params

Returns: bool|ModelProduct @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 407 of file Product.php.

     {
         // Prepare data for routine
         if (!$params) {
             $params = new \Magento\Framework\DataObject();
         }
 
         // Init and load product
         $this->_eventManager->dispatch(
             'catalog_controller_product_init_before',
             ['controller_action' => $controller, 'params' => $params]
         );
 
         if (!$productId) {
             return false;
         }
 
         try {
             $product = $this->productRepository->getById($productId, false, $this->_storeManager->getStore()->getId());
         } catch (NoSuchEntityException $e) {
             return false;
         }
 
         if (!$this->canShow($product)) {
             return false;
         }
         if (!in_array($this->_storeManager->getStore()->getWebsiteId(), $product->getWebsiteIds())) {
             return false;
         }
 
         // Load product current category
         $categoryId = $params->getCategoryId();
         if (!$categoryId && $categoryId !== false) {
             $lastId = $this->_catalogSession->getLastVisitedCategoryId();
             if ($product->canBeShowInCategory($lastId)) {
                 $categoryId = $lastId;
             }
         } elseif (!$product->canBeShowInCategory($categoryId)) {
             $categoryId = null;
         }
 
         if ($categoryId) {
             try {
                 $category = $this->categoryRepository->get($categoryId);
             } catch (NoSuchEntityException $e) {
                 $category = null;
             }
             if ($category) {
                 $product->setCategory($category);
                 $this->_coreRegistry->register('current_category', $category);
             }
         }
 
         // Register current data and dispatch final events
         $this->_coreRegistry->register('current_product', $product);
         $this->_coreRegistry->register('product', $product);
 
         try {
             $this->_eventManager->dispatch(
                 'catalog_controller_product_init_after',
                 ['product' => $product, 'controller_action' => $controller]
             );
         } catch (\Magento\Framework\Exception\LocalizedException $e) {
             $this->_logger->critical($e);
             return false;
         }
 
         return $product;
     }

◆ isDataForPriceIndexerWasChanged()

isDataForPriceIndexerWasChanged ( $data )

Retrieve data for price indexer update

Parameters

\Magento\Catalog\Model\Product | array $data

Returns: bool

Definition at line 139 of file Product.php.

     {
         if ($data instanceof ModelProduct) {
             foreach ($this->_reindexPriceIndexerData['byDataResult'] as $param) {
                 if ($data->getData($param)) {
                     return true;
                 }
             }
             foreach ($this->_reindexPriceIndexerData['byDataChange'] as $param) {
                 if ($data->dataHasChangedFor($param)) {
                     return true;
                 }
             }
         } elseif (is_array($data)) {
             foreach ($this->_reindexPriceIndexerData['byDataChange'] as $param) {
                 if (isset($data[$param])) {
                     return true;
                 }
             }
         }
         return false;
     }

◆ isDataForProductCategoryIndexerWasChanged()

isDataForProductCategoryIndexerWasChanged ( \Magento\Catalog\Model\Product $data )

Retrieve data for product category indexer update

Parameters

\Magento\Catalog\Model\Product $data

Returns: bool

Definition at line 168 of file Product.php.

     {
         foreach ($this->_reindexProductCategoryIndexerData['byDataChange'] as $param) {
             if ($data->dataHasChangedFor($param)) {
                 return true;
             }
         }
         return false;
     }

◆ prepareProductOptions()

prepareProductOptions	(	$product,
		$buyRequest
	)

Prepares product options by buyRequest: retrieves values and assigns them as default. Also parses and adds product management related values - e.g. qty

Parameters

ModelProduct	$product
\Magento\Framework\DataObject	$buyRequest

Returns: Product

Definition at line 485 of file Product.php.

     {
         $optionValues = $product->processBuyRequest($buyRequest);
         $optionValues->setQty($buyRequest->getQty());
         $product->setPreconfiguredValues($optionValues);
 
         return $this;
     }

◆ setSkipSaleableCheck()

setSkipSaleableCheck ( $skipSaleableCheck = false )

Set flag that shows if Magento has to check product to be saleable (enabled and/or inStock)

For instance, during order creation in the backend admin has ability to add any products to order

Parameters

bool $skipSaleableCheck

Returns: Product

Definition at line 549 of file Product.php.

     {
         $this->_skipSaleableCheck = $skipSaleableCheck;
         return $this;
     }

Field Documentation

◆ $_assetRepo

$_assetRepo

protected

Definition at line 46 of file Product.php.

◆ $_attributeConfig

$_attributeConfig

protected

Definition at line 58 of file Product.php.

◆ $_catalogSession

$_catalogSession

protected

Definition at line 65 of file Product.php.

◆ $_coreRegistry

$_coreRegistry

protected

Definition at line 53 of file Product.php.

◆ $_priceBlock

$_priceBlock

protected

Definition at line 41 of file Product.php.

◆ $_reindexPriceIndexerData

$_reindexPriceIndexerData

protected

Definition at line 79 of file Product.php.

◆ $_reindexProductCategoryIndexerData

$_reindexProductCategoryIndexerData

protected

Definition at line 72 of file Product.php.

◆ $_skipSaleableCheck

$_skipSaleableCheck = false

protected

Definition at line 31 of file Product.php.

◆ $_statuses

$_statuses

protected

Definition at line 36 of file Product.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 94 of file Product.php.

◆ $categoryRepository

$categoryRepository

protected

Definition at line 89 of file Product.php.

◆ $productRepository

$productRepository

protected

Definition at line 84 of file Product.php.

◆ XML_PATH_AUTO_GENERATE_MASK

const XML_PATH_AUTO_GENERATE_MASK = 'catalog/fields_masks'

Definition at line 24 of file Product.php.

◆ XML_PATH_PRODUCT_URL_USE_CATEGORY

const XML_PATH_PRODUCT_URL_USE_CATEGORY = 'catalog/seo/product_use_categories'

Definition at line 20 of file Product.php.

◆ XML_PATH_USE_PRODUCT_CANONICAL_TAG

const XML_PATH_USE_PRODUCT_CANONICAL_TAG = 'catalog/seo/product_canonical_tag'

Definition at line 22 of file Product.php.

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

vendor/magento/module-catalog/Helper/Product.php

Public Member Functions

Data Fields

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addParamsToBuyRequest()

◆ canShow()

◆ canUseCanonicalTag()

◆ getAttributeBackendModelByInputType()

◆ getAttributeInputTypes()

◆ getAttributesAllowedForAutogeneration()

◆ getAttributeSourceModelByInputType()

◆ getEmailToFriendUrl()

◆ getFieldsAutogenerationMasks()

◆ getFinalPrice()

◆ getImageUrl()

◆ getPrice()

◆ getProductUrl()

◆ getSkipSaleableCheck()

◆ getSmallImageUrl()

◆ getStatuses()

◆ getThumbnailUrl()

◆ initProduct()

◆ isDataForPriceIndexerWasChanged()

◆ isDataForProductCategoryIndexerWasChanged()

◆ prepareProductOptions()

◆ setSkipSaleableCheck()

Field Documentation

◆ $_assetRepo

◆ $_attributeConfig

◆ $_catalogSession

◆ $_coreRegistry

◆ $_priceBlock

◆ $_reindexPriceIndexerData

◆ $_reindexProductCategoryIndexerData

◆ $_skipSaleableCheck

◆ $_statuses

◆ $_storeManager

◆ $categoryRepository

◆ $productRepository

◆ XML_PATH_AUTO_GENERATE_MASK

◆ XML_PATH_PRODUCT_URL_USE_CATEGORY

◆ XML_PATH_USE_PRODUCT_CANONICAL_TAG