Skip to content

Commit b01435e

Browse files
vlmedvlmed
committed
[ReadMe] updated readMe file for ImportExport-LayeredNavigation modules
1 parent 9d1fe17 commit b01435e

File tree

5 files changed

+387
-21
lines changed

5 files changed

+387
-21
lines changed

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

Lines changed: 79 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,80 @@
1-
Magento_ImportExport module provides a framework and basic functionality for importing/exporting various entities in Magento.
1+
# Magento_ImportExport module
2+
3+
This module provides a framework and basic functionality for importing/exporting various entities in Magento.
24
It can be disabled and in such case all dependent import/export functionality (products, customers, orders etc.) will be disabled in Magento.
5+
6+
## Installation
7+
8+
The Magento_ImportExport module creates the following tables in the database:
9+
- `importexport_importdata`
10+
- `import_history`
11+
12+
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
13+
14+
## Structure
15+
16+
`Files/` - the directory that contains sample import files.
17+
18+
For information about a typical file structure of a module in Magento 2, see [Module file structure](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure).
19+
20+
## Extensibility
21+
22+
Extension developers can interact with the Magento_ImportExport module. For more information about the Magento extension mechanism, see [Magento plugins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
23+
24+
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_ImportExport module.
25+
26+
### Layouts
27+
28+
This module introduces the following layouts in the `view/frontend/layout` directory:
29+
30+
- `adminhtml_export_getfilter`
31+
- `adminhtml_export_index`
32+
- `adminhtml_history_grid_block`
33+
- `adminhtml_history_index`
34+
- `adminhtml_import_busy`
35+
- `adminhtml_import_index`
36+
- `adminhtml_import_start`
37+
- `adminhtml_import_validate`
38+
39+
For more information about a layout in Magento 2, see the [Layout documentation](http://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html).
40+
41+
### UI components
42+
43+
You can extend an export updates using the configuration files located in the `view/adminhtml/ui_component` directory:
44+
45+
- `export_grid`
46+
47+
For information about a UI component in Magento 2, see [Overview of UI components](http://devdocs.magento.com/guides/v2.4/ui_comp_guide/bk-ui_comps.html).
48+
49+
### Public APIs
50+
51+
- `Magento\ImportExport\Api\Data\ExportInfoInterface`
52+
- export data
53+
54+
- `\Magento\ImportExport\Api\ExportManagementInterface`:
55+
- get export data
56+
57+
For information about a public API in Magento 2, see [Public interfaces & APIs](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/api-concepts.html).
58+
59+
## Additional information
60+
61+
#### Message Queue Consumer
62+
63+
- `exportProcessor` - consumer to run export process
64+
65+
[Learn how to manage Message Queues](https://devdocs.magento.com/guides/v2.4/config-guide/mq/manage-message-queues.html).
66+
67+
#### Create custom import entity
68+
69+
1. Declare the new import entity in `etc/import.xml`
70+
2. Create an import model
71+
72+
#### Create custom export entity
73+
74+
1. Declare the new import entity in `etc/export.xml`
75+
2. Create an export model
76+
77+
You can get more information about import/export processes in magento at the articles:
78+
- [Create custom import entity](https://devdocs.magento.com/guides/v2.4/ext-best-practices/tutorials/custom-import-entity.html)
79+
- [Import](https://docs.magento.com/user-guide/system/data-import.html)
80+
- [Export](https://docs.magento.com/user-guide/system/data-export.html)

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

Lines changed: 111 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,114 @@
1-
## Overview
2-
Magento_Indexer module is a base of Magento Indexing functionality.
1+
# Magento_Indexer module
2+
3+
This module provides Magento Indexing functionality.
34
It allows:
4-
- read indexers configuration,
5-
- represent indexers in admin,
6-
- regenerate indexes by cron schedule,
7-
- regenerate indexes from console,
8-
- view and reset indexer state from console,
5+
- read indexers configuration
6+
- represent indexers in admin
7+
- regenerate indexes by cron schedule
8+
- regenerate indexes from console
9+
- view and reset indexer state from console
910
- view and set indexer mode from console
1011

11-
There are 2 modes of the Indexers: "Update on save" and "Update by schedule".
12-
Manual full reindex can be performed via console by running `php -f bin/magento indexer:reindex` console command.
12+
## Installation
13+
14+
The Magento_Indexer module is one of the base Magento 2 modules. You cannot disable or uninstall this module.
15+
16+
This module is dependent on the following modules:
17+
18+
- `Magento_Store`
19+
- `Magento_AdminNotification`
20+
21+
The Magento_Indexer module creates the following tables in the database:
22+
- `indexer_state`
23+
- `mview_state`
24+
25+
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
26+
27+
## Structure
28+
29+
`App/` - the directory that contains launch application entry point.
30+
31+
For information about a typical file structure of a module in Magento 2, see [Module file structure](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure).
32+
33+
## Extensibility
34+
35+
Extension developers can interact with the Magento_Indexer module. For more information about the Magento extension mechanism, see [Magento plugins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
36+
37+
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_Indexer module.
38+
39+
### Events
40+
41+
The module dispatches the following events:
42+
43+
#### Model
44+
45+
- `clean_cache_by_tags` event in the `\Magento\Indexer\Model\Indexer\CacheCleaner::cleanCache` method. Parameters:
46+
- `object` is a `$this->cacheContext` object (`Magento\Framework\Indexer\CacheContext` class)
47+
48+
#### Plugin
49+
50+
- `clean_cache_after_reindex` event in the `\Magento\Indexer\Model\Processor\CleanCache::afterUpdateMview` method. Parameters:
51+
- `object` is a `$this->context` object (`Magento\Framework\Indexer\CacheContext` class)
52+
53+
- `clean_cache_by_tags` event in the `\Magento\Indexer\Model\Processor\CleanCache::afterReindexAllInvalid` method. Parameters:
54+
- `object` is a `$this->context` object (`Magento\Framework\Indexer\CacheContext` class)
55+
56+
For information about an event in Magento 2, see [Events and observers](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/events-and-observers.html#events).
57+
58+
### Layouts
59+
60+
This module introduces the following layouts in the `view/adminhtml/layout` directory:
61+
- `indexer_indexer_list`
62+
- `indexer_indexer_list_grid`
63+
64+
For more information about layouts in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.3/frontend-dev-guide/layouts/layout-overview.html).
65+
66+
## Additional information
67+
68+
### Magento indexers
69+
70+
List of Magento default indexers:
71+
- `design_config_grid` - Design Config Grid
72+
- `customer_grid` - Customer Grid
73+
- `catalog_category_product` - Category Products
74+
- `catalog_product_category` - Product Categories
75+
- `catalogrule_rule` - Catalog Rule Product
76+
- `catalog_product_attribute` - Product EAV
77+
- `catalogrule_product` - Catalog Product Rule
78+
- `cataloginventory_stock` - Stock
79+
- `catalog_product_price` - Product Price
80+
- `catalogsearch_fulltext` - Catalog Search
81+
82+
### Indexer modes
83+
84+
There are 2 modes of the Indexers:
85+
86+
- Update on Save - index tables are updated immediately after the dictionary data is changed
87+
- Update by Schedule - index tables are updated by cron job according to the configured schedule
88+
89+
### Console commands
90+
91+
Magento_Indexers provides console commands:
92+
- `bin/magento indexer:info` - view a list of all indexers
93+
- `bin/magento indexer:status [indexer]` - view index status
94+
- `bin/magento indexer:info` - view list all indexers
95+
- `bin/magento indexer:reindex [indexer]` - run reindex
96+
- `bin/magento indexer:reset [indexer]` - reset indexers
97+
- `bin/magento indexer:show-mode [indexer]` - view the current indexer configuration
98+
- `bin/magento indexer:set-mode {realtime|schedule} [indexer]` - specify the indexer configuration
99+
100+
### Cron options
101+
102+
Cron group configuration can be set at `etc/crontab.xml`:
103+
- `indexer_reindex_all_invalid` - regenerate indexes for all invalid indexers
104+
- `indexer_update_all_views` - update indexer views
105+
- `indexer_clean_all_changelogs` - clean indexer view changelogs
106+
107+
[Learn how to configure and run cron in Magento.](http://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-cron.html).
108+
109+
More information can get at articles:
110+
- [Learn more about indexing](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/indexing.html)
111+
- [Learn more about Indexr optimization](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/indexer-batch.html)
112+
- [Learn more how to add custom indexer](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/indexing-custom.html)
113+
- [Learn how to manage indexers](https://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-index.html)
114+
- [Learn more about Index Management](https://docs.magento.com/user-guide/system/index-management.html)

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

Lines changed: 59 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,62 @@
1-
# Magento_InstantPurchase module
1+
## Magento_InstantPurchase module
22

3-
Instant Purchase feature allows the Customer to place the order in seconds without going through full checkout. Once clicked, system places the order using default shipping and billing addresses and stored payment method. Order is placed and customer gets confirmation message in notification area.
3+
This module allows the Customer to place the order in seconds without going through full checkout. Once clicked, system places the order using default shipping and billing addresses and stored payment method. Order is placed and customer gets confirmation message in notification area.
44

5-
Prerequisites to display the Instant Purchase button:
5+
## Installation
66

7-
1. Instant purchase enabled for a store at `Store / Configurations / Sales / Sales / Instant Purchase`
8-
2. Customer is logged in
9-
3. Customer has default shipping and billing address defined
10-
4. Customer has valid stored payment method with instant purchase support
7+
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
118

129
## Structure
1310

14-
In addition to [a typical file structure for a Magento 2 module](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html) `PaymentMethodsIntegration` directory contains interfaces and basic implementation of integration vault payment method to the instant purchase.
11+
`PaymentMethodsIntegration` - directory contains interfaces and basic implementation of integration vault payment method to the instant purchase.
12+
13+
For information about a typical file structure of a module in Magento 2, see [Module file structure](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure).
1514

1615
## Extensibility
1716

17+
Extension developers can interact with the Magento_InstantPurchase module. For more information about the Magento extension mechanism, see [Magento plugins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
18+
19+
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_InstantPurchase module.
20+
21+
### Layouts
22+
23+
This module introduces the following layouts in the `view/frontend/layout` directory:
24+
- `catalog_product_view`
25+
- `catalog_product_view_type_bundle`
26+
27+
For more information about layouts in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.3/frontend-dev-guide/layouts/layout-overview.html).
28+
29+
### Public APIs
30+
31+
- `\Magento\InstantPurchase\Model\BillingAddressChoose\BillingAddressChooserInterface`
32+
- choose billing address for a customer if available
33+
34+
- `\Magento\InstantPurchase\Model\PaymentMethodChoose\PaymentTokenChooserInterface`
35+
- choose one of the stored payment methods for a customer if available
36+
37+
- `\Magento\InstantPurchase\Model\ShippingAddressChoose\ShippingAddressChooserInterface`
38+
- choose shipping address for a customer if available
39+
40+
- `\Magento\InstantPurchase\Model\ShippingMethodChoose\DeferredShippingMethodChooserInterface`
41+
- choose shipping method for a quote address
42+
43+
- `\Magento\InstantPurchase\Model\ShippingMethodChoose\ShippingMethodChooserInterface`
44+
- choose shipping method for customer address if available
45+
46+
- `\Magento\InstantPurchase\Model\InstantPurchaseInterface`
47+
- detects instant purchase options for a customer in a store
48+
49+
- `\Magento\InstantPurchase\PaymentMethodIntegration\AvailabilityCheckerInterface`
50+
- checks if payment method may be used for instant purchase
51+
52+
- `\Magento\InstantPurchase\PaymentMethodIntegration\PaymentAdditionalInformationProviderInterface`
53+
- provides additional information part specific for payment method
54+
55+
- `\Magento\InstantPurchase\PaymentMethodIntegration\PaymentTokenFormatterInterface`
56+
- provides mechanism to create string presentation of token for payment method
57+
58+
For information about a public API in Magento 2, see [Public interfaces & APIs](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/api-concepts.html).
59+
1860
### Instant purchase customization
1961

2062
Almost all aspects of instant purchase may be customized. See comments to classes and interfaces marked with `@api` tag.
@@ -49,6 +91,15 @@ Basic implementation is a good start point but it's recommended to provide own i
4991

5092
## Additional information
5193

94+
#Prerequisites to display the Instant Purchase button
95+
96+
1. Instant purchase enabled for a store at `Store / Configurations / Sales / Sales / Instant Purchase`
97+
2. Customer is logged in
98+
3. Customer has default shipping and billing address defined
99+
4. Customer has valid stored payment method with instant purchase support
100+
101+
[Learn more about Instant Purchase](https://docs.magento.com/user-guide/sales/checkout-instant-purchase.html).
102+
52103
### Backward incompatible changes
53104

54105
The `Magento_InstantPurchase` module does not introduce backward incompatible changes.

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

Lines changed: 93 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,97 @@
1-
# Integration
1+
# Magento_Integration module
22

3-
**Integration** enables third-party services to call the Web API by using access tokens.
3+
This module enables third-party services to call the Web API by using access tokens.
44
It provides an admin UI that enables manual creation of integrations. Extensions can also provide a configuration
55
file so that an integration can be automatically pre-configured. The module also contains the data
66
model for request and access token management.
7+
8+
## Installation
9+
10+
Before installing this module, note that the Magento_Integration is dependent on the following modules:
11+
- `Magento_Store`
12+
- `Magento_User`
13+
- `Magento_Security`
14+
15+
The following modules depend on this module:
16+
- `Magento_Analytics`
17+
- `Magento_Webapi`
18+
19+
The Magento_Integration module creates the following tables in the database:
20+
- `oauth_consumer`
21+
- `oauth_token`
22+
- `oauth_nonce`
23+
- `integration`
24+
- `oauth_token_request_log`
25+
26+
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
27+
28+
## Extensibility
29+
30+
Extension developers can interact with the Magento_Integration module. For more information about the Magento extension mechanism, see [Magento plugins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
31+
32+
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_Integration module.
33+
34+
### Events
35+
36+
The module dispatches the following events:
37+
38+
#### Model
39+
- `customer_login` event in the `\Magento\Integration\Model\CustomerTokenService::createCustomerAccessToken` method. Parameters:
40+
- `customer` is a `$customerDataObject` object (`\Magento\Customer\Api\Data\CustomerInterface` class)
41+
42+
For information about an event in Magento 2, see [Events and observers](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/events-and-observers.html#events).
43+
44+
### Layouts
45+
46+
This module introduces the following layouts in the `view/adminhtml/layout` directory:
47+
- `adminhtml_integration_edit`
48+
- `adminhtml_integration_grid`
49+
- `adminhtml_integration_grid_block`
50+
- `adminhtml_integration_index`
51+
- `adminhtml_integration_new`
52+
- `adminhtml_integration_permissionsdialog`
53+
- `adminhtml_integration_tokensdialog`
54+
- `adminhtml_integration_tokensexchange`
55+
56+
For more information about a layout in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html).
57+
58+
### Public APIs
59+
60+
- `\Magento\Integration\Api\AdminTokenServiceInterface`:
61+
- create access token for admin given the admin credentials
62+
- revoke token by admin ID
63+
64+
- `\Magento\Integration\Api\AuthorizationServiceInterface`:
65+
- grant permissions to user to access the specified resources
66+
- grant permissions to the user to access all resources available in the system
67+
- remove role and associated permissions for the specified integration
68+
69+
- `\Magento\Integration\Api\CustomerTokenServiceInterface`:
70+
- create access token for admin given the customer credentials
71+
- revoke token by customer ID
72+
73+
- `\Magento\Integration\Api\IntegrationServiceInterface`:
74+
- create a new Integration
75+
- get the details of a specific Integration by integration ID
76+
- find Integration by name
77+
- get the details of an Integration by consumer_id
78+
- get the details of an active Integration by consumer_id
79+
- update an Integration
80+
- delete an Integration by integration ID
81+
- get an array of selected resources for an integration
82+
83+
For information about a public API in Magento 2, see [Public interfaces & APIs](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/api-concepts.html).
84+
85+
## Additional information
86+
87+
### Cron options
88+
89+
Cron group configuration can be set at `etc/crontab.xml`:
90+
- `outdated_authentication_failures_cleanup` - clearing log of outdated token request authentication failures
91+
- `expired_tokens_cleanups` - delete expired customer and admin tokens
92+
93+
[Learn how to configure and run cron in Magento.](http://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-cron.html).
94+
95+
More information can get at articles:
96+
- [Learn more about an Integration](https://docs.magento.com/user-guide/system/integrations.html)
97+
- [Lear how to create an Integration](https://devdocs.magento.com/guides/v2.4/get-started/create-integration.html)

0 commit comments

Comments
 (0)