README

An entry comments & reviews plugin for Craft CMS 3.x

Requirements

This plugin requires Craft CMS 3.0.0-beta.23 or later.

Installation

To install the plugin, follow these instructions.

Open your terminal and go to your Craft project:
```
cd /path/to/project
```
Then tell Composer to load the plugin:
```
composer require mortscode/reviews
```
In the Control Panel, go to Settings → Plugins and click the “Install” button for Reviews.

Reviews Overview

The Reviews plugin provides 2 types of forms for your users: Reviews & Questions. The idea is that sometimes you're looking for an actual review from users, other times, you just want to provide a way for users to ask questions or leave a suggestion. Below you'll find the 2 forms aimed at these 2 types of users.

Review Form

Required Fields:

Name
Email

Review-specific Fields:

Rating

<form id="reviews-form" class="er-form__form js-reviews-form" role="form" method="post" accept-charset="UTF-8">
    {{ hiddenInput('action', 'reviews/reviews/save') }}
    {{ hiddenInput('entryId', entry.id) }}
    {{ hiddenInput('token', "", {class: 'js-token-input'}) }}
    {{ hiddenInput('reviewType', 'review') }}
    {{ csrfInput() }}
    <input type="text" name="name" placeholder="name">
    <input type="email" name="email" placeholder="email">
    <div>
        <input type="radio" id="rating-1" name="rating" value="1"><label for="rating-1">1</label>
        <input type="radio" id="rating-2" name="rating" value="2"><label for="rating-2">2</label>
        <input type="radio" id="rating-3" name="rating" value="3"><label for="rating-3">3</label>
        <input type="radio" id="rating-4" name="rating" value="4"><label for="rating-4">4</label>
        <input type="radio" id="rating-5" name="rating" value="5"><label for="rating-5">5</label>
    </div>
    <textarea name="comment" id="comment" cols="30" rows="10"></textarea>
    <button type="submit">Submit!</button>
</form>

Questions Form

Add the following form to enable users to ask questions (no ratings):

<form id="reviews-form" class="er-form__form js-reviews-form" role="form" method="post" accept-charset="UTF-8">
    {{ hiddenInput('action', 'reviews/reviews/save') }}
    {{ hiddenInput('entryId', entry.id) }}
    {{ hiddenInput('token', "", {class: 'js-token-input'}) }}
    {{ hiddenInput('reviewType', 'question') }}
    {{ csrfInput() }}
    <input type="text" name="name" placeholder="name">
    <input type="email" name="email" placeholder="email">
    <textarea name="comment" id="comment" cols="30" rows="10"></textarea>
    <button type="submit">Submit!</button>
</form>

Configuring Reviews

Default Status

Set the status that your Reviews will start with when they're added.

Main Column Title

The heading above the 1st column on the main Reviews page in the CP. The default is "Entry".

Reviewable Sections

Check the section or sections that will have Reviews

Using Reviews

Available Variables

name
email
rating
comment
response

Templating

Render reviews in your templates like so:

{% set reviews = craft.reviews.getEntryReviews(entry.id) %}
<ol>
    {% for review in reviews %}
        <li>
            <h3>{{ review.name }}</h3>
            <p>{{ review.email }}</p>
            <p>Rating:
                {{ review.rating }}</p>
            <p>{{ review.comment }}</p>
            {% if review.response %}
                <p>{{ review.response }}</p>
            {% endif %}
        </li>
    {% endfor %}
</ol>

ReCaptcha

Register your site with Google ReCaptcha here.
Add your new site key and secret key to the Settings > Reviews page in the Craft CP
Add the JS script to pages using the Reviews plugin. You can grab the key from the settings page with the craft.reviews.getRecaptchaKey helper.

<script src="https://www.google.com/recaptcha/api.js?render={{ craft.reviews.getRecaptchaKey }}"></script>

On submit, get the token from ReCaptcha and pass it into the form before the submit takes place.

<script>
    var reviewForm = document.getElementById('reviews-form');

    reviewForm.addEventListener('submit', handleRecaptcha);

    function handleRecaptcha(e) {
        e.preventDefault();

        grecaptcha.ready(function() {
            grecaptcha.execute('{{ craft.reviews.getRecaptchaKey }}', {action: 'submit'}).then(function(token) {
                tokenizeForm(token);
            }).then(function() {
                // console.log('submit');
                reviewForm.submit();
            });
        });

        function tokenizeForm(token) {
            const tokenInput = document.querySelector('.js-token-input');
            console.log(tokenInput);
            tokenInput.value = token;
        }
    }

    reviewForm.addEventListener('submit', handleRecaptcha, false);
</script>

Reviews Roadmap

Some things to do, and ideas for potential features:

Release it

Brought to you by Mortscode

mortscode / reviews

Maintainers

Details