Skip to content

Magento 2 module for displaying additional information in configuration

Notifications You must be signed in to change notification settings

avstudnitz/AvS_ScopeHint2

Repository files navigation

AvS_ScopeHint for Magento 2

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

Facts

Description

Whenever a configuration setting is overwritten by a lower level website or store view, an icon is displayed. On Mouseover, a list of all stores / websites which overwrite the setting is shown with the respective values. See the screenshot to get an impression of what the module does:

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 >= 5.6.0

Compatibility

  • Magento >= 2.1.0 (not tested on 2.0.x)

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

Copyright

(c) 2017-2024 Andreas von Studnitz