Merge pull request #38 from evs-xsarus/feature/product-show-attribute-code

No ticket. Show attribute code on admin product edit.

Author: avstudnitz

Plugin/UIScopeLabel.php

@@ -0,0 +1,61 @@
+<?php
+namespace AvS\ScopeHint\Plugin;
+
+use Magento\Catalog\Api\Data\ProductAttributeInterface;
+use Magento\Eav\Api\Data\AttributeInterface;
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\Stdlib\ArrayManager;
+use Magento\Catalog\Ui\DataProvider\Product\Form\Modifier\Eav as EavModifier;
+
+class UIScopeLabel
+{
+    private const CONFIG_SHOW_ATTRIBUTE_CODE = 'dev/debug/show_attribute_code_in_adminhtml';
+
+    /**
+     * @var ArrayManager
+     */
+    private $arrayManager;
+
+    /**
+     * @var ScopeConfigInterface
+     */
+    private $scopeConfig;
+
+    public function __construct(
+        ArrayManager $arrayManager,
+        ScopeConfigInterface $scopeConfig,
+    ) {
+        $this->arrayManager = $arrayManager;
+        $this->scopeConfig = $scopeConfig;
+    }
+
+    /**
+     * @param EavModifier $subject
+     * @param array $result
+     * @param ProductAttributeInterface $attribute
+     * @return array
+     */
+    public function afterSetupAttributeMeta(EavModifier $subject, $result, ProductAttributeInterface $attribute)
+    {
+        if (!$this->scopeConfig->isSetFlag(self::CONFIG_SHOW_ATTRIBUTE_CODE)) {
+            return $result;
+        }
+
+        $configPath = ltrim(EavModifier::META_CONFIG_PATH, ArrayManager::DEFAULT_PATH_DELIMITER);
+        $scopeLabel = $this->arrayManager->get(
+            $configPath . ArrayManager::DEFAULT_PATH_DELIMITER . 'scopeLabel',
+            $result
+        );
+
+        if ($attribute->getFrontendInput() !== AttributeInterface::FRONTEND_INPUT) {
+            $scopeLabel = $attribute->getAttributeCode() . ' ' . (string)$scopeLabel;
+            $result = $this->arrayManager->merge(
+                $configPath,
+                $result,
+                ['scopeLabel' => trim($scopeLabel)]
+            );
+        }
+
+        return $result;
+    }
+}

etc/adminhtml/di.xml

@@ -14,4 +14,11 @@
                 sortOrder="1"
                 disabled="false"/>
     </type>
+
+    <type name="Magento\Catalog\Ui\DataProvider\Product\Form\Modifier\Eav">
+        <plugin name="avs_scopehint_plugin_add_attribute_code"
+                type="AvS\ScopeHint\Plugin\UIScopeLabel"
+                sortOrder="1"
+                disabled="false"/>
+    </type>
 </config>

etc/adminhtml/system.xml

@@ -8,6 +8,10 @@
                     <label>Display path for each option in system configuration</label>
                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
                 </field>
+                <field id="show_attribute_code_in_adminhtml" translate="label" type="select" sortOrder="10" showInDefault="1" showInWebsite="0" showInStore="0" canRestore="1">
+                    <label>Display attribute code for each field in the product edit</label>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                </field>
             </group>
         </section>
     </system>

etc/config.xml

@@ -5,6 +5,7 @@
         <dev>
             <debug>
                 <show_path_in_adminhtml>1</show_path_in_adminhtml>
+                <show_attribute_code_in_adminhtml>1</show_attribute_code_in_adminhtml>
             </debug>
         </dev>
     </default>

view/adminhtml/web/css/source/_module.less

@@ -0,0 +1,10 @@
+//
+//  Imports
+//  ---------------------------------------------
+
+@import './extend/_additional.less';
+
+
+//
+//  Common styles
+//  ---------------------------------------------

view/adminhtml/web/css/source/extend/_additional.less

@@ -0,0 +1,10 @@
+//
+//  [ Additional styles ]
+//  ---------------------------------------------
+
+
+//  Give attribute code enough room in the product edit.
+
+.admin__field-label > label > span {
+    width: 100%;
+}