Skip to content

Commit 08a77d7

Browse files
committed
Update Magento_Backend module ReadMe
1 parent 5ee35e5 commit 08a77d7

File tree

1 file changed

+112
-3
lines changed

1 file changed

+112
-3
lines changed

app/code/Magento/Backend/README.md

Lines changed: 112 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,112 @@
1-
The Backend module contains common infrastructure and assets for other modules to be defined and used in their
2-
administration user interface (UI). It does not contain anything specific to other modules. Among many things it
3-
handles the logic of authenticating and authorizing users.
1+
# Magento_Backend module
2+
3+
The Magento_Backend module contains common infrastructure and assets for other modules to be defined and used in their
4+
administration user interface (UI).
5+
6+
The Magento_Backend module does not contain anything specific to other modules. Among many things it handles the logic of authenticating and authorizing users.
7+
8+
## Installation details
9+
10+
Before disabling or uninstalling this module, note that the following modules depends on this module:
11+
12+
- Magento_Analytics
13+
- Magento_Authorization
14+
- Magento_NewRelicReporting
15+
- Magento_ProductVideo
16+
- Magento_ReleaseNotification
17+
- Magento_Search
18+
- Magento_Security
19+
- Magento_Signifyd
20+
- Magento_Swatches
21+
- Magento_Ui
22+
- Magento_User
23+
- Magento_Webapi
24+
25+
For information about module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.3/install-gde/install/cli/install-cli-subcommands-enable.html).
26+
27+
## Structure
28+
29+
Beyond the [usual module file structure](https://devdocs.magento.com/guides/v2.3/architecture/archi_perspectives/components/modules/mod_intro.html) the module contains a directory `Service/V1`.
30+
31+
`Service/V1` - contains logic to provide a list of modules installed in Magento.
32+
33+
For information about typical file structure of a module in Magento 2, see [Module file structure](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/build/module-file-structure.html#module-file-structure).
34+
35+
## Extensibility
36+
37+
Extension developers can interact with the Magento_Backend module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/plugins.html).
38+
39+
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_Backend module.
40+
41+
### Events
42+
43+
The module dispatches the following events:
44+
45+
- `adminhtml_block_html_before` event in the `\Magento\Backend\Block\Template::_toHtml()` method. Parameters:
46+
- `block` is the backend block template (this) (`\Magento\Backend\Block\Template` class).
47+
- `adminhtml_store_edit_form_prepare_form` event in the `\Magento\Backend\Block\System\Store\Edit\AbstractForm::_prepareForm()` method. Parameters:
48+
- `block` is the AbstractForm block (this) (`\Magento\Backend\Block\System\Store\Edit\AbstractForm` class).
49+
- `backend_block_widget_grid_prepare_grid_before` event in the `\Magento\Backend\Block\Widget\Grid::_prepareGrid()` method. Parameters:
50+
- `grid` is the widget grid block (this) (`\Magento\Backend\Block\Widget\Grid` class)
51+
- `collection` is the grid collection (`\Magento\Framework\Data\Collection` class).
52+
- `adminhtml_cache_flush_system` event in the `\Magento\Backend\Console\Command\CacheCleanCommand::performAction()` method.
53+
- `adminhtml_cache_flush_all` event in the `\Magento\Backend\Console\Command\CacheFlushCommand::performAction()` method.
54+
- `clean_catalog_images_cache_after` event in the `\Magento\Backend\Controller\Adminhtml\Cache\CleanImages::execute()` method.
55+
- `clean_media_cache_after` event in the `\Magento\Backend\Controller\Adminhtml\Cache\CleanMedia::execute()` method.
56+
- `clean_static_files_cache_after` event in the `\Magento\Backend\Controller\Adminhtml\Cache\CleanStaticFiles::execute()` method.
57+
- `adminhtml_cache_flush_all` event in the `\Magento\Backend\Controller\Adminhtml\Cache\FlushAll::execute()` method.
58+
- `adminhtml_cache_flush_system` event in the `\Magento\Backend\Controller\Adminhtml\Cache\FlushSystem::execute()` method.
59+
- `theme_save_after` event in the `\Magento\Backend\Controller\Adminhtml\System\Design\Save::execute()` method.
60+
- `backend_auth_user_login_success` event in the `\Magento\Backend\Model\Auth::login()` method. Parameters:
61+
- `user` is the credential storage object (`null | \Magento\Backend\Model\Auth\Credential\StorageInterface`)
62+
- `backend_auth_user_login_failed` event in the `\Magento\Backend\Model\Auth::login()` method. Parameters:
63+
- `user_name` is username extracted from the credential storage object (`null | \Magento\Backend\Model\Auth\Credential\StorageInterface`)
64+
- `exception` any exception generated (`\Magento\Framework\Exception\LocalizedException | \Magento\Framework\Exception\Plugin\AuthenticationException`)
65+
66+
For information about an event in Magento 2, see [Events and observers](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/events-and-observers.html#events).
67+
68+
### Layouts
69+
70+
This module introduces the following layouts and layout handles in the `view/adminhtml/layout` directory:
71+
72+
- `admin_login`
73+
- `adminhtml_auth_login`
74+
- `adminhtml_cache_block`
75+
- `adminhtml_cache_index`
76+
- `adminhtml_dashboard_customersmost`
77+
- `adminhtml_dashboard_customersnewest`
78+
- `adminhtml_dashboard_index`
79+
- `adminhtml_dashboard_productsviewed`
80+
- `adminhtml_denied`
81+
- `adminhtml_noroute`
82+
- `adminhtml_system_account_index`
83+
- `adminhtml_system_design_edit`
84+
- `adminhtml_system_design_grid`
85+
- `adminhtml_system_design_grid_block`
86+
- `adminhtml_system_design_index`
87+
- `adminhtml_system_store_deletestore`
88+
- `adminhtml_system_store_editstore`
89+
- `adminhtml_system_store_grid_block`
90+
- `adminhtml_system_store_index`
91+
- `default`
92+
- `editor`
93+
- `empty`
94+
- `formkey`
95+
- `overlay_popup`
96+
- `popup`
97+
98+
99+
For more information about layouts in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.3/frontend-dev-guide/layouts/layout-overview.html).
100+
101+
### UI components
102+
103+
You can extend Magento_Backend module using the following configuration files:
104+
105+
- `view/adminhtml/ui_component/design_config_form.xml`
106+
- `view/adminhtml/ui_component/design_config_listing.xml`
107+
108+
For information about UI components in Magento 2, see [Overview of UI components](https://devdocs.magento.com/guides/v2.3/ui_comp_guide/bk-ui_comps.html).
109+
110+
## Additional information
111+
112+
For information about significant changes in patch releases, see [2.3.x Release information](https://devdocs.magento.com/guides/v2.3/release-notes/bk-release-notes.html).

0 commit comments

Comments
 (0)