Chapter 11. Rating

The ratings feature allows users to rate objects on a configurable numeric scale.

Rating is enabled by default, but can be disabled on a global basis in the Control Panel. This will prevent receiving of ratings via both the template engine and the HTTP API, but will not affect output of ratings in either of these components. Ratings that have already been received will still appear.

In the template engine, ratings can also be disabled on a per-template set basis by removing any calls to $view->getHelper()->getHtmlRatingsSection() from the templates.

The ratings feature can be included within an object view template (object/single.html.php and object/compound.html.php) using the $view->getHelper()->getHtmlRatingsSection() method. This method will handle all aspects of generating the rating form.

Ratings can also be accessed and posted via the HTTP API.