DebugHints.php

Go to the documentation of this file.

<?php
namespace Magento\Developer\Model\TemplateEngine\Plugin;

use Magento\Developer\Helper\Data as DevHelper;
use Magento\Developer\Model\TemplateEngine\Decorator\DebugHintsFactory;
use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\View\TemplateEngineFactory;
use Magento\Framework\View\TemplateEngineInterface;
use Magento\Store\Model\ScopeInterface;
use Magento\Store\Model\StoreManagerInterface;
use Magento\Framework\App\Request\Http;

class DebugHints
{
    const XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS = 'dev/debug/template_hints_blocks';

    protected $scopeConfig;

    protected $storeManager;

    protected $devHelper;

    protected $debugHintsFactory;

    protected $debugHintsPath;

    private $debugHintsWithParam;

    private $debugHintsParameter;

    public function __construct(
        ScopeConfigInterface $scopeConfig,
        StoreManagerInterface $storeManager,
        DevHelper $devHelper,
        DebugHintsFactory $debugHintsFactory,
        $debugHintsPath,
        Http $http = null,
        $debugHintsWithParam = null,
        $debugHintsParameter = null
    ) {
        $this->scopeConfig = $scopeConfig;
        $this->storeManager = $storeManager;
        $this->devHelper = $devHelper;
        $this->debugHintsFactory = $debugHintsFactory;
        $this->debugHintsPath = $debugHintsPath;
        $this->http = $http ?: \Magento\Framework\App\ObjectManager::getInstance()->get(
            \Magento\Framework\App\Request\Http::class
        );
        $this->debugHintsWithParam = $debugHintsWithParam;
        $this->debugHintsParameter = $debugHintsParameter;
    }

    public function afterCreate(
        TemplateEngineFactory $subject,
        TemplateEngineInterface $invocationResult
    ) {
        $storeCode = $this->storeManager->getStore()->getCode();
        if ($this->scopeConfig->getValue($this->debugHintsPath, ScopeInterface::SCOPE_STORE, $storeCode)
            && $this->devHelper->isDevAllowed()) {
            $debugHintsWithParam = $this->scopeConfig->getValue(
                $this->debugHintsWithParam,
                ScopeInterface::SCOPE_STORE,
                $storeCode
            );
            $debugHintsParameter = $this->scopeConfig->getValue(
                $this->debugHintsParameter,
                ScopeInterface::SCOPE_STORE,
                $storeCode
            );
            $debugHintsParameterInUrl = $this->http->getParam('templatehints');

            $showHints = false;
            if (!$debugHintsWithParam) {
                $showHints = true;
            }
            if ($debugHintsWithParam && $debugHintsParameter == $debugHintsParameterInUrl) {
                $showHints = true;
            }

            if ($showHints) {
                $showBlockHints = $this->scopeConfig->getValue(
                    self::XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS,
                    ScopeInterface::SCOPE_STORE,
                    $storeCode
                );
                return $this->debugHintsFactory->create([
                    'subject' => $invocationResult,
                    'showBlockHints' => $showBlockHints,
                ]);
            }
        }
        return $invocationResult;
    }
}