Product Class Reference

Inheritance diagram for Product:

Public Member Functions
	__construct (\Magento\Framework\App\Action\Context $context, \Magento\Framework\Registry $coreRegistry, \Magento\Customer\Model\Session $customerSession, \Magento\Catalog\Api\CategoryRepositoryInterface $categoryRepository, \Psr\Log\LoggerInterface $logger, \Magento\Catalog\Api\ProductRepositoryInterface $productRepository, \Magento\Review\Model\ReviewFactory $reviewFactory, \Magento\Review\Model\RatingFactory $ratingFactory, \Magento\Catalog\Model\Design $catalogDesign, \Magento\Framework\Session\Generic $reviewSession, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\Data\Form\FormKey\Validator $formKeyValidator)
	dispatch (RequestInterface $request)
Public Member Functions inherited from Action
	__construct (Context $context)
	dispatch (RequestInterface $request)
	getActionFlag ()
Public Member Functions inherited from AbstractAction
	__construct (Context $context)
	dispatch (RequestInterface $request)
	getRequest ()
	getResponse ()
Public Member Functions inherited from ActionInterface
	execute ()

Protected Member Functions
	initProduct ()
	loadProduct ($productId)
Protected Member Functions inherited from Action
	_forward ($action, $controller=null, $module=null, array $params=null)
	_redirect ($path, $arguments=[])

Protected Attributes
	$coreRegistry = null
	$customerSession
	$reviewSession
	$categoryRepository
	$logger
	$productRepository
	$reviewFactory
	$ratingFactory
	$catalogDesign
	$storeManager
	$formKeyValidator
Protected Attributes inherited from Action
	$_objectManager
	$_sessionNamespace
	$_eventManager
	$_actionFlag
	$_redirect
	$_view
	$_url
	$messageManager
Protected Attributes inherited from AbstractAction
	$_request
	$_response
	$resultRedirectFactory
	$resultFactory

Additional Inherited Members
Data Fields inherited from ActionInterface
const	FLAG_NO_DISPATCH = 'no-dispatch'
const	FLAG_NO_POST_DISPATCH = 'no-postDispatch'
const	FLAG_NO_DISPATCH_BLOCK_EVENT = 'no-beforeGenerateLayoutBlocksDispatch'
const	PARAM_NAME_BASE64_URL = 'r64'
const	PARAM_NAME_URL_ENCODED = 'uenc'

Detailed Description

Review controller

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 18 of file Product.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Action\Context	$context,
		\Magento\Framework\Registry	$coreRegistry,
		\Magento\Customer\Model\Session	$customerSession,
		\Magento\Catalog\Api\CategoryRepositoryInterface	$categoryRepository,
		\Psr\Log\LoggerInterface	$logger,
		\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository,
		\Magento\Review\Model\ReviewFactory	$reviewFactory,
		\Magento\Review\Model\RatingFactory	$ratingFactory,
		\Magento\Catalog\Model\Design	$catalogDesign,
		\Magento\Framework\Session\Generic	$reviewSession,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\Data\Form\FormKey\Validator	$formKeyValidator
	)

Parameters

\Magento\Framework\App\Action\Context	$context
\Magento\Framework\Registry	$coreRegistry
\Magento\Customer\Model\Session	$customerSession
\Magento\Catalog\Api\CategoryRepositoryInterface	$categoryRepository
\Psr\Log\LoggerInterface	$logger
\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository
\Magento\Review\Model\ReviewFactory	$reviewFactory
\Magento\Review\Model\RatingFactory	$ratingFactory
\Magento\Catalog\Model\Design	$catalogDesign
\Magento\Framework\Session\Generic	$reviewSession
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\Data\Form\FormKey\Validator	$formKeyValidator	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 112 of file Product.php.

      {
        $this->storeManager = $storeManager;
        $this->coreRegistry = $coreRegistry;
        $this->customerSession = $customerSession;
        $this->reviewSession = $reviewSession;
        $this->categoryRepository = $categoryRepository;
        $this->logger = $logger;
        $this->productRepository = $productRepository;
        $this->reviewFactory = $reviewFactory;
        $this->ratingFactory = $ratingFactory;
        $this->catalogDesign = $catalogDesign;
        $this->formKeyValidator = $formKeyValidator;

        parent::__construct($context);
    }

Member Function Documentation

dispatch()

dispatch

(

RequestInterface

$request

)

Dispatch request

Parameters

RequestInterface

$request

Returns

\Magento\Framework\App\ResponseInterface

Definition at line 147 of file Product.php.

    {
        $allowGuest = $this->_objectManager->get(\Magento\Review\Helper\Data::class)->getIsGuestAllowToWrite();
        if (!$request->isDispatched()) {
            return parent::dispatch($request);
        }

        if (!$allowGuest && $request->getActionName() == 'post' && $request->isPost()) {
            if (!$this->customerSession->isLoggedIn()) {
                $this->_actionFlag->set('', self::FLAG_NO_DISPATCH, true);
                $this->customerSession->setBeforeAuthUrl($this->_url->getUrl('*/*/*', ['_current' => true]));
                $this->reviewSession->setFormData(
                    $request->getPostValue()
                )->setRedirectUrl(
                    $this->_redirect->getRefererUrl()
                );
                $this->getResponse()->setRedirect(
                    $this->_objectManager->get(\Magento\Customer\Model\Url::class)->getLoginUrl()
                );
            }
        }

        return parent::dispatch($request);
    }

initProduct()

initProduct ( )

protected

Initialize and check product

Returns

\Magento\Catalog\Model\Product|bool

Definition at line 177 of file Product.php.

    {
        $this->_eventManager->dispatch('review_controller_product_init_before', ['controller_action' => $this]);
        $categoryId = (int)$this->getRequest()->getParam('category', false);
        $productId = (int)$this->getRequest()->getParam('id');

        $product = $this->loadProduct($productId);
        if (!$product) {
            return false;
        }

        if ($categoryId) {
            $category = $this->categoryRepository->get($categoryId);
            $this->coreRegistry->register('current_category', $category);
        }

        try {
            $this->_eventManager->dispatch('review_controller_product_init', ['product' => $product]);
            $this->_eventManager->dispatch(
                'review_controller_product_init_after',
                ['product' => $product, 'controller_action' => $this]
            );
        } catch (\Magento\Framework\Exception\LocalizedException $e) {
            $this->logger->critical($e);
            return false;
        }

        return $product;
    }

loadProduct()

loadProduct (   $productId )

protected

Load product model with data by passed id. Return false if product was not loaded or has incorrect status.

Parameters

int

$productId

Returns

bool|CatalogProduct

Definition at line 214 of file Product.php.

    {
        if (!$productId) {
            return false;
        }

        try {
            $product = $this->productRepository->getById($productId);

            if (!in_array($this->storeManager->getStore()->getWebsiteId(), $product->getWebsiteIds())) {
                throw new NoSuchEntityException();
            }

            if (!$product->isVisibleInCatalog() || !$product->isVisibleInSiteVisibility()) {
                throw new NoSuchEntityException();
            }
        } catch (NoSuchEntityException $noEntityException) {
            return false;
        }

        $this->coreRegistry->register('current_product', $product);
        $this->coreRegistry->register('product', $product);

        return $product;
    }

Field Documentation

$catalogDesign

$catalogDesign

protected

Definition at line 81 of file Product.php.

$categoryRepository

$categoryRepository

protected

Definition at line 46 of file Product.php.

$coreRegistry

$coreRegistry = null

protected

Definition at line 25 of file Product.php.

$customerSession

$customerSession

protected

Definition at line 32 of file Product.php.

$formKeyValidator

$formKeyValidator

protected

Definition at line 95 of file Product.php.

$logger

$logger

protected

Definition at line 53 of file Product.php.

$productRepository

$productRepository

protected

Definition at line 60 of file Product.php.

$ratingFactory

$ratingFactory

protected

Definition at line 74 of file Product.php.

$reviewFactory

$reviewFactory

protected

Definition at line 67 of file Product.php.

$reviewSession

$reviewSession

protected

Definition at line 39 of file Product.php.

$storeManager

$storeManager

protected

Definition at line 88 of file Product.php.

---

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

• vendor/magento/module-review/Controller/Product.php