diff --git a/app/code/Magento/WebapiAsync/README.md b/app/code/Magento/WebapiAsync/README.md index ed57634e77caf..96f82d8b6e493 100644 --- a/app/code/Magento/WebapiAsync/README.md +++ b/app/code/Magento/WebapiAsync/README.md @@ -1,3 +1,28 @@ -# WebapiAsync +# Magento_WebapiAsync module -**WebapiAsync** Extends Webapi extension and provide functional to process asynchronous requests. It handle asynchronous requests, schedule, publish and consum bulk operations from queue. +Magento_WebapiAsync module extends Webapi extension and provide functional to process asynchronous requests. + +Magento_WebapiAsync module handles asynchronous requests, schedule, publish and consume bulk operations from a queue. + +## Installation details + +Before installing this module, note that the Magento_WebapiAsync is dependent on the following modules: + +- Magento_AsynchronousOperations +- Magento_Customer +- Magento_User +- Magento_Webapi + +For information about enabling or disabling a module, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). + +## Structure + +`Code/` - the directory that contains Remote service reader configuration files. + +For information about a typical file structure of a module, see [Module file structure](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure). + +## Extensibility + +Extension developers can interact with the Magento_WebapiAsync 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). + +[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_WebapiAsync module. diff --git a/app/code/Magento/WebapiSecurity/README.md b/app/code/Magento/WebapiSecurity/README.md index ec5f84d1d14fa..a355112536a00 100644 --- a/app/code/Magento/WebapiSecurity/README.md +++ b/app/code/Magento/WebapiSecurity/README.md @@ -1,6 +1,15 @@ -# WebapiSecurity +# Magento_WebapiSecurity module + +The Magento_WebapiSecurity module enables access management of some Web API resources. + +If checkbox enabled in backend through: `Stores -> Configuration -> Services -> Magento Web API -> Web Api Security` then the security of all the services outlined in `app/code/Magento/WebapiSecurity/etc/di.xml` would be loosened. You may modify this list to customize which services should follow this behavior. -**WebapiSecurity** enables access management of some Web API resources. -If checkbox is enabled in backend through: Stores -> Configuration -> Services -> Magento Web API -> Web Api Security -then the security of all of the services outlined in app/code/Magento/WebapiSecurity/etc/di.xml would be loosened. You may modify this list to customize which services should follow this behavior. By loosening the security, these services would allow access anonymously (by anyone). + +## Installation details + +Before installing this module, note that the Magento_WebapiSecurity is dependent on the following modules: + +- `Magento_Webapi` + +For information about enabling or disabling a module, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). diff --git a/app/code/Magento/Weee/README.md b/app/code/Magento/Weee/README.md index ef433ec4c96f9..516f442d23315 100644 --- a/app/code/Magento/Weee/README.md +++ b/app/code/Magento/Weee/README.md @@ -1,26 +1,99 @@ -# Overview +# Magento_Weee module + The Magento_Weee module enables the application of fees/fixed product taxes (FPT) on certain types of products, usually related to electronic devices and recycling. -Fixed product taxes can be used to setup a WEEE tax that is a fixed amount, rather than a percentage of the product price. FPT can be configured to be displayed at various places in Magento. Rules, amounts, and display options can be configured in the backend. This module extends the existing functionality of Magento_Tax. + +Fixed product taxes can be used to setup a WEEE tax that is a fixed amount, rather than a percentage of the product price. FPT can be configured to be displayed at various places in Magento. Rules, amounts, and display options can be configured in the backend. + +This module extends the existing functionality of Magento_Tax. The Magento_Weee module includes the following: -* ability to add different number of fixed product taxes to product. They are treated as a product attribute; -* configuration of where WEEE appears (on category, product, sales, invoice, or credit memo pages) and whether FPT should be taxed; -* a new line item in the totals section. +- Ability to add different number of fixed product taxes to product. They are treated as a product attribute. +- Configuration of where WEEE appears (on category, product, sales, invoice, or credit memo pages) and whether FPT should be taxed. +- A new line item in the totals section. + +## Installation details + +The Magento_Weee module can be installed automatically (using native Magento install mechanism) without any additional actions. + +Before installing this module, note that the Magento_Weee is dependent on the following modules: + +- Magento_Catalog +- Magento_Checkout +- Magento_Customer +- Magento_Quote +- Magento_Sales +- Magento_Store +- Magento_Tax + +Refer to [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). + +## Structure + +`Pricing/` - directory that contain tax adjustment. + +For information about a typical file structure of a module, see [Module file structure](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure). + +## Extensibility + +Extension developers can interact with the Magento_Weee 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). + +[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_Weee module. + +### Layouts + +This module introduces the following layouts and layout handles in the directories: + +- `view/adminhtml/layout`: + - `catalog_product_form` + - `sales_creditmemo_item_price` + - `sales_invoice_item_price` + - `sales_order_create_item_price` + - `sales_order_creditmemo_new` + - `sales_order_creditmemo_updateqty` + - `sales_order_creditmemo_view` + - `sales_order_invoice_new` + - `sales_order_invoice_updateqty` + - `sales_order_invoice_view` + - `sales_order_item_price` + - `sales_order_view` + +- `view/base/layout`: + - `catalog_product_prices` + +- `view/frantend/layout`: + - `checkout_cart_index` + - `checkout_index_index` + - `checkout_item_price_renderers` + - `default` + - `sales_email_item_price` + - `sales_email_order_creditmemo_items` + - `sales_email_order_invoice_items` + - `sales_email_order_items` + - `sales_guest_creditmemo` + - `sales_guest_invoice` + - `sales_guest_print` + - `sales_guest_printcreditmemo` + - `sales_guest_printinvoice` + - `sales_guest_view` + - `sales_order_creditmemo` + - `sales_order_invoice` + - `sales_order_item_price` + - `sales_order_print` + - `sales_order_printcreditmemo` + - `sales_order_printinvoice` + - `sales_order_view` + +For more information about a layout, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html). -# System requirements -The Magento_Weee module does not have any specific system requirements. +### UI components -## Install -Magento_Weee module can be installed automatically (using native Magento install mechanism) without any additional actions +You can extend a customer form and widgets using the configuration files located in the directories -## Uninstall -Magento installation with existing products with FPT: -* Disable FPT on the backend -* Remove all products with FPT -* Remove all FPT attributes from attribute sets -* Delete all FPT attributes -* Remove module directory from the code base +- `view/adminhtml/ui_component`: + - `product_attribute_add_form` +- `view/frontend/ui_component`: + - `widget_recently_compared` + - `widget_recently_viewed` -New Magento installation: -* Can be removed without additional actions +For information about a UI component, see [Overview of UI components](https://devdocs.magento.com/guides/v2.4/ui_comp_guide/bk-ui_comps.html). diff --git a/app/code/Magento/WeeeGraphQl/README.md b/app/code/Magento/WeeeGraphQl/README.md index b44771513d562..b1f44619785c4 100644 --- a/app/code/Magento/WeeeGraphQl/README.md +++ b/app/code/Magento/WeeeGraphQl/README.md @@ -1,4 +1,22 @@ -# WeeeGraphQl +# Magento_WeeeGraphQl module -**WeeeGraphQl** provides type information for the GraphQl module -to generate wee tax fields for catalog and product information endpoints. +The Magento_WeeeGraphQl module provides type information for the GraphQl module to generate wee tax fields for the catalog and product information endpoints. + +The Magento_WeeeGraphQl module extends Magento_GraphQl and Magento_Weee modules. This module provides type and resolver information for GraphQL API. + +## Installation details + +Before installing this module, note that the Magento_WeeeGraphQl is dependent on the following modules: + +- `Magento_CatalogGraphQl` +- `Magento_Store` +- `Magento_Tax` +- `Magento_Weee` + +For information about enabling or disabling a module, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). + +## Extensibility + +Extension developers can interact with the Magento_WeeeGraphQl 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). + +[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_WeeeGraphQl module. diff --git a/app/code/Magento/Widget/README.md b/app/code/Magento/Widget/README.md index 4d70d3b6838e0..0d51c6732ec58 100644 --- a/app/code/Magento/Widget/README.md +++ b/app/code/Magento/Widget/README.md @@ -1 +1,41 @@ -The Widget module allows Magento application to be extended with custom widget blocks. \ No newline at end of file +# Magento_Widget module + +The Magento_Widget module allows Magento application to be extended with custom widget blocks. + +## Installation details + +Before installing this module, note that the Magento_Widget is dependent on the following modules: + +- Magento_Catalog +- Magento_Cms +- Magento_Store + +Before disabling or uninstalling this module, note the following dependencies: + +- Magento_CatalogWidget +- Magento_CurrencySymbol +- Magento_Newsletter + +Refer to [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). + +## Extensibility + +Extension developers can interact with the Magento_Widget 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). + +[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_Widget module. + +### Layouts + +This module introduces the following layouts and layout handles in the directories: + +- `view/adminhtml/layout`: + - `adminhtml_widget_index` + - `adminhtml_widget_instance_block` + - `adminhtml_widget_instance_edit` + - `adminhtml_widget_instance_index` + - `adminhtml_widget_loadoptions` +- `view/frantend/layout`: + - `default` + - `print` + +For more information about a layout, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html). diff --git a/app/code/Magento/Wishlist/README.md b/app/code/Magento/Wishlist/README.md index 1caed125814e7..fef81ccacf000 100644 --- a/app/code/Magento/Wishlist/README.md +++ b/app/code/Magento/Wishlist/README.md @@ -1,2 +1,100 @@ -The Magento_Wishlist implements the Wishlist functionality. -This allows customers to create a list of products that they can add to their shopping cart to be purchased at a later date, or share with friends. +# Magento_Wishlist module + +The Magento_Wishlist module implements the Wishlist functionality. + +This module allows customers to create a list of products that they can add to their shopping cart to be purchased at a later date, or share with friends. + +## Installation details + +Before installing this module, note that the Magento_Wishlist is dependent on the following modules: + +- Magento_Captcha +- Magento_Catalog +- Magento_Customer + +Before disabling or uninstalling this module, note the following dependencies: + +- Magento_WishlistAnalytics + +Refer to [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). + +## Structure + +`Pricing/` - the directory that contain solutions for configurable and downloadable product price. + +For information about a typical file structure of a module, see [Module file structure](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure). + +## Extensibility + +Extension developers can interact with the Magento_Wishlist 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). + +[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_Wishlist module. + +### Events + +The module dispatches the following events: + +- `product_option_renderer_init` event in the `\Magento\Wishlist\Block\Customer\Wishlist\Item\Options::_construct()` method. Parameters: + - `block` is a Wishlist block customer items (`\Magento\Wishlist\Block\Customer\Wishlist\Item\Options` class). +- `rss_wishlist_xml_callback` event in the `\Magento\Wishlist\Model\Rss\Wishlist::getRssData()` method. Parameters: + - `$args` is a array of product object (`\Magento\Catalog\Model\Product` class). +- `wishlist_add_item` event in the `\Magento\Wishlist\Model\Wishlist::addItem()` method. Parameters: + - `item` is an item object (`\Magento\Wishlist\Model\Item` class). +- `wishlist_add_product` event in the `\Magento\Wishlist\Controller\Index\Add::execute()` method. Parameters: + - `wishlist` is a Wishlist object (`\Magento\Wishlist\Model\Wishlist` class). + - `product` is a product object (`\Magento\Catalog\Api\Data\ProductInterface` class). + - `item` is an item object (`\Magento\Wishlist\Model\Item` class). +- `wishlist_item_collection_products_after_load` event in the `\Magento\Wishlist\Model\ResourceModel\Item\Collection::_assignProducts()` method. Parameters: + - `product_collection` is a product collection object (`\Magento\Catalog\Model\ResourceModel\Product\Collection` class). +- `wishlist_items_renewed` event in the `\Magento\Wishlist\Helper\Data::calculate()` method. +- `wishlist_product_add_after` event in the `\Magento\Wishlist\Model\Wishlist::addNewItem()` method. Parameters: + - `items` is an array of item object (`\Magento\Wishlist\Model\Item` class). +- `wishlist_share` event in the `\Magento\Wishlist\Controller\Index\Send::execute()` method. Parameters: + - `wishlist` is a Wishlist object (`\Magento\Wishlist\Model\Wishlist` class). +- `wishlist_update_item` event in the `\Magento\Wishlist\Controller\Index\UpdateItemOptions::execute()` method. Parameters: + - `wishlist` is a Wishlist object (`\Magento\Wishlist\Model\Wishlist` class). + - `product` is a product object (`\Magento\Catalog\Api\Data\ProductInterface` class). + - `item` is an item object (`\Magento\Wishlist\Model\Item` class). + +For information about the event, see [Events and observers](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/events-and-observers.html#events). + +### Layouts + +This module introduces the following layouts and layout handles in the directories: + +- `view/adminhtml/layout`: + - `customer_index_wishlist` +- `view/base/layout`: + - `catalog_product_prices` +- `view/frantend/layout`: + - `catalog_category_view` + - `catalog_product_view` + - `catalogsearch_advanced_result` + - `checkout_cart_index` + - `checkout_cart_item_renderers` + - `customer_account` + - `default` + - `wishlist_email_items` + - `wishlist_email_rss` + - `wishlist_index_configure` + - `wishlist_index_configure_type_bundle` + - `wishlist_index_configure_type_configurable` + - `wishlist_index_configure_type_downloadable` + - `wishlist_index_configure_type_grouped` + - `wishlist_index_configure_type_simple` + - `wishlist_index_index` + - `wishlist_index_share` + - `wishlist_shared_index.xml` + +For more information about a layout, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html). + +### UI components + +You can extend a customer form and widgets using the configuration files located in the directories +- `view/base/ui_component`: + - `customer_form` +- `view/frontend/ui_component`: + - `widget_recently_compared` + - `widget_recently_viewed` + +For information about a UI component, see [Overview of UI components](https://devdocs.magento.com/guides/v2.4/ui_comp_guide/bk-ui_comps.html). diff --git a/app/code/Magento/WishlistAnalytics/README.md b/app/code/Magento/WishlistAnalytics/README.md index 275acf0796286..c932397e0803a 100644 --- a/app/code/Magento/WishlistAnalytics/README.md +++ b/app/code/Magento/WishlistAnalytics/README.md @@ -1,3 +1,12 @@ # Magento_WishlistAnalytics module -The Magento_WishlistAnalytics module configures data definitions for a data collection related to the Wishlist module entities to be used in [Advanced Reporting](https://devdocs.magento.com/guides/v2.3/advanced-reporting/modules.html). +The Magento_WishlistAnalytics module configures data definitions for a data collection related to the Wishlist module entities to be used in [Advanced Reporting](https://devdocs.magento.com/guides/v2.4/advanced-reporting/modules.html). + +## Installation details + +Before installing this module, note that the Magento_WishlistAnalytics is dependent on the following modules: + +- Magento_Analytics +- Magento_Wishlist + +For information about enabling or disabling a module, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). diff --git a/app/code/Magento/WishlistGraphQl/README.md b/app/code/Magento/WishlistGraphQl/README.md index 9121593e6a759..c635417f3a6ec 100644 --- a/app/code/Magento/WishlistGraphQl/README.md +++ b/app/code/Magento/WishlistGraphQl/README.md @@ -1,4 +1,42 @@ -# WishlistGraphQl +# Magento_WishlistGraphQl module -**WishlistGraphQl** provides type information for the GraphQl module -to generate wishlist fields. +The Magento_WishlistGraphQl module adds, removes, and updates products on the wishlist. + +The Magento_WishlistGraphQl module extends Magento_GraphQl and Magento_Wishlist modules. This module provides type and resolver information for GraphQL API. + +## Installation details + +Before installing this module, note that the Magento_WishlistGraphQl is dependent on the following modules: + +- Magento_Catalog +- Magento_Checkout +- Magento_Customer +- Magento_CustomerGraphQl +- Magento_Directory +- Magento_GiftMessage +- Magento_GraphQl +- Magento_Quote +- Magento_Sales +- Magento_Store + +For information about enabling or disabling a module, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). + +## Extensibility + +Extension developers can interact with the Magento_WishlistGraphQl 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). + +[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_WishlistGraphQl module. + +## Additional information + +For more information about the Magento_WishlistGraphQl [Queries](#queries) and [Mutations](#mutations) see below: + +### Queries {#queries} + +- [`wishlist`](https://devdocs.magento.com/guides/v2.4/graphql/queries/wishlist.html) + +### Mutations {#mutations} + +- [`addProductsToWishlist`](https://devdocs.magento.com/guides/v2.4/graphql/mutations/add-products-to-wishlist.html) +- [`removeProductsFromWishlist`](https://devdocs.magento.com/guides/v2.4/graphql/mutations/remove-products-from-wishlist.html) +- [`updateProductsInWishlist`](https://devdocs.magento.com/guides/v2.4/graphql/mutations/update-products-in-wishlist.html)