diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 615222321bca0..ec7ddb4085f24 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -15,7 +15,7 @@ For more detailed information on contribution please read our [beginners guide]( ## Contribution requirements -1. Contributions must adhere to the [Magento coding standards](https://devdocs.magento.com/guides/v2.4/coding-standards/bk-coding-standards.html). +1. Contributions must adhere to the [Magento coding standards](https://developer.adobe.com/commerce/php/coding-standards/). 2. Pull requests (PRs) must be accompanied by a meaningful description of their purpose. Comprehensive descriptions increase the chances of a pull request being merged quickly and without additional clarification requests. 3. Commits must be accompanied by meaningful commit messages. Please see the [Magento Pull Request Template](https://github.com/magento/magento2/blob/HEAD/.github/PULL_REQUEST_TEMPLATE.md) for more information. 4. PRs which include bug fixes must be accompanied with a step-by-step description of how to reproduce the bug. diff --git a/README.md b/README.md index 55af19302871e..a02a955a9ebbe 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ However, for those who need a full-featured eCommerce solution, we recommend [Ad ## Contribute -Our [Community](https://opensource.magento.com/) is large and diverse, and our project is enormous. As a contributor, you have countless opportunities to impact product development and delivery by introducing new features or improving existing ones, enhancing test coverage, updating documentation for [developers](https://devdocs.magento.com/) and [end-users](https://docs.magento.com/user-guide/), catching and fixing code bugs, suggesting points for optimization, and sharing your great ideas. +Our [Community](https://opensource.magento.com/) is large and diverse, and our project is enormous. As a contributor, you have countless opportunities to impact product development and delivery by introducing new features or improving existing ones, enhancing test coverage, updating documentation for [developers](https://developer.adobe.com/commerce/docs/) and [end-users](https://docs.magento.com/user-guide/), catching and fixing code bugs, suggesting points for optimization, and sharing your great ideas. - [Contribute to the code](https://developer.adobe.com/commerce/contributor/guides/code-contributions/) - [Report an issue](https://developer.adobe.com/commerce/contributor/guides/code-contributions/#report) @@ -36,7 +36,7 @@ Our [Community](https://opensource.magento.com/) is large and diverse, and our p ### Maintainers -We encourage experts from the Community to help us with GitHub routines such as accepting, merging, or rejecting pull requests and reviewing issues. Adobe has granted the Community Maintainers permission to accept, merge, and reject pull requests, as well as review issues. Thanks to invaluable input from the Community Maintainers team, we can significantly improve contribution quality and accelerate the time to deliver your updates to production. +We encourage experts from the Community to help us with GitHub routines such as accepting, merging, or rejecting pull requests and reviewing issues. Adobe has granted the Community Maintainers permission to accept, merge, and reject pull requests, as well as review issues. Thanks to invaluable input from the Community Maintainers team, we can significantly improve contribution quality and accelerate the time to deliver your updates to production. - [Learn more about the Maintainer role](https://developer.adobe.com/commerce/contributor/guides/maintainers/) - [Maintainer's Handbook](https://developer.adobe.com/commerce/contributor/guides/maintainers/handbook/) @@ -64,9 +64,9 @@ Stay up-to-date on the latest security news and patches by signing up for [Secur ## Licensing Each Magento source file included in this distribution is licensed under OSL 3.0 or the terms and conditions of the applicable ordering document between Licensee/Customer and Adobe (or Magento). - + [Open Software License (OSL 3.0)](https://opensource.org/licenses/osl-3.0.php) – Please see [LICENSE.txt](LICENSE.txt) for the full text of the OSL 3.0 license. - + Subject to Licensee's/Customer's payment of fees and compliance with the terms and conditions of the applicable ordering document between Licensee/Customer and Adobe (or Magento), the terms and conditions of the applicable ordering between Licensee/Customer and Adobe (or Magento) supersede the OSL 3.0 license for each source file. ## Communications diff --git a/app/bootstrap.php b/app/bootstrap.php index 8fbe2f770f53b..a7aea8094f816 100644 --- a/app/bootstrap.php +++ b/app/bootstrap.php @@ -17,12 +17,12 @@ if (!defined('PHP_VERSION_ID') || PHP_VERSION_ID < 80100) { if (PHP_SAPI == 'cli') { echo 'Magento supports PHP 8.1.0 or later. ' . - 'Please read https://devdocs.magento.com/guides/v2.4/install-gde/system-requirements-tech.html'; + 'Please read https://experienceleague.adobe.com/docs/commerce-operations/installation-guide/system-requirements.html'; } else { echo <<

Magento supports PHP 8.1.0 or later. Please read - + Magento System Requirements. HTML; diff --git a/app/code/Magento/AdminAnalytics/README.md b/app/code/Magento/AdminAnalytics/README.md index e905344031ad3..65a9e159f7aea 100644 --- a/app/code/Magento/AdminAnalytics/README.md +++ b/app/code/Magento/AdminAnalytics/README.md @@ -1 +1 @@ -The Magento\AdminAnalytics module gathers information about the features Magento administrators use. This information will be used to help improve the user experience on the Magento Admin. \ No newline at end of file +The Magento\AdminAnalytics module gathers information about the features Magento administrators use. This information will be used to help improve the user experience on the Magento Admin. diff --git a/app/code/Magento/CacheInvalidate/README.md b/app/code/Magento/CacheInvalidate/README.md index 6cca6ffec03e4..f12b0435e71bc 100644 --- a/app/code/Magento/CacheInvalidate/README.md +++ b/app/code/Magento/CacheInvalidate/README.md @@ -1,2 +1,2 @@ The CacheInvalidate module is used to invalidate the Varnish cache if it is configured. -It listens for events that request the cache to be flushed or cause the cache to be invalid, then sends Varnish a purge request using cURL. \ No newline at end of file +It listens for events that request the cache to be flushed or cause the cache to be invalid, then sends Varnish a purge request using cURL. diff --git a/app/code/Magento/Captcha/README.md b/app/code/Magento/Captcha/README.md index 35979fb2b4892..d4119e03e1d9f 100644 --- a/app/code/Magento/Captcha/README.md +++ b/app/code/Magento/Captcha/README.md @@ -1 +1 @@ -The Captcha module allows applying Turing test in the process of user authentication or similar tasks. \ No newline at end of file +The Captcha module allows applying Turing test in the process of user authentication or similar tasks. diff --git a/app/code/Magento/CardinalCommerce/README.md b/app/code/Magento/CardinalCommerce/README.md index 54db9114a2a0e..aa68470a496bc 100644 --- a/app/code/Magento/CardinalCommerce/README.md +++ b/app/code/Magento/CardinalCommerce/README.md @@ -1 +1 @@ -The CardinalCommerce module provides a possibility to enable 3-D Secure 2.0 support for payment methods. \ No newline at end of file +The CardinalCommerce module provides a possibility to enable 3-D Secure 2.0 support for payment methods. diff --git a/app/code/Magento/Catalog/README.md b/app/code/Magento/Catalog/README.md index 0e43661ba8cae..ef95c1effe0a5 100644 --- a/app/code/Magento/Catalog/README.md +++ b/app/code/Magento/Catalog/README.md @@ -1,7 +1,9 @@ -#Magento_Catalog +# 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 + +- 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. @@ -12,61 +14,61 @@ Catalog module provides API filtering that allows to limit product selection wit (https://developer.adobe.com/commerce/php/development/build/component-file-structure/). ## 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` \ No newline at end of file + +- `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` diff --git a/app/code/Magento/CatalogCmsGraphQl/README.md b/app/code/Magento/CatalogCmsGraphQl/README.md index f3b36e515ac6e..5e506e4cb6aed 100644 --- a/app/code/Magento/CatalogCmsGraphQl/README.md +++ b/app/code/Magento/CatalogCmsGraphQl/README.md @@ -1,3 +1,3 @@ # CatalogCmsGraphQl -**CatalogCmsGraphQl** provides type and resolver information for GraphQL attributes that have dependencies on the Catalog and Cms modules. \ No newline at end of file +**CatalogCmsGraphQl** provides type and resolver information for GraphQL attributes that have dependencies on the Catalog and Cms modules. diff --git a/app/code/Magento/CatalogCustomerGraphQl/README.md b/app/code/Magento/CatalogCustomerGraphQl/README.md index 525a1a4f76433..eb1a190e87bc0 100644 --- a/app/code/Magento/CatalogCustomerGraphQl/README.md +++ b/app/code/Magento/CatalogCustomerGraphQl/README.md @@ -1,3 +1,3 @@ # CatalogCustomerGraphQl -**CatalogCustomerGraphQl** provides type and resolver information for GraphQL attributes that have dependences on the Catalog and Customer modules. \ No newline at end of file +**CatalogCustomerGraphQl** provides type and resolver information for GraphQL attributes that have dependences on the Catalog and Customer modules. diff --git a/app/code/Magento/CatalogRuleGraphQl/README.md b/app/code/Magento/CatalogRuleGraphQl/README.md index 6f9761fedecbb..13a8f4a62e963 100644 --- a/app/code/Magento/CatalogRuleGraphQl/README.md +++ b/app/code/Magento/CatalogRuleGraphQl/README.md @@ -1,3 +1,3 @@ # CatalogRuleGraphQl -The *Magento_CatalogRuleGraphQl* module applies catalog rules to products for GraphQL requests. \ No newline at end of file +The *Magento_CatalogRuleGraphQl* module applies catalog rules to products for GraphQL requests. diff --git a/app/code/Magento/CatalogUrlRewrite/README.md b/app/code/Magento/CatalogUrlRewrite/README.md index a03229147129c..9d49b22319af1 100644 --- a/app/code/Magento/CatalogUrlRewrite/README.md +++ b/app/code/Magento/CatalogUrlRewrite/README.md @@ -1,6 +1,6 @@ # Magento_CatalogUrlRewrite module -This module generate url rewrite fields for catalog and product. +This module generate url rewrite fields for catalog and product. ## Extensibility @@ -8,4 +8,4 @@ Extension developers can interact with the Magento_CatalogUrlRewrite module. For [The Magento dependency injection mechanism](https://developer.adobe.com/commerce/php/development/components/dependency-injection/) enables you to override the functionality of the Magento_CatalogUrlRewrite module. -A lot of functionality in the module is on JavaScript, use [mixins](https://developer.adobe.com/commerce/frontend-core/javascript/mixins/) to extend it. \ No newline at end of file +A lot of functionality in the module is on JavaScript, use [mixins](https://developer.adobe.com/commerce/frontend-core/javascript/mixins/) to extend it. diff --git a/app/code/Magento/CatalogWidget/README.md b/app/code/Magento/CatalogWidget/README.md index ea1951198c744..b80085640a2df 100644 --- a/app/code/Magento/CatalogWidget/README.md +++ b/app/code/Magento/CatalogWidget/README.md @@ -1,4 +1,5 @@ # CatalogWidget **CatalogWidget** contains various widgets that extend Catalog module functionality: + - Product List widget provides widget that contains product list created using rule based filter. diff --git a/app/code/Magento/Checkout/README.md b/app/code/Magento/Checkout/README.md index 942e35ec4d772..d4d45b9ea66fc 100644 --- a/app/code/Magento/Checkout/README.md +++ b/app/code/Magento/Checkout/README.md @@ -1,20 +1,23 @@ # Magento_Checkout module + Magento\Checkout module allows merchant to register sale transaction with the customer. Module implements consumer flow that includes such actions like adding products to cart, providing shipping and billing information and confirming the purchase. #### Observer + This module observes the following events `etc/events.xml` - `sales_quote_save_after` event in + `sales_quote_save_after` event in `Magento\Checkout\Observer\SalesQuoteSaveAfterObserver` file. `/etc/frontend/events.xml` `customer_login` event in `Magento\Checkout\Observer\LoadCustomerQuoteObserver` file. `customer_logout` event in `Magento\Checkout\Observer\UnsetAllObserver` - ### Layouts - The module interacts with the following layout handles in the +### Layouts + + The module interacts with the following layout handles in the `view/frontend/layout` `catalog_category_view` `catalog_product_view` @@ -30,4 +33,4 @@ the purchase. `checkout_onepage_failure` `checkout_onepage_review_item_renderers` `checkout_onepage_success` - `default` \ No newline at end of file + `default` diff --git a/app/code/Magento/CheckoutAgreements/README.md b/app/code/Magento/CheckoutAgreements/README.md index 3d31bffd1b542..628bfa165013a 100644 --- a/app/code/Magento/CheckoutAgreements/README.md +++ b/app/code/Magento/CheckoutAgreements/README.md @@ -1,3 +1,3 @@ Magento\CheckoutAgreements module provides the ability add web store agreement that customers must accept before purchasing products from store. The customer will need to accept the terms and conditions in the Order Review section of the -checkout process to be able to place an order if Terms and Conditions functionality is enabled. \ No newline at end of file +checkout process to be able to place an order if Terms and Conditions functionality is enabled. diff --git a/app/code/Magento/Cms/README.md b/app/code/Magento/Cms/README.md index 7934f52cdf341..23e55f1b01a43 100644 --- a/app/code/Magento/Cms/README.md +++ b/app/code/Magento/Cms/README.md @@ -18,29 +18,33 @@ The module interacts with the following layout handles: The module interacts with the following layout handles: `view/adminhtml/layout` directory: - - `cms_block_edit.xml` - - `cms_block_index.xml` - - `cms_block_new.xml` - - `cms_page_edit.xml` - - `cms_page_index.xml` - - `cms_page_new.xml` - - `cms_wysiwyg_images_contents.xml` - - `cms_wysiwyg_images_index.xml` + + * `cms_block_edit.xml` + * `cms_block_index.xml` + * `cms_block_new.xml` + * `cms_page_edit.xml` + * `cms_page_index.xml` + * `cms_page_new.xml` + * `cms_wysiwyg_images_contents.xml` + * `cms_wysiwyg_images_index.xml` The module interacts with the following layout handles in the `view/frontend/layout` directory: - - `cms_index_defaultindex.xml` - - `cms_index_defaultnoroute.xml` - - `cms_index_index.xml` - - `cms_index_nocookies.xml` - - `cms_noroute_index.xml` - - `cms_page_view.xml` - - `default.xml` - - `print.xml` + + * `cms_index_defaultindex.xml` + * `cms_index_defaultnoroute.xml` + * `cms_index_index.xml` + * `cms_index_nocookies.xml` + * `cms_noroute_index.xml` + * `cms_page_view.xml` + * `default.xml` + * `print.xml` ### UI components + This module extends following ui components located in the `view/base/ui_component` directory: This module extends following ui components located in the `view/adminhtml/ui_component` directory: - - `cms_block_form.xml` - - `cms_block_listing.xml` - - `cms_page_form.xml` - - `cms_page_listing.xml` + + * `cms_block_form.xml` + * `cms_block_listing.xml` + * `cms_page_form.xml` + * `cms_page_listing.xml` diff --git a/app/code/Magento/CmsUrlRewrite/README.md b/app/code/Magento/CmsUrlRewrite/README.md index 1f1b1ca782532..a1c20e3daefb0 100644 --- a/app/code/Magento/CmsUrlRewrite/README.md +++ b/app/code/Magento/CmsUrlRewrite/README.md @@ -1,6 +1,6 @@ ## Overview - -The Magento_CmsUrlRewrite module adds support for URL rewrite rules for CMS pages. See also Magento_UrlRewrite module. + +The Magento_CmsUrlRewrite module adds support for URL rewrite rules for CMS pages. See also Magento_UrlRewrite module. The module adds and removes URL rewrite rules as CMS pages are added or removed by a user. -The rules can be edited by an admin user as any other URL rewrite rule. +The rules can be edited by an admin user as any other URL rewrite rule. diff --git a/app/code/Magento/CompareListGraphQl/README.md b/app/code/Magento/CompareListGraphQl/README.md index ed1c38ab33a3b..92215c13a6792 100644 --- a/app/code/Magento/CompareListGraphQl/README.md +++ b/app/code/Magento/CompareListGraphQl/README.md @@ -1,4 +1,3 @@ # CompareListGraphQl module The CompareListGraphQl module is designed to implement compare product functionality. - diff --git a/app/code/Magento/ConfigurableProduct/README.md b/app/code/Magento/ConfigurableProduct/README.md index 1a693b0db94eb..d495fca96f40d 100644 --- a/app/code/Magento/ConfigurableProduct/README.md +++ b/app/code/Magento/ConfigurableProduct/README.md @@ -35,7 +35,7 @@ Value | Description If the `gallery_switch_strategy` variable is not defined, the default value `replace` will be used. -For example, adding these lines of code to the theme view.xml file will set the gallery behavior to `replace` mode. +For example, adding these lines of code to the theme view.xml file will set the gallery behavior to `replace` mode. ```xml diff --git a/app/code/Magento/ConfigurableProductSales/README.md b/app/code/Magento/ConfigurableProductSales/README.md index af915a8265827..f49c6c0284d34 100644 --- a/app/code/Magento/ConfigurableProductSales/README.md +++ b/app/code/Magento/ConfigurableProductSales/README.md @@ -1,4 +1,4 @@ # Magento_ConfigurableProductSales module The Magento_ConfigurableProductSales module checks that the selected options of order item are still presented in -Catalog. Returns true if the previously ordered item configuration is still available. \ No newline at end of file +Catalog. Returns true if the previously ordered item configuration is still available. diff --git a/app/code/Magento/Cron/README.md b/app/code/Magento/Cron/README.md index 445666301ade4..47238153f9cad 100644 --- a/app/code/Magento/Cron/README.md +++ b/app/code/Magento/Cron/README.md @@ -1,2 +1,2 @@ Cron is a module that enables scheduling of jobs. Other modules can add cron jobs by including crontab.xml in their etc directory. The command "bin/magento cron:run" should be run periodically to trigger the Cron module to run its scheduled jobs. -This module also allows administrators to tune cron options in Magento Admin. \ No newline at end of file +This module also allows administrators to tune cron options in Magento Admin. diff --git a/app/code/Magento/Csp/README.md b/app/code/Magento/Csp/README.md index 0cd2cbb907054..6006f5cf14500 100644 --- a/app/code/Magento/Csp/README.md +++ b/app/code/Magento/Csp/README.md @@ -1,4 +1,5 @@ # Magento_Csp module + Magento_Csp implements Content Security Policies for Magento. Allows CSP configuration for Merchants, provides a way for extension and theme developers to configure CSP headers for their extensions. diff --git a/app/code/Magento/CurrencySymbol/README.md b/app/code/Magento/CurrencySymbol/README.md index 39fb926e410de..c839781f5594a 100644 --- a/app/code/Magento/CurrencySymbol/README.md +++ b/app/code/Magento/CurrencySymbol/README.md @@ -5,11 +5,12 @@ ## Controllers ### Currency Controllers + ***CurrencySymbol\Controller\Adminhtml\System\Currency\FetchRates.php*** gets a specified currency conversion rate. Supports all defined currencies in the system. ***CurrencySymbol\Controller\Adminhtml\System\Currency\SaveRates.php*** saves rates for defined currencies. ### Currency Symbol Controllers + ***CurrencySymbol\Controller\Adminhtml\System\Currencysymbol\Reset.php*** resets all custom currency symbols. ***CurrencySymbol\Controller\Adminhtml\System\Currencysymbol\Save.php*** creates custom currency symbols. - diff --git a/app/code/Magento/Customer/README.md b/app/code/Magento/Customer/README.md index 4b2b1a4d6211d..f63b7f0633279 100644 --- a/app/code/Magento/Customer/README.md +++ b/app/code/Magento/Customer/README.md @@ -1,7 +1,7 @@ # Magento_Customer module -This module serves to handle the customer data (Customer, Customer Address and Customer Group entities) both in the admin panel and the storefront. -For customer passwords, the module implements upgrading hashes. +This module serves to handle the customer data (Customer, Customer Address and Customer Group entities) both in the admin panel and the storefront. +For customer passwords, the module implements upgrading hashes. ## Installation @@ -12,6 +12,7 @@ This module is dependent on the following modules: - `Magento_Directory` The following modules depend on this module: + - `Magento_Captcha` - `Magento_Catalog` - `Magento_CatalogCustomerGraphQl` @@ -31,6 +32,7 @@ The following modules depend on this module: - `Magento_WishlistGraphQl` The Magento_Customer module creates the following tables in the database: + - `customer_entity` - `customer_entity_datetime` - `customer_entity_decimal` @@ -65,17 +67,19 @@ A lot of functionality in the module is on JavaScript, use [mixins](https://deve The module dispatches the following events: #### Block + - `adminhtml_block_html_before` event in the `\Magento\Customer\Block\Adminhtml\Edit\Tab\Carts::_toHtml` method. Parameters: - `block` is a `$this` object (`Magento\Customer\Block\Adminhtml\Edit\Tab\Carts` class) - + #### Controller + - `customer_register_success` event in the `\Magento\Customer\Controller\Account\CreatePost::execute` method. Parameters: - `account_controller` is a `$this` object (`\Magento\Customer\Controller\Account\CreatePost` class) - `customer` is a customer object (`\Magento\Customer\Model\Data\Customer` class) - + - `customer_account_edited` event in the `\Magento\Customer\Controller\Account\EditPost::dispatchSuccessEvent` method. Parameters: - `email` is a customer email (`string` type) - + - `adminhtml_customer_prepare_save` event in the `\Magento\Customer\Controller\Adminhtml\Index\Save::execute` method. Parameters: - `customer` is a customer object to be saved (`\Magento\Customer\Model\Data\Customer` class) - `request` is a request object with the `\Magento\Framework\App\RequestInterface` interface. @@ -85,6 +89,7 @@ The module dispatches the following events: - `request` is a request object with the `\Magento\Framework\App\RequestInterface` interface. #### Model + - `customer_customer_authenticated` event in the `\Magento\Customer\Model\AccountManagement::authenticate` method. Parameters: - `model` is a customer object (`\Magento\Customer\Model\Customer` class) - `password` is a customer password (`string` type) @@ -134,6 +139,7 @@ For information about an event in Magento 2, see [Events and observers](https:// ### Layouts This module introduces the following layouts in the `view/frontend/layout` and `view/adminhtml/layout` directories: + - `view/adminhtml/layout`: - `customer_address_edit` - `customer_group_index` @@ -146,7 +152,7 @@ This module introduces the following layouts in the `view/frontend/layout` and ` - `customer_index_viewcart` - `customer_index_viewwishlist` - `customer_online_index` - + - `view/frontend/layout`: - `customer_account` - `customer_account_confirmation` @@ -202,25 +208,25 @@ For more information about a layout in Magento 2, see the [Layout documentation] #### Metadata - `\Magento\Customer\Api\MetadataInterface`: - - retrieve all attributes filtered by form code + - retrieve all attributes filtered by form code - retrieve attribute metadata by attribute code - get all attribute metadata - get custom attributes metadata for the given data interface - + - `\Magento\Customer\Api\MetadataManagementInterface`: - check whether attribute is searchable in admin grid and it is allowed - check whether attribute is filterable in admin grid and it is allowed - + #### Customer address - `\Magento\Customer\Api\AddressMetadataInterface`: - retrieve information about customer address attributes metadata - extends `Magento\Customer\MetadataInterface` - + - `\Magento\Customer\Api\AddressMetadataManagementInterface`: - manage customer address attributes metadata - extends `Magento\Customer\Api\MetadataManagementInterface` - + - `\Magento\Customer\Api\AddressRepositoryInterface`: - save customer address - get customer address by address ID @@ -237,7 +243,7 @@ For more information about a layout in Magento 2, see the [Layout documentation] - `\Magento\Customer\Model\Address\CustomAttributeListInterface` - retrieve list of customer addresses custom attributes - + #### Customer - `\Magento\Customer\Api\AccountManagementInterface`: @@ -260,21 +266,21 @@ For more information about a layout in Magento 2, see the [Layout documentation] - retrieve default billing address for the given customer ID - retrieve default shipping address for the given customer ID - get hashed password - + - `\Magento\Customer\Api\CustomerManagementInterface`: - provide the number of customer count - + - `\Magento\Customer\Api\CustomerMetadataInterface`: - retrieve information about customer attributes metadata - extends `Magento\Customer\MetadataInterface` - + - `\Magento\Customer\Api\CustomerMetadataManagementInterface`: - manage customer attributes metadata - extends `Magento\Customer\Api\MetadataManagementInterface` - + - `\Magento\Customer\Api\CustomerNameGenerationInterface`: - concatenate all customer name parts into full customer name - + - `\Magento\Customer\Api\CustomerRepositoryInterface`: - create or update a customer - get customer by customer EMAIL @@ -294,19 +300,19 @@ For more information about a layout in Magento 2, see the [Layout documentation] - send email with new customer password - send email with reset password confirmation link - send email with new account related information - + #### Customer group - `\Magento\Customer\Api\CustomerGroupConfigInterface`: - set system default customer group - + - `\Magento\Customer\Api\GroupManagementInterface`: - check if customer group can be deleted - get default customer group - get customer group representing customers not logged in - get all customer groups except group representing customers not logged in - get customer group representing all customers - + - `\Magento\Customer\Api\GroupRepositoryInterface`: - save customer group - get customer group by group ID @@ -319,12 +325,13 @@ For more information about a layout in Magento 2, see the [Layout documentation] - `\Magento\Customer\Model\Customer\Source\GroupSourceLoggedInOnlyInterface` - get customer group attribute source - + For information about a public API in Magento 2, see [Public interfaces & APIs](https://developer.adobe.com/commerce/php/development/components/api-concepts/). ### UI components You can extend customer and customer address updates using the configuration files located in the `view/adminhtml/ui_component` and `view/base/ui_component` directories: + - `view/adminhtml/ui_component`: - `customer_address_form` - `customer_address_listing` @@ -334,12 +341,13 @@ You can extend customer and customer address updates using the configuration fil - `view/base/ui_component`: - `customer_form` - + For information about a UI component in Magento 2, see [Overview of UI components](https://developer.adobe.com/commerce/frontend-core/ui-components/). ## Additional information More information can get at articles: + - [Customer Configurations](https://docs.magento.com/user-guide/configuration/customers/customer-configuration.html) - [Customer Attributes](https://docs.magento.com/user-guide/stores/attributes-customer.html) - [Customer Address Attributes](https://docs.magento.com/user-guide/stores/attributes-customer-address.html) @@ -349,11 +357,13 @@ More information can get at articles: ### Console commands Magento_Customer provides console commands: + - `bin/magento customer:hash:upgrade` - upgrades a customer password hash to the latest hash algorithm ### Cron options Cron group configuration can be set at `etc/crontab.xml`: + - `visitor_clean` - clean visitor's outdated records [Learn how to configure and run cron in Magento.](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/cli/configure-cron-jobs.html). @@ -361,6 +371,7 @@ Cron group configuration can be set at `etc/crontab.xml`: ### Indexers This module introduces the following indexers: + - `customer_grid` - customer grid indexer [Learn how to manage the indexers](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/cli/manage-indexers.html). diff --git a/app/code/Magento/CustomerAnalytics/README.md b/app/code/Magento/CustomerAnalytics/README.md index b9cc560cea7e0..153379cd97679 100644 --- a/app/code/Magento/CustomerAnalytics/README.md +++ b/app/code/Magento/CustomerAnalytics/README.md @@ -14,5 +14,6 @@ For information about a module installation in Magento 2, see [Enable or disable ## Additional data More information can get at articles: + - [Advanced Reporting](https://developer.adobe.com/commerce/php/development/advanced-reporting/) - [Data collection for advanced reporting](https://developer.adobe.com/commerce/php/development/advanced-reporting/data-collection/) diff --git a/app/code/Magento/CustomerDownloadableGraphQl/README.md b/app/code/Magento/CustomerDownloadableGraphQl/README.md index 2a3729b36007e..28d777e27cb09 100644 --- a/app/code/Magento/CustomerDownloadableGraphQl/README.md +++ b/app/code/Magento/CustomerDownloadableGraphQl/README.md @@ -19,7 +19,7 @@ Extension developers can interact with the Magento_CatalogGraphQl module. For mo ## Additional information -You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql). +You can get more information about [GraphQl In Magento 2](https://developer.adobe.com/commerce/webapi/graphql/). ### GraphQl Query diff --git a/app/code/Magento/CustomerGraphQl/README.md b/app/code/Magento/CustomerGraphQl/README.md index ae374c045bae0..8f5df3db3b647 100644 --- a/app/code/Magento/CustomerGraphQl/README.md +++ b/app/code/Magento/CustomerGraphQl/README.md @@ -23,7 +23,7 @@ Extension developers can interact with the Magento_CustomerGraphQl module. For m ## Additional information -You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql). +You can get more information about [GraphQl In Magento 2](https://developer.adobe.com/commerce/webapi/graphql/). ### GraphQl Query diff --git a/app/code/Magento/CustomerImportExport/README.md b/app/code/Magento/CustomerImportExport/README.md index 16c4189acfe63..50c978eae1a7a 100644 --- a/app/code/Magento/CustomerImportExport/README.md +++ b/app/code/Magento/CustomerImportExport/README.md @@ -15,6 +15,7 @@ Extension developers can interact with the Magento_CustomerImportExport module. ### Layouts This module introduces the following layouts in the `view/adminhtml/layout` directory: + - `customer_import_export_index_exportcsv` - `customer_import_export_index_exportxml` - `customer_index_grid_block` @@ -24,5 +25,6 @@ For more information about a layout in Magento 2, see the [Layout documentation] ## Additional information You can get more information about import/export processes in magento at the articles: + - [Import](https://docs.magento.com/user-guide/system/data-import.html) - [Export](https://docs.magento.com/user-guide/system/data-export.html) diff --git a/app/code/Magento/Deploy/README.md b/app/code/Magento/Deploy/README.md index 0e4bdb11e0bb8..1d55d55b54e30 100644 --- a/app/code/Magento/Deploy/README.md +++ b/app/code/Magento/Deploy/README.md @@ -1,19 +1,23 @@ # Overview + ## Purpose of module -Deploy is a module that holds collection of services and command line tools to help with Magento application deployment. +Deploy is a module that holds collection of services and command line tools to help with Magento application deployment. To execute this command, please, run "bin/magento setup:static-content:deploy" from the Magento root directory. -Deploy module contains 2 additional commands that allows switching between application modes (for instance from +Deploy module contains 2 additional commands that allows switching between application modes (for instance from development to production) and show current application mode. To change the mode run "bin/magento deploy:mode:set [mode]". Where mode can be one of the following: + - development - production -When switching to production mode, you can pass optional parameter skip-compilation to do not compile static files, CSS +When switching to production mode, you can pass optional parameter skip-compilation to do not compile static files, CSS and do not run the compilation process. # Deployment + ## System requirements ## Install + The Magento_Deploy module is installed automatically (using the native Magento install mechanism) without any additional actions. diff --git a/app/code/Magento/Developer/README.md b/app/code/Magento/Developer/README.md index d5a6a2cee9d46..aa29586df140d 100644 --- a/app/code/Magento/Developer/README.md +++ b/app/code/Magento/Developer/README.md @@ -8,4 +8,4 @@ Extension developers can interact with the Magento_Developer module. For more in [The Magento dependency injection mechanism](https://developer.adobe.com/commerce/php/development/components/dependency-injection/) enables you to override the functionality of the Magento_Developer module. -A lot of functionality in the module is on JavaScript, use [mixins](https://developer.adobe.com/commerce/frontend-core/javascript/mixins/) to extend it. \ No newline at end of file +A lot of functionality in the module is on JavaScript, use [mixins](https://developer.adobe.com/commerce/frontend-core/javascript/mixins/) to extend it. diff --git a/app/code/Magento/Eav/README.md b/app/code/Magento/Eav/README.md index 6710044ac6c89..f669e534a973a 100644 --- a/app/code/Magento/Eav/README.md +++ b/app/code/Magento/Eav/README.md @@ -1,2 +1,2 @@ Magento\EAV stands for Entity-Attribute-Value. The purpose of Magento\Eav module is to make entities -configurable/extendable by admin user. \ No newline at end of file +configurable/extendable by admin user. diff --git a/app/code/Magento/EavGraphQl/README.md b/app/code/Magento/EavGraphQl/README.md index 6bf418c798dec..be4879ac18ceb 100644 --- a/app/code/Magento/EavGraphQl/README.md +++ b/app/code/Magento/EavGraphQl/README.md @@ -10,6 +10,6 @@ For information about enabling or disabling a module in Magento 2, see [Enable o You can get more information at articles: -- [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql). +- [GraphQl In Magento 2](https://developer.adobe.com/commerce/webapi/graphql/). - [customAttributeMetadata query](https://developer.adobe.com/commerce/webapi/graphql/schema/store/queries/custom-attribute-metadata/). - [2.4.x Release information](https://experienceleague.adobe.com/docs/commerce-operations/release/notes/overview.html) diff --git a/app/code/Magento/Elasticsearch/README.md b/app/code/Magento/Elasticsearch/README.md index 835cd4ab37f19..8a58ddfde39a7 100644 --- a/app/code/Magento/Elasticsearch/README.md +++ b/app/code/Magento/Elasticsearch/README.md @@ -1,7 +1,7 @@ -#Magento_Elasticsearch module +# Magento_Elasticsearch module -Magento_Elasticsearch module allows using the Elasticsearch engine for the product searching capabilities. This module -provides logic used by other modules implementing newer versions of Elasticsearch, this module by itself only adds +Magento_Elasticsearch module allows using the Elasticsearch engine for the product searching capabilities. This module +provides logic used by other modules implementing newer versions of Elasticsearch, this module by itself only adds support for Elasticsearch v5. The module implements Magento_Search library interfaces. diff --git a/app/code/Magento/Elasticsearch7/README.md b/app/code/Magento/Elasticsearch7/README.md index d520f5efc3b91..a0c4063da5d3e 100644 --- a/app/code/Magento/Elasticsearch7/README.md +++ b/app/code/Magento/Elasticsearch7/README.md @@ -1,4 +1,4 @@ -#Magento_Elasticsearch7 module +# Magento_Elasticsearch7 module Magento_Elasticsearch7 module allows using ElasticSearch engine 7.x version for the product searching capabilities. diff --git a/app/code/Magento/EncryptionKey/README.md b/app/code/Magento/EncryptionKey/README.md index 07838cceeb3f2..1d4f642ac6033 100644 --- a/app/code/Magento/EncryptionKey/README.md +++ b/app/code/Magento/EncryptionKey/README.md @@ -1,4 +1,4 @@ -#Magento_EncryptionKey module +# Magento_EncryptionKey module The Magento_EncryptionKey module provides an advanced encryption model to protect passwords and other sensitive data. diff --git a/app/code/Magento/Fedex/README.md b/app/code/Magento/Fedex/README.md index b872b53bf879e..419d9771987fb 100644 --- a/app/code/Magento/Fedex/README.md +++ b/app/code/Magento/Fedex/README.md @@ -17,12 +17,14 @@ A lot of functionality in the module is on JavaScript, use [mixins](https://deve ### Layouts This module introduces the following layouts in the `view/frontend/layout` directory: + - `checkout_cart_index` - `checkout_index_index` ## Additional information You can get more information about delivery method in magento at the articles: + - [FedEx Configuration Settings](https://docs.magento.com/user-guide/shipping/fedex.html) - [Delivery Methods Configuration](https://docs.magento.com/user-guide/configuration/sales/delivery-methods.html) - [Add custom shipping carrier](https://developer.adobe.com/commerce/php/tutorials/frontend/custom-checkout/add-shipping-carrier/) diff --git a/app/code/Magento/GiftMessage/README.md b/app/code/Magento/GiftMessage/README.md index b63c37cc64c7d..ba3bb3962b062 100644 --- a/app/code/Magento/GiftMessage/README.md +++ b/app/code/Magento/GiftMessage/README.md @@ -36,6 +36,7 @@ A lot of functionality in the module is on JavaScript, use [mixins](https://deve ### Events The module dispatches the following events: + - `gift_options_prepare_items` event in the `\Magento\GiftMessage\Block\Message\Inline::getItems` method. Parameters: - `items` is a entityItems (`array` type) @@ -47,6 +48,7 @@ For information about an event in Magento 2, see [Events and observers](https:// ### Layout This module introduces the following layouts in the `view/frontend/layout` and `view/adminhtml/layout` directories: + - `view/adminhtml/layout`: - `sales_order_create_index` - `sales_order_create_load_block_data` @@ -70,11 +72,11 @@ For more information about a layout in Magento 2, see the [Layout documentation] - `\Magento\GiftMessage\Api\CartRepositoryInterface` - get the gift message by cart ID for specified shopping cart - set the gift message for an entire shopping cart - + - `\Magento\GiftMessage\Api\GuestCartRepositoryInterface` - get the gift message by cart ID for specified shopping cart - set the gift message for an entire shopping cart - + #### Cart Item - `\Magento\GiftMessage\Api\GuestItemRepositoryInterface` @@ -84,7 +86,7 @@ For more information about a layout in Magento 2, see the [Layout documentation] - `\Magento\GiftMessage\Api\ItemRepositoryInterface` - get the gift message for a specified item in a specified shopping cart - set the gift message for a specified item in a specified shopping cart - + #### Order - `\Magento\GiftMessage\Api\OrderItemRepositoryInterface` @@ -96,7 +98,7 @@ For more information about a layout in Magento 2, see the [Layout documentation] - `\Magento\GiftMessage\Api\OrderItemRepositoryInterface` - get the gift message for a specified item in a specified order - set the gift message for a specified item in a specified order - + For information about a public API in Magento 2, see [Public interfaces & APIs](https://developer.adobe.com/commerce/php/development/components/api-concepts/). ## Additional information diff --git a/app/code/Magento/GiftMessageGraphQl/README.md b/app/code/Magento/GiftMessageGraphQl/README.md index 5eb270c12fdb1..485b403bbc34c 100644 --- a/app/code/Magento/GiftMessageGraphQl/README.md +++ b/app/code/Magento/GiftMessageGraphQl/README.md @@ -16,4 +16,4 @@ Extension developers can interact with the Magento_GiftMessageGraphQl module. Fo ## Additional information -You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql). +You can get more information about [GraphQl In Magento 2](https://developer.adobe.com/commerce/webapi/graphql/). diff --git a/app/code/Magento/GoogleAdwords/README.md b/app/code/Magento/GoogleAdwords/README.md index 2e2b275787f32..d79a7837149db 100644 --- a/app/code/Magento/GoogleAdwords/README.md +++ b/app/code/Magento/GoogleAdwords/README.md @@ -17,6 +17,7 @@ Extension developers can interact with the Magento_GoogleAdwords module. For mor ### Layouts This module introduces the following layouts in the `view/frontend/layout` directory: + - `checkout_onepage_success` For more information about a layout in Magento 2, see the [Layout documentation](https://developer.adobe.com/commerce/frontend-core/guide/layouts/). diff --git a/app/code/Magento/GoogleAnalytics/README.md b/app/code/Magento/GoogleAnalytics/README.md index d4abd290bd665..226871406e241 100644 --- a/app/code/Magento/GoogleAnalytics/README.md +++ b/app/code/Magento/GoogleAnalytics/README.md @@ -21,6 +21,7 @@ A lot of functionality in the module is on JavaScript, use [mixins](https://deve ### Layouts This module introduces the following layouts in the `view/frontend/layout` directory: + - `default` For more information about a layout in Magento 2, see the [Layout documentation](https://developer.adobe.com/commerce/frontend-core/guide/layouts/). diff --git a/app/code/Magento/GoogleGtag/README.md b/app/code/Magento/GoogleGtag/README.md index 4d1a49ada70c7..d5985c308bbc2 100644 --- a/app/code/Magento/GoogleGtag/README.md +++ b/app/code/Magento/GoogleGtag/README.md @@ -21,6 +21,7 @@ A lot of functionality in the module is on JavaScript, use [mixins](https://deve ### Layouts This module introduces the following layouts in the `view/frontend/layout` directory: + - `default` - `checkout_onepage_success` diff --git a/app/code/Magento/GoogleOptimizer/README.md b/app/code/Magento/GoogleOptimizer/README.md index 5e493d69cf13b..2d2a32562f828 100644 --- a/app/code/Magento/GoogleOptimizer/README.md +++ b/app/code/Magento/GoogleOptimizer/README.md @@ -22,6 +22,7 @@ Extension developers can interact with the Magento_GoogleOptimizer module. For m ### Layouts This module introduces the following layouts in the `view/frontend/layout` and `view/adminhtml/layout` directories: + - `view/adminhtml/layout`: - `catalog_product_new` - `cms_page_edit` @@ -35,13 +36,14 @@ For more information about a layout in Magento 2, see the [Layout documentation] ### UI components This module extends following ui components located in the `view/adminhtml/ui_component` directory: + - `category_form` - `cms_page_form` - `new_category_form` For information about a UI component in Magento 2, see [Overview of UI components](https://developer.adobe.com/commerce/frontend-core/ui-components/). -## Additional information +## Additional information Google Experiment (on Google side) allows to make two variants of the same page and compare their popularity. From Magento side, code generated by Google should be saved and displayed on a particular page. diff --git a/app/code/Magento/GraphQl/README.md b/app/code/Magento/GraphQl/README.md index de575fae59b5f..1372e5760e936 100644 --- a/app/code/Magento/GraphQl/README.md +++ b/app/code/Magento/GraphQl/README.md @@ -1,7 +1,7 @@ # Magento_GraphQl module This module provides the framework for the application to expose GraphQL compliant web services. It exposes an area for -GraphQL services and resolves request data based on the generated schema. It also maps this response to a JSON object +GraphQL services and resolves request data based on the generated schema. It also maps this response to a JSON object for the client to read. ## Installation @@ -9,10 +9,12 @@ for the client to read. The Magento_GraphQl module is one of the base Magento 2 modules. You cannot disable or uninstall this module. This module is dependent on the following modules: + - `Magento_Authorization` - `Magento_Eav` The following modules depend on this module: + - `Magento_BundleGraphQl` - `Magento_CatalogGraphQl` - `Magento_CmsGraphQl` @@ -35,4 +37,4 @@ Extension developers can interact with the Magento_GraphQl module. For more info ## Additional information -You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql). +You can get more information about [GraphQl In Magento 2](https://developer.adobe.com/commerce/webapi/graphql/). diff --git a/app/code/Magento/GraphQlCache/README.md b/app/code/Magento/GraphQlCache/README.md index 32555f1423666..85e03391eb9ee 100644 --- a/app/code/Magento/GraphQlCache/README.md +++ b/app/code/Magento/GraphQlCache/README.md @@ -1,7 +1,7 @@ # Magento_GraphQlCache module This module provides the ability to cache GraphQL queries. -This module allows Magento built-in cache or Varnish as the application for serving the Full Page Cache to the front end. +This module allows Magento built-in cache or Varnish as the application for serving the Full Page Cache to the front end. ## Installation @@ -20,5 +20,5 @@ Extension developers can interact with the Magento_GraphQlCache module. For more ## Additional information -- [Learn more about GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql). +- [Learn more about GraphQl In Magento 2](https://developer.adobe.com/commerce/webapi/graphql/). - [Learn more about GraphQl Caching In Magento 2](https://developer.adobe.com/commerce/webapi/graphql/usage/caching/). diff --git a/app/code/Magento/GroupedImportExport/README.md b/app/code/Magento/GroupedImportExport/README.md index b092f88f421bd..fd055be68bdbe 100644 --- a/app/code/Magento/GroupedImportExport/README.md +++ b/app/code/Magento/GroupedImportExport/README.md @@ -16,5 +16,6 @@ Extension developers can interact with the Magento_GroupedImportExport module. F ## Additional information You can get more information about import/export processes in magento at the articles: + - [Import](https://docs.magento.com/user-guide/system/data-import.html) - [Export](https://docs.magento.com/user-guide/system/data-export.html) diff --git a/app/code/Magento/GroupedProduct/README.md b/app/code/Magento/GroupedProduct/README.md index 2f141b463b19e..986b8f20791e8 100644 --- a/app/code/Magento/GroupedProduct/README.md +++ b/app/code/Magento/GroupedProduct/README.md @@ -11,12 +11,14 @@ This module extends the existing functionality of Magento_Catalog module by addi ## Installation details Before installing this module, note that the Magento_GroupedProduct module is dependent on the following modules: + - `Magento_Catalog` - `Magento_CatalogInventory` - `Magento_Sales` - `Magento_Quote` Before disabling or uninstalling this module, note that the following modules depends on this module: + - `Magento_GroupedCatalogInventory` - `Magento_GroupedProductGraphQl` - `Magento_MsrpGroupedProduct` @@ -38,6 +40,7 @@ Extension developers can interact with the Magento_GroupedProduct module. For mo ### Layouts This module introduces the following layouts in the `view/frontend/layout`, `view/adminhtml/layout` and `view/base/layout` directories: + - `view/adminhtml/layout`: - `catalog_product_grouped` - `catalog_product_new` @@ -73,9 +76,11 @@ For more information about a layout in Magento 2, see the [Layout documentation] ### UI components You can extend a grouped product listing updates using the configuration files located in the `view/adminhtml/ui_component` directory: + - `grouped_product_listing` This module extends widgets ui components the configuration files located in the `view/frontend/ui_component` directory: + - `widget_recently_compared` - `widget_recently_viewed` @@ -85,7 +90,7 @@ For information about a UI component in Magento 2, see [Overview of UI component - `\Magento\GroupedProduct\Api\Data\GroupedOptionsInterface` - represents `product item id with qty` of a grouped product - + For information about a public API in Magento 2, see [Public interfaces & APIs](https://developer.adobe.com/commerce/php/development/components/api-concepts/). ## Additional information diff --git a/app/code/Magento/GroupedProductGraphQl/README.md b/app/code/Magento/GroupedProductGraphQl/README.md index 07ac1f2cecf98..f29f3098ae033 100644 --- a/app/code/Magento/GroupedProductGraphQl/README.md +++ b/app/code/Magento/GroupedProductGraphQl/README.md @@ -21,4 +21,4 @@ Extension developers can interact with the Magento_GroupedProductGraphQll module ## Additional information -You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql). +You can get more information about [GraphQl In Magento 2](https://developer.adobe.com/commerce/webapi/graphql/). diff --git a/app/code/Magento/ImportExport/README.md b/app/code/Magento/ImportExport/README.md index ef1a9acbcce0f..a7a395c291cbe 100644 --- a/app/code/Magento/ImportExport/README.md +++ b/app/code/Magento/ImportExport/README.md @@ -1,4 +1,4 @@ -# Magento_ImportExport module +# Magento_ImportExport module This module provides a framework and basic functionality for importing/exporting various entities in Magento. It can be disabled and in such case all dependent import/export functionality (products, customers, orders etc.) will be disabled in Magento. @@ -6,6 +6,7 @@ It can be disabled and in such case all dependent import/export functionality (p ## Installation The Magento_ImportExport module creates the following tables in the database: + - `importexport_importdata` - `import_history` @@ -44,7 +45,7 @@ For more information about a layout in Magento 2, see the [Layout documentation] You can extend an export updates using the configuration files located in the `view/adminhtml/ui_component` directory: -- `export_grid` +- `export_grid` For information about a UI component in Magento 2, see [Overview of UI components](https://developer.adobe.com/commerce/frontend-core/ui-components/). @@ -80,6 +81,7 @@ For information about a public API in Magento 2, see [Public interfaces & APIs]( 2. Create an export model You can get more information about import/export processes in magento at the articles: + - [Create custom import entity](https://developer.adobe.com/commerce/php/tutorials/backend/create-custom-import-entity/) - [Import](https://docs.magento.com/user-guide/system/data-import.html) - [Export](https://docs.magento.com/user-guide/system/data-export.html) diff --git a/app/code/Magento/Indexer/README.md b/app/code/Magento/Indexer/README.md index ed9ee7ec9723f..0285d3400924a 100644 --- a/app/code/Magento/Indexer/README.md +++ b/app/code/Magento/Indexer/README.md @@ -2,6 +2,7 @@ This module provides Magento Indexing functionality. It allows to: + - read indexers configuration - represent indexers in admin - regenerate indexes by cron schedule @@ -19,6 +20,7 @@ This module is dependent on the following modules: - `Magento_AdminNotification` The Magento_Indexer module creates the following tables in the database: + - `indexer_state` - `mview_state` @@ -45,7 +47,7 @@ The module dispatches the following events: - `clean_cache_by_tags` event in the `\Magento\Indexer\Model\Indexer\CacheCleaner::cleanCache` method. Parameters: - `object` is a `cacheContext` object (`Magento\Framework\Indexer\CacheContext` class) -#### Plugin +#### Plugin - `clean_cache_after_reindex` event in the `\Magento\Indexer\Model\Processor\CleanCache::afterUpdateMview` method. Parameters: - `object` is a `context` object (`Magento\Framework\Indexer\CacheContext` class) @@ -58,6 +60,7 @@ For information about an event in Magento 2, see [Events and observers](https:// ### Layouts This module introduces the following layout handles in the `view/adminhtml/layout` directory: + - `indexer_indexer_list` - `indexer_indexer_list_grid` @@ -75,6 +78,7 @@ There are 2 modes of the Indexers: ### Console commands Magento_Indexers provides console commands: + - `bin/magento indexer:info` - view a list of all indexers - `bin/magento indexer:status [indexer]` - view index status - `bin/magento indexer:reindex [indexer]` - run reindex @@ -87,6 +91,7 @@ Magento_Indexers provides console commands: ### Cron options Cron group configuration can be set at `etc/crontab.xml`: + - `indexer_reindex_all_invalid` - regenerate indexes for all invalid indexers - `indexer_update_all_views` - update indexer views - `indexer_clean_all_changelogs` - clean indexer view changelogs @@ -94,8 +99,9 @@ Cron group configuration can be set at `etc/crontab.xml`: [Learn how to configure and run cron in Magento.](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/cli/configure-cron-jobs.html). More information can get at articles: + - [Learn more about indexing](https://developer.adobe.com/commerce/php/development/components/indexing/) -- [Learn more about Indexer optimization](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/indexer-batch.html) +- [Learn more about Indexer optimization](https://developer.adobe.com/commerce/php/development/components/indexing/optimization/) - [Learn more how to add custom indexer](https://developer.adobe.com/commerce/php/development/components/indexing/custom-indexer/) - [Learn how to manage indexers](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/cli/manage-indexers.html) - [Learn more about Index Management](https://docs.magento.com/user-guide/system/index-management.html) diff --git a/app/code/Magento/InstantPurchase/README.md b/app/code/Magento/InstantPurchase/README.md index a4dfa6500e19a..f92335e4c4701 100644 --- a/app/code/Magento/InstantPurchase/README.md +++ b/app/code/Magento/InstantPurchase/README.md @@ -34,13 +34,13 @@ Extension developers can interact with the Magento_InstantPurchase module. For m - `\Magento\InstantPurchase\Model\ShippingMethodChoose\ShippingMethodChooserInterface` - choose shipping method for customer address if available - + - `\Magento\InstantPurchase\Model\InstantPurchaseInterface` - detects instant purchase options for a customer in a store - + - `\Magento\InstantPurchase\PaymentMethodIntegration\AvailabilityCheckerInterface` - checks if payment method may be used for instant purchase - + - `\Magento\InstantPurchase\PaymentMethodIntegration\PaymentAdditionalInformationProviderInterface` - provides additional information part specific for payment method diff --git a/app/code/Magento/Integration/README.md b/app/code/Magento/Integration/README.md index 0e17dc80c1355..c9caeb63a9555 100644 --- a/app/code/Magento/Integration/README.md +++ b/app/code/Magento/Integration/README.md @@ -10,11 +10,13 @@ model for request and access token management. The Magento_Integration module is one of the base Magento 2 modules. You cannot disable or uninstall this module. This module is dependent on the following modules: + - `Magento_Store` - `Magento_User` - `Magento_Security` The Magento_Integration module creates the following tables in the database: + - `oauth_consumer` - `oauth_token` - `oauth_nonce` @@ -34,6 +36,7 @@ Extension developers can interact with the Magento_Integration module. For more The module dispatches the following events: #### Model + - `customer_login` event in the `\Magento\Integration\Model\CustomerTokenService::createCustomerAccessToken` method. Parameters: - `customer` is an object (`\Magento\Customer\Api\Data\CustomerInterface` class) @@ -42,6 +45,7 @@ For information about an event in Magento 2, see [Events and observers](https:// ### Layouts This module introduces the following layout handles in the `view/adminhtml/layout` directory: + - `adminhtml_integration_edit` - `adminhtml_integration_grid` - `adminhtml_integration_grid_block` @@ -82,7 +86,7 @@ For more information about a layout in Magento 2, see the [Layout documentation] - create a new consumer account - create access token for provided consumer - retrieve access token assigned to the consumer - - load consumer by its ID + - load consumer by its ID - load consumer by its key - execute post to integration (consumer) HTTP Post URL. Generate and return oauth_verifier - delete the consumer data associated with the integration including its token and nonce @@ -95,11 +99,13 @@ For information about a public API in Magento 2, see [Public interfaces & APIs]( ### Cron options Cron group configuration can be set at `etc/crontab.xml`: + - `outdated_authentication_failures_cleanup` - clearing log of outdated token request authentication failures - `expired_tokens_cleanups` - delete expired customer and admin tokens [Learn how to configure and run cron in Magento.](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/cli/configure-cron-jobs.html). More information can get at articles: + - [Learn more about an Integration](https://docs.magento.com/user-guide/system/integrations.html) - [Lear how to create an Integration](https://developer.adobe.com/commerce/webapi/get-started/create-integration/) diff --git a/app/code/Magento/LayeredNavigation/README.md b/app/code/Magento/LayeredNavigation/README.md index b27fa3d5360ed..0d324c2a6c2f0 100644 --- a/app/code/Magento/LayeredNavigation/README.md +++ b/app/code/Magento/LayeredNavigation/README.md @@ -17,6 +17,7 @@ Extension developers can interact with the Magento_LayeredNavigation module. For ### Layouts This module introduces the following layout handles in the `view/frontend/layout` directory: + - `catalog_category_view_type_layered` - `catalog_category_view_type_layered_without_children` - `catalogsearch_result_index` @@ -26,6 +27,7 @@ For more information about a layout in Magento 2, see the [Layout documentation] ### UI components This module extends following ui components located in the `view/adminhtml/ui_component` directory: + - `product_attribute_add_form` - `product_attributes_grid` - `product_attributes_listing` @@ -42,7 +44,9 @@ For information about a public API in Magento 2, see [Public interfaces & APIs]( ## Additional information ### Page Layout -This module modifies the following page_layout in the `view/frontend.page_layout` directory: + +This module modifies the following page_layout in the `view/frontend.page_layout` directory: + - `1columns` - moves block `catalog.leftnav` into the `content.top` container - `2columns-left` - moves block `catalog.leftnav` into the `sidebar.main"` container - `2columns-right` - moves block `catalog.leftnav` into the `sidebar.main"` container @@ -50,5 +54,6 @@ This module modifies the following page_layout in the `view/frontend.page_layout - `empty` - moves block `catalog.leftnav` into the `category.product.list.additional` container More information can be found in: + - [Learn more about Layered Navigation](https://docs.magento.com/user-guide/catalog/navigation-layered.html) - [Learn how to Configuring Layered Navigation](https://docs.magento.com/user-guide/catalog/navigation-layered-configuration.html) diff --git a/app/code/Magento/LoginAsCustomerApi/README.md b/app/code/Magento/LoginAsCustomerApi/README.md index 4f2bf5d82495a..39dc0d7bee6eb 100644 --- a/app/code/Magento/LoginAsCustomerApi/README.md +++ b/app/code/Magento/LoginAsCustomerApi/README.md @@ -6,7 +6,7 @@ This module provides API for ability to login into customer account for an admin - `\Magento\LoginAsCustomerApi\Api\Data\AuthenticationDataInterface`: - contains authentication data - + -`\Magento\LoginAsCustomerApi\Api\Data\IsLoginAsCustomerEnabledForCustomerResultInterface`: - contains the result of the check whether the login as customer is enabled @@ -26,7 +26,7 @@ This module provides API for ability to login into customer account for an admin - `\Magento\LoginAsCustomerApi\Api\GetAuthenticationDataBySecretInterface`: - get authentication data by secret - + - `\Magento\LoginAsCustomerApi\Api\GetLoggedAsCustomerAdminIdInterface`: - get id of admin logged as customer diff --git a/app/code/Magento/LoginAsCustomerGraphQl/README.md b/app/code/Magento/LoginAsCustomerGraphQl/README.md index 8a42feab75bc2..fa3ff4d8cbcc9 100755 --- a/app/code/Magento/LoginAsCustomerGraphQl/README.md +++ b/app/code/Magento/LoginAsCustomerGraphQl/README.md @@ -19,4 +19,4 @@ This module is a part of Login As Customer feature. [Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html). -You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql). +You can get more information about [GraphQl In Magento 2](https://developer.adobe.com/commerce/webapi/graphql/). diff --git a/app/code/Magento/LoginAsCustomerLog/README.md b/app/code/Magento/LoginAsCustomerLog/README.md index 6b867473e6b5f..197a5886e07e2 100644 --- a/app/code/Magento/LoginAsCustomerLog/README.md +++ b/app/code/Magento/LoginAsCustomerLog/README.md @@ -11,6 +11,7 @@ For information about a module installation in Magento 2, see [Enable or disable ### Layouts This module introduces the following layouts in the `view/adminhtml/layout` directory: + - `loginascustomer_log_log_index` For more information about a layout in Magento 2, see the [Layout documentation](https://developer.adobe.com/commerce/frontend-core/guide/layouts/). @@ -18,6 +19,7 @@ For more information about a layout in Magento 2, see the [Layout documentation] ### UI components You can extend log listing updates using the configuration files located in the directories + - `view/adminhtml/ui_component`: - `login_as_customer_log_listing` diff --git a/app/code/Magento/Marketplace/README.md b/app/code/Magento/Marketplace/README.md index 732d6d77543ae..36ba12e706b4b 100644 --- a/app/code/Magento/Marketplace/README.md +++ b/app/code/Magento/Marketplace/README.md @@ -15,6 +15,7 @@ Extension developers can interact with the Magento_Marketplace module. For more ### Layouts This module introduces the following layouts in the `view/adminhtml/layout` directory: + - `marketplace_index_index` - `marketplace_partners_index` diff --git a/app/code/Magento/MediaGalleryApi/README.md b/app/code/Magento/MediaGalleryApi/README.md index 8db7d800a9a78..c7a389384e5fe 100644 --- a/app/code/Magento/MediaGalleryApi/README.md +++ b/app/code/Magento/MediaGalleryApi/README.md @@ -34,7 +34,7 @@ Extension developers can interact with the Magento_MediaGalleryApi module. For m - `\Magento\MediaGalleryApi\Api\GetAssetsByIdsInterface`: - get media gallery assets by id attribute - + - `\Magento\MediaGalleryApi\Api\GetAssetsByPathsInterface`: - get media gallery assets by paths in media storage diff --git a/app/code/Magento/MediaGalleryCatalogUi/README.md b/app/code/Magento/MediaGalleryCatalogUi/README.md index f53cc0f8f328c..e6a9655d4adba 100644 --- a/app/code/Magento/MediaGalleryCatalogUi/README.md +++ b/app/code/Magento/MediaGalleryCatalogUi/README.md @@ -15,6 +15,7 @@ Extension developers can interact with the Magento_MediaGalleryCatalogUi module. ### Layouts This module introduces the following layouts in the `view/adminhtml/layout` directory: + - `media_gallery_catalog_category_index` For more information about a layout in Magento 2, see the [Layout documentation](https://developer.adobe.com/commerce/frontend-core/guide/layouts/). @@ -24,9 +25,11 @@ For more information about a layout in Magento 2, see the [Layout documentation] The configuration files located in the directory `view/adminhtml/ui_component`. You can extend media gallery listing updates using the following configuration files: + - `media_gallery_category_listing` This module extends ui components: + - `media_gallery_listing` - `standalone_media_gallery_listing` diff --git a/app/code/Magento/MediaGalleryCmsUi/README.md b/app/code/Magento/MediaGalleryCmsUi/README.md index a7e8446de77cf..eaa218995ae16 100644 --- a/app/code/Magento/MediaGalleryCmsUi/README.md +++ b/app/code/Magento/MediaGalleryCmsUi/README.md @@ -17,6 +17,7 @@ Extension developers can interact with the Magento_MediaGalleryCmsUi module. For The configuration files located in the directory `view/adminhtml/ui_component`. This module extends ui components: + - `media_gallery_listing` - `standalone_media_gallery_listing` diff --git a/app/code/Magento/MediaGalleryUi/README.md b/app/code/Magento/MediaGalleryUi/README.md index 584f242ccd425..c1dc448bc7990 100644 --- a/app/code/Magento/MediaGalleryUi/README.md +++ b/app/code/Magento/MediaGalleryUi/README.md @@ -17,6 +17,7 @@ Extension developers can interact with the Magento_MediaGalleryUi module. For mo ### Layouts This module introduces the following layouts in the `view/adminhtml/layout` directory: + - `media_gallery_index_index` - `media_gallery_media_index` @@ -32,6 +33,7 @@ You can extend media gallery listing updates using the following configuration f - `standalone_media_gallery_listing` This module extends ui components: + - `cms_block_listing` - `cms_page_listing` - `product_listing` diff --git a/app/code/Magento/MediaGalleryUiApi/README.md b/app/code/Magento/MediaGalleryUiApi/README.md index f4b0d1a1d6dce..585428276f13e 100644 --- a/app/code/Magento/MediaGalleryUiApi/README.md +++ b/app/code/Magento/MediaGalleryUiApi/README.md @@ -11,4 +11,3 @@ For information about module installation in Magento 2, see [Enable or disable m For information about significant changes in patch releases, see [2.4.x Release information](https://experienceleague.adobe.com/docs/commerce-operations/release/notes/overview.html). [Learn more about New Media Gallery](https://docs.magento.com/user-guide/cms/media-gallery.html). - diff --git a/app/code/Magento/MediaStorage/README.md b/app/code/Magento/MediaStorage/README.md index f77ddac816cb4..3e401c7aa6058 100644 --- a/app/code/Magento/MediaStorage/README.md +++ b/app/code/Magento/MediaStorage/README.md @@ -36,5 +36,6 @@ Extension developers can interact with the Magento_MediaStorage module. For more [Learn how to manage Message Queues](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/message-queues/manage-message-queues.html). More information can get at articles: + - [Learn how to configure Media Storage Database](https://docs.magento.com/user-guide/system/media-storage-database.html). - [Learn how to Resize catalog images](https://developer.adobe.com/commerce/frontend-core/guide/themes/configure/#resize-catalog-images) diff --git a/app/code/Magento/Msrp/README.md b/app/code/Magento/Msrp/README.md index deef2e0dcef5e..a82a5b391c5df 100644 --- a/app/code/Magento/Msrp/README.md +++ b/app/code/Magento/Msrp/README.md @@ -1,9 +1,10 @@ # Magento_Msrp module -The **Magento_Msrp** module is responsible for Manufacturer’s Suggested Retail Price functionality. +The **Magento_Msrp** module is responsible for Manufacturer's Suggested Retail Price functionality. A current module provides base functional for msrp pricing rendering, configuration and calculation. ## Installation + The Magento_Msrp module creates the following attributes: Entity type - `catalog_product`. @@ -14,7 +15,8 @@ Attribute group - `Advanced Pricing`. - `msrp_display_actual_price_type` -Display Actual Price **Pay attention** if described attributes not removed when the module is removed/disabled, it would trigger errors -because they use models and blocks from Magento_Msrp module: +because they use models and blocks from Magento_Msrp module: + - `\Magento\Msrp\Block\Adminhtml\Product\Helper\Form\Type` - `\Magento\Msrp\Model\Product\Attribute\Source\Type\Price` - `\Magento\Msrp\Block\Adminhtml\Product\Helper\Form\Type\Price` @@ -22,36 +24,39 @@ because they use models and blocks from Magento_Msrp module: For information about a module installation in Magento 2, see [Enable or disable modules](https://experienceleague.adobe.com/docs/commerce-operations/installation-guide/tutorials/manage-modules.html). ## Structure + `Pricing\` - directory contains interfaces and implementation for msrp pricing calculations - (`\Magento\Msrp\Pricing\MsrpPriceCalculatorInterface`), price renderers + (`\Magento\Msrp\Pricing\MsrpPriceCalculatorInterface`), price renderers and price models. - + `Pricing\Price\` - the directory contains declares msrp price model interfaces and implementations. `Pricing\Renderer\` - contains price renderers implementations. For information about a typical file structure of a module in Magento 2, see [Module file structure](https://developer.adobe.com/commerce/php/development/build/component-file-structure/#module-file-structure). - + ## Extensibility - - Developers can pass custom `msrpPriceCalculators` for `Magento\Msrp\Pricing\MsrpPriceCalculator` using type configuration using `di.xml`. - + + Developers can pass custom `msrpPriceCalculators` for `Magento\Msrp\Pricing\MsrpPriceCalculator` using type configuration using `di.xml`. + For example: - ``` - - - - - Magento\ConfigurableProduct\Model\Product\Type\Configurable::TYPE_CODE - Magento\MsrpConfigurableProduct\Pricing\MsrpPriceCalculator - - - - -``` + + ```xml + + + + + Magento\ConfigurableProduct\Model\Product\Type\Configurable::TYPE_CODE + Magento\MsrpConfigurableProduct\Pricing\MsrpPriceCalculator + + + + +``` + More information about [type configuration](https://developer.adobe.com/commerce/php/development/build/dependency-injection-file/). - + Extension developers can interact with the Magento_Msrp module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://developer.adobe.com/commerce/php/development/components/plugins/). [The Magento dependency injection mechanism](https://developer.adobe.com/commerce/php/development/components/dependency-injection/) enables you to override the functionality of the Magento_Msrp module. @@ -62,13 +67,15 @@ This module observes the following event: `etc/frontend/` - - `sales_quote_collect_totals_after` in the `Magento\Msrp\Observer\Frontend\Quote\SetCanApplyMsrpObserver` file. + - `sales_quote_collect_totals_after` in the `Magento\Msrp\Observer\Frontend\Quote\SetCanApplyMsrpObserver` file. `etc/webapi_rest` - - `sales_quote_collect_totals_after` in the `Magento\Msrp\Observer\Frontend\Quote\SetCanApplyMsrpObserver` file. + + - `sales_quote_collect_totals_after` in the `Magento\Msrp\Observer\Frontend\Quote\SetCanApplyMsrpObserver` file. `etc/webapi_soap` - - `sales_quote_collect_totals_after` in the `Magento\Msrp\Observer\Frontend\Quote\SetCanApplyMsrpObserver` file. + + - `sales_quote_collect_totals_after` in the `Magento\Msrp\Observer\Frontend\Quote\SetCanApplyMsrpObserver` file. For information about an event in Magento 2, see [Events and observers](https://developer.adobe.com/commerce/php/development/components/events-and-observers/#events). @@ -105,7 +112,7 @@ This module introduces the following layouts and layout handles: ### UI components -Module provides product admin form modifier: +Module provides product admin form modifier: `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. @@ -114,10 +121,13 @@ Module provides product admin form modifier: ### Catalog attributes A current module extends `etc/catalog_attributes.xml` and provides following attributes for `quote_item` group: + - `msrp` - `msrp_display_actual_price_type` ### Extension Attributes + The Magento_Msrp provides extension attributes for `Magento\Catalog\Api\Data\ProductRender\PriceInfoInterface` + - attribute code: `msrp` - attribute type: `Magento\Msrp\Api\Data\ProductRender\MsrpPriceInfoInterface` diff --git a/app/code/Magento/MsrpConfigurableProduct/README.md b/app/code/Magento/MsrpConfigurableProduct/README.md index 7afb0d834693c..de3160ad7c51c 100644 --- a/app/code/Magento/MsrpConfigurableProduct/README.md +++ b/app/code/Magento/MsrpConfigurableProduct/README.md @@ -9,8 +9,8 @@ For information about a module installation in Magento 2, see [Enable or disable ## Structure -`Pricing\` - directory contains implementation of msrp price calculation -for Grouped Product (`Magento\MsrpGroupedProduct\Pricing\MsrpPriceCalculator` class). +`Pricing\` - directory contains implementation of msrp price calculation +for Grouped Product (`Magento\MsrpGroupedProduct\Pricing\MsrpPriceCalculator` class). For information about a typical file structure of a module in Magento 2, see [Module file structure](https://developer.adobe.com/commerce/php/development/build/component-file-structure/#module-file-structure). diff --git a/app/code/Magento/MsrpGroupedProduct/README.md b/app/code/Magento/MsrpGroupedProduct/README.md index 1c2a5c15a146d..605ca4714a0bb 100644 --- a/app/code/Magento/MsrpGroupedProduct/README.md +++ b/app/code/Magento/MsrpGroupedProduct/README.md @@ -9,8 +9,8 @@ For information about a module installation in Magento 2, see [Enable or disable ## Structure -`Pricing\` - directory contains implementation of msrp price calculation -for Configurable Product (`Magento\MsrpConfigurableProduct\Pricing\MsrpPriceCalculator` class). +`Pricing\` - directory contains implementation of msrp price calculation +for Configurable Product (`Magento\MsrpConfigurableProduct\Pricing\MsrpPriceCalculator` class). For information about a typical file structure of a module in Magento 2, see [Module file structure](https://developer.adobe.com/commerce/php/development/build/component-file-structure/#module-file-structure). @@ -33,7 +33,7 @@ For information about a UI component in Magento 2, see [Overview of UI component ### collection attributes -Module adds attribute `msrp` to select for the `Magento\Catalog\Model\ResourceModel\Product\Link\Product\Collection` +Module adds attribute `msrp` to select for the `Magento\Catalog\Model\ResourceModel\Product\Link\Product\Collection` in `Magento\MsrpGroupedProduct\Plugin\Model\Product\Type\Grouped` plugin. For information about significant changes in patch releases, see [2.4.x Release information](https://experienceleague.adobe.com/docs/commerce-operations/release/notes/overview.html). diff --git a/app/code/Magento/Multishipping/README.md b/app/code/Magento/Multishipping/README.md index 436357afa0436..2e1c88dc1818b 100644 --- a/app/code/Magento/Multishipping/README.md +++ b/app/code/Magento/Multishipping/README.md @@ -11,26 +11,27 @@ For information about a module installation in Magento 2, see [Enable or disable For information about a typical file structure of a module in Magento 2, see [Module file structure](https://developer.adobe.com/commerce/php/development/build/component-file-structure/#module-file-structure). - - ## Extensibility + +## Extensibility Developers can interact with the module and change behaviour using type configuration feature. -Namely, we can change `paymentSpecification` for `Magento\Multishipping\Block\Checkout\Billing` and `Magento\Multishipping\Model\Checkout\Type\Multishipping` classes. -As result, we will get changed behaviour, new logic or something what our business need. +Namely, we can change `paymentSpecification` for `Magento\Multishipping\Block\Checkout\Billing` and `Magento\Multishipping\Model\Checkout\Type\Multishipping` classes. +As result, we will get changed behaviour, new logic or something what our business need. For example: -``` + +```xml multishippingPaymentSpecification ``` + Yo can check this configuration and find more examples in the `etc/frontend/di.xml` file. - -More information about [type configuration](https://developer.adobe.com/commerce/php/development/build/dependency-injection-file/). +More information about [type configuration](https://developer.adobe.com/commerce/php/development/build/dependency-injection-file/). Extension developers can interact with the Magento_Multishipping module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://developer.adobe.com/commerce/php/development/components/plugins/). @@ -42,7 +43,7 @@ This module observes the following event: `etc/frontend/` - - `checkout_cart_save_before` in the `Magento\Multishipping\Observer\DisableMultishippingObserver` file. + - `checkout_cart_save_before` in the `Magento\Multishipping\Observer\DisableMultishippingObserver` file. The module dispatches the following events: @@ -78,7 +79,7 @@ The module interacts with the following layout handles: `view/frontend/layout` directory: - `checkout_cart_index` - + This module introduces the following layouts and layout handles: `view/frontend/layout` directory: @@ -135,5 +136,4 @@ Module introduces the new pages: More information about [layout types](https://developer.adobe.com/commerce/frontend-core/guide/layouts/types/). - For information about significant changes in patch releases, see [2.3.x Release information](https://experienceleague.adobe.com/docs/commerce-operations/release/notes/overview.html). diff --git a/app/code/Magento/MysqlMq/README.md b/app/code/Magento/MysqlMq/README.md index be9c23dda9bda..9da1e54fd787e 100644 --- a/app/code/Magento/MysqlMq/README.md +++ b/app/code/Magento/MysqlMq/README.md @@ -2,7 +2,7 @@ **Magento_MysqlMq** provides message queue implementation based on MySQL. -Module contain recurring script, declared in `Magento\MysqlMq\Setup\Recurring` +Module contain recurring script, declared in `Magento\MysqlMq\Setup\Recurring` class. This script is executed by Magento post each schema installation or upgrade stage and populates the queue table. @@ -14,7 +14,6 @@ Module creates the following tables: - `queue_message` - Queue messages - `queue_message_status` - Relation table to keep associations between queues and messages - For information about a module installation in Magento 2, see [Enable or disable modules](https://experienceleague.adobe.com/docs/commerce-operations/installation-guide/tutorials/manage-modules.html). ## Additional information diff --git a/app/code/Magento/NewRelicReporting/README.md b/app/code/Magento/NewRelicReporting/README.md index 97bceff86da3e..a2cebb0ee45ff 100644 --- a/app/code/Magento/NewRelicReporting/README.md +++ b/app/code/Magento/NewRelicReporting/README.md @@ -1,10 +1,11 @@ # Magento_NewRelicReporting module -This module implements integration New Relic APM and New Relic Insights with Magento, giving real-time visibility into business and performance metrics for data-driven decision making. +This module implements integration New Relic APM and New Relic Insights with Magento, giving real-time visibility into business and performance metrics for data-driven decision making. ## Installation Before installing this module, note that the Magento_NewRelicReporting is dependent on the following modules: + - `Magento_Store` - `Magento_Customer` - `Magento_Backend` @@ -13,6 +14,7 @@ Before installing this module, note that the Magento_NewRelicReporting is depend - `Magento_Config` This module creates the following tables in the database: + - `reporting_counts` - `reporting_module_status` - `reporting_orders` @@ -34,6 +36,7 @@ Extension developers can interact with the Magento_NewRelicReporting module. For ### Console commands The Magento_NewRelicReporting provides console commands: + - `bin/magento newrelic:create:deploy-marker []` - check the deploy queue for entries and create an appropriate deploy marker [Learn more about command's parameters](https://experienceleague.adobe.com/docs/commerce-operations/reference/magento-open-source.html#newreliccreatedeploy-marker). @@ -41,6 +44,7 @@ The Magento_NewRelicReporting provides console commands: ### Cron options Cron group configuration can be set at `etc/crontab.xml`: + - `magento_newrelicreporting_cron` - runs collecting all new relic reports [Learn how to configure and run cron in Magento.](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/cli/configure-cron-jobs.html). diff --git a/app/code/Magento/Newsletter/README.md b/app/code/Magento/Newsletter/README.md index b9aac71e222b2..b51cc7508d3fb 100644 --- a/app/code/Magento/Newsletter/README.md +++ b/app/code/Magento/Newsletter/README.md @@ -5,15 +5,18 @@ This module allows clients to subscribe for information about new promotions and ## Installation Before installing this module, note that the Magento_Newsletter is dependent on the following modules: + - `Magento_Store` - `Magento_Customer` - `Magento_Eav` - `Magento_Widget` Before disabling or uninstalling this module, note that the following modules depends on this module: + - `Magento_NewsletterGraphQl` This module creates the following tables in the database: + - `newsletter_subscriber` - `newsletter_template` - `newsletter_queue` @@ -34,6 +37,7 @@ A lot of functionality in the module is on JavaScript, use [mixins](https://deve ### Layouts This module introduces the following layouts in the `view/frontend/layout` and `view/adminhtml/layout` directories: + - `view/adminhtml/layout`: - `newsletter_problem_block` - `newsletter_problem_grid` @@ -53,7 +57,7 @@ This module introduces the following layouts in the `view/frontend/layout` and ` - `newsletter_template_preview` - `newsletter_template_preview_popup` - `preview` - + - `view/frontend/layout`: - `customer_account` - `customer_account_create` @@ -65,6 +69,7 @@ For more information about a layout in Magento 2, see the [Layout documentation] ### UI components This module extends customer form ui component the configuration file located in the `view/base/ui_component` directory: + - `customer_form` For information about a UI component in Magento 2, see [Overview of UI components](https://developer.adobe.com/commerce/frontend-core/ui-components/). @@ -76,7 +81,7 @@ For information about a UI component in Magento 2, see [Overview of UI component ### Cron options Cron group configuration can be set at `etc/crontab.xml`: + - `newsletter_send_all` - schedules newsletter sending [Learn how to configure and run cron in Magento.](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/cli/configure-cron-jobs.html). - diff --git a/app/code/Magento/OfflinePayments/README.md b/app/code/Magento/OfflinePayments/README.md index 1e9c3fb5426fb..8b34b3f2c4999 100644 --- a/app/code/Magento/OfflinePayments/README.md +++ b/app/code/Magento/OfflinePayments/README.md @@ -1,7 +1,8 @@ # Magento_OfflinePayments module -This module implements the payment methods which do not require interaction with a payment gateway (so called offline methods). +This module implements the payment methods which do not require interaction with a payment gateway (so called offline methods). These methods are the following: + - Bank transfer - Cash on delivery - Check / Money Order @@ -10,6 +11,7 @@ These methods are the following: ## Installation Before installing this module, note that the Magento_OfflinePayments is dependent on the following modules: + - `Magento_Store` - `Magento_Catalog` @@ -26,6 +28,7 @@ A lot of functionality in the module is on JavaScript, use [mixins](https://deve ### Layouts This module introduces the following layouts in the `view/frontend/layout` directory: + - `checkout_index_index` - `multishipping_checkout_billing` diff --git a/app/code/Magento/OfflineShipping/README.md b/app/code/Magento/OfflineShipping/README.md index c45767d3190da..440f2bc3e1541 100644 --- a/app/code/Magento/OfflineShipping/README.md +++ b/app/code/Magento/OfflineShipping/README.md @@ -1,7 +1,8 @@ # Magento_OfflineShipping module -This module implements the shipping methods which do not involve a direct interaction with shipping carriers, so called offline shipping methods. +This module implements the shipping methods which do not involve a direct interaction with shipping carriers, so called offline shipping methods. Namely, the following: + - Free Shipping - Flat Rate - Table Rates @@ -10,6 +11,7 @@ Namely, the following: ## Installation Before installing this module, note that the Magento_OfflineShipping is dependent on the following modules: + - `Magento_Store` - `Magento_Sales` - `Magento_Quote` @@ -19,6 +21,7 @@ Before installing this module, note that the Magento_OfflineShipping is dependen The Magento_OfflineShipping module creates the `shipping_tablerate` table in the database. This module modifies the following tables in the database: + - `salesrule` - adds column `simple_free_shipping` - `sales_order_item` - adds column `free_shipping` - `quote_address` - adds column `free_shipping` @@ -38,6 +41,7 @@ A lot of functionality in the module is on JavaScript, use [mixins](https://deve ### Layouts This module introduces the following layouts in the `view/frontend/layout` directory: + - `checkout_cart_index` - `checkout_index_index` @@ -46,6 +50,7 @@ For more information about a layout in Magento 2, see the [Layout documentation] ### UI components This module extends following ui components located in the `view/adminhtml/ui_component` directory: + - `sales_rule_form` - `salesrulestaging_update_form` @@ -54,6 +59,7 @@ For information about a UI component in Magento 2, see [Overview of UI component ## Additional information You can get more information about offline shipping methods in magento at the articles: + - [How to configure Free Shipping](https://docs.magento.com/user-guide/shipping/shipping-free.html) - [How to configure Flat Rate](https://docs.magento.com/user-guide/shipping/shipping-flat-rate.html) - [How to configure Table Rates](https://docs.magento.com/user-guide/shipping/shipping-table-rate.html) diff --git a/app/code/Magento/OpenSearch/README.md b/app/code/Magento/OpenSearch/README.md index 36ab12072d572..eeeffcd968ef3 100644 --- a/app/code/Magento/OpenSearch/README.md +++ b/app/code/Magento/OpenSearch/README.md @@ -1,3 +1,3 @@ -#Magento_OpenSearch module +# Magento_OpenSearch module Magento_OpenSearch module allows using OpenSearch 1.x engine for the product searching capabilities. diff --git a/app/code/Magento/PageCache/README.md b/app/code/Magento/PageCache/README.md index 1b109926fd9f0..30e46cb560d55 100644 --- a/app/code/Magento/PageCache/README.md +++ b/app/code/Magento/PageCache/README.md @@ -1,4 +1,4 @@ The PageCache module provides functionality of caching full pages content in Magento application. An administrator may switch between built-in caching and Varnish caching. Built-in caching is default and ready to use without the need of any external tools. Requests and responses are managed by PageCache plugin. It loads data from cache and returns a response. If data is not present in cache, it passes the request to Magento and waits for the response. Response is then saved in cache. Blocks can be set as private blocks by setting the property '_isScopePrivate' to true. These blocks contain personalized information and are not cached in the server. These blocks are being rendered using AJAX call after the page is loaded. Contents are cached in browser instead. -Blocks can also be set as non-cacheable by setting the 'cacheable' attribute in layout XML files. For example ``. Pages containing such blocks are not cached. \ No newline at end of file +Blocks can also be set as non-cacheable by setting the 'cacheable' attribute in layout XML files. For example ``. Pages containing such blocks are not cached. diff --git a/app/code/Magento/Paypal/README.md b/app/code/Magento/Paypal/README.md index 0ed4f2e90291b..555449257de5c 100644 --- a/app/code/Magento/Paypal/README.md +++ b/app/code/Magento/Paypal/README.md @@ -1,4 +1,5 @@ Module Magento\PayPal implements integration with the PayPal payment system. Namely, it enables the following payment methods: + * PayPal Express Checkout * PayPal Payments Standard * PayPal Payments Pro diff --git a/app/code/Magento/PaypalCaptcha/README.md b/app/code/Magento/PaypalCaptcha/README.md index 71588599a5ecd..02b1cd3c3f93a 100644 --- a/app/code/Magento/PaypalCaptcha/README.md +++ b/app/code/Magento/PaypalCaptcha/README.md @@ -1 +1 @@ -The PayPal Captcha module provides a possibility to enable Captcha validation on Payflow Pro payment form. \ No newline at end of file +The PayPal Captcha module provides a possibility to enable Captcha validation on Payflow Pro payment form. diff --git a/app/code/Magento/Persistent/README.md b/app/code/Magento/Persistent/README.md index abbf4482eda6c..3d2f19e4fc91b 100644 --- a/app/code/Magento/Persistent/README.md +++ b/app/code/Magento/Persistent/README.md @@ -9,12 +9,14 @@ checkbox during first login. ## Installation Before installing this module, note that the Magento_Persistent is dependent on the following modules: + - `Magento_Checkout` - `Magento_PageCache` The Magento_Persistent module creates the `persistent_session` table in the database. This module modifies the following tables in the database: + - `quote` - adds column `is_persistent` All database schema changes made by this module are rolled back when the module gets disabled and setup:upgrade command is run. @@ -50,12 +52,14 @@ For more information about a layout in Magento 2, see the [Layout documentation] ## Additional information More information can get at articles: + - [Persistent Shopping Cart](https://docs.magento.com/user-guide/configuration/customers/persistent-shopping-cart.html) - [Persistent Cart](https://experienceleague.adobe.com/docs/commerce-admin/stores-sales/point-of-purchase/cart/cart-persistent.html) ### Cron options Cron group configuration can be set at `etc/crontab.xml`: + - `persistent_clear_expired` - clear expired persistent sessions [Learn how to configure and run cron in Magento.](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/cli/configure-cron-jobs.html). diff --git a/app/code/Magento/ProductAlert/README.md b/app/code/Magento/ProductAlert/README.md index 76ee9f8066cd5..1d54f5e7b811b 100644 --- a/app/code/Magento/ProductAlert/README.md +++ b/app/code/Magento/ProductAlert/README.md @@ -5,16 +5,18 @@ This module enables product alerts, which allow customers to sign up for emails ## Installation Before installing this module, note that the Magento_ProductAlert is dependent on the following modules: + - `Magento_Catalog` - `Magento_Customer` The Magento_ProductAlert module creates the following tables in the database: + - `product_alert_price` - `product_alert_stock` All database schema changes made by this module are rolled back when the module gets disabled and setup:upgrade command is run. -The Magento_ProductAlert module contains the recurring script. Script's modifications don't need to be manually reverted upon uninstallation. +The Magento_ProductAlert module contains the recurring script. Script's modifications don't need to be manually reverted upon uninstallation. For information about a module installation in Magento 2, see [Enable or disable modules](https://experienceleague.adobe.com/docs/commerce-operations/installation-guide/tutorials/manage-modules.html). @@ -27,6 +29,7 @@ Extension developers can interact with the Magento_ProductAlert module. For more ### Layouts This module introduces the following layouts in the `view/frontend/layout` directory: + - `catalog_product_view` - `productalert_unsubscribe_email` @@ -35,13 +38,14 @@ For more information about a layout in Magento 2, see the [Layout documentation] ## Additional information More information can get at articles: + - [Product Alerts](https://docs.magento.com/user-guide/catalog/inventory-product-alerts.html) - [Product Alert Run Settings](https://docs.magento.com/user-guide/catalog/inventory-product-alert-run-settings.html) ### Cron options Cron group configuration can be set at `etc/crontab.xml`: + - `catalog_product_alert` - send product alerts to customers [Learn how to configure and run cron in Magento.](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/cli/configure-cron-jobs.html). - diff --git a/app/code/Magento/ProductVideo/README.md b/app/code/Magento/ProductVideo/README.md index a36a1f777c655..f3b9926dd111b 100644 --- a/app/code/Magento/ProductVideo/README.md +++ b/app/code/Magento/ProductVideo/README.md @@ -5,6 +5,7 @@ This module implements functionality related with linking video files from exter ## Installation Before installing this module, note that the Magento_ProductAlert is dependent on the following modules: + - `Magento_Catalog` - `Magento_Backend` @@ -25,6 +26,7 @@ A lot of functionality in the module is on JavaScript, use [mixins](https://deve ### Layouts This module introduces the following layouts in the `view/frontend/layout` and `view/adminhtml/layout` directories: + - `view/adminhtml/layout` - `catalog_product_new` - `view/frontend/layout` @@ -35,6 +37,7 @@ For more information about a layout in Magento 2, see the [Layout documentation] ### UI components This module extends following ui components located in the `view/adminhtml/ui_component` directory: + - `product_form` For information about a UI component in Magento 2, see [Overview of UI components](https://developer.adobe.com/commerce/frontend-core/ui-components/). @@ -42,5 +45,6 @@ For information about a UI component in Magento 2, see [Overview of UI component ## Additional information More information can get at articles: + - [Learn how to add Product Video](https://docs.magento.com/user-guide/catalog/product-video.html) - [Learn how to configure Product Video](https://developer.adobe.com/commerce/frontend-core/guide/themes/product-video/) diff --git a/app/code/Magento/Quote/README.md b/app/code/Magento/Quote/README.md index 4c3cf42359f0c..439b902ca9946 100644 --- a/app/code/Magento/Quote/README.md +++ b/app/code/Magento/Quote/README.md @@ -7,6 +7,7 @@ This module provides customer cart management functionality. The Magento_Quote module is one of the base Magento 2 modules. You cannot disable or uninstall this module. The Magento_Quote module creates the following table in the database: + - `quote` - `quote_address` - `quote_item` @@ -27,6 +28,7 @@ Extension developers can interact with the Magento_Quote module. For more inform ### Events The module dispatches the following events: + - `sales_quote_address_collection_load_after` event in the `\Magento\Quote\Model\ResourceModel\Quote\Address\Collection::_afterLoad` method. Parameters: - `quote_address_collection` is a `$this` object (`Magento\Quote\Model\ResourceModel\Quote\Address\Collection` class) @@ -108,7 +110,7 @@ The module dispatches the following events: - `sales_quote_item_collection_products_after_load` event in the `\Magento\Quote\Model\QuoteManagement::_assignProducts` method. Parameters: - `collection` is a product collection object (`\Magento\Catalog\Model\ResourceModel\Product\Collection` class) -For information about an event in Magento 2, see [Events and observers](https://developer.adobe.com/commerce/php/development/components/events-and-observers/#events). +For information about an event in Magento 2, see [Events and observers](https://developer.adobe.com/commerce/php/development/components/events-and-observers/#events). ### Public APIs @@ -169,7 +171,7 @@ For information about an event in Magento 2, see [Events and observers](https:// - `\Magento\Quote\Api\ChangeQuoteControlInterface` - checks if user is allowed to change the quote - + #### Guest - `\Magento\Quote\Api\GuestBillingAddressManagementInterface` @@ -180,7 +182,7 @@ For information about an event in Magento 2, see [Events and observers](https:// - gets lists items that are assigned to a specified quote - add/update the specified cart guest item - removes the specified item from the specified quote - + - `\Magento\Quote\Api\GuestCouponManagementInterface` - gets coupon for a specified quote by quote ID - adds a coupon by code to a specified quote @@ -205,7 +207,7 @@ For information about an event in Magento 2, see [Events and observers](https:// - `\Magento\Quote\Api\GuestCartRepositoryInterface` - gets quote by quote ID for guest user - + - `\Magento\Quote\Api\GuestCartTotalManagementInterface` - sets shipping/billing methods and additional data for a quote and collect totals for guest @@ -237,7 +239,7 @@ For information about an event in Magento 2, see [Events and observers](https:// - returns information for the quote for a specified customer - assigns a specified customer to a specified shopping quote - places an order for a specified quote - + - `\Magento\Quote\Api\CartRepositoryInterface` - gets quote by quote ID - gets list carts that match specified search criteria @@ -252,7 +254,7 @@ For information about an event in Magento 2, see [Events and observers](https:// - `\Magento\Quote\Api\CartTotalRepositoryInterface` - gets quote totals by quote ID - + - `\Magento\Quote\Api\CouponManagementInterface` - gets coupon for a specified quote by quote ID - adds a coupon by code to a specified quote @@ -278,20 +280,19 @@ For information about an event in Magento 2, see [Events and observers](https:// - `\Magento\Quote\Model\ShippingMethodManagementInterface` - sets the carrier and shipping methods codes for a specified quote - gets the selected shipping method for a specified quote - + #### Model - + - `\Magento\Quote\Model\Quote\Address\FreeShippingInterface` - checks if is a free shipping - `\Magento\Quote\Model\Quote\Address\RateCollectorInterface` - retrieves all methods for supplied shipping data - + - `\Magento\Quote\Model\MaskedQuoteIdToQuoteIdInterface` - converts masked quote ID to the quote ID (entity ID) - `\Magento\Quote\Model\QuoteIdToMaskedQuoteIdInterface` - converts quote ID to the masked quote ID - -For information about a public API in Magento 2, see [Public interfaces & APIs](https://developer.adobe.com/commerce/php/development/components/api-concepts/). +For information about a public API in Magento 2, see [Public interfaces & APIs](https://developer.adobe.com/commerce/php/development/components/api-concepts/). diff --git a/app/code/Magento/QuoteAnalytics/README.md b/app/code/Magento/QuoteAnalytics/README.md index c7abc18ffccbe..e9e220549ab44 100644 --- a/app/code/Magento/QuoteAnalytics/README.md +++ b/app/code/Magento/QuoteAnalytics/README.md @@ -5,6 +5,7 @@ This module configures data definitions for a data collection related to the Quo ## Installation Before installing this module, note that the Magento_QuoteAnalytics is dependent on the following modules: + - `Magento_Quote` - `Magento_Analytics` @@ -15,5 +16,6 @@ For information about a module installation in Magento 2, see [Enable or disable ## Additional data More information can get at articles: + - [Advanced Reporting](https://developer.adobe.com/commerce/php/development/advanced-reporting/) - [Data collection for advanced reporting](https://developer.adobe.com/commerce/php/development/advanced-reporting/data-collection/) diff --git a/app/code/Magento/QuoteGraphQl/README.md b/app/code/Magento/QuoteGraphQl/README.md index 396f886fc04be..7eebc7c5e5291 100644 --- a/app/code/Magento/QuoteGraphQl/README.md +++ b/app/code/Magento/QuoteGraphQl/README.md @@ -6,6 +6,7 @@ to generate quote (cart) information endpoints. Also provides endpoints for modi ## Installation Before installing this module, note that the Magento_QuoteGraphQl is dependent on the following modules: + - `Magento_CatalogGraphQl` This module does not introduce any database schema modifications or new data. @@ -20,7 +21,7 @@ Extension developers can interact with the Magento_QuoteDownloadableLinks module ## Additional information -You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql). +You can get more information about [GraphQl In Magento 2](https://developer.adobe.com/commerce/webapi/graphql/). ### GraphQl Query diff --git a/app/code/Magento/RelatedProductGraphQl/README.md b/app/code/Magento/RelatedProductGraphQl/README.md index 7aa93403a6949..d25286e686aed 100644 --- a/app/code/Magento/RelatedProductGraphQl/README.md +++ b/app/code/Magento/RelatedProductGraphQl/README.md @@ -16,4 +16,4 @@ Extension developers can interact with the Magento_QuoteDownloadableLinks module ## Additional information -You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql). +You can get more information about [GraphQl In Magento 2](https://developer.adobe.com/commerce/webapi/graphql/). diff --git a/app/code/Magento/ReleaseNotification/README.md b/app/code/Magento/ReleaseNotification/README.md index 060aeb24f473a..c6e55ab091bc3 100644 --- a/app/code/Magento/ReleaseNotification/README.md +++ b/app/code/Magento/ReleaseNotification/README.md @@ -19,6 +19,7 @@ Extension developers can interact with the Magento_ReleaseNotification module. F ### UI components You can extend release notification updates using the configuration files located in the `view/adminhtml/ui_component` directory: + - `release_notification` For information about a UI component in Magento 2, see [Overview of UI components](https://developer.adobe.com/commerce/frontend-core/ui-components/). @@ -27,19 +28,19 @@ For information about a UI component in Magento 2, see [Overview of UI component ### Purpose and Content -* Provides a method of notifying administrators of changes, features, and functionality being introduced in a Magento release. -* Displays a modal containing a high level overview of the features included in the installed or upgraded release of Magento upon the initial login of each administrator into the Admin Panel for a given Magento version. -* The modal is enabled with pagination functionality to allow for easy navigation between each modal page. -* Each modal page includes detailed information about a highlighted feature of the Magento release or other notification. -* Release Notification modal content is determined and provided by Magento Marketing. +- Provides a method of notifying administrators of changes, features, and functionality being introduced in a Magento release. +- Displays a modal containing a high level overview of the features included in the installed or upgraded release of Magento upon the initial login of each administrator into the Admin Panel for a given Magento version. +- The modal is enabled with pagination functionality to allow for easy navigation between each modal page. +- Each modal page includes detailed information about a highlighted feature of the Magento release or other notification. +- Release Notification modal content is determined and provided by Magento Marketing. ### Content Retrieval Release notification content is maintained by Magento for each Magento version, edition, and locale. To retrieve the content, a response is returned from a request with the following parameters: -* **version** = The Magento version that the client has installed (ex. 2.4.0). -* **edition** = The Magento edition that the client has installed (ex. Community). -* **locale** = The chosen locale of the admin user (ex. en_US). +- **version** = The Magento version that the client has installed (ex. 2.4.0). +- **edition** = The Magento edition that the client has installed (ex. Community). +- **locale** = The chosen locale of the admin user (ex. en_US). The module will make three attempts to retrieve content for the parameters in the order listed: @@ -51,21 +52,21 @@ If there is no content to be retrieved after these requests, the release notific ### Content Guidelines -The modal system in the ReleaseNotification module can have up to four modal pages. The admin user can navigate between pages using the "< Prev" and "Next >" buttons at the bottom of the modal. The last modal page will have a "Done" button that will close the modal and record that the admin user has seen the notification. +The modal system in the ReleaseNotification module can have up to four modal pages. The admin user can navigate between pages using the "< Prev" and "Next >" buttons at the bottom of the modal. The last modal page will have a "Done" button that will close the modal and record that the admin user has seen the notification. Each modal page can have the following optional content: -* Main Content - * Title - * URL to the image to be displayed alongside the title - * Text body - * Bullet point list -* Sub Headings (highlighted overviews of the content to be detailed on subsequent modal pages) - one to three Sub Headings may be displayed - * Sub heading title - * URL to the image to be display before the sub heading title - * Sub heading content -* Footer - * Footer content text +- Main Content + - Title + - URL to the image to be displayed alongside the title + - Text body + - Bullet point list +- Sub Headings (highlighted overviews of the content to be detailed on subsequent modal pages) - one to three Sub Headings may be displayed + - Sub heading title + - URL to the image to be display before the sub heading title + - Sub heading content +- Footer + - Footer content text The Sub Heading section is ideally used on the first modal page as a way to describe one to three highlighted features that will be presented in greater detail on the following modal pages. It is recommended to use the Main Content -> Text Body and Bullet Point lists as the paragraph and list content displayed on a highlighted feature's detail modal page. diff --git a/app/code/Magento/ReleaseNotification/i18n/en_US.csv b/app/code/Magento/ReleaseNotification/i18n/en_US.csv index 178482dc7a980..50a4587b4398c 100644 --- a/app/code/Magento/ReleaseNotification/i18n/en_US.csv +++ b/app/code/Magento/ReleaseNotification/i18n/en_US.csv @@ -5,11 +5,11 @@ "We’ll try to show it again the next time you sign in to Magento Admin.

To learn more about new features, see our latest Release Notes in - DevDocs' Release Information.

]]>","We’ll try to show it again the next time you sign in to Magento Admin.

To learn more about new features, see our latest Release Notes in - DevDocs' Release Information.

]]>" diff --git a/app/code/Magento/ReleaseNotification/view/adminhtml/ui_component/release_notification.xml b/app/code/Magento/ReleaseNotification/view/adminhtml/ui_component/release_notification.xml index 9c6d152bed27b..16b7b94da858b 100644 --- a/app/code/Magento/ReleaseNotification/view/adminhtml/ui_component/release_notification.xml +++ b/app/code/Magento/ReleaseNotification/view/adminhtml/ui_component/release_notification.xml @@ -67,7 +67,7 @@ We’ll try to show it again the next time you sign in to Magento Admin.

To learn more about new features, see our latest Release Notes in - DevDocs' Release Information.

]]> @@ -127,7 +127,7 @@ We’ll try to show it again the next time you sign in to Magento Admin.

To learn more about new features, see our latest Release Notes in - DevDocs' Release Information.

]]> @@ -208,7 +208,7 @@ We’ll try to show it again the next time you sign in to Magento Admin.

To learn more about new features, see our latest Release Notes in - DevDocs' Release Information.

]]> @@ -289,7 +289,7 @@ We’ll try to show it again the next time you sign in to Magento Admin.

To learn more about new features, see our latest Release Notes in - DevDocs' Release Information.

]]> diff --git a/app/code/Magento/Reports/README.md b/app/code/Magento/Reports/README.md index 1fac1a15782cb..3d90323a3ee5d 100644 --- a/app/code/Magento/Reports/README.md +++ b/app/code/Magento/Reports/README.md @@ -1,4 +1,5 @@ Magento_Reports module provides ability to collect various reports such as: + - products reports (bestsellers, low stock, most viewed, products ordered), - sales reports (orders, tax, invoiced, shipping, refunds, coupons, and PayPal settlement reports), - customer reports (new accounts, customer by order totals, customers by number of orders), diff --git a/app/code/Magento/RequireJs/README.md b/app/code/Magento/RequireJs/README.md index 8ed9f88095606..55573d9c5fafd 100644 --- a/app/code/Magento/RequireJs/README.md +++ b/app/code/Magento/RequireJs/README.md @@ -1,12 +1,15 @@ # Overview + ## Purpose of module The Magento\RequireJs module introduces support for RequireJs JavaScript library and provides infrastructure for other modules to have them declared related configuration for RequireJs library. # Deployment + ## System requirements The Magento\RequireJs module does not have any specific system requirements. ## Install + The Magento\RequireJs module is installed automatically (using the native Magento Setup). No additional actions required. diff --git a/app/code/Magento/Robots/README.md b/app/code/Magento/Robots/README.md index 936dbe973a3ee..c2fe027715f67 100644 --- a/app/code/Magento/Robots/README.md +++ b/app/code/Magento/Robots/README.md @@ -1,3 +1,4 @@ -The Robots module provides the following functionalities: +The Robots module provides the following functionalities: + * contains a router to match application action class for requests to the `robots.txt` file; * allows obtaining the content of the `robots.txt` file depending on the settings of the current website. diff --git a/app/code/Magento/Sales/README.md b/app/code/Magento/Sales/README.md index 69068f5bfc5dc..9d4f6c369587a 100644 --- a/app/code/Magento/Sales/README.md +++ b/app/code/Magento/Sales/README.md @@ -1,8 +1,10 @@ # Overview + ## Purpose of module Magento\Sales module is responsible for order processing and appearance in system, Magento\Sales module manages next system entities and flows: + * order management; * invoice management; * shipment management (including tracks management); @@ -10,10 +12,12 @@ Magento\Sales module manages next system entities and flows: Magento\Sales module is required for Magento\Checkout module to perform checkout operations. # Deployment + ## System requirements The Magento_Sales module does not have any specific system requirements. Depending on how many orders are being placed, there might be consideration for the database size ## Install + The Magento_Sales module is installed automatically (using the native Magento install mechanism) without any additional actions. diff --git a/app/code/Magento/SalesRule/README.md b/app/code/Magento/SalesRule/README.md index 88fb4e2acd45d..1f693e18c9ecf 100644 --- a/app/code/Magento/SalesRule/README.md +++ b/app/code/Magento/SalesRule/README.md @@ -1,2 +1 @@ SalesRule module is responsible for managing and processing Promotion Shopping Cart Rules. - diff --git a/app/code/Magento/SalesSequence/README.md b/app/code/Magento/SalesSequence/README.md index ab34b8a233e2c..4cea80e4334d6 100644 --- a/app/code/Magento/SalesSequence/README.md +++ b/app/code/Magento/SalesSequence/README.md @@ -1,8 +1,10 @@ # Overview + ## Purpose of module Magento\SalesSequence module is responsible for sequences processing in Sales module, Magento\SalesSequence module manages sequences for next system entities and flows: + * order; * invoice; * shipment; @@ -10,9 +12,11 @@ Magento\SalesSequence module manages sequences for next system entities and flow Magento\SalesSequence module is required for Magento\Sales module. # Deployment + ## System requirements The Magento_SalesSequence module does not have any specific system requirements. ## Install + The Magento_SalesSequence module is installed automatically (using the native Magento install mechanism) without any additional actions. diff --git a/app/code/Magento/SampleData/README.md b/app/code/Magento/SampleData/README.md index 3e66c2cc1c7b0..569a5a3eb9711 100644 --- a/app/code/Magento/SampleData/README.md +++ b/app/code/Magento/SampleData/README.md @@ -23,7 +23,8 @@ To deploy sample data from the Magento composer repository using Magento CLI: To deploy sample data from the Magento composer repository without Magento CLI: 1. Specify sample data packages in the `require` section of the root `composer.json` file, for example: -``` + +```json { "require": { ... diff --git a/app/code/Magento/Security/README.md b/app/code/Magento/Security/README.md index 76ece8057edc7..2522ef72d5435 100644 --- a/app/code/Magento/Security/README.md +++ b/app/code/Magento/Security/README.md @@ -2,6 +2,7 @@ **Security** management module _Main features:_ + 1. Added support for simultaneous admin user logins with ability to enable/disable the feature, review and disconnect the list of current logged in sessions 2. Added password complexity configuration 3. Enhanced security to prevent account takeover for sessions opened on public computers and similar: diff --git a/app/code/Magento/Sitemap/README.md b/app/code/Magento/Sitemap/README.md index 1bca90e32eaad..fe2d0bb17d894 100644 --- a/app/code/Magento/Sitemap/README.md +++ b/app/code/Magento/Sitemap/README.md @@ -1,2 +1,2 @@ The Sitemap module allows managing the Magento application sitemap and -[sitemap.xml](http://en.wikipedia.org/wiki/Sitemaps) for searching engines. \ No newline at end of file +[sitemap.xml](http://en.wikipedia.org/wiki/Sitemaps) for searching engines. diff --git a/app/code/Magento/Store/README.md b/app/code/Magento/Store/README.md index 877dd4a3cab25..f56b8c6bcdc37 100644 --- a/app/code/Magento/Store/README.md +++ b/app/code/Magento/Store/README.md @@ -1,4 +1,4 @@ The Store module provides one of the basic and major features of a content management system for e-commerce web sites by creating and managing a store for the customers to conduct online-shopping. Stores can be combined in groups, and are linked to a specific website. All store related configurations (currency, locale, scope etc.), management and -storage maintenance are covered under this module. \ No newline at end of file +storage maintenance are covered under this module. diff --git a/app/code/Magento/SwaggerWebapi/README.md b/app/code/Magento/SwaggerWebapi/README.md index 3529848949d77..7efa4089a4f09 100644 --- a/app/code/Magento/SwaggerWebapi/README.md +++ b/app/code/Magento/SwaggerWebapi/README.md @@ -1 +1 @@ -The Magento_SwaggerWebapi module provides the implementation of the REST Webapi module with Magento_Swagger. \ No newline at end of file +The Magento_SwaggerWebapi module provides the implementation of the REST Webapi module with Magento_Swagger. diff --git a/app/code/Magento/SwaggerWebapiAsync/README.md b/app/code/Magento/SwaggerWebapiAsync/README.md index 373733639c65c..3eeb7a1566c93 100644 --- a/app/code/Magento/SwaggerWebapiAsync/README.md +++ b/app/code/Magento/SwaggerWebapiAsync/README.md @@ -1 +1 @@ -The Magento_SwaggerWebapiAsync module provides the implementation of the Asynchronous WebApi module with Magento_Swagger. \ No newline at end of file +The Magento_SwaggerWebapiAsync module provides the implementation of the Asynchronous WebApi module with Magento_Swagger. diff --git a/app/code/Magento/Swatches/README.md b/app/code/Magento/Swatches/README.md index 801a8f32f3fc5..507ce9a8a02b8 100644 --- a/app/code/Magento/Swatches/README.md +++ b/app/code/Magento/Swatches/README.md @@ -1 +1 @@ -Magento_Swatches module is replacing default product attributes text values with swatch images, for more convenient product displaying and selection. \ No newline at end of file +Magento_Swatches module is replacing default product attributes text values with swatch images, for more convenient product displaying and selection. diff --git a/app/code/Magento/SwatchesLayeredNavigation/README.md b/app/code/Magento/SwatchesLayeredNavigation/README.md index 7199bfa628634..fb21b4dc10de4 100644 --- a/app/code/Magento/SwatchesLayeredNavigation/README.md +++ b/app/code/Magento/SwatchesLayeredNavigation/README.md @@ -5,16 +5,20 @@ The **Magento_SwatchesLayeredNavigation** module enables LayeredNavigation functionality for Swatch attributes ## Backward incompatible changes + No backward incompatible changes ## Dependencies + The **Magento_SwatchesLayeredNavigation** is dependent on the following modules: - Magento_Swatches - Magento_LayeredNavigation ## Specific Settings + The **Magento_SwatchesLayeredNavigation** module does not provide any specific settings. ## Specific Extension Points + The **Magento_SwatchesLayeredNavigation** module does not provide any specific extension points. You can extend it using the Magento extension mechanism. diff --git a/app/code/Magento/Tax/README.md b/app/code/Magento/Tax/README.md index f449b1c6c6cba..5f3193d438214 100644 --- a/app/code/Magento/Tax/README.md +++ b/app/code/Magento/Tax/README.md @@ -1,11 +1,14 @@ # Overview + ## Purpose of module + The Magento_Tax module provides the calculations needed to compute the consumption tax on goods and services. The Magento_Tax module includes the following: + * configuration of the tax rates and rules to apply * configuration of tax classes that apply to: -** taxation on products +**taxation on products ** taxation on shipping charges ** taxation on gift options (example: gift wrapping) * specification whether the consumption tax is "sales & use" (typically product prices are loaded without any tax) or "VAT" (typically product prices are loaded including tax) @@ -13,20 +16,25 @@ The Magento_Tax module includes the following: * display of prices (presented with tax, without tax, or both with and without) The Magento_Tax module also handles special cases when computing tax, such as: + * determining the tax on an individual item (for example, one that is being returned) when the original tax has been computed on the entire shopping cart ** example country: United States * being able to handle 2 or more tax rates that are applied separately (examples include a "luxury tax" on exclusive items) * being able to handle a subsequent tax rate that is applied after a previous one is applied (a "tax on tax" situation, which recently was a part of Canadian tax law) # Deployment + ## System requirements + The Magento_Tax module does not have any specific system requirements. Depending on how many tax rates and tax rules are being used, there might be consideration for the database size Depending on the frequency of updating tax rates and tax rules, there might be consideration for the scheduling of these updates ## Install + The Magento_Tax module is installed automatically (using the native Magento install mechanism) without any additional actions. ## Uninstall -The Magento_Tax module should not be uninstalled; it is a required module. \ No newline at end of file + +The Magento_Tax module should not be uninstalled; it is a required module. diff --git a/app/code/Magento/Theme/README.md b/app/code/Magento/Theme/README.md index 9035df6395263..4bd55394389a3 100644 --- a/app/code/Magento/Theme/README.md +++ b/app/code/Magento/Theme/README.md @@ -1 +1 @@ -The Theme module contains common infrastructure that provides an ability to apply and use themes in Magento application. \ No newline at end of file +The Theme module contains common infrastructure that provides an ability to apply and use themes in Magento application. diff --git a/app/code/Magento/Ui/README.md b/app/code/Magento/Ui/README.md index b7dd1a858e4a8..cc3105258bbd6 100644 --- a/app/code/Magento/Ui/README.md +++ b/app/code/Magento/Ui/README.md @@ -1,12 +1,15 @@ # Overview + ## Purpose of module The Magento\Ui module introduces a set of common UI components, which could be used and configured via layout XML files. # Deployment + ## System requirements The Magento\Ui module does not have any specific system requirements. ## Install + The Magento\Ui module is installed automatically (using the native Magento Setup). No additional actions required. diff --git a/app/code/Magento/Webapi/README.md b/app/code/Magento/Webapi/README.md index 26f7ad9f09ebd..cfa33741133f2 100644 --- a/app/code/Magento/Webapi/README.md +++ b/app/code/Magento/Webapi/README.md @@ -2,4 +2,4 @@ **Webapi** provides the framework for the application to expose REST and SOAP web services. It exposes an area for REST and another area for SOAP services and routes requests based on the Webapi configuration. It also handles -deserialization of requests and serialization of responses. +deserialization of requests and serialization of responses. diff --git a/app/code/Magento/Weee/README.md b/app/code/Magento/Weee/README.md index b3d59174a8337..64d6973e048cd 100644 --- a/app/code/Magento/Weee/README.md +++ b/app/code/Magento/Weee/README.md @@ -88,7 +88,7 @@ For more information about a layout, see the [Layout documentation](https://deve ### UI components -You can extend a customer form and widgets using the configuration files located in the directories +You can extend a customer form and widgets using the configuration files located in the directories - `view/adminhtml/ui_component`: - `product_attribute_add_form` diff --git a/app/code/Magento/Widget/README.md b/app/code/Magento/Widget/README.md index ee4594e1cef2b..4eff2e758b4c4 100644 --- a/app/code/Magento/Widget/README.md +++ b/app/code/Magento/Widget/README.md @@ -37,5 +37,5 @@ This module introduces the following layouts and layout handles in the directori - `view/frantend/layout`: - `default` - `print` - + For more information about a layout, see the [Layout documentation](https://developer.adobe.com/commerce/frontend-core/guide/layouts/). diff --git a/app/code/Magento/Wishlist/README.md b/app/code/Magento/Wishlist/README.md index a0ec7d70d9955..3c1d0af7390c5 100644 --- a/app/code/Magento/Wishlist/README.md +++ b/app/code/Magento/Wishlist/README.md @@ -85,12 +85,13 @@ This module introduces the following layouts and layout handles in the directori - `wishlist_index_index` - `wishlist_index_share` - `wishlist_shared_index.xml` - + For more information about a layout, see the [Layout documentation](https://developer.adobe.com/commerce/frontend-core/guide/layouts/). ### UI components -You can extend a customer form and widgets using the configuration files located in the directories +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`: diff --git a/dev/tests/static/testsuite/Magento/Test/Legacy/LegacyFixtureTest.php b/dev/tests/static/testsuite/Magento/Test/Legacy/LegacyFixtureTest.php index e99ce8fb84adf..02361244d5a99 100644 --- a/dev/tests/static/testsuite/Magento/Test/Legacy/LegacyFixtureTest.php +++ b/dev/tests/static/testsuite/Magento/Test/Legacy/LegacyFixtureTest.php @@ -22,7 +22,7 @@ class LegacyFixtureTest extends TestCase */ public function testNew(): void { - $docUrl = 'https://devdocs.magento.com/guides/v2.4/test/integration/parameterized_data_fixture.html'; + $docUrl = 'https://developer.adobe.com/commerce/testing/guide/integration/attributes/data-fixture/'; $files = AddedFiles::getAddedFilesList(__DIR__ . '/..'); $legacyFixtureFiles = []; foreach ($files as $file) { diff --git a/lib/internal/Magento/Framework/App/Cache/README.md b/lib/internal/Magento/Framework/App/Cache/README.md index 4f6964d150fef..43bbcbf8deec1 100644 --- a/lib/internal/Magento/Framework/App/Cache/README.md +++ b/lib/internal/Magento/Framework/App/Cache/README.md @@ -1,6 +1,7 @@ Components of Magento application use caches in their implementation. The **Magento\Cache** library provides an interface for cache storage and segmentation (a.k.a. "types"). **Magento\Framework\App\Cache** extends **Magento\Cache** and provides more specific features: + * State of cache segments (enabled/disabled) and managing their state * Pool of cache frontends * List of cache segments (types) diff --git a/lib/internal/Magento/Framework/App/README.md b/lib/internal/Magento/Framework/App/README.md index 87665be48425a..99736f9f8018a 100644 --- a/lib/internal/Magento/Framework/App/README.md +++ b/lib/internal/Magento/Framework/App/README.md @@ -3,16 +3,17 @@ Unlike other components of **Magento\Framework** that are generic libraries not specific to Magento application, the **Magento\Framework\App** is "aware of" Magento application intentionally. The library implements a variety of features of the Magento application: - * bootstrap and initialization parameters - * error handling - * entry point handlers (application scripts): + +* bootstrap and initialization parameters +* error handling +* entry point handlers (application scripts): * HTTP -- the web-application entry point for serving pages of Storefront, Admin, etc * Static Resource -- for retrieving and serving static content (CSS, JavaScript, images) * Cron -- for launching cron jobs - * Object manager, filesystem components (inheritors specific to Magento application) - * Caching, cache types - * Language packages, dictionaries - * DB connection configuration and pool - * Request dispatching, routing, front controller - * Services for view layer - * Application areas +* Object manager, filesystem components (inheritors specific to Magento application) +* Caching, cache types +* Language packages, dictionaries +* DB connection configuration and pool +* Request dispatching, routing, front controller +* Services for view layer +* Application areas diff --git a/lib/internal/Magento/Framework/Archive/README.md b/lib/internal/Magento/Framework/Archive/README.md index 4fa38a201db6e..197089214b0a7 100644 --- a/lib/internal/Magento/Framework/Archive/README.md +++ b/lib/internal/Magento/Framework/Archive/README.md @@ -1,4 +1,5 @@ Archive library provides functionalities for archiving files including following formats: + * tar * gz -* bzip2 \ No newline at end of file +* bzip2 diff --git a/lib/internal/Magento/Framework/Async/README.md b/lib/internal/Magento/Framework/Async/README.md index f71598637601c..ac4b9772a562c 100644 --- a/lib/internal/Magento/Framework/Async/README.md +++ b/lib/internal/Magento/Framework/Async/README.md @@ -1 +1 @@ -Async library provides classes to work with asynchronous/deferred operations, for instance sending an HTTP request. \ No newline at end of file +Async library provides classes to work with asynchronous/deferred operations, for instance sending an HTTP request. diff --git a/lib/internal/Magento/Framework/Backup/README.md b/lib/internal/Magento/Framework/Backup/README.md index e3785a3025e33..4cddf00d77b9b 100644 --- a/lib/internal/Magento/Framework/Backup/README.md +++ b/lib/internal/Magento/Framework/Backup/README.md @@ -1 +1 @@ -The Backup library provides functions to create and rollback backup types such as database, filesystem and media. It also provides an archiving facility. \ No newline at end of file +The Backup library provides functions to create and rollback backup types such as database, filesystem and media. It also provides an archiving facility. diff --git a/lib/internal/Magento/Framework/Bulk/README.md b/lib/internal/Magento/Framework/Bulk/README.md index 8ddbc686147ff..d0ee4069093f3 100644 --- a/lib/internal/Magento/Framework/Bulk/README.md +++ b/lib/internal/Magento/Framework/Bulk/README.md @@ -1 +1 @@ - This component is designed to provide Bulk Operations Framework. \ No newline at end of file + This component is designed to provide Bulk Operations Framework. diff --git a/lib/internal/Magento/Framework/Code/README.md b/lib/internal/Magento/Framework/Code/README.md index 6868b68e8d881..c058607922093 100644 --- a/lib/internal/Magento/Framework/Code/README.md +++ b/lib/internal/Magento/Framework/Code/README.md @@ -1,6 +1,7 @@ # Code **Code** library provides functionalities for processing code, including the following: + * Generating service entities - factories, proxies and interceptors. * Minifying content * Class, arguments reader diff --git a/lib/internal/Magento/Framework/Communication/README.md b/lib/internal/Magento/Framework/Communication/README.md index cf0dce084c5dc..105b0a8afec7b 100644 --- a/lib/internal/Magento/Framework/Communication/README.md +++ b/lib/internal/Magento/Framework/Communication/README.md @@ -1,2 +1,2 @@ This component provides capabilities for connection to remote systems using any available transport mechanisms. -Concrete transport implementations are provided by other components. \ No newline at end of file +Concrete transport implementations are provided by other components. diff --git a/lib/internal/Magento/Framework/Component/README.md b/lib/internal/Magento/Framework/Component/README.md index 6e99e472cb799..02df6996bc65b 100644 --- a/lib/internal/Magento/Framework/Component/README.md +++ b/lib/internal/Magento/Framework/Component/README.md @@ -2,20 +2,27 @@ **Component** library provides feature for components (modules/themes/languages/libraries) to load from any custom directory like vendor. + * Modules should be registered using -``` + +```php ComponentRegistrar::register(ComponentRegistrar::MODULE, '', __DIR__); ``` + * Themes should be registered using -``` + +```php ComponentRegistrar::register(ComponentRegistrar::THEME, '', __DIR__); ``` + * Languages should be registered using -``` + +```php ComponentRegistrar::register(ComponentRegistrar::LANGUAGE, '', __DIR__); ``` + * Libraries should be registered using -``` + +```php ComponentRegistrar::register(ComponentRegistrar::LIBRARY, '', __DIR__); ``` - diff --git a/lib/internal/Magento/Framework/Console/README.md b/lib/internal/Magento/Framework/Console/README.md index 245b85a27d4ea..534436c2dc69d 100644 --- a/lib/internal/Magento/Framework/Console/README.md +++ b/lib/internal/Magento/Framework/Console/README.md @@ -4,7 +4,7 @@ This component contains Magento Cli and can be extended via DI configuration. For example we can introduce new command in module using di.xml: -``` +```xml @@ -13,4 +13,3 @@ For example we can introduce new command in module using di.xml: ``` - diff --git a/lib/internal/Magento/Framework/Controller/README.md b/lib/internal/Magento/Framework/Controller/README.md index ec10676d52620..bf1649b0f4c29 100644 --- a/lib/internal/Magento/Framework/Controller/README.md +++ b/lib/internal/Magento/Framework/Controller/README.md @@ -4,4 +4,4 @@ * **Response** * Adapter for Zend Response class. Needed for DI -* **Router** * Route Factory \ No newline at end of file +* **Router** * Route Factory diff --git a/lib/internal/Magento/Framework/Crontab/README.md b/lib/internal/Magento/Framework/Crontab/README.md index bfbf194715dc8..76e50b89da617 100644 --- a/lib/internal/Magento/Framework/Crontab/README.md +++ b/lib/internal/Magento/Framework/Crontab/README.md @@ -1,12 +1,14 @@ Library for working with crontab The library has the next interfaces: + * CrontabManagerInterface * TasksProviderInterface *CrontabManagerInterface* provides working with crontab: + * *getTasks* - get list of Magento cron tasks from crontab * *saveTasks* - save Magento cron tasks to crontab * *removeTasks* - remove Magento cron tasks from crontab -*TasksProviderInterface* has only one method *getTasks*. This interface provides transportation the list of tasks from DI \ No newline at end of file +*TasksProviderInterface* has only one method *getTasks*. This interface provides transportation the list of tasks from DI diff --git a/lib/internal/Magento/Framework/Css/README.md b/lib/internal/Magento/Framework/Css/README.md index 2a7b46812470c..d7ccad3a7d70c 100644 --- a/lib/internal/Magento/Framework/Css/README.md +++ b/lib/internal/Magento/Framework/Css/README.md @@ -1,3 +1,4 @@ # Overview + CSS library contains common infrastructure to work with style sheets. It provides an ability to process LESS files in Magento application and convert this dynamic stylesheet language into CSS using correspondent parser. diff --git a/lib/internal/Magento/Framework/Data/README.md b/lib/internal/Magento/Framework/Data/README.md index b8913069b396b..07dd49bd36dd1 100644 --- a/lib/internal/Magento/Framework/Data/README.md +++ b/lib/internal/Magento/Framework/Data/README.md @@ -11,18 +11,17 @@ **Data interpreter** is responsible for computation of effective value, i.e. evaluation of input data. Each individual interpreter recognizes only one particular type of input data. *Magento\Framework\Data\Argument\Interpreter\Composite* is used to dynamically choose which of underlying interpreters to delegate evaluation to. Child interpreters can be registered in it via constructor and later on through the adder method of its public interface. Each sub-interpreter is associated with a unique name during adding to the composite. In order to make a decision of which interpreter to use, input data has to carry an extra metadata – data key carrying name of an interpreter to use. Metadata value is intended for the composite interpreter only, thus it's not passed down to underlying interpreters. Data interpreters are used for handling DI arguments and layout arguments. ## Supported Data Structures - + ### Data Collections **Data Collection** is traversable, countable, ordered list. Class *Magento\Framework\Data\Collection* is at the top of the collections hierarchy. Every collection in the system is its descendant, directly or indirectly. - - * Database Data Collections are used to load items from a database. Two fetching strategies are supported in this library: - * Cache fetching strategy - retrieve data from cache - * Query fetching strategy - retrieve data from database - - * Filesystem Data Collection is used to scan a folder for files and/or folders. + +* Database Data Collections are used to load items from a database. Two fetching strategies are supported in this library: + * Cache fetching strategy - retrieve data from cache + * Query fetching strategy - retrieve data from database +* Filesystem Data Collection is used to scan a folder for files and/or folders. -### DataArray +### DataArray **DataArray** is data container with array access. @@ -36,4 +35,4 @@ ### Structure -**Structure** is a hierarchical data structure of elements. A structure contains elements; elements can be grouped into groups under the structure. It is used in layout. \ No newline at end of file +**Structure** is a hierarchical data structure of elements. A structure contains elements; elements can be grouped into groups under the structure. It is used in layout. diff --git a/lib/internal/Magento/Framework/DataObject/README.md b/lib/internal/Magento/Framework/DataObject/README.md index 624c4e759be41..4a59f6bf0403f 100644 --- a/lib/internal/Magento/Framework/DataObject/README.md +++ b/lib/internal/Magento/Framework/DataObject/README.md @@ -1,4 +1,4 @@ # Object **Object** library contains functionality for mapping, management and the creation of dynamic member objects. -This also includes the objects which merge, read and make available xml configurations. \ No newline at end of file +This also includes the objects which merge, read and make available xml configurations. diff --git a/lib/internal/Magento/Framework/Encryption/README.md b/lib/internal/Magento/Framework/Encryption/README.md index a2bc6aa0f67f3..1f77c341417bd 100644 --- a/lib/internal/Magento/Framework/Encryption/README.md +++ b/lib/internal/Magento/Framework/Encryption/README.md @@ -1 +1 @@ -The Encryption library provides functionalities such as hashing passwords, encrypting/decrypting data, URLs encoding, using cryptographic algorithms. \ No newline at end of file +The Encryption library provides functionalities such as hashing passwords, encrypting/decrypting data, URLs encoding, using cryptographic algorithms. diff --git a/lib/internal/Magento/Framework/EntityManager/README.md b/lib/internal/Magento/Framework/EntityManager/README.md index f1c4692ef04d0..b6b71bd8c1bfd 100644 --- a/lib/internal/Magento/Framework/EntityManager/README.md +++ b/lib/internal/Magento/Framework/EntityManager/README.md @@ -1,16 +1,16 @@ # EntityManager **EntityManager** library contains functionality for entity persistence layer. -EntityManager supports persistence of basic entity attributes as well as extension and custom attributes +EntityManager supports persistence of basic entity attributes as well as extension and custom attributes added by 3rd party developers for the purpose of extending default entity behavior. It's not recommended to use EntityManager and its infrastructure for your entity persistence. -In the nearest future new Persistence Entity Manager would be released which will cover all the requirements for +In the nearest future new Persistence Entity Manager would be released which will cover all the requirements for persistence layer along with Query API as performance efficient APIs for Read scenarios. -Currently, it's recommended to use Resource Model infrastructure and make a successor of -Magento\Framework\Model\ResourceModel\Db\AbstractDb class or successor of +Currently, it's recommended to use Resource Model infrastructure and make a successor of +Magento\Framework\Model\ResourceModel\Db\AbstractDb class or successor of Magento\Eav\Model\Entity\AbstractEntity if EAV attributes support needed. -For filtering operations, it's recommended to use successor of +For filtering operations, it's recommended to use successor of Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection class. diff --git a/lib/internal/Magento/Framework/Event/README.md b/lib/internal/Magento/Framework/Event/README.md index b79de1d8f6b0b..c045d82fadd35 100644 --- a/lib/internal/Magento/Framework/Event/README.md +++ b/lib/internal/Magento/Framework/Event/README.md @@ -5,5 +5,3 @@ * Event manager is responsible for event configuration processing and event dispatching. All client code that dispatches events must ask for \Magento\Framework\Event\Manager in constructor. * Event config provides interface to retrieve related observers configuration by specified event name. * Event observer object passes data from the code that fires the event to the observer function. There are two special types of observer objects supported in this library: Cron, and Regex. Each one has its own unique functionality in addition to basic observer functionality. - - diff --git a/lib/internal/Magento/Framework/Exception/README.md b/lib/internal/Magento/Framework/Exception/README.md index 4b0d4fbbaf421..c156a829d6adb 100644 --- a/lib/internal/Magento/Framework/Exception/README.md +++ b/lib/internal/Magento/Framework/Exception/README.md @@ -1,4 +1,4 @@ -#Exception +# Exception * Classes that extend the base Exception class represent types of Exceptions. * All Exception classes extend, directly or indirectly, LocalizedException. Thus, error messages can be localized. diff --git a/lib/internal/Magento/Framework/Locale/README.md b/lib/internal/Magento/Framework/Locale/README.md index 0785a09cd518d..ad02c374f42a5 100644 --- a/lib/internal/Magento/Framework/Locale/README.md +++ b/lib/internal/Magento/Framework/Locale/README.md @@ -1,4 +1,5 @@ -#Locale +# Locale + * Contains logic to handle currency and number formatting based on locale. * Provides access to locale information translated into given languages. * Manages locale information for a store instance. diff --git a/lib/internal/Magento/Framework/Lock/README.md b/lib/internal/Magento/Framework/Lock/README.md index cd5ae425b949d..75078d6a37895 100644 --- a/lib/internal/Magento/Framework/Lock/README.md +++ b/lib/internal/Magento/Framework/Lock/README.md @@ -3,6 +3,7 @@ Lock library provides mechanism to acquire Magento system-wide lock. Default implementation is based on MySQL locks, where any locks are automatically released on connection close. The library provides interface *LockManagerInterface* which provides following methods: + * *lock* - Acquires a named lock * *unlock* - Releases a named lock * *isLocked* - Tests if a named lock exists diff --git a/lib/internal/Magento/Framework/Math/README.md b/lib/internal/Magento/Framework/Math/README.md index d7b31ad376563..7242beea699a7 100644 --- a/lib/internal/Magento/Framework/Math/README.md +++ b/lib/internal/Magento/Framework/Math/README.md @@ -1 +1 @@ -The Math module provides mathematical functionality including price rounding, finding floating point remainder of a division, random number and string generation, and unique hash generation. \ No newline at end of file +The Math module provides mathematical functionality including price rounding, finding floating point remainder of a division, random number and string generation, and unique hash generation. diff --git a/lib/internal/Magento/Framework/Message/README.md b/lib/internal/Magento/Framework/Message/README.md index 40ae8358e8b19..b3c402e9614e0 100644 --- a/lib/internal/Magento/Framework/Message/README.md +++ b/lib/internal/Magento/Framework/Message/README.md @@ -1,3 +1,3 @@ # Message -**Message** library is responsible for message creation and management. \ No newline at end of file +**Message** library is responsible for message creation and management. diff --git a/lib/internal/Magento/Framework/MessageQueue/README.md b/lib/internal/Magento/Framework/MessageQueue/README.md index 9708d30102f43..4e0de76b13ecc 100644 --- a/lib/internal/Magento/Framework/MessageQueue/README.md +++ b/lib/internal/Magento/Framework/MessageQueue/README.md @@ -1 +1 @@ -This component is designed to provide Message Queue Framework +This component is designed to provide Message Queue Framework diff --git a/lib/internal/Magento/Framework/Model/README.md b/lib/internal/Magento/Framework/Model/README.md index 0f5eb1761169f..288902765be65 100644 --- a/lib/internal/Magento/Framework/Model/README.md +++ b/lib/internal/Magento/Framework/Model/README.md @@ -1,3 +1,3 @@ # Model -**Model** library provides support for MVC models, model context, and storing and retrieving models to the database. \ No newline at end of file +**Model** library provides support for MVC models, model context, and storing and retrieving models to the database. diff --git a/lib/internal/Magento/Framework/Module/README.md b/lib/internal/Magento/Framework/Module/README.md index 533097f5f273b..59a50e6186e92 100644 --- a/lib/internal/Magento/Framework/Module/README.md +++ b/lib/internal/Magento/Framework/Module/README.md @@ -6,4 +6,4 @@ Magento\Framework\Module is Magento framework component that allows to build mod * module manager that provides all information about loaded modules * directory reader, that allows to read configuration files from module * ability to turn on/off module output in separate configuration application - * module db data installers \ No newline at end of file + * module db data installers diff --git a/lib/internal/Magento/Framework/ObjectManager/README.md b/lib/internal/Magento/Framework/ObjectManager/README.md index 5fccda9eaad75..1cecd7fc4576c 100644 --- a/lib/internal/Magento/Framework/ObjectManager/README.md +++ b/lib/internal/Magento/Framework/ObjectManager/README.md @@ -1,3 +1,3 @@ # ObjectManager -**ObjectManager** library is responsible for constructing objects and injecting dependencies based on module di.xml files. \ No newline at end of file +**ObjectManager** library is responsible for constructing objects and injecting dependencies based on module di.xml files. diff --git a/lib/internal/Magento/Framework/Option/README.md b/lib/internal/Magento/Framework/Option/README.md index 689cc2023dede..cdae5652a90a9 100644 --- a/lib/internal/Magento/Framework/Option/README.md +++ b/lib/internal/Magento/Framework/Option/README.md @@ -1 +1 @@ -This module is used to create option values in models to value-label pairs that are used in forms. The model must implement Magento\Framework\Option\ArrayInterface or an exception will be thrown. \ No newline at end of file +This module is used to create option values in models to value-label pairs that are used in forms. The model must implement Magento\Framework\Option\ArrayInterface or an exception will be thrown. diff --git a/lib/internal/Magento/Framework/Phrase/README.md b/lib/internal/Magento/Framework/Phrase/README.md index 779979edbb489..5fb87063cb18f 100644 --- a/lib/internal/Magento/Framework/Phrase/README.md +++ b/lib/internal/Magento/Framework/Phrase/README.md @@ -5,4 +5,4 @@ Class *\Magento\Framework\Phrase* calls renderer to make the translation of the * Placeholder render - it replaces placeholders with parameters for substitution. It is the default render if none is set for the Phrase. * Translate render - it is a base renderer that implements text translations. * Inline render - it adds inline translate part to text translation and returns the strings by a template. - * Composite render - it can have several renderers, calls each renderer for processing the text. Array of renderer class names pass into composite render constructor as a parameter. \ No newline at end of file + * Composite render - it can have several renderers, calls each renderer for processing the text. Array of renderer class names pass into composite render constructor as a parameter. diff --git a/lib/internal/Magento/Framework/Profiler/README.md b/lib/internal/Magento/Framework/Profiler/README.md index 07441d3607be6..acace9c459fa6 100644 --- a/lib/internal/Magento/Framework/Profiler/README.md +++ b/lib/internal/Magento/Framework/Profiler/README.md @@ -1,8 +1,9 @@ A library for profiling source code. This is a manual type of profiler, when programmer adds profiling instructions explicitly inline to the source code. Features: + * Measures time between tags (events), number of calls and calculates average time * Measures memory usage * Allows nesting of events and enforces its integrity, and measures aggregated stats of nested elements * Allows configuring filters for tags - * Provides various output formats out of the box: direct HTML output and CSV-file \ No newline at end of file + * Provides various output formats out of the box: direct HTML output and CSV-file diff --git a/lib/internal/Magento/Framework/Serialize/README.md b/lib/internal/Magento/Framework/Serialize/README.md index d900f89208a54..2c4f9894d707c 100644 --- a/lib/internal/Magento/Framework/Serialize/README.md +++ b/lib/internal/Magento/Framework/Serialize/README.md @@ -5,5 +5,5 @@ * *Json* - default implementation. Uses PHP native json_encode/json_decode functions; * *JsonHexTag* - default implementation. Uses PHP native json_encode/json_decode functions with `JSON_HEX_TAG` option enabled; * *Serialize* - less secure than *Json*, but gives higher performance on big arrays. Uses PHP native serialize/unserialize functions, does not unserialize objects on PHP 7. - -Using *Serialize* implementation directly is discouraged, always use *SerializerInterface*, using *Serialize* implementation may lead to security vulnerabilities. \ No newline at end of file + +Using *Serialize* implementation directly is discouraged, always use *SerializerInterface*, using *Serialize* implementation may lead to security vulnerabilities. diff --git a/lib/internal/Magento/Framework/Session/README.md b/lib/internal/Magento/Framework/Session/README.md index 3a5f3b32bcf74..909620e1b449e 100644 --- a/lib/internal/Magento/Framework/Session/README.md +++ b/lib/internal/Magento/Framework/Session/README.md @@ -1,4 +1,4 @@ -#Session +# Session * **SessionManager** Manages active sessions and session metadata. * **SaveHandler** Supports filesystem and database storage of session data. diff --git a/lib/internal/Magento/Framework/Setup/README.md b/lib/internal/Magento/Framework/Setup/README.md index 860ce4bc7ca50..286756642c5d8 100644 --- a/lib/internal/Magento/Framework/Setup/README.md +++ b/lib/internal/Magento/Framework/Setup/README.md @@ -1,5 +1,5 @@ **Setup** provides interfaces that should be used or implemented by Setup data and schema installs, upgrades and uninstalls. - + Implement `InstallSchemaInterface` and/or `UpgradeSchemaInterface` for DB schema install and/or upgrade. Implement `InstallDataInterface` and/or `UpgradeDataInterface` for DB data install and/or upgrade. Implement `UninstallInterface` for handling data removal during module uninstall. diff --git a/lib/internal/Magento/Framework/Stdlib/README.md b/lib/internal/Magento/Framework/Stdlib/README.md index d6f877953ab87..3937bfc9a4592 100644 --- a/lib/internal/Magento/Framework/Stdlib/README.md +++ b/lib/internal/Magento/Framework/Stdlib/README.md @@ -1,2 +1,2 @@ The Stdlib library contains utility classes that extend or relate to base PHP classes. Modules should use the CookieManager to get and set cookies instead of the built-in cookie functions for improved security. -Other classes provide convenient methods for dealing with arrays, boolean, date/time, and strings. \ No newline at end of file +Other classes provide convenient methods for dealing with arrays, boolean, date/time, and strings. diff --git a/lib/internal/Magento/Framework/Translate/README.md b/lib/internal/Magento/Framework/Translate/README.md index 7bb68ad88aca3..b4b1ff43dfc3c 100644 --- a/lib/internal/Magento/Framework/Translate/README.md +++ b/lib/internal/Magento/Framework/Translate/README.md @@ -11,4 +11,4 @@ Magento provides an *Inline Translation* tool that allows inline editing of phra * State - It can disable, enable, suspend and resume inline translation. * *StateInterface* and a *State* class * Resource - It stores and retrieve translation array - * *ResourceInterface* \ No newline at end of file + * *ResourceInterface* diff --git a/lib/internal/Magento/Framework/Unserialize/README.md b/lib/internal/Magento/Framework/Unserialize/README.md index 2dbf7436aa60f..c473cdf4e865c 100644 --- a/lib/internal/Magento/Framework/Unserialize/README.md +++ b/lib/internal/Magento/Framework/Unserialize/README.md @@ -1 +1 @@ -This library is deprecated, please use Magento\Framework\Serialize\SerializerInterface instead. \ No newline at end of file +This library is deprecated, please use Magento\Framework\Serialize\SerializerInterface instead. diff --git a/lib/internal/Magento/Framework/View/README.md b/lib/internal/Magento/Framework/View/README.md index 6c04c6ab59861..ffe5be98414fa 100644 --- a/lib/internal/Magento/Framework/View/README.md +++ b/lib/internal/Magento/Framework/View/README.md @@ -1 +1 @@ -View library contains common infrastructure to work with view related components. \ No newline at end of file +View library contains common infrastructure to work with view related components. diff --git a/lib/web/css/docs/source/README.md b/lib/web/css/docs/source/README.md index 872a01eae4a50..872bf41aad5c4 100644 --- a/lib/web/css/docs/source/README.md +++ b/lib/web/css/docs/source/README.md @@ -34,7 +34,9 @@ The library provides the ability to customize all of the following user interfac * list of theme variables # Magento UI library file structure + Magento UI library is located under `/lib/web/` folder. It and employs: + * `css/` folder where the library files are placed * `fonts/` folder where default and icon fonts are placed * `images/` folder where default images are placed @@ -135,6 +137,7 @@ Magento UI library is located under `/lib/web/` folder. It and employs: └── jquery/ (Library javascript files) ``` +   # Magento UI library naming convention @@ -183,6 +186,7 @@ Private variables: @paddingleft; @__font-size; ``` +   # Less mixins naming @@ -194,19 +198,23 @@ A mixin name can consist of one or several words, concatenated with one hyphen. #### Examples: ##### Acceptable: + ```css .mixin-name() {} .transition() {} .mixin() {} ._button-gradient() {} ``` + ##### Unacceptable: + ```css .mixinName() {} .__transition() {} .MiXiN() {} ._button--gradient() {} ``` +   # Less Code Standards @@ -236,6 +244,7 @@ Please verified that you use spaces instead tabs: Add space before opening brace and line break after. And line break before closing brace. ##### Not recommended: + ```css .nav{color: @nav__color;} ``` @@ -575,6 +584,7 @@ Using class names this way contributes to acceptable levels of understandability Write selector name together in single line, don't use concatenation ##### Not recommended: + ```css .product { ... @@ -605,6 +615,7 @@ Generic names are simply a fallback for elements that have no particular or no m Using functional or generic names reduces the probability of unnecessary document or template changes. ##### Not recommended: + ```css .foo-1901 { ... @@ -757,7 +768,7 @@ Using shorthand properties is useful for code efficiency and understandability. padding-top: 0; ``` - ##### Recommended: +##### Recommended: ```css border-top: 0; @@ -831,6 +842,7 @@ Omit leading "0"s in values, use dot instead If variables are local and used only in module scope it should be located in module file, on the top of the file with general comment Example **_module.less**: + ```css ... diff --git a/lib/web/jquery/fileUploader/README.md b/lib/web/jquery/fileUploader/README.md index 5a13ef4252e44..b48a4b1d5d702 100644 --- a/lib/web/jquery/fileUploader/README.md +++ b/lib/web/jquery/fileUploader/README.md @@ -204,10 +204,13 @@ To run the tests, follow these steps: 1. Start [Docker](https://docs.docker.com/). 2. Install development dependencies: + ```sh npm install ``` + 3. Run the tests: + ```sh npm test ``` diff --git a/lib/web/jquery/fileUploader/vendor/blueimp-load-image/README.md b/lib/web/jquery/fileUploader/vendor/blueimp-load-image/README.md index 5759a126aa172..77b6b1195e3de 100644 --- a/lib/web/jquery/fileUploader/vendor/blueimp-load-image/README.md +++ b/lib/web/jquery/fileUploader/vendor/blueimp-load-image/README.md @@ -565,7 +565,7 @@ available. Exif orientation values to correctly display the letter F: -``` +```diagram 1 2 ██████ ██████ ██ ██