Guest Class Reference

Inheritance diagram for Guest:

Public Member Functions
	__construct (App\Helper\Context $context, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\Registry $coreRegistry, \Magento\Customer\Model\Session $customerSession, \Magento\Framework\Stdlib\CookieManagerInterface $cookieManager, \Magento\Framework\Stdlib\Cookie\CookieMetadataFactory $cookieMetadataFactory, \Magento\Framework\Message\ManagerInterface $messageManager, \Magento\Sales\Model\OrderFactory $orderFactory, \Magento\Framework\Controller\Result\RedirectFactory $resultRedirectFactory, \Magento\Sales\Api\OrderRepositoryInterface $orderRepository=null, \Magento\Framework\Api\SearchCriteriaBuilder $searchCriteria=null)
	loadValidOrder (App\RequestInterface $request)
	getBreadcrumbs (\Magento\Framework\View\Result\Page $resultPage)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	COOKIE_NAME = 'guest-view'
const	COOKIE_PATH = '/'
const	COOKIE_LIFETIME = 600

Protected Attributes
	$coreRegistry
	$customerSession
	$cookieManager
	$cookieMetadataFactory
	$messageManager
	$orderFactory
	$resultRedirectFactory
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

Sales module base helper @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 19 of file Guest.php.

Constructor & Destructor Documentation

__construct()

__construct	(	App\Helper\Context	$context,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\Registry	$coreRegistry,
		\Magento\Customer\Model\Session	$customerSession,
		\Magento\Framework\Stdlib\CookieManagerInterface	$cookieManager,
		\Magento\Framework\Stdlib\Cookie\CookieMetadataFactory	$cookieMetadataFactory,
		\Magento\Framework\Message\ManagerInterface	$messageManager,
		\Magento\Sales\Model\OrderFactory	$orderFactory,
		\Magento\Framework\Controller\Result\RedirectFactory	$resultRedirectFactory,
		\Magento\Sales\Api\OrderRepositoryInterface	$orderRepository = null,
		\Magento\Framework\Api\SearchCriteriaBuilder	$searchCriteria = null
	)

Parameters

App\Helper\Context	$context
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\Registry	$coreRegistry
\Magento\Customer\Model\Session	$customerSession
\Magento\Framework\Stdlib\CookieManagerInterface	$cookieManager
\Magento\Framework\Stdlib\Cookie\CookieMetadataFactory	$cookieMetadataFactory
\Magento\Framework\Message\ManagerInterface	$messageManager
\Magento\Sales\Model\OrderFactory	$orderFactory
\Magento\Framework\Controller\Result\RedirectFactory	$resultRedirectFactory
\Magento\Sales\Api\OrderRepositoryInterface	$orderRepository
\Magento\Framework\Api\SearchCriteriaBuilder	$searchCriteria	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 108 of file Guest.php.

      {
        $this->coreRegistry = $coreRegistry;
        $this->storeManager = $storeManager;
        $this->customerSession = $customerSession;
        $this->cookieManager = $cookieManager;
        $this->cookieMetadataFactory = $cookieMetadataFactory;
        $this->messageManager = $messageManager;
        $this->orderFactory = $orderFactory;
        $this->resultRedirectFactory = $resultRedirectFactory;
        $this->orderRepository = $orderRepository ?: \Magento\Framework\App\ObjectManager::getInstance()
            ->get(\Magento\Sales\Api\OrderRepositoryInterface::class);
        $this->searchCriteriaBuilder = $searchCriteria?: \Magento\Framework\App\ObjectManager::getInstance()
            ->get(\Magento\Framework\Api\SearchCriteriaBuilder::class);
        parent::__construct(
            $context
        );
    }

Member Function Documentation

getBreadcrumbs()

getBreadcrumbs

(

\Magento\Framework\View\Result\Page

$resultPage

)

Get Breadcrumbs for current controller action

Parameters

\Magento\Framework\View\Result\Page

$resultPage

Returns

void

Definition at line 179 of file Guest.php.

    {
        $breadcrumbs = $resultPage->getLayout()->getBlock('breadcrumbs');
        if (!$breadcrumbs) {
            return;
        }
        $breadcrumbs->addCrumb(
            'home',
            [
                'label' => __('Home'),
                'title' => __('Go to Home Page'),
                'link' => $this->storeManager->getStore()->getBaseUrl()
            ]
        );
        $breadcrumbs->addCrumb(
            'cms_page',
            ['label' => __('Order Information'), 'title' => __('Order Information')]
        );
    }

loadValidOrder()

loadValidOrder

(

App\RequestInterface

$request

)

Try to load valid order by $_POST or $_COOKIE

Parameters

App\RequestInterface

$request

Returns

\Magento\Framework\Controller\Result\Redirect|bool

Exceptions

Definition at line 148 of file Guest.php.

    {
        if ($this->customerSession->isLoggedIn()) {
            return $this->resultRedirectFactory->create()->setPath('sales/order/history');
        }
        $post = $request->getPostValue();
        $fromCookie = $this->cookieManager->getCookie(self::COOKIE_NAME);
        if (empty($post) && !$fromCookie) {
            return $this->resultRedirectFactory->create()->setPath('sales/guest/form');
        }
        // It is unique place in the class that process exception and only InputException. It is need because by
        // input data we found order and one more InputException could be throws deeper in stack trace
        try {
            $order = (!empty($post)
                && isset($post['oar_order_id'], $post['oar_type'])
                && !$this->hasPostDataEmptyFields($post))
                ? $this->loadFromPost($post) : $this->loadFromCookie($fromCookie);
            $this->coreRegistry->register('current_order', $order);
            return true;
        } catch (InputException $e) {
            $this->messageManager->addErrorMessage($e->getMessage());
            return $this->resultRedirectFactory->create()->setPath('sales/guest/form');
        }
    }

Field Documentation

$cookieManager

$cookieManager

protected

Definition at line 36 of file Guest.php.

$cookieMetadataFactory

$cookieMetadataFactory

protected

Definition at line 41 of file Guest.php.

$coreRegistry

$coreRegistry

protected

Definition at line 26 of file Guest.php.

$customerSession

$customerSession

protected

Definition at line 31 of file Guest.php.

$messageManager

$messageManager

protected

Definition at line 46 of file Guest.php.

$orderFactory

$orderFactory

protected

Definition at line 51 of file Guest.php.

$resultRedirectFactory

$resultRedirectFactory

protected

Definition at line 56 of file Guest.php.

COOKIE_LIFETIME

const COOKIE_LIFETIME = 600

Cookie lifetime value

Definition at line 81 of file Guest.php.

COOKIE_NAME

const COOKIE_NAME = 'guest-view'

Cookie key for guest view

Definition at line 71 of file Guest.php.

COOKIE_PATH

const COOKIE_PATH = '/'

Cookie path

Definition at line 76 of file Guest.php.

---

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

• vendor/magento/module-sales/Helper/Guest.php