Download the PHP package hypejunction/elgg_stars without Composer
On this page you can find all versions of the php package hypejunction/elgg_stars. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download hypejunction/elgg_stars
More information about hypejunction/elgg_stars
Files in hypejunction/elgg_stars
Package elgg_stars
Short Description Star rating for Elgg
License GPL-2.0
Homepage http://hypejunction.com
Informations about the package elgg_stars
Elgg Stars
Star rating for Elgg
Usage
Adding a rating form
-
First, either define your rating criteria using the plugin setting, or by calling for each rating criteria you are intending to use.
- Add a form to rate an existing entity:
This will display a form with 2 star rating modules. User input will be processed in real time. No need for any further coding on your side.
Adding a static star input to a form
To add a star input to your form, simple call:
In your action, you would then use standard Elgg API:
See for a list of additional parameters, including minimum and maximum values;
Getting rating values
To get a value for a single or multiple criteria, you can call
You can leave the second parameter empty, to get a total value for all registered rating criteria.
Note that this function will return an associative array, where: is an actual average value of all ratings. Ratings are not weighed, so if you are planning to use multiple rating scales, you need to add your own weighing algorithms.
Displaying star ratings without user input
To display any value on a star rating scale:
You can also specify, 'min', 'max', and 'step' parameters to configure the scale.
Credits / Acknowledgements
RateIt - a jQuery star rating plugin http://rateit.codeplex.com/
Fast, Progressive enhancement, touch support, customizable (just swap out the images, or change some CSS), Unobtrusive JavaScript (using HTML5 data-* attributes), RTL support, ARIA & keyboard support. Use as many stars as you'd like, and also any step size.
Notes
- This is a framework-agnostic adaptation of discontinued hypeStarRating