Context.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\View;

use Magento\Framework\App\Cache\StateInterface as CacheState;
use Magento\Framework\App\CacheInterface as Cache;
use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\App\FrontControllerInterface;
use Magento\Framework\App\Request\Http as Request;
use Magento\Framework\App\State as AppState;
use Magento\Framework\Event\ManagerInterface;
use Psr\Log\LoggerInterface as Logger;
use Magento\Framework\Session\SessionManager;
use Magento\Framework\TranslateInterface;
use Magento\Framework\UrlInterface;
use Magento\Framework\View\ConfigInterface as ViewConfig;

class Context
{
    protected $request;

    protected $eventManager;

    protected $urlBuilder;

    protected $translator;

    protected $cache;

    protected $design;

    protected $session;

    protected $scopeConfig;

    protected $frontController;

    protected $layout;

    protected $viewConfig;

    protected $cacheState;

    protected $logger;

    protected $appState;

    public function __construct(
        Request $request,
        ManagerInterface $eventManager,
        UrlInterface $urlBuilder,
        TranslateInterface $translator,
        Cache $cache,
        DesignInterface $design,
        SessionManager $session,
        ScopeConfigInterface $scopeConfig,
        FrontControllerInterface $frontController,
        ViewConfig $viewConfig,
        CacheState $cacheState,
        Logger $logger,
        AppState $appState,
        LayoutInterface $layout
    ) {
        $this->request = $request;
        $this->eventManager = $eventManager;
        $this->urlBuilder = $urlBuilder;
        $this->translator = $translator;
        $this->cache = $cache;
        $this->design = $design;
        $this->session = $session;
        $this->scopeConfig = $scopeConfig;
        $this->frontController = $frontController;
        $this->viewConfig      = $viewConfig;
        $this->cacheState      = $cacheState;
        $this->logger          = $logger;
        $this->appState        = $appState;
        $this->layout          = $layout;
    }

    public function getCache()
    {
        return $this->cache;
    }

    public function getDesignPackage()
    {
        return $this->design;
    }

    public function getEventManager()
    {
        return $this->eventManager;
    }

    public function getFrontController()
    {
        return $this->frontController;
    }

    public function getLayout()
    {
        return $this->layout;
    }

    public function getRequest()
    {
        return $this->request;
    }

    public function getSession()
    {
        return $this->session;
    }

    public function getScopeConfig()
    {
        return $this->scopeConfig;
    }

    public function getTranslator()
    {
        return $this->translator;
    }

    public function getUrlBuilder()
    {
        return $this->urlBuilder;
    }

    public function getViewConfig()
    {
        return $this->viewConfig;
    }

    public function getCacheState()
    {
        return $this->cacheState;
    }

    public function getLogger()
    {
        return $this->logger;
    }

    public function getArea()
    {
        return $this->appState->getAreaCode();
    }

    public function getModuleName()
    {
        return $this->getRequest()->getModuleName();
    }

    public function getFrontName()
    {
        return $this->getModuleName();
    }

    public function getControllerName()
    {
        return $this->getRequest()->getControllerName();
    }

    public function getActionName()
    {
        return $this->getRequest()->getActionName();
    }

    public function getFullActionName()
    {
        return strtolower($this->getFrontName() . '_' . $this->getControllerName() . '_' . $this->getActionName());
    }

    public function getAcceptType()
    {
        // TODO: do intelligence here
        $type = $this->getHeader('Accept', 'html');
        if (strpos($type, 'json') !== false) {
            return 'json';
        } elseif (strpos($type, 'soap') !== false) {
            return 'soap';
        } elseif (strpos($type, 'text/html') !== false) {
            return 'html';
        } else {
            return 'xml';
        }
    }

    public function getPost($key = null, $default = null)
    {
        return $this->getRequest()->getPost($key, $default);
    }

    public function getQuery($key = null, $default = null)
    {
        return $this->getRequest()->getPost($key, $default);
    }

    public function getParam($key = null, $default = null)
    {
        return $this->getRequest()->getParam($key, $default);
    }

    public function getParams()
    {
        return $this->getRequest()->getParams();
    }

    public function getHeader($header)
    {
        return $this->getRequest()->getHeader($header);
    }

    public function getContent()
    {
        return $this->getRequest()->getContent();
    }

    public function getAppState()
    {
        return $this->appState;
    }

    protected function getPhysicalTheme(Design\ThemeInterface $theme)
    {
        $result = $theme;
        while ($result->getId() && !$result->isPhysical()) {
            $result = $result->getParentTheme();
        }
        if (!$result) {
            throw new \Exception("Unable to find a physical ancestor for a theme '{$theme->getThemeTitle()}'.");
        }
        return $result;
    }
}