open social's sandbox: Rating system

Documentation of the Drupal rating system module

Description

The rating system module provides a framework and user interface for creating rating algorithms. The great thing of the rating system module is that you can change the algorithm and recalculate it.
We have build this module because we could not do that with userpoints or the voting framework.

Along with the core rating system module come three submodules and an example feature.
One for registering dynamic actions and one for calculation static cck values.
All rating system configurations are exportable through features.

So what does the Rating system core module?

The core let's you create rating groups. A rating group is an entity that holds the total points of all nodes belonging to that rating group. The core also provides rating group tokens so you can re-use the score of a node. There are some API calls which let you get the score of a node. It is also rendered for use on your node.tpl.php

rating_system_calculate($rating_group, $node, $update = FALSE, $long_route = FALSE, $route_data = NULL)

Check rating_system.module line 171 for more info.

Core let's other module integrate with it's caching and token system.

Rating system dynamic:

This submodule is for registering dynamic actions on your site with rules or a custom module. You can register actions like 'user views a page', 'user creates a page' and more like that.

These Rating system rules are only objects. It does not get triggered by the rating system module. You can trigger them with the rules module or with your own custom code.

Rating system CCK:

This submodule enables the calculation of a score to a node filled with cck values. You can give each possible value a certain points and these will all be added to the final score of a node.

Rating system final calculation:

The rating system final calculation module let's you create a specific calculation for the total score. Like ([cck-values-in-group-about-me] * 2) + ([cck-values-in-group-experience] *5) + ([total-profile-views] / 3)