hryvinskyi / magento2-catalog-sorting-top-rated
Catalog sort option Top Rated: the products with the highest customer rating first, taken from the review summaries by the daily popularity data refresh.
Package info
github.com/hryvinskyi/magento2-catalog-sorting-top-rated
Type:magento2-module
pkg:composer/hryvinskyi/magento2-catalog-sorting-top-rated
Requires
- php: ~8.1.0||~8.2.0||~8.3.0||~8.4.0||~8.5.0
- hryvinskyi/magento2-catalog-sorting: ^1.0
- hryvinskyi/magento2-catalog-sorting-metrics: ^1.0
- hryvinskyi/magento2-catalog-sorting-options: ^1.0
- magento/framework: *
- magento/module-backend: *
- magento/module-catalog: *
- magento/module-config: *
- magento/module-review: *
- magento/module-store: *
Requires (Dev)
None
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Adds Top Rated to the storefront Sort By list: the products with the highest customer rating first, per store view.
What it does for a store
- A Top Rated sort order (
product_list_order=rating_summary), offered in the store views where it is enabled. A listing sorted by it opens highest-rated first when the shopper chose no direction. - The platform's rating summary, per store. A product's value in a store is the
rating_summaryits review summary row holds for that store. The module computes no rating of its own. - Copied once a day, not per request. The value is read with one select over the review summaries by the popularity data refresh of
hryvinskyi/magento2-catalog-sorting-metrics. Only products whose value changed get their search documents rebuilt. - Sorted in the search engine on the numeric document field
sort_rating_summary; no join and no computation per query. A product without a rating sorts as 0.
Requirements
- PHP 8.1 to 8.5.
hryvinskyi/magento2-catalog-sorting,hryvinskyi/magento2-catalog-sorting-optionsandhryvinskyi/magento2-catalog-sorting-metrics, ^1.0 each.- The platform's Review, Catalog, Store, Config and Backend modules (what
composer.jsonandetc/module.xmldeclare).
Installation
composer require hryvinskyi/magento2-catalog-sorting-top-rated bin/magento setup:upgrade bin/magento setup:di:compile bin/magento cache:flush bin/magento indexer:reindex catalogsearch_fulltext
The module adds the field sort_rating_summary to the product search documents. One full catalogsearch_fulltext reindex puts it into the index mapping; listings keep working before it. After enabling the option in a store view, run bin/magento catalog-sorting:metrics:refresh --metric=rating_summary, or wait for the next scheduled refresh.
Configuration
Stores › Configuration › Catalog › Catalog Sorting › Top Rated
| Path | Label | Default | Scope |
|---|---|---|---|
catalog_sorting/rating_summary/enabled |
Enabled | No | default, website, store view |
The label, the place and the visibility of the option in Sort By are set in Catalog Sorting › Sort Options. The refresh schedule is in Catalog Sorting › Popularity Data Refresh.
Registrations
| Pool | Item |
|---|---|
metrics of Hryvinskyi\CatalogSortingMetrics\Model\MetricRegistry |
metric rating_summary, field sort_rating_summary (double) |
sortFields of Hryvinskyi\CatalogSorting\Model\Search\ShopperSortFields |
code rating_summary on sort_rating_summary |
options of Hryvinskyi\CatalogSortingOptions\Model\ListingSortOptions |
option rating_summary, "Top Rated", descending, sortOrder 130 |