Skip to content

Commit 0ba4767

Browse files
vlmedvlmed
committed
[ReadMe] updated readMe file for LoginAsCustomer-Marketplace modules
1 parent 58ede28 commit 0ba4767

File tree

11 files changed

+303
-15
lines changed

11 files changed

+303
-15
lines changed

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

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
11
# Magento_LoginAsCustomer module
22

3-
The Magento_LoginAsCustomer module is responsible for ability to login into customer account using the admin panel.
3+
This module is responsible for ability to login into customer account using the admin panel.
4+
5+
## Installation
6+
7+
The Magento_LoginAsCustomer module creates the `login_as_customer` table in the database.
8+
9+
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).
10+
11+
## Extensibility
12+
13+
Extension developers can interact with the Magento_LoginAsCustomer module. For more information about the Magento extension mechanism, see [Magento plugins](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
14+
15+
[The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_LoginAsCustomer module.
16+
17+
## Additional information
18+
19+
This module is a part of Login As Customer feature.
20+
21+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html)

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

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,38 @@
1-
# Magento_LoginAsCustomerSales module
1+
# Magento_LoginAsCustomerAdminUi module
22

3-
The Magento_LoginAsCustomerAdminUi module provides UI for Admin Panel
3+
This module provides UI for Admin Panel for Login As Customer functionality.
4+
5+
## Installation
6+
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).
8+
9+
## Extensibility
10+
11+
Extension developers can interact with the Magento_LoginAsCustomerAdminUi module. For more information about the Magento extension mechanism, see [Magento plugins](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
12+
13+
[The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_LoginAsCustomerAdminUi module.
14+
15+
### Layouts
16+
17+
This module introduces the following layouts in the `view/adminhtml/layout` directory:
18+
- `adminhtml_order_shipment_view`
19+
- `customer_index_edit`
20+
- `loginascustomer_confirmation_popup`
21+
- `sales_order_creditmemo_view`
22+
- `sales_order_invoice_view`
23+
- `sales_order_view`
24+
25+
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).
26+
27+
### UI components
28+
29+
This module extends ui components. The configuration files located in the directory `view/adminhtml/ui_component`:
30+
- `customer_form`
31+
32+
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).
33+
34+
## Additional information
35+
36+
This module is a part of Login As Customer feature.
37+
38+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html).

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

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,46 @@
1-
# Magento_LoginAsCustomer module
1+
# Magento_LoginAsCustomerApi module
22

3-
The Magento_LoginAsCustomerApi module provides API for ability to login into customer account for an admin user.
3+
This module provides API for ability to login into customer account for an admin user.
4+
5+
## Installation
6+
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).
8+
9+
## Extensibility
10+
11+
Extension developers can interact with the Magento_LoginAsCustomerApi module. For more information about the Magento extension mechanism, see [Magento plugins](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
12+
13+
[The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_LoginAsCustomerApi module.
14+
15+
### Public APIs
16+
17+
- `\Magento\LoginAsCustomerApi\Api\DataAuthenticationDataInterface`:
18+
- authentication data
19+
20+
- `\Magento\LoginAsCustomerApi\Api\AuthenticateCustomerBySecretInterface`:
21+
- authenticate a customer by secret
22+
23+
- `\Magento\LoginAsCustomerApi\Api\ConfigInterface`:
24+
- check if Login as Customer extension is enabled
25+
- check if store view manual choice is enabled
26+
- get authentication data expiration time (in seconds)
27+
28+
- `\Magento\LoginAsCustomerApi\Api\DeleteAuthenticationDataForUserInterface`:
29+
- delete authentication data by user id
30+
31+
- `\Magento\LoginAsCustomerApi\Api\GetAuthenticationDataBySecretInterface`:
32+
- get authentication data by secret
33+
34+
- `\Magento\LoginAsCustomerApi\Api\IsLoginAsCustomerSessionActiveInterface`:
35+
- check if Login as Customer session is still active
36+
37+
- `\Magento\LoginAsCustomerApi\Api\SaveAuthenticationDataInterface`:
38+
- save authentication data. Return secret key
39+
40+
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).
41+
42+
## Additional information
43+
44+
This module is a part of Login As Customer feature.
45+
46+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html).

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

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,39 @@
11
# Magento_LoginAsCustomerAssistance module
22

3-
The Magento_LoginAsCustomerAssistance module provides possibility to enable/disable LoginAsCustomer functionality per Customer.
3+
This module provides possibility to enable/disable LoginAsCustomer functionality per Customer.
4+
5+
## Installation
6+
7+
The Magento_LoginAsCustomerAssistance module creates the `login_as_customer_assistance_allowed` table in the database.
8+
9+
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).
10+
11+
## Extensibility
12+
13+
Extension developers can interact with the Magento_LoginAsCustomerAssistance module. For more information about the Magento extension mechanism, see [Magento plugins](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
14+
15+
[The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_LoginAsCustomerAssistance module.
16+
17+
### Layouts
18+
19+
This module introduces the following layouts in the `view/adminhtml/layout` and `view/frontend/layout` directories:
20+
- `view/adminhtml/layout`:
21+
- `loginascustomer_confirmation_popup`
22+
- `view/frontend/layout`:
23+
- `customer_account_create`
24+
- `customer_account_edit`
25+
26+
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).
27+
28+
### UI components
29+
30+
This module extends ui components. The configuration files located in the directory `view/adminhtml/ui_component`:
31+
- `customer_form`
32+
33+
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).
34+
35+
## Additional information
36+
37+
This module is a part of Login As Customer feature.
38+
39+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html).

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

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1-
# Magento_LoginAsCustomerSales module
1+
# Magento_LoginAsCustomerFrontendUi module
22

3-
The Magento_LoginAsCustomerFrontendUi module provides UI for Storefront
3+
This module provides UI for Storefront for Login As Customer functionality.
4+
5+
## Extensibility
6+
7+
Extension developers can interact with the Magento_LoginAsCustomerFrontendUi module. For more information about the Magento extension mechanism, see [Magento plugins](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
8+
9+
[The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_LoginAsCustomerFrontendUi module.
10+
11+
### Layouts
12+
13+
This module introduces the following layouts in the `view/frontend/layout` directory:
14+
- `loginascustomer_login_index`
15+
- `default`
16+
17+
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).
18+
19+
## Additional information
20+
21+
This module is a part of Login As Customer feature.
22+
23+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html).

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

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,28 @@
1-
# LoginAsCustomerGraphQl
1+
# Magento_LoginAsCustomerGraphQl module
22

3-
**LoginAsCustomerGraphQl** provides flexible login as a customer so a merchant or merchant admin can log into an end customer's account to assist them with their account.
3+
This module provides flexible login as a customer so a merchant or merchant admin can log into an end customer's account to assist them with their account.
4+
5+
## Installation
6+
7+
Before installing this module, note that the Magento_GroupedProductGraphQl is dependent on the following modules:
8+
9+
- Magento_LoginAsCustomerApi
10+
- Magento_Customer
11+
- Magento_Store
12+
- Magento_CatalogGraphQlr
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+
## Extensibility
17+
18+
Extension developers can interact with the Magento_LoginAsCustomerApi module. For more information about the Magento extension mechanism, see [Magento plugins](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
19+
20+
[The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_LoginAsCustomerApi module.
21+
22+
## Additional information
23+
24+
This module is a part of Login As Customer feature.
25+
26+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html).
27+
28+
You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql).

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

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,52 @@
11
# Magento_LoginAsCustomerLog module
22

3-
The Magento_LoginAsCustomerLog module provides log for Login as Customer functionality
3+
This module provides log for Login as Customer functionality
4+
5+
## Installation
6+
7+
The Magento_LoginAsCustomerLog module creates the `magento_login_as_customer_log` table in the database.
8+
9+
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).
10+
11+
## Extensibility
12+
13+
Extension developers can interact with the Magento_LoginAsCustomerLog module. For more information about the Magento extension mechanism, see [Magento plugins](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
14+
15+
[The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_LoginAsCustomerLog module.
16+
17+
### Layouts
18+
19+
This module introduces the following layouts in the `view/adminhtml/layout` directory:
20+
- `loginascustomer_log_log_index`
21+
22+
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).
23+
24+
### UI components
25+
26+
You can extend log listing updates using the configuration files located in the directories
27+
- `view/adminhtml/ui_component`:
28+
- `login_as_customer_log_listing`
29+
30+
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).
31+
32+
### Public APIs
33+
34+
- `\Magento\LoginAsCustomerLog\Api\Data\LogInterface`
35+
- login as customer log data
36+
37+
- `\Magento\LoginAsCustomerLog\Api\Data\LogSearchResultsInterface`
38+
- login as customer log entity search results data
39+
40+
- `\Magento\LoginAsCustomerLog\Api\GetLogsListInterface`:
41+
- get login as customer log list considering search criteria
42+
43+
- `\Magento\LoginAsCustomerLog\Api\SaveLogsInterface`:
44+
- save login as custom logs entities
45+
46+
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).
47+
48+
## Additional information
49+
50+
This module is a part of Login As Customer feature.
51+
52+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html).

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

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1-
# LoginAsCustomerPageCache module
1+
# Magento_LoginAsCustomerPageCache module
22

3-
The Magento_LoginAsCustomerPageCache module provides adaptation to PageCache functionality
3+
This module provides adaptation to PageCache functionality for Login as Customer functionality.
4+
5+
## Installation
6+
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).
8+
9+
## Extensibility
10+
11+
[The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_LoginAsCustomerPageCache module.
12+
13+
## Additional information
14+
15+
This module is a part of Login As Customer feature.
16+
17+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html).

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
11
# Magento_LoginAsCustomerQuote module
22

33
The Magento_LoginAsCustomerQuote module is responsible for communication between Magento_LoginAsCustomer and shopping cart state.
4+
5+
## Installation
6+
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).
8+
9+
## Extensibility
10+
11+
[The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_LoginAsCustomerQuote module.
12+
13+
## Additional information
14+
15+
This module is a part of Login As Customer feature.
16+
17+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html).

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

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
11
# Magento_LoginAsCustomerSales module
22

3-
The Magento_LoginAsCustomerSales module is responsible for communication between Magento_LoginAsCustomer and order placement.
3+
This module is responsible for communication between Magento_LoginAsCustomer and order placement.
4+
5+
## Installation
6+
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).
8+
9+
## Extensibility
10+
11+
[The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_LoginAsCustomerSales module.
12+
13+
## Additional information
14+
15+
This module is a part of Login As Customer feature.
16+
17+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html).

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

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,21 @@
1-
The Magento_Marketplace module allows to display partners of Magento in the backend.
1+
# Magento_Marketplace module
2+
3+
This module allows to display partners of Magento in the backend.
4+
5+
## Installation
6+
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).
8+
9+
## Extensibility
10+
11+
Extension developers can interact with the Magento_Marketplace module. For more information about the Magento extension mechanism, see [Magento plugins](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
12+
13+
[The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_Marketplace module.
14+
15+
### Layouts
16+
17+
This module introduces the following layouts in the `view/adminhtml/layout` directory:
18+
- `marketplace_index_index`
19+
- `marketplace_partners_index`
20+
21+
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).

0 commit comments

Comments
 (0)