README

Simple Rating plugin

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 ournameismud/rate-me
```
In the Control Panel, go to Settings → Plugins and click the “Install” button for Rate Me.

Rate Me Overview

Simple plugin to capture ratings for elements.

Configuring Rate Me

The following settings are available for the plugin:

Logged-in users only

Check this option to limit posting to logged-in users only (otherwise ratings can be submitted anonymously).

Email recipients

You can specify recipients to be notified when a rating is posted. Simply add a comma-separated list of email recipients.

Using Rate Me

Sample form

Example form with 1 to 5 rating dropdown:

<form method="POST">
	<input type="hidden" name="action" value="rate-me/default/rate" />
	<input type="hidden" name="element" value="{{ elementId }}" />
	{{ csrfInput() }}
	{% set rating = craft.rateMe.getRating( elementId ) %}
	<fieldset>
		<legend>Rate Me</legend>
		<label for="rating">Rating</label>
		<select name="rating" id="rating">
			{% for i in 1..5 %}
			<option {{ rating == i ? 'selected' }} value="{{ i }}">{{ i }}</option>
			{% endfor %}
		</select>	
		<button" type="submit">{{'Submit'|t}}</button>
	</fieldset>
</form>

Variables

getRating

Pass element id into the following: {{ craft.rateMe.getRating( elementId ) }} to get the rating for that user (if not logged in then will generate an anonymous session ID)

getAverage

To get average ratings for a particular element then use the following: {% set average = craft.rateMe.getAverage( elementId ) %}. This will return an object with count and average rating, eg {{ average.rating }} and {{ average.count }}. If no ratings exist for that element then the variable will return null.

You can use the |number_format twig filter to round the rating number.

Rate Me Roadmap

Some things to do, and ideas for potential features:

Release it

Brought to you by @cole007 Icon rate by Rose Alice Design from the Noun Project

ournameismud / rate-me

Maintainers

Details