Skip to content

Commit 4b0bf14

Browse files
Added Msrp documentation
1 parent 98e089e commit 4b0bf14

File tree

3 files changed

+88
-5
lines changed

3 files changed

+88
-5
lines changed

app/code/Magento/Msrp/README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Magento_Msrp module
22

3-
The Magento_Msrp module is responsible for Manufacturer’s Suggested Retail Price functionality.
3+
The **Magento_Msrp** module is responsible for Manufacturer’s Suggested Retail Price functionality.
44
A current module provides base functional for msrp pricing rendering, configuration and calculation.
55

66
## Installation
@@ -35,6 +35,22 @@ For information about a typical file structure of a module in Magento 2,
3535

3636
## Extensibility
3737

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+
3854
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).
3955

4056
[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.
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).
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).

0 commit comments

Comments
 (0)