Skip to content

Commit 017de9a

Browse files
ProkopovVitaliyProkopovVitaliy
committed
Added documentation for multishipping module
1 parent 4b0bf14 commit 017de9a

File tree

2 files changed

+122
-4
lines changed

2 files changed

+122
-4
lines changed

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

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ For information about a typical file structure of a module in Magento 2,
5050
</arguments>
5151
</type>
5252
```
53+
More information about [type configuration](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/di-xml-file.html).
5354

5455
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).
5556

@@ -73,7 +74,7 @@ For information about an event in Magento 2, see [Events and observers](https://
7374

7475
### Layouts
7576

76-
This module introduces the following layouts:
77+
The module interacts with the following layout handles:
7778

7879
`view/base/layout` directory:
7980

@@ -90,13 +91,18 @@ This module introduces the following layouts:
9091
- `checkout_cart_sidebar_total_renderers`
9192
- `checkout_onepage_failure`
9293
- `checkout_onepage_success`
93-
- `msrp_popup`
9494
- `review_product_list`
9595
- `wishlist_index_configure_type_downloadable`
9696
- `wishlist_index_index`
9797
- `wishlist_search_view`
9898
- `wishlist_shared_index`
9999

100+
This module introduces the following layouts and layout handles:
101+
102+
`view/frontend/layout` directory:
103+
104+
- `msrp_popup`
105+
100106
### UI components
101107

102108
Module provides product admin form modifier:

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

Lines changed: 114 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,114 @@
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_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).
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+
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).
48+
49+
### Layouts
50+
51+
The module interacts with the following layout handles:
52+
53+
`view/frontend/layout` directory:
54+
55+
- `checkout_cart_index`
56+
57+
This module introduces the following layouts and layout handles:
58+
59+
`view/frontend/layout` directory:
60+
61+
- `multishipping_checkout`
62+
- `multishipping_checkout_address_editaddress`
63+
- `multishipping_checkout_address_editbilling`
64+
- `multishipping_checkout_address_editshipping`
65+
- `multishipping_checkout_address_newbilling`
66+
- `multishipping_checkout_address_newshipping`
67+
- `multishipping_checkout_address_select`
68+
- `multishipping_checkout_address_selectbilling`
69+
- `multishipping_checkout_addresses`
70+
- `multishipping_checkout_billing`
71+
- `multishipping_checkout_customer_address`
72+
- `multishipping_checkout_login`
73+
- `multishipping_checkout_overview`
74+
- `multishipping_checkout_register`
75+
- `multishipping_checkout_results`
76+
- `multishipping_checkout_shipping`
77+
- `multishipping_checkout_success`
78+
79+
## Additional information
80+
81+
### ACL
82+
83+
Module introduces the following resources:
84+
85+
- `Magento_Multishipping::config_multishipping` - Multishipping Settings Section
86+
87+
More information about [Access Control List rule](https://devdocs.magento.com/guides/v2.4/ext-best-practices/tutorials/create-access-control-list-rule.html).
88+
89+
### Page Types
90+
91+
Module introduces the new pages:
92+
93+
`etc/frontend/page_types.xml` file.
94+
95+
- `checkout_cart_multishipping` - Catalog Quick Search Form Suggestion
96+
- `checkout_cart_multishipping_address_editaddress` - Multishipping Checkout One Address Edit Form
97+
- `checkout_cart_multishipping_address_editbilling` - Multishipping Checkout Billing Address Edit Form
98+
- `checkout_cart_multishipping_address_editshipping` - Multishipping Checkout Shipping Address Edit Form
99+
- `checkout_cart_multishipping_address_newbilling` - Multishipping Checkout Billing Address Creation
100+
- `checkout_cart_multishipping_address_newshipping` - Multishipping Checkout Shipping Address Creation
101+
- `checkout_cart_multishipping_address_selectbilling` - Multishipping Checkout Billing Address Selection
102+
- `checkout_cart_multishipping_addresses` - Multishipping Checkout Address (Any) Form
103+
- `checkout_cart_multishipping_billing` - Multishipping Checkout Billing Information Step
104+
- `checkout_cart_multishipping_customer_address` - Multishipping Checkout Customer Address Edit Form
105+
- `checkout_cart_multishipping_login` - Multishipping Checkout Login User Form
106+
- `checkout_cart_multishipping_overview` - Multishipping Checkout Overview
107+
- `checkout_cart_multishipping_register` - Multishipping Checkout Register User Form
108+
- `checkout_cart_multishipping_shipping` - Multishipping Checkout Shipping Information Step
109+
- `checkout_cart_multishipping_success` - Multishipping Checkout Success
110+
111+
More information about [layout types](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-types.html).
112+
113+
114+
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).

0 commit comments

Comments
 (0)