Skip to content

Commit 62ec278

Browse files
ENGCOM-9026: [ReadMe] updated readMe file for Persistent-QuoteAnalitics #32356
- Merge Pull Request #32356 from vlmed/magento2:update_readme_persistent-quote_analitics - Merged commits: 1. 889703b 2. 50389ce
2 parents 4898eb4 + 50389ce commit 62ec278

File tree

5 files changed

+462
-13
lines changed

5 files changed

+462
-13
lines changed

app/code/Magento/Persistent/README.md

Lines changed: 58 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,61 @@
1-
Magento\Persistent module enables set customer a long-term cookie containing internal id (random hash - to exclude brute
2-
force) of persistent session. Persistent session data is kept in DB - so it's not deleted in some days and is kept for
1+
# Magento_Persistent module
2+
3+
This module enables setting a long-term cookie containing internal id (random hash - to exclude brute
4+
force) of persistent session for customer. Persistent session data is kept in DB - so it's not deleted in some days and is kept for
35
as much time as we need. DB session keeps customerId + some data from real customer session that we want to sync (e.g.
46
num items in shopping cart). For registered customer this info is synced to persistent session if choose "Remember me"
57
checkbox during first login.
8+
9+
## Installation
10+
11+
Before installing this module, note that the Magento_Persistent is dependent on the following modules:
12+
- `Magento_Checkout`
13+
- `Magento_PageCache`
14+
15+
The Magento_Persistent module creates the `persistent_session` table in the database.
16+
17+
This module modifies the following tables in the database:
18+
- `quote` - adds column `is_persistent`
19+
20+
All database schema changes made by this module are rolled back when the module gets disabled and setup:upgrade command is run.
21+
22+
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).
23+
24+
## Extensibility
25+
26+
Extension developers can interact with the Magento_Persistent module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
27+
28+
[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_Persistent module.
29+
30+
A lot of functionality in the module is on JavaScript, use [mixins](https://devdocs.magento.com/guides/v2.4/javascript-dev-guide/javascript/js_mixins.html) to extend it.
31+
32+
### Events
33+
34+
The module dispatches the following events:
35+
36+
#### Controller
37+
38+
- `persistent_session_expired` event in the `\Magento\Persistent\Controller\Index\UnsetCookie::execute` method
39+
40+
#### Observer
41+
42+
- `persistent_session_expired` event in the `\Magento\Persistent\Observer\CheckExpirePersistentQuoteObserver::execute` method
43+
44+
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).
45+
46+
### Layouts
47+
48+
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).
49+
50+
## Additional information
51+
52+
More information can get at articles:
53+
- [Persistent Shopping Cart](https://docs.magento.com/user-guide/configuration/customers/persistent-shopping-cart.html)
54+
- [Persistent Cart](https://docs.magento.com/user-guide/sales/cart-persistent.html)
55+
56+
### Cron options
57+
58+
Cron group configuration can be set at `etc/crontab.xml`:
59+
- `persistent_clear_expired` - clear expired persistent sessions
60+
61+
[Learn how to configure and run cron in Magento.](http://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-cron.html).
Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,47 @@
1-
The Magento_ProductAlert module enables product alerts, which allow customers to sign up for emails about product price or stock status change.
1+
# Magento_ProductAlert module
2+
3+
This module enables product alerts, which allow customers to sign up for emails about product price or stock status change.
4+
5+
## Installation
6+
7+
Before installing this module, note that the Magento_ProductAlert is dependent on the following modules:
8+
- `Magento_Catalog`
9+
- `Magento_Customer`
10+
11+
The Magento_ProductAlert module creates the following tables in the database:
12+
- `product_alert_price`
13+
- `product_alert_stock`
14+
15+
All database schema changes made by this module are rolled back when the module gets disabled and setup:upgrade command is run.
16+
17+
The Magento_ProductAlert module contains the recurring script. Script's modifications don't need to be manually reverted upon uninstallation.
18+
19+
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).
20+
21+
## Extensibility
22+
23+
Extension developers can interact with the Magento_ProductAlert module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
24+
25+
[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_ProductAlert module.
26+
27+
### Layouts
28+
29+
This module introduces the following layouts in the `view/frontend/layout` directory:
30+
- `catalog_product_view`
31+
- `productalert_unsubscribe_email`
32+
33+
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).
34+
35+
## Additional information
36+
37+
More information can get at articles:
38+
- [Product Alerts](https://docs.magento.com/user-guide/catalog/inventory-product-alerts.html)
39+
- [Product Alert Run Settings](https://docs.magento.com/user-guide/catalog/inventory-product-alert-run-settings.html)
40+
41+
### Cron options
42+
43+
Cron group configuration can be set at `etc/crontab.xml`:
44+
- `catalog_product_alert` - send product alerts to customers
45+
46+
[Learn how to configure and run cron in Magento.](http://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-cron.html).
47+
Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,46 @@
1-
The Magento_ProductVideo module implements functionality related with linking video files from external resources to product.
1+
# Magento_ProductVideo module
2+
3+
This module implements functionality related with linking video files from external resources to product.
4+
5+
## Installation
6+
7+
Before installing this module, note that the Magento_ProductAlert is dependent on the following modules:
8+
- `Magento_Catalog`
9+
- `Magento_Backend`
10+
11+
The Magento_ProductVideo module creates the `catalog_product_entity_media_gallery_value_video` table in the database.
12+
13+
All database schema changes made by this module are rolled back when the module gets disabled and setup:upgrade command is run.
14+
15+
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).
16+
17+
## Extensibility
18+
19+
Extension developers can interact with the Magento_ProductVideo module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
20+
21+
[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_ProductVideo module.
22+
23+
A lot of functionality in the module is on JavaScript, use [mixins](https://devdocs.magento.com/guides/v2.4/javascript-dev-guide/javascript/js_mixins.html) to extend it.
24+
25+
### Layouts
26+
27+
This module introduces the following layouts in the `view/frontend/layout` and `view/adminhtml/layout` directories:
28+
- `view/adminhtml/layout`
29+
- `catalog_product_new`
30+
- `view/frontend/layout`
31+
- `catalog_product_view`
32+
33+
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).
34+
35+
### UI components
36+
37+
This module extends following ui components located in the `view/adminhtml/ui_component` directory:
38+
- `product_form`
39+
40+
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).
41+
42+
## Additional information
43+
44+
More information can get at articles:
45+
- [Learn how to add Product Video](https://docs.magento.com/user-guide/catalog/product-video.html)
46+
- [Learn how to configure Product Video](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/themes/product-video.html)

0 commit comments

Comments
 (0)