Skip to content

Commit 103bcad

Browse files
magento-engcom-teammagento-engcom-team
committed
ENGCOM-8959: [ReadMe] updated readMe file for Magento_Msrp-Magento_MysqlMq modules #31938
- Merge Pull Request #31938 from ProkopovVitaliy/magento2:documentation-part-1 - Merged commits: 1. 98e089e 2. 4b0bf14 3. 017de9a 4. 3682d87 5. 67e3881 6. e7b3b4d 7. 8916dee
2 parents 81672a2 + 8916dee commit 103bcad

File tree

5 files changed

+360
-8
lines changed

5 files changed

+360
-8
lines changed

‎app/code/Magento/Msrp/README.md

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# Magento_Msrp module
2+
3+
The **Magento_Msrp** module is responsible for Manufacturer’s Suggested Retail Price functionality.
4+
A current module provides base functional for msrp pricing rendering, configuration and calculation.
5+
6+
## Installation
7+
The Magento_Msrp module creates the following attributes:
8+
9+
Entity type - `catalog_product`.
10+
11+
Attribute group - `Advanced Pricing`.
12+
13+
- `msrp` - Manufacturer's Suggested Retail Price
14+
- `msrp_display_actual_price_type` -Display Actual Price
15+
16+
**Pay attention** if described attributes not removed when the module is removed/disabled, it would trigger errors
17+
because they use models and blocks from Magento_Msrp module:
18+
- `\Magento\Msrp\Block\Adminhtml\Product\Helper\Form\Type`
19+
- `\Magento\Msrp\Model\Product\Attribute\Source\Type\Price`
20+
- `\Magento\Msrp\Block\Adminhtml\Product\Helper\Form\Type\Price`
21+
22+
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
23+
24+
## Structure
25+
`Pricing\` - directory contains interfaces and implementation for msrp pricing calculations
26+
(`\Magento\Msrp\Pricing\MsrpPriceCalculatorInterface`), price renderers
27+
and price models.
28+
29+
`Pricing\Price\` - the directory contains declares msrp price model interfaces and implementations.
30+
31+
`Pricing\Renderer\` - contains price renderers implementations.
32+
33+
For information about a typical file structure of a module in Magento 2,
34+
see [Module file structure](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure).
35+
36+
## Extensibility
37+
38+
Developers can pass custom `msrpPriceCalculators` for `Magento\Msrp\Pricing\MsrpPriceCalculator` using type configuration using `di.xml`.
39+
40+
For example:
41+
```
42+
<type name="Magento\Msrp\Pricing\MsrpPriceCalculator">
43+
<arguments>
44+
<argument name="msrpPriceCalculators" xsi:type="array">
45+
<item name="configurable" xsi:type="array">
46+
<item name="productType" xsi:type="const">Magento\ConfigurableProduct\Model\Product\Type\Configurable::TYPE_CODE</item>
47+
<item name="priceCalculator" xsi:type="object">Magento\MsrpConfigurableProduct\Pricing\MsrpPriceCalculator</item>
48+
</item>
49+
</argument>
50+
</arguments>
51+
</type>
52+
```
53+
More information about [type configuration](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/di-xml-file.html).
54+
55+
Extension developers can interact with the Magento_Msrp module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
56+
57+
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_Msrp module.
58+
59+
### Events
60+
61+
This module observes the following event:
62+
63+
`etc/frontend/`
64+
65+
- `sales_quote_collect_totals_after` in the `Magento\Msrp\Observer\Frontend\Quote\SetCanApplyMsrpObserver` file.
66+
67+
`etc/webapi_rest`
68+
- `sales_quote_collect_totals_after` in the `Magento\Msrp\Observer\Frontend\Quote\SetCanApplyMsrpObserver` file.
69+
70+
`etc/webapi_soap`
71+
- `sales_quote_collect_totals_after` in the `Magento\Msrp\Observer\Frontend\Quote\SetCanApplyMsrpObserver` file.
72+
73+
For information about an event in Magento 2, see [Events and observers](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/events-and-observers.html#events).
74+
75+
### Layouts
76+
77+
The module interacts with the following layout handles:
78+
79+
`view/base/layout` directory:
80+
81+
- `catalog_product_prices`
82+
- `cms_index_index`
83+
84+
`view/frontend/layout` directory:
85+
86+
- `catalog_category_view`
87+
- `catalog_product_compare_index`
88+
- `catalog_product_view`
89+
- `catalogsearch_advanced_result`
90+
- `catalogsearch_result_index`
91+
- `checkout_cart_sidebar_total_renderers`
92+
- `checkout_onepage_failure`
93+
- `checkout_onepage_success`
94+
- `review_product_list`
95+
- `wishlist_index_configure_type_downloadable`
96+
- `wishlist_index_index`
97+
- `wishlist_search_view`
98+
- `wishlist_shared_index`
99+
100+
This module introduces the following layouts and layout handles:
101+
102+
`view/frontend/layout` directory:
103+
104+
- `msrp_popup`
105+
106+
### UI components
107+
108+
Module provides product admin form modifier:
109+
110+
`Magento\Msrp\Ui\DataProvider\Product\Form\Modifier\Msrp` - removes `msrp_display_actual_price_type` field from the form if config disabled else adds `validate-zero-or-greater` validation to the fild.
111+
112+
## Additional information
113+
114+
### Catalog attributes
115+
116+
A current module extends `etc/catalog_attributes.xml` and provides following attributes for `quote_item` group:
117+
- `msrp`
118+
- `msrp_display_actual_price_type`
119+
120+
### Extension Attributes
121+
The Magento_Msrp provides extension attributes for `Magento\Catalog\Api\Data\ProductRender\PriceInfoInterface`
122+
- attribute code: `msrp`
123+
- attribute type: `Magento\Msrp\Api\Data\ProductRender\MsrpPriceInfoInterface`

‎app/code/Magento/MsrpConfigurableProduct/README.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,34 @@
1-
# MsrpConfigurableProduct
1+
# Magento_MsrpConfigurableProduct module
22

3-
**MsrpConfigurableProduct** provides type and resolver information for the Msrp module from the ConfigurableProduct module.
3+
The **Magento_MsrpConfigurableProduct** module provides type and resolver information for the Magento_Msrp module from the ConfigurableProduct module.
4+
Provides implementation of msrp price calculation for Configurable Product.
5+
6+
## Installation
7+
8+
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html)
9+
10+
## Structure
11+
12+
`Pricing\` - directory contains implementation of msrp price calculation
13+
for Grouped Product (`Magento\MsrpGroupedProduct\Pricing\MsrpPriceCalculator` class).
14+
15+
For information about a typical file structure of a module in Magento 2,
16+
see [Module file structure](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure).
17+
18+
## Extensibility
19+
20+
Extension developers can interact with the Magento_Msrp module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
21+
22+
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_Msrp module.
23+
24+
### Layouts
25+
26+
For more information about a layout in Magento 2, see the [Layout documentation](http://devdocs.magento.com/guides/v2.3/frontend-dev-guide/layouts/layout-overview.html).
27+
28+
### UI components
29+
30+
For information about a UI component in Magento 2, see [Overview of UI components](http://devdocs.magento.com/guides/v2.3/ui_comp_guide/bk-ui_comps.html).
31+
32+
## Additional information
33+
34+
For information about significant changes in patch releases, see [2.4.x Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).

‎app/code/Magento/MsrpGroupedProduct/README.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,39 @@
1-
# MsrpGroupedProduct
1+
# Magento_MsrpGroupedProduct module
22

3-
**MsrpGroupedProduct** provides type and resolver information for the Msrp module from the GroupedProduct module.
3+
**Magento_MsrpGroupedProduct** module provides type and resolver information for the Msrp module from the GroupedProduct module.
4+
Provides implementation of msrp price calculation for Grouped Product.
5+
6+
## Installation
7+
8+
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html)
9+
10+
## Structure
11+
12+
`Pricing\` - directory contains implementation of msrp price calculation
13+
for Configurable Product (`Magento\MsrpConfigurableProduct\Pricing\MsrpPriceCalculator` class).
14+
15+
For information about a typical file structure of a module in Magento 2,
16+
see [Module file structure](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure).
17+
18+
## Extensibility
19+
20+
Extension developers can interact with the Magento_Msrp module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
21+
22+
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_Msrp module.
23+
24+
### Layouts
25+
26+
For more information about a layout in Magento 2, see the [Layout documentation](http://devdocs.magento.com/guides/v2.3/frontend-dev-guide/layouts/layout-overview.html).
27+
28+
### UI components
29+
30+
For information about a UI component in Magento 2, see [Overview of UI components](http://devdocs.magento.com/guides/v2.3/ui_comp_guide/bk-ui_comps.html).
31+
32+
## Additional information
33+
34+
### collection attributes
35+
36+
Module adds attribute `msrp` to select for the `Magento\Catalog\Model\ResourceModel\Product\Link\Product\Collection`
37+
in `Magento\MsrpGroupedProduct\Plugin\Model\Product\Type\Grouped` plugin.
38+
39+
For information about significant changes in patch releases, see [2.4.x Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).

‎app/code/Magento/Multishipping/README.md

Lines changed: 139 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,139 @@
1-
Magento\Multishipping module provides functionality that allows customer to request shipping to more than one address
2-
using different carriers. The module provides alternative to standard checkout flow.
1+
# Magento_Multishipping module
2+
3+
**Magento_Multishipping** module provides functionality that allows customer to request shipping to more than one address
4+
using different carriers. The module provides alternative to standard checkout flow.
5+
6+
## Installation
7+
8+
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
9+
10+
## Structure
11+
12+
For information about a typical file structure of a module in Magento 2,
13+
see [Module file structure](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure).
14+
15+
## Extensibility
16+
17+
Developers can interact with the module and change behaviour using type configuration feature.
18+
19+
Namely, we can change `paymentSpecification` for `Magento\Multishipping\Block\Checkout\Billing` and `Magento\Multishipping\Model\Checkout\Type\Multishipping` classes.
20+
As result, we will get changed behaviour, new logic or something what our business need.
21+
22+
For example:
23+
```
24+
<type name="Magento\Multishipping\Model\Checkout\Type\Multishipping">
25+
<arguments>
26+
<argument name="paymentSpecification" xsi:type="object">multishippingPaymentSpecification</argument>
27+
</arguments>
28+
</type>
29+
```
30+
Yo can check this configuration and find more examples in the `etc/frontend/di.xml` file.
31+
32+
More information about [type configuration](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/di-xml-file.html).
33+
34+
35+
Extension developers can interact with the Magento_Multishipping module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
36+
37+
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_Msrp module.
38+
39+
### Events
40+
41+
This module observes the following event:
42+
43+
`etc/frontend/`
44+
45+
- `checkout_cart_save_before` in the `Magento\Multishipping\Observer\DisableMultishippingObserver` file.
46+
47+
The module dispatches the following events:
48+
49+
- `multishipping_checkout_controller_success_action` event in the
50+
class `\Magento\Multishipping\Controller\Checkout\Success::execute()` method. Parameters:
51+
- `order_ids` is order ids created during checkout
52+
- `checkout_controller_multishipping_shipping_post` event in the
53+
class `\Magento\Multishipping\Controller\Checkout\ShippingPost::execute()` method. Parameters:
54+
- `request` is a request object `Magento\Framework\App\RequestInterface`.
55+
- `quote` is a quote object for current checkout `Magento\Quote\Model\Quote`.
56+
- `checkout_type_multishipping_set_shipping_items` event in the
57+
class `\Magento\Multishipping\Model\Checkout\Type\Multishipping::setShippingItemsInformation()` method. Parameters:
58+
- `quote` is a quote object for current checkout `Magento\Quote\Model\Quote`.
59+
- `checkout_type_multishipping_create_orders_single` event in the
60+
class `\Magento\Multishipping\Model\Checkout\Type\Multishipping::createOrders()` method. Parameters:
61+
- `order` is a prepared order object for creating `\Magento\Sales\Model\Order`.
62+
- `address` is an address array.
63+
- `quote` is a quote object for current checkout `Magento\Quote\Model\Quote`.
64+
- `checkout_submit_all_after` event in the
65+
class `\Magento\Multishipping\Model\Checkout\Type\Multishipping::createOrders()` method. Parameters:
66+
- `orders` is order object array `\Magento\Sales\Model\Order` that was created.
67+
- `quote` is a quote object for current checkout `Magento\Quote\Model\Quote`.
68+
- `checkout_multishipping_refund_all` event in the
69+
class `\Magento\Multishipping\Model\Checkout\Type\Multishipping::createOrders()` method. Parameters:
70+
- `orders` is order object array `\Magento\Sales\Model\Order` that was created.
71+
72+
For information about an event in Magento 2, see [Events and observers](http://devdocs.magento.com/guides/v2.3/extension-dev-guide/events-and-observers.html#events).
73+
74+
### Layouts
75+
76+
The module interacts with the following layout handles:
77+
78+
`view/frontend/layout` directory:
79+
80+
- `checkout_cart_index`
81+
82+
This module introduces the following layouts and layout handles:
83+
84+
`view/frontend/layout` directory:
85+
86+
- `multishipping_checkout`
87+
- `multishipping_checkout_address_editaddress`
88+
- `multishipping_checkout_address_editbilling`
89+
- `multishipping_checkout_address_editshipping`
90+
- `multishipping_checkout_address_newbilling`
91+
- `multishipping_checkout_address_newshipping`
92+
- `multishipping_checkout_address_select`
93+
- `multishipping_checkout_address_selectbilling`
94+
- `multishipping_checkout_addresses`
95+
- `multishipping_checkout_billing`
96+
- `multishipping_checkout_customer_address`
97+
- `multishipping_checkout_login`
98+
- `multishipping_checkout_overview`
99+
- `multishipping_checkout_register`
100+
- `multishipping_checkout_results`
101+
- `multishipping_checkout_shipping`
102+
- `multishipping_checkout_success`
103+
104+
## Additional information
105+
106+
### ACL
107+
108+
Module introduces the following resources:
109+
110+
- `Magento_Multishipping::config_multishipping` - Multishipping Settings Section
111+
112+
More information about [Access Control List rule](https://devdocs.magento.com/guides/v2.4/ext-best-practices/tutorials/create-access-control-list-rule.html).
113+
114+
### Page Types
115+
116+
Module introduces the new pages:
117+
118+
`etc/frontend/page_types.xml` file.
119+
120+
- `checkout_cart_multishipping` - Catalog Quick Search Form Suggestion
121+
- `checkout_cart_multishipping_address_editaddress` - Multishipping Checkout One Address Edit Form
122+
- `checkout_cart_multishipping_address_editbilling` - Multishipping Checkout Billing Address Edit Form
123+
- `checkout_cart_multishipping_address_editshipping` - Multishipping Checkout Shipping Address Edit Form
124+
- `checkout_cart_multishipping_address_newbilling` - Multishipping Checkout Billing Address Creation
125+
- `checkout_cart_multishipping_address_newshipping` - Multishipping Checkout Shipping Address Creation
126+
- `checkout_cart_multishipping_address_selectbilling` - Multishipping Checkout Billing Address Selection
127+
- `checkout_cart_multishipping_addresses` - Multishipping Checkout Address (Any) Form
128+
- `checkout_cart_multishipping_billing` - Multishipping Checkout Billing Information Step
129+
- `checkout_cart_multishipping_customer_address` - Multishipping Checkout Customer Address Edit Form
130+
- `checkout_cart_multishipping_login` - Multishipping Checkout Login User Form
131+
- `checkout_cart_multishipping_overview` - Multishipping Checkout Overview
132+
- `checkout_cart_multishipping_register` - Multishipping Checkout Register User Form
133+
- `checkout_cart_multishipping_shipping` - Multishipping Checkout Shipping Information Step
134+
- `checkout_cart_multishipping_success` - Multishipping Checkout Success
135+
136+
More information about [layout types](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-types.html).
137+
138+
139+
For information about significant changes in patch releases, see [2.3.x Release information](http://devdocs.magento.com/guides/v2.3/release-notes/bk-release-notes.html).

‎app/code/Magento/MysqlMq/README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,28 @@
1-
# MysqlMq
1+
# Magento_MysqlMq module
22

3-
**MysqlMq** provides message queue implementation based on MySQL.
3+
**Magento_MysqlMq** provides message queue implementation based on MySQL.
4+
5+
Module contain recurring script, declared in `Magento\MysqlMq\Setup\Recurring`
6+
class. This script is executed by Magento post each schema installation or upgrade
7+
stage and populates the queue table.
8+
9+
## Installation
10+
11+
Module creates the following tables:
12+
13+
- `queue` - Table storing unique queues
14+
- `queue_message` - Queue messages
15+
- `queue_message_status` - Relation table to keep associations between queues and messages
16+
17+
18+
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
19+
20+
## Additional information
21+
22+
For information about significant changes in patch releases, see [2.3.x Release information](http://devdocs.magento.com/guides/v2.3/release-notes/bk-release-notes.html).
23+
24+
### cron options
25+
26+
cron group configuration can be set in `etc/crontab.xml`.
27+
28+
- `mysqlmq_clean_messages` - clean up old messages from database

0 commit comments

Comments
 (0)