Getting Started

Welcome to the Advanced Reviews Documentation. Whether you are a new or an advanced user, you can find some useful information here.

First of all, we recommend you check the following link:

How to install extension

How to install the extension

Backup your store's database and web directory.
Login to your server's SSH console and navigate to the root directory of the Magento 2 store.
Copy the installation instructions from the page My Downloadable Products into the SSH console and press ENTER.

Run the command below to enable the extension:

    php -f bin/magento module:enable Mirasvit_Core Mirasvit_Review

Run the command below to install the extension:
```
    php -f bin/magento setup:upgrade
```
Run the command below to clean the cache:
```
    php -f bin/magento cache:clean
```

Deploy static view files:

    rm -rf pub/static/frontend/*; rm -rf pub/static/backend/*; rm -rf var/view_preprocessed/*;
    php -f bin/magento setup:static-content:deploy

Make sure that the native Magento cronjob is configured and working correctly. The extension performs all tasks in cron.
The module Mirasvit_OptimizeImage requires server-side software to work properly. You can find information about required packages and their installation here.

Advanced Reviews settings

The settings of Advanced Reviews are located at Stores ▸ Configuration ▸ Mirasvit Extensions ▸ Advanced Reviews and are grouped into the following sections:

General Settings - basic configuration of the extension;
Review Media - attachments and gallery settings;
AI Features - settings for AI-powered features;

Extended Settings

Enabled - enable/disable reviews.
Allow Guests to Write Reviews - enable/disable the ability to leave reviews for guests.
Default Sort by - default sort order for reviews.
Display Pros/Cons - enable/disable additional review fields - pros and cons.
Display Reviewer Location - enable/disable location label from where the review was placed.
Display "Verified Buyer" Labels - enable/disable "Verified Buyer" label for reviews placed after the product was ordered.
Display Purchased Product Info - displays additional information of purchased product. This option only affects reviews for configurable products placed by verified buyers.
Order Statuses - Select for which order statuses the customer should be considered as a "Verified Buyer". By default only the "complete" status is used. After changing this setting reindex reviews with the command bin/magento mirasvit:review:reindex --verify --force

Review Media

Enable attaching photos to reviews - enable/disable the ability to attach photos to reviews.
Display review photos gallery - enable/disable the media gallery for attached photos.
Maximum number of photos per review - Max number of images to upload per review. The limit should be between 1 and 20 photos. If empty, the default limit will be used (5 photos).

AI Features

API Key - Generate an OpenAI API key. You'll need to create an account if you don't have one.
Enable review aggregation - If enabled the extension will generate a summarized review for each products. The summarized review will be generated based on the last 10 customer reviews. The summarized review won't be generated for products with less than 5 reviews.
Add info hint to review summary title - If enabled the extension will add info icon and popup with info that the summary was generated by AI.
Autowrite Review - Enable/disable the ability to generate the content for a product review using Open AI (ChatGPT) when creating a new review from the admin panel.

Command Line Interface

Usage: php -f bin/magento [command]

mirasvit:mirasvit:review:aggregate [options] - generate aggregated reviews (AI-powered). Allowoed Options:
- --product [id] - specify the ID of the product for which aggregated review should be generated. If ommited the extension will generate aggregated reviews for all reviewed products.
mirasvit:mirasvit:review:generate [options] - generate reviews using Open AI. Allowed options:
- --nickname [nickname] - the nickname of the reviewer. This option is required.
- --rating [rating] - rating from 1 to 5. This option is required.
- --product [product_id] - the ID of the product for which the review should be generated. If ommited the extension will generate reviews for all products.
- --store [store_id] - specify for which store view the review should be generated
- --additional [text] - add additional instructions for Open AI. These instructions will be included in the prompt for reviews generation.
- --qty [number] - the limit of reviews to generate in one execution.
- --autoapprove - define if generated reviews should be automaticaly marked as approved
mirasvit:review:reindex [options] - reindex reviews locations and "verified buyer" data. If no options specified the extension will reindex both. Allowed options:
- --verify - reindex "verified buyer" data.
- --location - reindex reviewers' location data.
- --force - force reindex. Affects only the "verified buyer" data reindex. Should be used after changing the Store Statuses setting of the extension.

How to upgrade extension

To upgrade the extension, follow these steps:

Backup your store's database and web directory.
Login to your server's SSH console and navigate to the root directory of the Magento 2 store.
Run the command below to update the current extension with all dependencies:
```
    composer require mirasvit/module-review:* --update-with-dependencies
```
Note
In some cases, the command above is not applicable; neither is it possible to update just the current module, nor need to upgrade all the Mirasvit modules in a bundle. In this case, the command above will be of no effect.

Run instead composer update mirasvit/* command. It will update all the Mirasvit modules installed in your store.

Run the command below to enable the extension:

    php -f bin/magento module:enable Mirasvit_Core Mirasvit_Review

Run the command below to install updates:
```
    php -f bin/magento setup:upgrade
```
Run the command below to clean the cache:
```
    php -f bin/magento cache:clean
```

Deploy static view files:

    rm -rf pub/static/frontend/*; rm -rf pub/static/backend/*; rm -rf var/view_preprocessed/*;
    php -f bin/magento setup:static-content:deploy

Disabling the Extension

Temporarily Disable

To temporarily disable the extension please follow the following steps:

Run the command below to disable the extension:

    php -f bin/magento module:disable Mirasvit_Review

Removing the Extension

To uninstall the extension, please follow these steps:

Run the command below to remove the extension:

    composer remove mirasvit/module-review

Change Log

1.0.5

(2024-04-22)

Improvements

Ability to select order statuses for which the customer should be considered as 'verified buyer'

1.0.4

(2024-04-22)

Fixed

Fixed the issue with the error 'Disallowed image type' on .jpeg images

1.0.3

(2024-03-22)

Features

Review widgets: Photo gallery, All reviews, Overall rating

1.0.2

(2024-01-09)

Fixed

Fixed the issue with the error: Class Zend_Validate not found
Fixed the issue with image uploader

1.0.1

(2023-11-14)

Features

CLI interface for generating review

Fixed

Fixed the issue with reviews photo gallery

1.0.0

(2023-11-10)

Features

Added ability to attach photo to review
Purchased product info in reviews for configurable products
Reviews photos gallery in reviews listing on product pages

0.0.2

(2023-10-17)

Improvements

Initial release

0.0.1

(2023-10-17)

Getting Started

How to install the extension

Advanced Reviews settings

Extended Settings

Review Media

AI Features

Command Line Interface

How to upgrade extension

Note

Disabling the Extension

Temporarily Disable

Removing the Extension

Change Log

1.0.5

Improvements

1.0.4

Fixed

1.0.3

Features

1.0.2

Fixed

1.0.1

Features

Fixed

1.0.0

Features

0.0.2

Improvements

0.0.1