├── registration.php
├── view
└── adminhtml
│ ├── layout
│ └── adminhtml_system_config_edit.xml
│ ├── templates
│ ├── config_field_info.phtml
│ └── override_tooltip.phtml
│ └── web
│ └── js
│ └── copy-config-field-info.js
├── etc
├── module.xml
├── config.xml
├── adminhtml
│ ├── di.xml
│ └── system.xml
└── acl.xml
├── COPYING.txt
├── composer.json
├── Plugin
└── Backend
│ └── Magento
│ └── Config
│ └── Model
│ └── Config
│ └── Structure
│ └── Element
│ └── Field
│ ├── FieldPlugin.php
│ ├── DisplayHintAndValue.php
│ └── DisplayOverrideValue.php
└── README.md
/registration.php:
--------------------------------------------------------------------------------
1 |
2 |
10 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/etc/module.xml:
--------------------------------------------------------------------------------
1 |
2 |
10 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
--------------------------------------------------------------------------------
/etc/config.xml:
--------------------------------------------------------------------------------
1 |
2 |
10 |
12 |
13 |
14 |
15 | 1
16 | 1
17 |
18 |
19 |
20 |
21 |
--------------------------------------------------------------------------------
/etc/adminhtml/di.xml:
--------------------------------------------------------------------------------
1 |
2 |
10 |
12 |
13 |
16 |
19 |
20 |
21 |
--------------------------------------------------------------------------------
/etc/acl.xml:
--------------------------------------------------------------------------------
1 |
2 |
10 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
--------------------------------------------------------------------------------
/COPYING.txt:
--------------------------------------------------------------------------------
1 | Copyright © 2022-present Anass touati
2 |
3 | Permission is hereby granted, free of charge, to any person obtaining a copy
4 | of this software and associated documentation files (the "Software"), to deal
5 | in the Software without restriction, including without limitation the rights
6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7 | copies of the Software, and to permit persons to whom the Software is
8 | furnished to do so, subject to the following conditions:
9 |
10 | The above copyright notice and this permission notice shall be included in all
11 | copies or substantial portions of the Software.
12 |
13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19 | SOFTWARE.
20 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "anasstouaticoder/magento2-module-instantconfigurationcopy",
3 | "description": "The InstantConfigurationCopy module provides easy way to copy configuration field information for admin in back office Magento 2.",
4 | "keywords": [
5 | "magento 2",
6 | "back office",
7 | "config hint path",
8 | "config value",
9 | "copy past",
10 | "copy to clipboard",
11 | "hint path"
12 | ],
13 | "authors": [
14 | {
15 | "name": "Anass TOUATI",
16 | "email": "anass1touati@gmail.com",
17 | "homepage": "https://www.linkedin.com/in/anass-touati-9a3b028b/",
18 | "role": "Leader"
19 | }
20 | ],
21 | "require": {
22 | "anasstouaticoder/magento2-module-base": "^1.2.18",
23 | "magento/framework": "*",
24 | "magento/module-config": "*",
25 | "php": "^7.0 || ^8.0"
26 | },
27 | "type": "magento2-module",
28 | "version": "1.2.6",
29 | "minimum-stability": "dev",
30 | "prefer-stable": true,
31 | "license": [
32 | "MIT"
33 | ],
34 | "autoload": {
35 | "files": [
36 | "registration.php"
37 | ],
38 | "psr-4": {
39 | "AnassTouatiCoder\\InstantConfigurationCopy\\": ""
40 | }
41 | }
42 | }
43 |
--------------------------------------------------------------------------------
/view/adminhtml/templates/config_field_info.phtml:
--------------------------------------------------------------------------------
1 |
19 | getDisplayPath()): ?>
20 | getBreakLine() ? '
' : '' ?>
21 | escapeHtml(__('Path:')) ?>
22 | escapeHtml($block->getPath()) ?>
23 |
27 |
28 |
29 | getDisplayValue()): ?>
30 |
36 |
37 |
--------------------------------------------------------------------------------
/view/adminhtml/templates/override_tooltip.phtml:
--------------------------------------------------------------------------------
1 |
17 |
23 |
24 |
25 | getToolTipContent(); ?>
27 |
28 |
46 |
--------------------------------------------------------------------------------
/Plugin/Backend/Magento/Config/Model/Config/Structure/Element/Field/FieldPlugin.php:
--------------------------------------------------------------------------------
1 | scopeConfig = $scopeConfig;
49 | $this->blockFactory = $blockFactory;
50 | $this->initConfig();
51 | }
52 |
53 | /**
54 | * Get active HTML Renderer
55 | *
56 | * @return void
57 | */
58 | abstract protected function initConfig(): void;
59 |
60 | /**
61 | * Get field config path
62 | *
63 | * @param MagentoField $field
64 | * @return string|null
65 | */
66 | protected function getConfigPath(MagentoField $field): ?string
67 | {
68 | return $field->getConfigPath() ?: $field->getPath();
69 | }
70 |
71 | /**
72 | * Get Field HTML ID
73 | *
74 | * @param MagentoField $field
75 | * @return array|string|string[]
76 | */
77 | protected function getFieldHTMLId(MagentoField $field)
78 | {
79 | return str_replace('/', '_', $field->getPath());
80 | }
81 | }
82 |
--------------------------------------------------------------------------------
/Plugin/Backend/Magento/Config/Model/Config/Structure/Element/Field/DisplayHintAndValue.php:
--------------------------------------------------------------------------------
1 | config, true)) {
38 | return $result;
39 | }
40 | return $result . $this->getAdditionalHTML($result, $subject);
41 | }
42 |
43 | /**
44 | * HTML Renderer
45 | *
46 | * @param string $comment
47 | * @param MagentoField $field
48 | * @return string
49 | */
50 | public function getAdditionalHTML(string $comment, MagentoField $field): string
51 | {
52 | $block = $this->blockFactory->createBlock(Template::class);
53 | $fieldPath = $this->getConfigPath($field);
54 | $block
55 | ->setTemplate('AnassTouatiCoder_InstantConfigurationCopy::config_field_info.phtml')
56 | ->setBreakLine(strlen($comment))
57 | ->addData($this->config)
58 | ->setPath($fieldPath);
59 |
60 | if (in_array($field->getType(), self::ALLOWED_FIELD_TYPE_LIST)) {
61 | $block->setFieldId($this->getFieldHTMLId($field))
62 | ->setFieldType($field->getType());
63 | }
64 |
65 | return $block->toHtml();
66 | }
67 |
68 | /**
69 | * {@inheritdoc }
70 | */
71 | protected function initConfig(): void
72 | {
73 | $this->config = [
74 | 'display_path' => $this->scopeConfig->isSetFlag(self::XML_CONFIG_PATH_ENABLE_HINTS_PATH),
75 | 'display_value' => $this->scopeConfig->isSetFlag(self::XML_CONFIG_PATH_SYSTEM_FIELD_VALUE)
76 | ];
77 | }
78 | }
79 |
--------------------------------------------------------------------------------
/etc/adminhtml/system.xml:
--------------------------------------------------------------------------------
1 |
2 |
10 |
12 |
13 |
15 |
16 | anass_Touati_coder
17 | AnassTouatiCoder_InstantConfigurationCopy::anasstouaticoder_instantconfigurationcopy
18 |
20 |
21 |
23 |
24 |
26 | Magento\Config\Model\Config\Source\Yesno
27 |
28 |
30 |
31 |
Allowed Field TypesText, Textarea, Select and
34 | Multiselect
]]>
35 | Magento\Config\Model\Config\Source\Yesno
36 |
37 |
39 |
40 |
Allowed Field TypesText, Textarea, Select and
43 | Multiselect
]]>
44 | Magento\Config\Model\Config\Source\Yesno
45 |
46 |
47 |
48 |
49 |
50 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | Magento 2 Module AnassTouatiCoder InstantConfigurationCopy
2 |
3 |
Copy field path and value, display its override values in parent scope
4 |
5 |
6 |
7 |
8 |
9 |
', $lines);
106 | $tooltip = $this->blockFactory->createBlock(Template::class)
107 | ->setFieldLabel($label)
108 | ->setTemplate('AnassTouatiCoder_InstantConfigurationCopy::override_tooltip.phtml')
109 | ->setToolTipContent($tooltipContent)
110 | ->toHtml();
111 | }
112 |
113 | return $tooltip;
114 | }
115 |
116 | /**
117 | * {@inheritdoc }
118 | */
119 | protected function initConfig(): void
120 | {
121 | $this->config = [
122 | 'display_tooltip' => $this->scopeConfig->isSetFlag(self::XML_CONFIG_PATH_SYSTEM_OVERRIDE_VALUES)
123 | ];
124 | }
125 |
126 | /**
127 | * Get scope data
128 | *
129 | * @param MagentoField $field
130 | * @param string $scopeType
131 | * @param $scope
132 | * @return Phrase|string
133 | */
134 | private function getScopeHint(MagentoField $field, string $scopeType, $scope)
135 | {
136 | $path = $this->getConfigPath($field);
137 | $scopeLine = '';
138 | if ($websiteId = $this->getWebsiteParam()) {
139 | $currentValue = $this->scopeConfig->getValue(
140 | $path,
141 | ScopeInterface::SCOPE_WEBSITE,
142 | $websiteId
143 | );
144 | } else {
145 | $currentValue = $this->scopeConfig->getValue($path);
146 | }
147 | $scopeValue = $this->scopeConfig->getValue($path, $scopeType, $scope->getId());
148 |
149 | if (is_array($currentValue) || is_array($scopeValue)) {
150 | return $scopeLine;
151 | }
152 |
153 | $currentValue = (string)$currentValue;
154 | $scopeValue = (string)$scopeValue;
155 |
156 | if ($scopeValue !== $currentValue) {
157 | $scopeValue = $this->escaper->escapeHtml($scopeValue);
158 |
159 | switch ($scopeType) {
160 | case self::SCOPE_TYPE_STORES:
161 | return __(
162 | 'Store %1:
"%2"',
163 | $scope->getCode(),
164 | $this->getValueLabel($field, $scopeValue)
165 | );
166 | case self::SCOPE_TYPE_WEBSITES:
167 | return __(
168 | 'Website %1:
"%2"',
169 | $scope->getCode(),
170 | $this->getValueLabel($field, $scopeValue)
171 | );
172 | }
173 | }
174 | return $scopeLine;
175 | }
176 |
177 | /**
178 | * Get Value
179 | *
180 | * @param MagentoField $field
181 | * @param string $scopeValue
182 | * @return string|Phrase
183 | */
184 | private function getValueLabel(MagentoField $field, string $scopeValue)
185 | {
186 | $scopeValue = trim($scopeValue);
187 | if ($field->hasOptions()) {
188 | if ($field->getType() === 'multiselect' && strpos($scopeValue, ',') !== false) {
189 | return implode(
190 | ', ',
191 | array_map(
192 | function ($key) use ($field) {
193 | return $this->getValueLabel($field, $key);
194 | },
195 | explode(',', $scopeValue)
196 | )
197 | );
198 | }
199 | foreach ($field->getOptions() as $option) {
200 | if (is_array($option) && $option['value'] == $scopeValue) {
201 | return $option['label'];
202 | }
203 | }
204 | }
205 | return $scopeValue;
206 | }
207 |
208 | /**
209 | * Get Website ID parameter from request
210 | *
211 | * @return string|null
212 | */
213 | private function getWebsiteParam(): ?string
214 | {
215 | return $this->request->getParam('website');
216 | }
217 |
218 | /**
219 | * Get store ID parameter from request
220 | *
221 | * @return string|null
222 | */
223 | private function getStoreParam(): ?string
224 | {
225 | return $this->request->getParam('store');
226 | }
227 | }
228 |
--------------------------------------------------------------------------------