Skip to content

Update Catalog Module README Content #34423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions app/code/Magento/Catalog/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,72 @@
#Magento_Catalog
Magento_Catalog module functionality is represented by the following sub-systems:
- Products Management. It includes CRUD operation of product, product media, product attributes, etc...
- Category Management. It includes CRUD operation of category, category attributes

Catalog module provides mechanism for creating new product type in the system.
Catalog module provides API filtering that allows to limit product selection with advanced filters.

## Structure

[Learn about a typical file structure for a Magento 2 module]
(https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html).

## Observer
This module observes the following events:
`etc/events.xml`
`magento_catalog_api_data_productinterface_save_before` event in
`Magento\Framework\EntityManager\Observer\BeforeEntitySave` file.
`magento_catalog_api_data_productinterface_save_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntitySave` file.
`magento_catalog_api_data_productinterface_delete_before` event in
`Magento\Framework\EntityManager\Observer\BeforeEntityDelete` file.
`magento_catalog_api_data_productinterface_delete_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntityDelete` file.
`magento_catalog_api_data_productinterface_load_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntityLoad` file.
`magento_catalog_api_data_categoryinterface_save_before` event in
`Magento\Framework\EntityManager\Observer\BeforeEntitySave` file.
`magento_catalog_api_data_categoryinterface_save_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntitySave` file.
`magento_catalog_api_data_categoryinterface_save_after` event in
`Magento\Catalog\Observer\InvalidateCacheOnCategoryDesignChange` file.
`magento_catalog_api_data_categoryinterface_delete_before` event in
`Magento\Framework\EntityManager\Observer\BeforeEntityDelete` file.
`magento_catalog_api_data_categoryinterface_delete_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntityDelete` file.
`magento_catalog_api_data_categoryinterface_load_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntityLoad` file.
`magento_catalog_api_data_categorytreeinterface_save_before` event in
`Magento\Framework\EntityManager\Observer\BeforeEntitySave` file.
`magento_catalog_api_data_categorytreeinterface_save_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntitySave` file.
`magento_catalog_api_data_categorytreeinterface_delete_before` event in
`Magento\Framework\EntityManager\Observer\BeforeEntityDelete` file.
`magento_catalog_api_data_categorytreeinterface_delete_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntityDelete` file.
`magento_catalog_api_data_categorytreeinterface_load_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntityLoad` file.
`admin_system_config_changed_section_catalog` event in
`Magento\Catalog\Observer\SwitchPriceAttributeScopeOnConfigChange` file.
`catalog_product_save_before` event in
`Magento\Catalog\Observer\SetSpecialPriceStartDate` file.
`store_save_after` event in
`Magento\Catalog\Observer\SynchronizeWebsiteAttributesOnStoreChange` file.
`catalog_product_save_commit_after` event in
`Magento\Catalog\Observer\ImageResizeAfterProductSave` file.
`catalog_category_prepare_save` event in
`Magento\Catalog\Observer\CategoryDesignAuthorization` file.

`/etc/frontend/events.xml`
`customer_login` event in
`Magento\Catalog\Observer\Compare\BindCustomerLoginObserver` file.
`customer_logout` event in
`Magento\Catalog\Observer\Compare\BindCustomerLogoutObserver` file.

`/etc/adminhtml/events.xml`
`cms_wysiwyg_images_static_urls_allowed` event in
`Magento\Catalog\Observer\CatalogCheckIsUsingStaticUrlsAllowedObserver` file.
`catalog_category_change_products` event in
`Magento\Catalog\Observer\CategoryProductIndexer` file.
`category_move` event in
`Magento\Catalog\Observer\FlushCategoryPagesCache`