Merge pull request #24 from fredden/show-path-optional

Optionally show path for configuration options

Author: avstudnitz

Plugin/ConfigFieldPlugin.php

@@ -17,6 +17,8 @@ class ConfigFieldPlugin
     const SCOPE_TYPE_WEBSITES = 'websites';
     const SCOPE_TYPE_STORES = 'stores';
 
+    private const CONFIG_SHOW_PATH = 'dev/debug/show_path_in_adminhtml';
+
     /** @var Escaper */
     private $escaper;
 
@@ -92,6 +94,10 @@ public function afterGetData(
         Subject $subject,
         array $result
     ) {
+        if (!$this->scopeConfig->isSetFlag(self::CONFIG_SHOW_PATH)) {
+            return $result;
+        }
+
         $result['path_hint'] = '<small>' . __('Path: <code>%1</code>', $this->getPath($subject) . '</small>');
 
         return $result;

etc/adminhtml/system.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
+    <system>
+        <section id="dev">
+            <group id="debug">
+                <field id="show_path_in_adminhtml" translate="label" type="select" sortOrder="10" showInDefault="1" showInWebsite="0" showInStore="0" canRestore="1">
+                    <label>Display path for each option in system configuration</label>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                </field>
+            </group>
+        </section>
+    </system>
+</config>

etc/config.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
+    <default>
+        <dev>
+            <debug>
+                <show_path_in_adminhtml>1</show_path_in_adminhtml>
+            </debug>
+        </dev>
+    </default>
+</config>

readme.md

@@ -17,7 +17,9 @@ See the screenshot to get an impression of what the module does:
 
 ![Screenshot](scopehint2-screenshot.png?raw=true "ScopeHint for Magento 2")
 
-The module also displays the configuration code (which is used for `ScopeConfigInterface::getValue()`) with the configuration fields.
+The module also optionally displays the configuration code (which is used for `ScopeConfigInterface::getValue()`) with the configuration fields.
+This is on by default, and can be enabled/disabled in
+Stores -> Settings -> Configuration -> Advanced -> Developer -> Debug -> `Display path for each option in system configuration`
 
 Requirements
 ------------