# smile/module-elasticsuite-rating

> Smile ElasticSuite - Rating search module.

`composer require smile/module-elasticsuite-rating`

Canonical URL: https://packagento.com/smile/module-elasticsuite-rating

## At a glance

- **Vendor**: smile (https://packagento.com/smile.md)
- **Latest version**: 2.4.0 — released 2026-04-14
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/smile/module-elasticsuite-rating and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require smile/module-elasticsuite-rating:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Smile ElasticSuite - Rating search module.

## README

This module is a plugin for [ElasticSuite](https://github.com/Smile-SA/elasticsuite).

It allows to display Magento2 user's ratings as a facet filter, and also as a sort order.

#### Benefits

- You will see a new facet allowing to **filter on products average ratings**.

![Rating Filter](doc/static/rating_filter.png)


- You will also be able to use the ratings as a **sort order** in category pages and search results.

![Rating Filter](doc/static/rating_sort.png)



#### Requirements

The module requires :

- [ElasticSuite](https://github.com/Smile-SA/elasticsuite) > 2.3.*

- Magento2 CE/EE Edition

#### Quick Start Guide

1. Install the module via Composer :

``` composer require smile/module-elasticsuite-rating ```

2. Enable it

``` bin/magento module:enable Smile_ElasticsuiteRating ```

3. Install the module and rebuild the DI cache

``` bin/magento setup:upgrade ```

4. Process a full reindex of catalogsearch index to reindex the Ratings data

``` bin/magento index:reindex catalogsearch_fulltext ```


#### How to use

The module is adding a new Product Attribute, called **ratings_summary**.

Since this is managed via an attribute, you are able to :

- display/hide it on category pages (via the __Is Filterable__ option)
- display/hide it on search pages (via the __Is Filterable In Search__ option)
- allow/disallow it for sort order (via the __Used for Sort By__ option)

## Recent Versions

| Version | Released |
|---|---|
| 2.4.0 | 2026-04-14 |
| 2.3.2 | 2021-08-30 |
| 2.3.1 | 2019-05-09 |
| 2.3.0 | 2019-03-05 |
| 2.2.0 | 2019-03-05 |
| 2.1.6 | 2019-03-05 |
| 2.1.5 | 2018-03-13 |
| 2.1.4 | 2018-02-12 |
| 2.1.3 | 2018-01-10 |
| 2.1.2 | 2017-11-21 |

Showing 10 of 15 versions. Full release history on https://packagento.com/smile/module-elasticsuite-rating.

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | >=102.0.0 |
| magento/magento-composer-installer | * |
| magento/module-review | >=100.1.0 |
| smile/elasticsuite | ^2.8.0 |

### Require (dev)

| Package | Constraint |
|---|---|
| smile/magento2-smilelab-quality-suite | ~2.1.0\|~2.2.0 |

## Quality

Latest release (2.4.0) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Fail | 42 | 2 errors, 40 warnings (ruleset: Magento2) — 31 auto-fixable with phpcbf |
| PHPMD | Pass | 0 |  |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 3 | valid; 3 advisory notes (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 964 | 964 | – | – |
| 2.4.8 | – | 964 | 964 | – |
| 2.4.9 | – | – | 956 | 956 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["smile/module-elasticsuite-rating"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

smile is a Magento 2 vendor on Packagento. See https://packagento.com/smile.md for their full catalogue.