DebugHints Class Reference

Public Member Functions
	__construct (ScopeConfigInterface $scopeConfig, StoreManagerInterface $storeManager, DevHelper $devHelper, DebugHintsFactory $debugHintsFactory, $debugHintsPath, Http $http=null, $debugHintsWithParam=null, $debugHintsParameter=null)
	afterCreate (TemplateEngineFactory $subject, TemplateEngineInterface $invocationResult)

Data Fields
const	XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS = 'dev/debug/template_hints_blocks'

Protected Attributes
	$scopeConfig
	$storeManager
	$devHelper
	$debugHintsFactory
	$debugHintsPath

Detailed Description

Definition at line 19 of file DebugHints.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ScopeConfigInterface	$scopeConfig,
		StoreManagerInterface	$storeManager,
		DevHelper	$devHelper,
		DebugHintsFactory	$debugHintsFactory,
			$debugHintsPath,
		Http	$http = null,
			$debugHintsWithParam = null,
			$debugHintsParameter = null
	)

Parameters

ScopeConfigInterface	$scopeConfig
StoreManagerInterface	$storeManager
DevHelper	$devHelper
DebugHintsFactory	$debugHintsFactory
string	$debugHintsPath
Http	$http
string	$debugHintsWithParam
string	$debugHintsParameter

Definition at line 85 of file DebugHints.php.

      {
        $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;
    }

Member Function Documentation

afterCreate()

afterCreate	(	TemplateEngineFactory	$subject,
		TemplateEngineInterface	$invocationResult
	)

Wrap template engine instance with the debugging hints decorator, depending of the store configuration

Parameters

TemplateEngineFactory	$subject
TemplateEngineInterface	$invocationResult

Returns

TemplateEngineInterface @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 116 of file DebugHints.php.

      {
        $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;
    }

Field Documentation

$debugHintsFactory

$debugHintsFactory

protected

Definition at line 44 of file DebugHints.php.

$debugHintsPath

$debugHintsPath

protected

Definition at line 55 of file DebugHints.php.

$devHelper

$devHelper

protected

Definition at line 39 of file DebugHints.php.

$scopeConfig

$scopeConfig

protected

Definition at line 29 of file DebugHints.php.

$storeManager

$storeManager

protected

Definition at line 34 of file DebugHints.php.

XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS

const XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS = 'dev/debug/template_hints_blocks'

XPath of configuration of the debug block names

Definition at line 24 of file DebugHints.php.

---

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

• vendor/magento/module-developer/Model/TemplateEngine/Plugin/DebugHints.php