Skip to content

Commit 72d551a

Browse files
magento-engcom-teammagento-engcom-team
committed
ENGCOM-9075: [ReadMe] updated readMe file for ImportExport-LayeredNavigation modules #31809
- Merge Pull Request #31809 from vlmed/magento2:update_readme_import-export_layered-navigation - Merged commits: 1. b01435e 2. 7f1dd3f
2 parents aff512b + 7f1dd3f commit 72d551a

File tree

5 files changed

+389
-23
lines changed

5 files changed

+389
-23
lines changed

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

Lines changed: 84 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,85 @@
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+
All database schema changes made by this module are rolled back when the module gets disabled and setup:upgrade command is run.
13+
14+
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).
15+
16+
## Structure
17+
18+
`Files/` - the directory that contains sample import files.
19+
20+
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).
21+
22+
## Extensibility
23+
24+
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).
25+
26+
[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.
27+
28+
### Layouts
29+
30+
This module introduces the following layout handles in the `view/frontend/layout` directory:
31+
32+
- `adminhtml_export_getfilter`
33+
- `adminhtml_export_index`
34+
- `adminhtml_history_grid_block`
35+
- `adminhtml_history_index`
36+
- `adminhtml_import_busy`
37+
- `adminhtml_import_index`
38+
- `adminhtml_import_start`
39+
- `adminhtml_import_validate`
40+
41+
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).
42+
43+
### UI components
44+
45+
You can extend an export updates using the configuration files located in the `view/adminhtml/ui_component` directory:
46+
47+
- `export_grid`
48+
49+
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).
50+
51+
### Public APIs
52+
53+
- `Magento\ImportExport\Api\Data\ExportInfoInterface`
54+
- getter and setter interface with data needed for export
55+
56+
- `Magento\ImportExport\Api\Data\ExtendedExportInfoInterface`
57+
- extends `Magento\ImportExport\Api\Data\ExportInfoInterface`. Contains data for skipped attributes
58+
59+
- `\Magento\ImportExport\Api\ExportManagementInterface`
60+
- Executing actual export and returns export data
61+
62+
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).
63+
64+
## Additional information
65+
66+
#### Message Queue Consumer
67+
68+
- `exportProcessor` - consumer to run export process
69+
70+
[Learn how to manage Message Queues](https://devdocs.magento.com/guides/v2.4/config-guide/mq/manage-message-queues.html).
71+
72+
#### Create custom import entity
73+
74+
1. Declare the new import entity in `etc/import.xml`
75+
2. Create an import model
76+
77+
#### Create custom export entity
78+
79+
1. Declare the new import entity in `etc/export.xml`
80+
2. Create an export model
81+
82+
You can get more information about import/export processes in magento at the articles:
83+
- [Create custom import entity](https://devdocs.magento.com/guides/v2.4/ext-best-practices/tutorials/custom-import-entity.html)
84+
- [Import](https://docs.magento.com/user-guide/system/data-import.html)
85+
- [Export](https://docs.magento.com/user-guide/system/data-export.html)

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

Lines changed: 99 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,101 @@
1-
## Overview
2-
Magento_Indexer module is a base of Magento Indexing functionality.
3-
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,
1+
# Magento_Indexer module
2+
3+
This module provides Magento Indexing functionality.
4+
It allows to:
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 `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 `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 `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 layout handles 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+
### Indexer modes
69+
70+
There are 2 modes of the Indexers:
71+
72+
- Update on Save - index tables are updated immediately after the dictionary data is changed
73+
- Update by Schedule - index tables are updated by cron job according to the configured schedule
74+
75+
### Console commands
76+
77+
Magento_Indexers provides console commands:
78+
- `bin/magento indexer:info` - view a list of all indexers
79+
- `bin/magento indexer:status [indexer]` - view index status
80+
- `bin/magento indexer:reindex [indexer]` - run reindex
81+
- `bin/magento indexer:reset [indexer]` - reset indexers
82+
- `bin/magento indexer:show-mode [indexer]` - view the current indexer configuration
83+
- `bin/magento indexer:set-mode {realtime|schedule} [indexer]` - specify the indexer configuration
84+
- `bin/magento indexer:set-dimensions-mode [indexer]` - set indexer dimension mode
85+
- `bin/magento indexer:show-dimensions-mode [indexer]` - set indexer dimension mode
86+
87+
### Cron options
88+
89+
Cron group configuration can be set at `etc/crontab.xml`:
90+
- `indexer_reindex_all_invalid` - regenerate indexes for all invalid indexers
91+
- `indexer_update_all_views` - update indexer views
92+
- `indexer_clean_all_changelogs` - clean indexer view changelogs
93+
94+
[Learn how to configure and run cron in Magento.](http://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-cron.html).
95+
96+
More information can get at articles:
97+
- [Learn more about indexing](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/indexing.html)
98+
- [Learn more about Indexer optimization](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/indexer-batch.html)
99+
- [Learn more how to add custom indexer](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/indexing-custom.html)
100+
- [Learn how to manage indexers](https://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-index.html)
101+
- [Learn more about Index Management](https://docs.magento.com/user-guide/system/index-management.html)

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

Lines changed: 52 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,56 @@
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+
### Public APIs
22+
23+
- `\Magento\InstantPurchase\Model\BillingAddressChoose\BillingAddressChooserInterface`
24+
- choose billing address for a customer if available
25+
26+
- `\Magento\InstantPurchase\Model\PaymentMethodChoose\PaymentTokenChooserInterface`
27+
- choose one of the stored payment methods for a customer if available
28+
29+
- `\Magento\InstantPurchase\Model\ShippingAddressChoose\ShippingAddressChooserInterface`
30+
- choose shipping address for a customer if available
31+
32+
- `\Magento\InstantPurchase\Model\ShippingMethodChoose\DeferredShippingMethodChooserInterface`
33+
- choose shipping method for a quote address
34+
35+
- `\Magento\InstantPurchase\Model\ShippingMethodChoose\ShippingMethodChooserInterface`
36+
- choose shipping method for customer address if available
37+
38+
- `\Magento\InstantPurchase\Model\InstantPurchaseInterface`
39+
- detects instant purchase options for a customer in a store
40+
41+
- `\Magento\InstantPurchase\PaymentMethodIntegration\AvailabilityCheckerInterface`
42+
- checks if payment method may be used for instant purchase
43+
44+
- `\Magento\InstantPurchase\PaymentMethodIntegration\PaymentAdditionalInformationProviderInterface`
45+
- provides additional information part specific for payment method
46+
47+
- `\Magento\InstantPurchase\PaymentMethodIntegration\PaymentTokenFormatterInterface`
48+
- provides mechanism to create string presentation of token for payment method
49+
50+
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).
51+
52+
## Additional information
53+
1854
### Instant purchase customization
1955

2056
Almost all aspects of instant purchase may be customized. See comments to classes and interfaces marked with `@api` tag.
@@ -47,7 +83,14 @@ Basic implementation is a good start point but it's recommended to provide own i
4783
- `Magento\InstantPurchase\PaymentMethodIntegration\PaymentTokenFormatterInterface` - creates string that describes stored payment method. Basic implementation returns payment method name. It is highly recommended to implement own formatter.
4884
- `Magento\InstantPurchase\PaymentMethodIntegration\PaymentAdditionalInformationProviderInterface` - allows to add some extra values to payment additional information array. Default implementation returns empty array.
4985

50-
## Additional information
86+
### Prerequisites to display the Instant Purchase button
87+
88+
1. Instant purchase enabled for a store at `Store / Configurations / Sales / Sales / Instant Purchase`
89+
2. Customer is logged in
90+
3. Customer has default shipping and billing address defined
91+
4. Customer has valid stored payment method with instant purchase support
92+
93+
[Learn more about Instant Purchase](https://docs.magento.com/user-guide/sales/checkout-instant-purchase.html).
5194

5295
### Backward incompatible changes
5396

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

Lines changed: 101 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,105 @@
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+
The Magento_Integration module is one of the base Magento 2 modules. You cannot disable or uninstall this module.
11+
12+
This module is dependent on the following modules:
13+
- `Magento_Store`
14+
- `Magento_User`
15+
- `Magento_Security`
16+
17+
The Magento_Integration module creates the following tables in the database:
18+
- `oauth_consumer`
19+
- `oauth_token`
20+
- `oauth_nonce`
21+
- `integration`
22+
- `oauth_token_request_log`
23+
24+
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).
25+
26+
## Extensibility
27+
28+
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).
29+
30+
[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.
31+
32+
### Events
33+
34+
The module dispatches the following events:
35+
36+
#### Model
37+
- `customer_login` event in the `\Magento\Integration\Model\CustomerTokenService::createCustomerAccessToken` method. Parameters:
38+
- `customer` is an object (`\Magento\Customer\Api\Data\CustomerInterface` class)
39+
40+
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).
41+
42+
### Layouts
43+
44+
This module introduces the following layout handles in the `view/adminhtml/layout` directory:
45+
- `adminhtml_integration_edit`
46+
- `adminhtml_integration_grid`
47+
- `adminhtml_integration_grid_block`
48+
- `adminhtml_integration_index`
49+
- `adminhtml_integration_new`
50+
- `adminhtml_integration_permissionsdialog`
51+
- `adminhtml_integration_tokensdialog`
52+
- `adminhtml_integration_tokensexchange`
53+
54+
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).
55+
56+
### Public APIs
57+
58+
- `\Magento\Integration\Api\AdminTokenServiceInterface`:
59+
- create access token for admin given the admin credentials
60+
- revoke token by admin ID
61+
62+
- `\Magento\Integration\Api\AuthorizationServiceInterface`:
63+
- grant permissions to user to access the specified resources
64+
- grant permissions to the user to access all resources available in the system
65+
- remove role and associated permissions for the specified integration
66+
67+
- `\Magento\Integration\Api\CustomerTokenServiceInterface`:
68+
- create access token for admin given the customer credentials
69+
- revoke token by customer ID
70+
71+
- `\Magento\Integration\Api\IntegrationServiceInterface`:
72+
- create a new Integration
73+
- get the details of a specific Integration by integration ID
74+
- find Integration by name
75+
- get the details of an Integration by consumer_id
76+
- get the details of an active Integration by consumer_id
77+
- update an Integration
78+
- delete an Integration by integration ID
79+
- get an array of selected resources for an integration
80+
81+
- `\Magento\Integration\Api\OauthServiceInterface`:
82+
- create a new consumer account
83+
- create access token for provided consumer
84+
- retrieve access token assigned to the consumer
85+
- load consumer by its ID
86+
- load consumer by its key
87+
- execute post to integration (consumer) HTTP Post URL. Generate and return oauth_verifier
88+
- delete the consumer data associated with the integration including its token and nonce
89+
- remove token associated with provided consumer
90+
91+
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).
92+
93+
## Additional information
94+
95+
### Cron options
96+
97+
Cron group configuration can be set at `etc/crontab.xml`:
98+
- `outdated_authentication_failures_cleanup` - clearing log of outdated token request authentication failures
99+
- `expired_tokens_cleanups` - delete expired customer and admin tokens
100+
101+
[Learn how to configure and run cron in Magento.](http://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-cron.html).
102+
103+
More information can get at articles:
104+
- [Learn more about an Integration](https://docs.magento.com/user-guide/system/integrations.html)
105+
- [Lear how to create an Integration](https://devdocs.magento.com/guides/v2.4/get-started/create-integration.html)

0 commit comments

Comments
 (0)