Skip to content

Commit

Permalink
[ReadMe] updated readMe file for LoginAsCustomer-Marketplace modules
Browse files Browse the repository at this point in the history
  • Loading branch information
vlmed committed Feb 3, 2021
1 parent 2a4641b commit 32c32fd
Show file tree
Hide file tree
Showing 11 changed files with 303 additions and 15 deletions.
20 changes: 19 additions & 1 deletion app/code/Magento/LoginAsCustomer/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
# Magento_LoginAsCustomer module

The Magento_LoginAsCustomer module is responsible for ability to login into customer account using the admin panel.
This module is responsible for ability to login into customer account using the admin panel.

## Installation

The Magento_LoginAsCustomer module creates the `login_as_customer` table in the database.

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).

## Extensibility

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).

[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.

## Additional information

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)
39 changes: 37 additions & 2 deletions app/code/Magento/LoginAsCustomerAdminUi/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,38 @@
# Magento_LoginAsCustomerSales module
# Magento_LoginAsCustomerAdminUi module

The Magento_LoginAsCustomerAdminUi module provides UI for Admin Panel
This module provides UI for Admin Panel for Login As Customer functionality.

## Installation

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).

## Extensibility

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).

[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.

### Layouts

This module introduces the following layouts in the `view/adminhtml/layout` directory:
- `adminhtml_order_shipment_view`
- `customer_index_edit`
- `loginascustomer_confirmation_popup`
- `sales_order_creditmemo_view`
- `sales_order_invoice_view`
- `sales_order_view`

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).

### UI components

This module extends ui components. The configuration files located in the directory `view/adminhtml/ui_component`:
- `customer_form`

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).

## Additional information

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).
47 changes: 45 additions & 2 deletions app/code/Magento/LoginAsCustomerApi/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,46 @@
# Magento_LoginAsCustomer module
# Magento_LoginAsCustomerApi module

The Magento_LoginAsCustomerApi module provides API for ability to login into customer account for an admin user.
This module provides API for ability to login into customer account for an admin user.

## Installation

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).

## Extensibility

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).

[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.

### Public APIs

- `\Magento\LoginAsCustomerApi\Api\DataAuthenticationDataInterface`:
- authentication data

- `\Magento\LoginAsCustomerApi\Api\AuthenticateCustomerBySecretInterface`:
- authenticate a customer by secret

- `\Magento\LoginAsCustomerApi\Api\ConfigInterface`:
- check if Login as Customer extension is enabled
- check if store view manual choice is enabled
- get authentication data expiration time (in seconds)

- `\Magento\LoginAsCustomerApi\Api\DeleteAuthenticationDataForUserInterface`:
- delete authentication data by user id

- `\Magento\LoginAsCustomerApi\Api\GetAuthenticationDataBySecretInterface`:
- get authentication data by secret

- `\Magento\LoginAsCustomerApi\Api\IsLoginAsCustomerSessionActiveInterface`:
- check if Login as Customer session is still active

- `\Magento\LoginAsCustomerApi\Api\SaveAuthenticationDataInterface`:
- save authentication data. Return secret key

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).

## Additional information

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).
38 changes: 37 additions & 1 deletion app/code/Magento/LoginAsCustomerAssistance/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,39 @@
# Magento_LoginAsCustomerAssistance module

The Magento_LoginAsCustomerAssistance module provides possibility to enable/disable LoginAsCustomer functionality per Customer.
This module provides possibility to enable/disable LoginAsCustomer functionality per Customer.

## Installation

The Magento_LoginAsCustomerAssistance module creates the `login_as_customer_assistance_allowed` table in the database.

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).

## Extensibility

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).

[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.

### Layouts

This module introduces the following layouts in the `view/adminhtml/layout` and `view/frontend/layout` directories:
- `view/adminhtml/layout`:
- `loginascustomer_confirmation_popup`
- `view/frontend/layout`:
- `customer_account_create`
- `customer_account_edit`

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).

### UI components

This module extends ui components. The configuration files located in the directory `view/adminhtml/ui_component`:
- `customer_form`

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).

## Additional information

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).
24 changes: 22 additions & 2 deletions app/code/Magento/LoginAsCustomerFrontendUi/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
# Magento_LoginAsCustomerSales module
# Magento_LoginAsCustomerFrontendUi module

The Magento_LoginAsCustomerFrontendUi module provides UI for Storefront
This module provides UI for Storefront for Login As Customer functionality.

## Extensibility

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).

[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.

### Layouts

This module introduces the following layouts in the `view/frontend/layout` directory:
- `loginascustomer_login_index`
- `default`

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).

## Additional information

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).
29 changes: 27 additions & 2 deletions app/code/Magento/LoginAsCustomerGraphQl/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,28 @@
# LoginAsCustomerGraphQl
# Magento_LoginAsCustomerGraphQl module

**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.
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.

## Installation

Before installing this module, note that the Magento_GroupedProductGraphQl is dependent on the following modules:

- Magento_LoginAsCustomerApi
- Magento_Customer
- Magento_Store
- Magento_CatalogGraphQlr

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).

## Extensibility

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).

[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.

## Additional information

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).
51 changes: 50 additions & 1 deletion app/code/Magento/LoginAsCustomerLog/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,52 @@
# Magento_LoginAsCustomerLog module

The Magento_LoginAsCustomerLog module provides log for Login as Customer functionality
This module provides log for Login as Customer functionality

## Installation

The Magento_LoginAsCustomerLog module creates the `magento_login_as_customer_log` table in the database.

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).

## Extensibility

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).

[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.

### 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://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html).

### 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`

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).

### Public APIs

- `\Magento\LoginAsCustomerLog\Api\Data\LogInterface`
- login as customer log data

- `\Magento\LoginAsCustomerLog\Api\Data\LogSearchResultsInterface`
- login as customer log entity search results data

- `\Magento\LoginAsCustomerLog\Api\GetLogsListInterface`:
- get login as customer log list considering search criteria

- `\Magento\LoginAsCustomerLog\Api\SaveLogsInterface`:
- save login as custom logs entities

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).

## Additional information

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).
18 changes: 16 additions & 2 deletions app/code/Magento/LoginAsCustomerPageCache/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# LoginAsCustomerPageCache module
# Magento_LoginAsCustomerPageCache module

The Magento_LoginAsCustomerPageCache module provides adaptation to PageCache functionality
This module provides adaptation to PageCache functionality for Login as Customer functionality.

## Installation

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).

## Extensibility

[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.

## Additional information

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).
14 changes: 14 additions & 0 deletions app/code/Magento/LoginAsCustomerQuote/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Magento_LoginAsCustomerQuote module

The Magento_LoginAsCustomerQuote module is responsible for communication between Magento_LoginAsCustomer and shopping cart state.

## Installation

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).

## Extensibility

[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.

## Additional information

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).
16 changes: 15 additions & 1 deletion app/code/Magento/LoginAsCustomerSales/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Magento_LoginAsCustomerSales module

The Magento_LoginAsCustomerSales module is responsible for communication between Magento_LoginAsCustomer and order placement.
This module is responsible for communication between Magento_LoginAsCustomer and order placement.

## Installation

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).

## Extensibility

[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.

## Additional information

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).
22 changes: 21 additions & 1 deletion app/code/Magento/Marketplace/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,21 @@
The Magento_Marketplace module allows to display partners of Magento in the backend.
# Magento_Marketplace module

This module allows to display partners of Magento in the backend.

## Installation

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).

## Extensibility

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).

[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.

### Layouts

This module introduces the following layouts in the `view/adminhtml/layout` directory:
- `marketplace_index_index`
- `marketplace_partners_index`

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 comments on commit 32c32fd

Please sign in to comment.