The full plugin documentation is available here.

Extension ProductItem class

Plugin adds fields:

• (float) rating
• (ReviewCollection) review

"review" field in ProductItem object returns ReviewCollection object with sorted reviews for this product.

Example: render product reviews on product page

[ProductPage]
slug = "{{ :slug }}"
==

{# Get product item #}s
{% set obProduct = ProductPage.get() %}
<div data-id="{{ obProduct.id }}">
    <h1>{{ obProduct.name }}</h1>
   {# Render product rating #}
    <div>{{ obProduct.rating }}</div>
    {# Get list of reviews #}
    {% set obReviewList = obProduct.review %}
    {% if obReviewList.isNotEmpty() == true %}
        <ul>
            {% for obReview in obReviewList %}
            <li>{{ obReview.comment }}</li>
            {% endfor %}
        </ul>
    {% endif %}
</div>

MakeReview component

The component allows to create reviews.

Component properties:

• Mode (Submit form/Ajax form)
• Send flash message (only for Ajax mode)
• Enable redirect
• Choose page for redirect (the URL of the page will be passed to the review ID, product ID and product slug)

Usage: The component is used to process the review form. To send an ajax request, you must use the MakeReview::onCreate method. Available fields: name, email, phone, comment, rating.

Example 1 (Submit form).

[MakeReview]
mode = "submit"
redirect_on = 1
redirect_page = "review_success"
==

{% set arError = MakeReview.getErrorMessage %}
{% set arForm = MakeReview.getOldFormData %}

<form>
    <label for="field-email">Email</label>
    <input type="email" id="field-email" placeholder="Email" name="email" value="{{ arForm.email }}">
    {% if arError.message is not empty and arError.field == 'email' %}
        <p>{{ arError.message }}</p>
    {% endif %}

    <label for="field-comment">Comment</label>
    <textarea id="field-comment" name="comment">{{ arForm.comment }}</textarea>
    {% if arError.message is not empty and arError.field == 'comment' %}
        <p>{{ arError.message }}</p>
    {% endif %}

    <span>Rating:</label>
    <label><input type="radio" name="rating" value="1">1</label>
    <label><input type="radio" name="rating" value="2">2</label>
    <label><input type="radio" name="rating" value="3">3</label>
    <label><input type="radio" name="rating" value="4">4</label>
    <label><input type="radio" name="rating" value="5">5</label>

    <input type="hidden" name="product_id" value="10">
    <button type="submit">Submit</button>
</form>
{% if arError.message is not empty %}
    <p>{{ arError.message }}</p>
{% endif %}

Example 1 (Ajax request).

$('form').request('MakeReview::onCreate');

The MakeReview.getOldFormData method returns the filled form fields, if the form was sent and an error occurred. The MakeReview.getErrorMessage method returns an error message if the form was sent and an error occurred.

[
    'message' => 'Error message',
    'field'   => 'email',           //Field name, if there was a validation error
]

Plugin adds sorting by rating to ProductCollection class ('rating|desc', 'rating|asc').

Example: render of product list

Get collection of product, apply sorting by rating (desc), filter by flag "active" and category ID.

{% set obCategory = CategoryPage.get() %}

{% set obProductList = ProductList.make().sort('rating|desc').active().category(obCategory.id) %}
{% if obProductList.isNotEmpty() %}
    <div class="product-list-wrapper">
        {% for obProduct in obProductList %}
            <div data-id="{{ obProduct.id }}">
                <h1>{{ obProduct.name }}</h1>
                {% if obProduct.preview_image is not empty %}
                    <img src="{{ obProduct.preview_image.path }}" title="{{ obProduct.preview_image.title }}" alt="{{ obProduct.preview_image.alt }}">
                {% endif %}
                <div>{{ obProduct.preview_text }}</div>
            </div>
        {% endfor %}
    </div>
{% endif %}