AvS_ScopeHint for Magento 2

Displays a hint when a configuration value is overwritten on a lower scope (website or store view).

Facts

• extension on GitHub
• direct download link
• Composer key: avstudnitz/scopehint2 (registered at Packagist)

Description

Whenever a configuration setting is overwritten by a lower-level website or store view, an icon is displayed.
Clicking the icon opens an accessible popover grouped by website with the overridden values.
Product Page Builder attributes are supported, with rich content represented as a concise text preview.
See the screenshot to get an impression of what the module does:

[image: Screenshot]

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

• PHP 8.1 through 8.5

Compatibility

• Magento 2.4.x (Open Source and Commerce)
• Compatible with the default backend theme, the Mage-OS M137 admin theme, and the Hyvä commerce admin theme

Installation Instructions

Via Composer:

1. Call composer require avstudnitz/scopehint2 in your Magento root dir from the command line

Via Download

1. Copy all the files into the newly created directory
   app/code/AvS/ScopeHint/ in the Magento 2 root.

In both cases:

1. Enable the extension by calling bin/magento module:enable AvS_ScopeHint.
2. Run bin/magento setup:upgrade.

Uninstallation

1. Uninstall the extension by calling bin/magento module:uninstall AvS_ScopeHint.
2. Remove all extension files from app/code/AvS/ScopeHint/ or use Composer to remove the extension if you have installed it with Composer

Support

If you have any issues with this extension, open an issue on GitHub.

Contribution

Any contribution is highly appreciated. The best way to contribute code is to open a pull request on GitHub.

Developer

Andreas von Studnitz

@avstudnitz

Licence

OSL - Open Software Licence 3.0

Performance

When a category is edited at a non-default store-view scope, the module loads the category once per
store view to check for overridden attribute values. On large setups this can issue many
CategoryRepository::get() calls (one per store per page load of the category edit form).
To prevent excessive load, detection is automatically skipped — and a warning is written to the Magento
system log — when the total number of store views exceeds the configurable threshold.

The threshold is set under:
Stores → Settings → Configuration → Advanced → Developer → Debug → Maximum stores for scope hint detection
(config path dev/debug/scopehint_max_stores, default 50).

Copyright

(c) 2017-2024 Andreas von Studnitz

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog.

[Unreleased]

Added

• Service\ValueFormatter\ParentAwareValueFormatterInterface — optional
  extension of ValueFormatterInterface for system-config formatters that
  describe an override relative to the value it overrides. Field arrays use it
  to list the changed rows instead of only the row count.
• Api\OverrideSourceInterface — extension point for UI-form scope-override
  detection. Third-party modules can register custom sources via
  AvS\ScopeHint\Service\OverrideSourcePool in etc/adminhtml/di.xml.
  See docs/extending.md for a worked example.
• Service\OverrideSourcePool — first-match-wins dispatcher. Sources are
  prioritised by their order in the DI sources array.
• Service\OverrideSource\EavProductOverrideSource — default source covering
  real Magento EAV product attributes (extracted from
  ProductEavDataProviderPlugin).
• Service\OverrideSource\EavCategoryOverrideSource — default source covering
  real Magento EAV category attributes.
• Plugin\CategoryDataProviderPlugin — scope-override popovers on the category
  edit form, using the same OverrideSourcePool and legacy-tooltip flag as the
  product form.
• Block\Adminhtml\Eav\Popover + view/adminhtml/templates/eav/popover.phtml
  — interactive popover block for EAV UI form fields (mirrors the system-config
  popover block from PR 5).
• view/adminhtml/web/js/popover-bootstrap.js — RequireJS bootstrap that
  re-binds [data-scopehint-popover] nodes after Knockout injects HTML into the
  DOM (KO html= does not trigger mage/apply automatically).
• Scope-aware product-grid cells that preserve Magento's native rendering and
  add a separately escaped override popover.
• Modern system-configuration popovers rendered next to each input, including
  support for Magento Backend and Hyvä Commerce admin themes.
• Product Page Builder attributes show scope-override popovers with concise,
  plain-text content previews instead of escaped Page Builder markup.

Changed

• System configuration override detection loads all website/store-view rows of
  core_config_data once per request instead of one query per rendered field.
• Select, multiselect and source_model config values resolve to option labels
  through Field::getOptions(); serialized-array and editor formatters read the
  field definition through Field::getAttribute().
• Product and category form hints compare against the value in the store view
  being edited and exclude that store view, as in earlier releases.
• Product grid pills show option labels, include store values that have no
  default-scope row, and only scan the attributes of the grid's columns. The
  static Status and Visibility columns show pills as well.
• Serialized-array (field array) config fields show the popover in their value
  cell; their renderers never output after_element_html.
• Plugin\ProductEavDataProviderPlugin — slim; delegates override detection to
  OverrideSourcePool, renders popover into the field's additionalInfo meta
  slot. Legacy <br>-list tooltip in tooltip.description preserved behind the
  dev/debug/scopehint_legacy_tooltip config flag.
• System configuration detection now reads explicit core_config_data rows,
  so inherited website values are not misreported as store-view overrides.
• Product grid aggregation uses Magento's metadata link field and therefore
  supports both Open Source (entity_id) and Commerce (row_id) schemas.
• Category fields resolve their real EAV attribute scope before enabling hints.
• Datetime formatting retains the time component for datetime and time
  fields. Popovers bind after asynchronous rendering and close on Escape.

Breaking Changes

• Plugin\ProductEavDataProviderPlugin constructor changed. Previous
  constructor accepted StoreManagerInterface, Registry, and
  ProductRepositoryInterface. New constructor accepts OverrideSourcePool,
  LayoutInterface, ScopeConfigInterface, Registry, and Escaper. These are private
  plugin classes with no public API contract; no deprecated alias is provided.
• Plugin\ConfigFieldPlugin public constants removed. SCOPE_TYPE_WEBSITES
  and SCOPE_TYPE_STORES no longer exist on the plugin; use
  Api\Data\ScopeOverrideInterface::SCOPE_TYPE_WEBSITES / SCOPE_TYPE_STORES
  (same values).
• Plugin\ConfigFieldPlugin constructor changed. Previous constructor
  accepted Escaper, ScopeConfigInterface, WebsiteRepositoryInterface,
  StoreRepositoryInterface, and RequestInterface. New constructor accepts
  ScopeConfigInterface and Service\ScopeOverrideDetectorInterface.
• PHP 7.4 support dropped. The module now requires PHP 8.1 or later.

If you have overridden one of these plugin classes via <preference> in your DI
configuration, update your constructor accordingly.