admin/content/types and edit the type you would like to rate.', array('!types' => url('admin/content/types'))),
t('On the settings page for the content type, a set of options is available for fivestar, where you can enable rating for that type and set rating options.'),
);
$output .= theme('item_list', $steps, NULL, 'ol');
break;
case 'admin/content/node-type/'. $arg[3] .'/fivestar':
$arg[5] = 'vote';
case 'admin/content/node-type/'. $arg[3] .'/fivestar/'. $arg[5]:
$output = t('Use the settings on this page to set up Fivestar rating for the %type content type. These settings specifically affect the %axis rating axis. If needing to set up different criteria for voting, see the main Fivestar settings page.', array('%type' => node_get_types('name', $arg[3]), '%axis' => $arg[5], '@url' => url('admin/settings/fivestar')));
break;
}
return $output;
}
/**
* Implementation of hook_menu().
*/
function fivestar_menu() {
$items = array();
$items['admin/settings/fivestar'] = array(
'title' => 'Fivestar',
'description' => 'Configure site-wide widgets used for Fivestar rating.',
'page callback' => 'drupal_get_form',
'page arguments' => array('fivestar_settings'),
'access callback' => 'user_access',
'access arguments' => array('administer site configuration'),
'type' => MENU_NORMAL_ITEM,
'file' => 'includes/fivestar.admin.inc',
);
$items['fivestar/preview/node'] = array(
'page callback' => 'fivestar_preview',
'access callback' => 'user_access',
'access arguments' => array('administer content types'),
'type' => MENU_CALLBACK,
'file' => 'includes/fivestar.admin.inc',
);
$items['fivestar/preview/color'] = array(
'page callback' => 'fivestar_preview_color',
'access callback' => 'user_access',
'access arguments' => array('administer site configuration'),
'type' => MENU_CALLBACK,
'file' => 'includes/fivestar.color.inc',
);
$items['fivestar/vote'] = array(
'page callback' => 'fivestar_vote',
'access callback' => 'user_access',
'access arguments' => array('rate content'),
'type' => MENU_CALLBACK,
);
// Add a "fivestar" tab to each content type.
// We can't yet add it to the "operations" column in content types, due to a TODO in CCK
// (content.admin.inc line 32)
foreach (node_get_types() as $type) {
$type_name = $type->type;
$type_url_str = str_replace('_', '-', $type_name);
$items['admin/content/node-type/'. $type_url_str .'/fivestar'] = array(
'title' => 'Fivestar voting',
'page callback' => 'drupal_get_form',
'page arguments' => array('fivestar_node_type_tag_form', $type_name),
'access arguments' => array('administer content types'),
'type' => MENU_LOCAL_TASK,
'weight' => 5,
'file' => 'includes/fivestar.admin.inc',
);
foreach (fivestar_get_tags() as $tag) {
$items['admin/content/node-type/'. $type_url_str .'/fivestar/' . urlencode($tag)] = array(
'title' => $tag,
'page callback' => 'drupal_get_form',
'page arguments' => array('fivestar_node_type_tag_form', $type_name, $tag),
'access arguments' => array('administer content types'),
'type' => $tag == 'vote' ? MENU_DEFAULT_LOCAL_TASK : MENU_LOCAL_TASK,
'weight' => $tag == 'vote' ? 0 : 1,
'file' => 'includes/fivestar.admin.inc',
);
}
}
return $items;
}
/**
* Implementation of hook_init().
*
* These includes do not need to be loaded for cached pages.
*/
function fivestar_init() {
if (module_exists('content')) {
module_load_include('inc', 'fivestar', 'includes/fivestar.field');
}
// Add necessary CSS and JS.
// TODO: These shouldn't be loaded on every page, but block caching omits
// CSS and JS files that would be otherwise added.
fivestar_add_js();
fivestar_add_css();
}
/**
* Implementation of hook_perm().
*
* Exposes permissions for rating content, viewing aggregate ratings, and using PHP
* snippets when configuring fivestar CCK fields.
*/
function fivestar_perm() {
return array('rate content', 'use PHP for fivestar target');
}
/**
* Implementation of hook_theme().
*/
function fivestar_theme() {
return array(
// Fivestar theme functions.
'fivestar' => array(
'arguments' => array('element' => NULL),
),
'fivestar_select' => array(
'arguments' => array('element' => NULL),
),
'fivestar_static' => array(
'arguments' => array('rating' => NULL, 'stars' => 5),
),
'fivestar_static_element' => array(
'arguments' => array('star_display' => NULL, 'title' => NULL, 'description' => NULL),
),
'fivestar_summary' => array(
'arguments' => array('user_rating' => NULL, 'average_rating' => NULL, 'votes' => 0, 'stars' => 5),
),
'fivestar_widget' => array(
'arguments' => array('form' => NULL),
),
// fivestar.admin.inc.
'fivestar_preview' => array(
'arguments' => array('style' => NULL, 'text' => NULL, 'stars' => NULL, 'unvote' => NULL, 'title' => NULL, 'labels_enable' => TRUE, 'labels' => array()),
'file' => 'includes/fivestar.admin.inc',
),
'fivestar_preview_widget' => array(
'arguments' => array('css_file' => NULL),
'file' => 'includes/fivestar.admin.inc',
),
'fivestar_preview_wrapper' => array(
'arguments' => array('content' => NULL, 'type' => 'direct'),
'file' => 'includes/fivestar.admin.inc',
),
'fivestar_settings' => array(
'arguments' => array('form' => NULL),
'file' => 'includes/fivestar.admin.inc',
),
'fivestar_node_type_tag_form' => array(
'arguments' => array('form' => NULL),
'file' => 'includes/fivestar.admin.inc',
),
// fivestar.color.inc.
'fivestar_color_form' => array(
'arguments' => array('form' => NULL),
),
// fivestar.field.inc.
'fivestar_formatter_default' => array(
'arguments' => array('element' => NULL),
),
'fivestar_formatter_rating' => array(
'arguments' => array('element' => NULL),
),
'fivestar_formatter_percentage' => array(
'arguments' => array('element' => NULL),
),
);
}
/**
* Implementation of hook_node_types().
*/
function fivestar_node_type($op, $info) {
$type = $info->type;
$variables = array('fivestar', 'fivestar_unvote', 'fivestar_style', 'fivestar_stars', 'fivestar_comment', 'fivestar_position', 'fivestar_position_teaser', 'fivestar_labels_enable', 'fivestar_labels', 'fivestar_text', 'fivestar_title', 'fivestar_feedback');
// Be responsible and cleanup unneeded variables.
if ($op == 'delete') {
foreach ($variables as $variable) {
foreach (fivestar_get_tags() as $tag) {
$suffix = fivestar_get_suffix($type, $tag);
variable_del($variable . '_' . $suffix);
}
}
}
// When changing the type name, update the variables.
elseif ($op == 'update' && !empty($info->old_type) && $info->old_type != $info->type) {
foreach ($variables as $variable) {
foreach (fivestar_get_tags() as $tag) {
$oldvarname = $variable . '_' . fivestar_get_suffix($info->old_type, $tag);
$newvarname = $variable . '_' . fivestar_get_suffix($info->type, $tag);
$value = variable_get($oldvarname, -1);
if ($value != -1) {
variable_del($oldvarname);
variable_set($newvarname, $value);
}
}
}
}
}
/**
* Callback function for fivestar/vote.
*
* @param type
* A content-type to log the vote to. 'node' is the most common.
* @param cid
* A content id to log the vote to. This would be a node ID, a comment ID, etc.
* @param tag
* Multi-axis tag to allow multiple votes per node. 'vote' is the most common.
* @param value
* A value from 1-100, representing the vote cast for the content.
* @return
* An XML chunk containing the results of the vote, for use by the client-side
* javascript code.
*/
function fivestar_vote($type, $cid, $tag, $value) {
drupal_set_header("Content-Type: text/xml");
$output = '';
$output .= '';
// Rebuild the #auto_submit_path that was used as the token seed.
$path = preg_replace('/\/'. $value .'$/', '', $_GET['q']);
if (!isset($_GET['token']) || !fivestar_check_token($_GET['token'], $path)) {
$output .= ''. t('Invalid token') .'';
exit($output);
}
$result = _fivestar_cast_vote($type, $cid, $value, $tag, NULL, TRUE);
votingapi_recalculate_results($type, $cid);
if ($type == 'node') {
$node = node_load($cid);
}
$suffix = fivestar_get_suffix((!isset($node) ? 'default' : $node->type), $tag);
$stars = variable_get('fivestar_stars_' . $suffix, 5);
$feedback_enable = variable_get('fivestar_feedback_' . $suffix, 1);
$output .= '';
if (count($result)) {
foreach ($result as $data) {
if (isset($data['tag']) && $data['tag'] == $tag) {
$output .= '<'. $data['function'] .'>'. $data['value'] .'';
$summary[$data['tag']][$data['function']] = $data['value'];
}
}
}
$output .= '';
$output .= '';
$output .= '';
$output .= '';
$output .= '';
$output .= '';
$output .= '';
$output .= '';
$output .= '';
$output .= '';
$output .= ''. $value .'';
$output .= ''. $type .'';
$output .= ''. $cid .'';
$output .= ''. $tag .'';
$output .= '';
drupal_set_header("Content-Type: text/xml");
exit($output);
}
/**
* Internal function to handle vote casting, flood control, XSS, IP based
* voting, etc...
*/
function _fivestar_cast_vote($type, $cid, $value, $tag = NULL, $uid = NULL, $result = FALSE, $skip_validation = FALSE) {
global $user;
$tag = empty($tag) ? 'vote' : $tag;
$uid = empty($uid) ? $user->uid : $uid;
// Bail out if the user's trying to vote on an invalid object.
if (!$skip_validation && !fivestar_validate_target($type, $cid, $tag, $uid)) {
return array();
}
// Sanity-check the incoming values.
if (is_numeric($cid) && is_numeric($value)) {
if ($value > 100) {
$value = 100;
}
// Get the user's current vote.
$criteria = array('content_type' => $type, 'content_id' => $cid, 'tag' => $tag, 'uid' => $uid);
// Get the unique identifier for the user (IP Address if anonymous).
$user_criteria = votingapi_current_user_identifier();
$user_votes = votingapi_select_votes($criteria + $user_criteria);
if ($value == 0) {
votingapi_delete_votes($user_votes);
}
else {
$votes = $criteria += array('value' => $value);
votingapi_set_votes($votes, $user_votes);
}
return fivestar_get_votes($type, $cid, $tag, $uid);
}
}
/**
* Utility function to retreive VotingAPI votes.
*
* Note that this should not be used for general vote retreival, instead the
* VotingAPI function votingapi_select_results() should be used, which is more
* efficient when retrieving multiple votes.
*
* @param $type
* The content type for which to retreive votes.
* @param $cid
* The content ID for which to retreive votes.
* @param $tag
* The VotingAPI tag for which to retreive votes.
* @param $uid
* Optional. A user ID for which to retreive votes.
* @return
* An array of the following keys:
* - average: An array of VotingAPI results, including the average 'value'.
* - count: An array of VotingAPI results, including the count 'value'.
* - user: An array of VotingAPI results, including the user's vote 'value'.
*/
function fivestar_get_votes($type, $cid, $tag = 'vote', $uid = NULL) {
global $user;
if (!isset($uid)) {
$uid = $user->uid;
}
$criteria = array(
'content_type' => $type,
'content_id' => $cid,
'value_type' => 'percent',
'tag' => $tag,
);
$votes = array(
'average' => array(),
'count' => array(),
'user' => array(),
);
$results = votingapi_select_results($criteria);
foreach ($results as $result) {
if ($result['function'] == 'average') {
$votes['average'] = $result;
}
if ($result['function'] == 'count') {
$votes['count'] = $result;
}
}
if ($uid) {
$user_vote = votingapi_select_votes($criteria += array('uid' => $uid));
if ($user_vote) {
$votes['user'] = $user_vote[0];
$votes['user']['function'] = 'user';
}
}
else {
// If the user is anonymous, we never bother loading their existing votes.
// Not only would it be hit-or-miss, it would break page caching. Safer to always
// show the 'fresh' version to anon users.
$votes['user'] = array('value' => 0);
}
return $votes;
}
/**
* Check that an item being voted upon is a valid vote.
*
* @param $type
* Type of target (currently only node is supported).
* @param $id
* Identifier within the type (in this case nid).
* @param $tag
* The VotingAPI tag string.
* @param $uid
* The user trying to cast the vote.
*
* @return boolean
*/
function fivestar_validate_target($type, $id, $tag, $uid = NULL) {
if (!isset($uid)) {
$uid = $GLOBALS['user']->uid;
}
$access = module_invoke_all('fivestar_access', $type, $id, $tag, $uid);
foreach ($access as $result) {
if ($result == TRUE) {
return TRUE;
}
if ($result === FALSE) {
return FALSE;
}
}
}
/**
* Implementation of hook_fivestar_access().
*
* This hook is called before every vote is cast through Fivestar. It allows
* modules to allow voting on any type of content, such as nodes, users, or
* comments, even though only nodes are supported by Fivestar directly.
*
* @param $type
* Type of target (currently only node is supported).
* @param $id
* Identifier within the type (in this case nid).
* @param $tag
* The VotingAPI tag string.
* @param $uid
* The user ID trying to cast the vote.
*
* @return boolean or NULL
* Returns TRUE if voting is supported on this object.
* Returns NULL if voting is not supported on this object by this module.
* If needing to absolutely deny all voting on this object, regardless
* of permissions defined in other modules, return FALSE. Note if all
* modules return NULL, stating no preference, then access will be denied.
*/
function fivestar_fivestar_access($type, $id, $tag, $uid) {
if ($type == 'node' && $node = node_load($id)) {
if (variable_get('fivestar_'. fivestar_get_suffix($node->type, $tag), 0)) {
return TRUE;
}
}
}
/**
* Implementation of hook_fivestar_widgets().
*
* This hook allows other modules to create additional custom widgets for
* the fivestar module.
*
* @return array
* An array of key => value pairs suitable for inclusion as the #options in a
* select or radios form element. Each key must be the location of a css
* file for a fivestar widget. Each value should be the name of the widget.
*/
function fivestar_fivestar_widgets() {
$widgets_directory = drupal_get_path('module', 'fivestar') .'/widgets';
$files = file_scan_directory($widgets_directory, '\.css$');
$widgets = array();
foreach ($files as $file) {
if (strpos($file->filename, '-rtl.css') === FALSE) {
$widgets[$file->filename] = drupal_ucfirst(str_replace('-color', '', $file->name));
}
}
return $widgets;
}
function fivestar_get_position($type, $teaser, $tag) {
if ($teaser) {
$teaser = '_teaser';
}
else {
$teaser = '';
}
$var = variable_get('fivestar_position' . $teaser . '_'. $type . '_' . $tag, 0);
return $var;
}
/**
* Implementation of hook_nodeapi().
*
* Adds the fievestar widget to the node view.
*/
function fivestar_nodeapi(&$node, $op, $teaser, $page) {
if ($op == 'view') {
$exclude_modes = array(
NODE_BUILD_PREVIEW,
NODE_BUILD_SEARCH_INDEX,
NODE_BUILD_SEARCH_RESULT,
NODE_BUILD_RSS,
);
if (!in_array($node->build_mode, array(NODE_BUILD_PREVIEW, NODE_BUILD_SEARCH_INDEX)) && !isset($node->modr8_form_teaser) && fivestar_widget_enabled('fivestar_'. $node->type)) {
foreach (fivestar_get_tags() as $tag) {
$position = fivestar_get_position($node->type, $teaser, $tag);
switch ($position) {
case 'above':
case 'below':
if (user_access('rate content')) {
$content = '';
if (fivestar_validate_target('node', $node->nid, $tag)) {
$content .= fivestar_widget_form($node, $tag);
}
if ($content) {
$node->content['fivestar_widget_' . $tag] = array(
'#value' => $content,
'#weight' => $position == 'above' ? -10 : 50,
);
} // Fall through to static if not allowed to rate.
}
break;
$position .= '_static';
case 'above_static':
case 'below_static':
$content = '';
if (fivestar_validate_target('node', $node->nid, $tag)) {
$content .= fivestar_static('node', $node->nid, $node->type, $tag);
}
}
if ($content) {
$node->content['fivestar_widget_' . $tag] = array(
'#value' => $content,
'#weight' => strpos($position, 'above') === 0 ? -10 : 50,
);
}
}
}
}
}
/**
* Implementation of hook_link().
*
* Add a "rate" link to node teaser.
*/
function fivestar_link($type, $node = NULL, $teaser = FALSE) {
$links = array();
if ($type == "node" && $teaser) {
if (variable_get('fivestar_position_teaser_'. $node->type, 'above') == "link") {
$links['rate'] = array(
'title' => t('Rate'),
'href' => 'node/'. $node->nid,
'fragment' => 'fivestar-form-node-'. $node->nid,
'attributes' => array('title' => t('Rate this @type', array('@type' => node_get_types('name', $node->type)))),
);
}
}
return $links;
}
function fivestar_block($op = 'list', $delta = 0, $edit = array()) {
switch ($op) {
case 'list':
$blocks[0]['info'] = t('Fivestar: Rate this node');
return $blocks;
case 'view':
if (user_access('access content') && user_access('rate content')) {
if (arg(0) == 'node' && is_numeric(arg(1)) && (arg(2) == '' || arg(2) == 'view')) {
$node = node_load(arg(1));
$block = array();
foreach (fivestar_get_tags() as $tag) {
if (fivestar_validate_target('node', $node->nid, $tag)) {
if (!$block) {
$block['subject'] = t('Rate This');
$block['content'] = '';
}
$block['content'] .= fivestar_widget_form($node, $tag);
}
}
return $block;
}
}
break;
}
}
/**
* Check if nodetype has a fivestar voting tag enabled.
*
* Since that multi axis votes don't nessesarely have the 'vote' tag enabled,
* we need check all of the tags entered at the fivestar admin page.
*/
function fivestar_widget_enabled($lookup) {
// Check if vote tag is enabled since that will be enough in most cases.
if (variable_get($lookup, 0)) {
return 1;
}
$tags_txt = variable_get('fivestar_tags', 0);
$tags_exploded = explode(',', $tags_txt);
foreach ($tags_exploded as $tag) {
if (variable_get($lookup . '_' . trim($tag), 0)) {
return 1;
}
}
// If we get this far, no match, so return 0.
return 0;
}
function fivestar_widget_form($node, $tag = 'vote') {
return drupal_get_form('fivestar_form_node_'. $node->nid .'_'. $tag, 'node', $node->nid, $tag);
}
/**
* Get a private token used to protect links from CSRF attacks.
*/
function fivestar_get_token($value) {
global $user;
// Anonymous users don't get a session ID, which breaks page caching.
$session_id = $user->uid ? session_id() : '';
$private_key = drupal_get_private_key();
return md5($session_id . $value . $private_key);
}
/**
* Check to see if a token value matches the specified node.
*/
function fivestar_check_token($token, $value) {
return fivestar_get_token($value) == $token;
}
/**
* Implementation of hook_forms().
*
* This is necessary when multiple fivestar forms appear on the same page, each
* requiring a separate form_id, but all using the same underlying callbacks.
*/
function fivestar_forms($form_id, $args) {
if (strpos($form_id, 'fivestar_form') !== FALSE) {
if ($form_id == 'fivestar_form_'. $args[0] .'_'. $args[1] .'_'. $args[2]) {
$forms[$form_id] = array('callback' => 'fivestar_form');
return $forms;
}
}
}
/**
* Create the fivestar form for the current item.
* Note that this is not an implementation of hook_form(). We should probably
* change the function to reflect that.
*/
function fivestar_form(&$form_state, $content_type, $content_id, $tag) {
global $user;
if ($content_type == 'node') {
if (is_numeric($content_id)) {
$node = node_load($content_id);
}
else {
return array();
}
}
$suffix = fivestar_get_suffix($node->type, $tag);
$star_display = variable_get('fivestar_style_' . $suffix, 'average');
$text_display = variable_get('fivestar_text_' . $suffix, 'dual');
if ($star_display == 'average' && ($text_display == 'average' || $text_display == 'none')) {
// Save a query and don't retrieve the user vote unnecessarily.
$votes = fivestar_get_votes($content_type, $content_id, $tag, 0);
}
else {
$votes = fivestar_get_votes($content_type, $content_id, $tag);
}
$values = array(
'user' => isset($votes['user']['value']) ? $votes['user']['value'] : 0,
'average' => isset($votes['average']['value']) ? $votes['average']['value'] : 0,
'count' => isset($votes['count']['value']) ? $votes['count']['value'] : 0,
);
$settings = fivestar_get_settings($node->type, $tag);
$settings += array(
'content_type' => $content_type,
'content_id' => $content_id,
'tag' => $tag,
'autosubmit' => TRUE,
'title' => FALSE,
);
return fivestar_custom_widget($form_state, $values, $settings);
}
/**
* Retreive and print out a static display of stars for a piece of content.
*
* @param $content_type
* The type of content that will have its vote retreived. i.e. "node".
* @param $content_id
* The ID of the content that will have its vote retreived.
* @param $node_type
* Optional. If retreiving a node's rating, passing in the node type will
* prevent Fivestar from doing an additional query to find it.
* @param $tag
* Optional. The voting tag that will be retreived. Defaults to "vote" if none
* is specified.
*/
function fivestar_static($content_type, $content_id, $node_type = NULL, $tag = 'vote') {
global $user;
$criteria = array(
'content_type' => $content_type,
'content_id' => $content_id,
'value_type' => 'percent',
'tag' => 'vote',
);
$votes = fivestar_get_votes($content_type, $content_id, $tag);
if ($content_type == 'node') {
// Content type should always be passed to avoid this node load.
if (!isset($node_type)) {
$node = node_load($content_id);
$node_type = $node->type;
}
$settings = fivestar_get_settings($node_type, $tag);
$stars = $settings['stars'];
switch ($settings['star_display']) {
case 'average':
case 'dual':
$star_value = $votes['average']['value'];
$title = $settings['title_display'] ? t('Average') : NULL;
break;
case 'user':
$star_value = $votes['user']['value'];
$title = $settings['title_display'] ? t('Your rating') : NULL;
break;
case 'smart':
$star_value = $votes['user']['value'] ? $votes['user']['value'] : $votes['average']['value'];
$title = $settings['title_display'] ? $votes['user']['value'] ? t('Your rating') : t('Average') : NULL;
break;
}
if ($tag != 'vote') {
$title .= ' (' . ucfirst($tag) . ')';
}
// Set all text values, then unset the unnecessary ones.
$user_value = $votes['user']['value'];
$average_value = $votes['average']['value'];
$count_value = $votes['count']['value'];
switch ($settings['text_display']) {
case 'average':
$user_value = NULL;
break;
case 'user':
$average_value = NULL;
break;
case 'smart':
if ($votes['user']['value']) {
$average_value = NULL;
}
else {
$user_value = NULL;
}
break;
}
}
// Possibly add other content types here (comment, user, etc).
else {
$stars = 5;
$star_value = $votes['average']['value'];
$user_value = $votes['user']['value'];
$average_value = $votes['average']['value'];
$count_value = $votes['count']['value'];
}
$star_display = theme('fivestar_static', $star_value, $stars);
$text_display = $settings['text_display'] == 'none' ? NULL : theme('fivestar_summary', $user_value, $average_value, $count_value, $stars, FALSE);
return theme('fivestar_static_element', $star_display, $title, $text_display);
}
/**
* Form builder; Build a custom Fivestar rating widget with arbitrary settings.
*
* This function is usually not called directly, instead call
* drupal_get_form('fivestar_custom_widget', $values, $settings) when wanting
* to display a widget.
*
* @param $form_state
* The form state provided by Form API.
* @param $values
* An array of current vote values from 0 to 100, with the following array
* keys:
* - user: The user's current vote.
* - average: The average vote value.
* - count: The total number of votes so far on this content.
* @param $settings
* An array of settings that configure the properties of the rating widget.
* Available keys for the settings include:
* - content_type: The type of content which will be voted upon.
* - content_id: The content ID which will be voted upon.
* - stars: The number of stars to display in this widget, from 2 to 10.
* Defaults to 5.
* - autosubmit: Whether the form should be submitted upon star selection.
* Defaults to TRUE.
* - allow_clear: Whether or not to show the "Clear current vote" icon when
* showing the widget. Defaults to FALSE.
* - required: Whether this field is required before the form can be
* submitted. Defaults to FALSE.
* - feedback_enable: Toggles the option to show the "Vote is being saved"
* text while a vote is being registered through AJAX. Defaults to TRUE.
* - labels_enable: Toggles the option to show the "Give it 2/5 stars" text
* while hovering over the stars with the mouse.
* - labels: An array of labels to be used. The number of labels should match
* the number of stars.
* - tag: The VotingAPI tag that will be registered by this widget. Defaults
* to "vote".
*/
function fivestar_custom_widget(&$form_state, $values, $settings) {
$form = array(
'#attributes' => array('class' => 'fivestar-widget'),
'#redirect' => FALSE,
'#theme' => 'fivestar_widget',
);
$form['#submit'][] = 'fivestar_form_submit';
if (isset($settings['content_type'])) {
$form['content_type'] = array(
'#type' => 'hidden',
'#value' => $settings['content_type'],
);
}
if (isset($settings['content_id'])) {
$form['content_id'] = array(
'#type' => 'hidden',
'#value' => $settings['content_id'],
);
}
if (isset($settings['tag'])) {
$form['tag'] = array(
'#type' => 'hidden',
'#value' => $settings['tag'],
);
}
$form['vote'] = array(
'#type' => 'fivestar',
'#stars' => $settings['stars'],
'#vote_count' => $values['count'],
'#vote_average' => $values['average'],
'#auto_submit' => isset($settings['autosubmit']) ? $settings['autosubmit'] : TRUE,
'#auto_submit_path' => (!isset($settings['autosubmit']) || $settings['autosubmit']) ? 'fivestar/vote/'. $settings['content_type'] .'/'. $settings['content_id'] .'/' . $settings['tag'] : NULL,
'#allow_clear' => $settings['allow_clear'],
'#content_id' => isset($settings['content_id']) ? $settings['content_id'] : NULL,
'#required' => isset($settings['required']) ? $settings['required'] : FALSE,
'#feedback_enable' => isset($settings['feedback_enable']) ? $settings['feedback_enable'] : TRUE,
'#labels_enable' => isset($settings['labels_enable']) ? $settings['labels_enable'] : TRUE,
'#labels' => isset($settings['labels']) ? $settings['labels'] : NULL,
'#tag' => isset($settings['tag']) ? $settings['tag'] : 'vote',
);
$form['destination'] = array(
'#type' => 'hidden',
'#value' => $_GET['q'],
);
$form['fivestar_submit'] = array(
'#type' => 'submit',
'#value' => t('Rate'),
'#attributes' => array('class' => 'fivestar-submit'),
);
$form['vote']['#attributes']['class'] = isset($form['vote']['#attributes']['class']) ? $form['vote']['#attributes']['class'] : '';
$settings['feedback_enable'] = isset($settings['feedback_enable']) ? $settings['feedback_enable'] : TRUE;
switch ($settings['text_display']) {
case 'user':
$form['vote']['#description'] = theme('fivestar_summary', $values['user'], NULL, $settings['style'] == 'dual' ? NULL : $values['count'], $settings['stars'], $settings['feedback_enable']);
$form['vote']['#attributes']['class'] .= ' fivestar-user-text';
break;
case 'average':
$form['vote']['#description'] = $settings['style'] == 'dual' ? NULL : theme('fivestar_summary', NULL, $values['average'], $values['count'], $settings['stars'], $settings['feedback_enable']);
$form['vote']['#attributes']['class'] .= ' fivestar-average-text';
break;
case 'smart':
$form['vote']['#description'] = ($settings['style'] == 'dual' && !$values['user']) ? NULL : theme('fivestar_summary', $values['user'], $values['user'] ? NULL : $values['average'], $settings['style'] == 'dual' ? NULL : $values['count'], $settings['stars'], $settings['feedback_enable']);
$form['vote']['#attributes']['class'] .= ' fivestar-smart-text '. ($values['user'] ? 'fivestar-user-text' : 'fivestar-average-text');
break;
case 'dual':
$form['vote']['#description'] = theme('fivestar_summary', $values['user'], $settings['style'] == 'dual' ? NULL : $values['average'], $settings['style'] == 'dual' ? NULL : $values['count'], $settings['stars'], $settings['feedback_enable']);
$form['vote']['#attributes']['class'] .= ' fivestar-combo-text';
break;
}
switch ($settings['star_display']) {
case 'average':
$form['vote']['#title'] = t('Average');
$form['vote']['#default_value'] = $values['average'];
$form['vote']['#attributes']['class'] .= ' fivestar-average-stars';
break;
case 'user':
$form['vote']['#title'] = t('Your rating');
$form['vote']['#default_value'] = $values['user'];
$form['vote']['#attributes']['class'] .= ' fivestar-user-stars';
break;
case 'smart':
$form['vote']['#title'] = $values['user'] ? t('Your rating') : t('Average');
$form['vote']['#default_value'] = $values['user'] ? $values['user'] : $values['average'];
$form['vote']['#attributes']['class'] .= ' fivestar-smart-stars '. ($values['user'] ? 'fivestar-user-stars' : 'fivestar-average-stars');
break;
case 'dual':
$form['vote']['#title'] = t('Your rating');
$form['vote']['#default_value'] = $values['user'];
$form['vote']['#attributes']['class'] .= ' fivestar-combo-stars';
$form['#attributes']['class'] .= ' fivestar-combo-stars';
$static_average = theme('fivestar_static', $values['average'], $settings['stars'], $settings['tag']);
if ($settings['text_display'] == 'none' && !$settings['labels_enable'] && !$settings['feedback_enable']) {
$static_description = NULL;
}
elseif ($settings['text_display'] != 'none') {
$static_description = theme('fivestar_summary', NULL, $settings['text_display'] == 'user' ? NULL : (isset($values['average']) ? $values['average'] : 0), isset($values['count']) ? $values['count'] : 0, $settings['stars'], FALSE);
}
else {
$static_description = ' ';
}
$form['average'] = array(
'#type' => 'markup',
'#value' => theme('fivestar_static_element', $static_average, $settings['title'] !== FALSE ? t('Average') : NULL, $static_description),
'#weight' => -1,
);
break;
}
// Set an over-ridding title if passed in.
// An empty title won't change the default, a string will set a new title,
// and title === FALSE will unset the title entirely.
if (isset($settings['title'])) {
if ($settings['title'] !== FALSE) {
$form['vote']['#title'] = $settings['title'];
}
else {
unset($form['vote']['#title']);
unset($form['average']['#title']);
}
}
elseif ($settings['tag'] && $settings['tag'] != 'vote') {
$form['vote']['#title'] .= ' (' . ucfirst($settings['tag']) . ')';
}
return $form;
}
/**
* Submit handler for the above form (non-javascript version).
*/
function fivestar_form_submit($form, &$form_state) {
if ($form_state['values']['form_id'] == 'fivestar_form_'. $form_state['values']['content_type'] .'_'. $form_state['values']['content_id'] . '_' . $form_state['values']['tag']) {
// Cast the vote.
_fivestar_cast_vote($form_state['values']['content_type'], $form_state['values']['content_id'], $form_state['values']['vote'], $form_state['values']['tag']);
votingapi_recalculate_results($form_state['values']['content_type'], $form_state['values']['content_id']);
// Set a message that the vote was received.
if ($form_state['values']['vote'] === '0') {
drupal_set_message(t('Your vote has been cleared.'));
}
elseif (is_numeric($form_state['values']['vote'])) {
drupal_set_message(t('Thank you for your vote.'));
}
// Regenerate the page with a drupal_goto() to update the current values.
drupal_goto();
}
}
/**
* Implementation of hook_elements().
*
* Defines 'fivestar' form element type
*/
function fivestar_elements() {
$type['fivestar'] = array(
'#input' => TRUE,
'#stars' => 5,
'#widget' => 'stars',
'#allow_clear' => FALSE,
'#auto_submit' => FALSE,
'#auto_submit_path' => '',
'#labels_enable' => TRUE,
'#feedback_enable' => TRUE,
'#process' => array('fivestar_expand'),
);
return $type;
}
/**
* Theme the fivestar form element by adding necessary css and javascript.
*/
function theme_fivestar($element) {
if (empty($element['#description'])) {
if ($element['#feedback_enable']) {
$element['#description'] = '
';
}
}
return theme('form_element', $element, $element['#children']);
}
/**
* Theme the straight HTML version of the fivestar select list. This is used
* to remove the wrapping 'form-item' div from the select list.
*/
function theme_fivestar_select($element) {
$select = '';
$size = $element['#size'] ? ' size="'. $element['#size'] .'"' : '';
_form_set_class($element, array('form-select'));
$multiple = isset($element['#multiple']) && $element['#multiple'];
return '';
}
/**
* Theme an entire fivestar widget, including the submit button and the normal
* fivestar widget themed in the theme_fivestar() function.
*/
function theme_fivestar_widget($form) {
// Only print out the summary if text is being displayed or using rollover text.
if (empty($form['vote']['#description']) && strpos($form['vote']['#prefix'], 'fivestar-labels-hover') === FALSE) {
unset($form['vote']['#description']);
}
$class = 'fivestar-form';
$class .= '-'. (isset($form['vote']['#tag']) ? $form['vote']['#tag'] : 'vote');
$class .= '-'. (isset($form['content_id']['#value']) ? $form['content_id']['#value'] : 0);
$output = '';
$output .= '
';
$output .= drupal_render($form);
$output .= '
';
return $output;
}
/**
* Display a plain HTML view-only version of the widget with a specified rating.
*
* @param $rating
* The desired rating to display out of 100 (i.e. 80 is 4 out of 5 stars).
* @param $stars
* The total number of stars this rating is out of.
* @param $tag
* Allows multiple ratings per node.
* @return
* A themed HTML string representing the star widget.
*/
function theme_fivestar_static($rating, $stars = 5, $tag = 'vote') {
$output = '';
$output .= '
';
return $output;
}
/**
* Display the text associated with a static star display.
*
* Note that passing in explicit data types is extremely important when using
* this function. A NULL value will exclude the value entirely from display,
* while a 0 value indicates that the text should be shown but it has no value
* yet.
*
* All ratings are from 0 to 100.
*
* @param $user_rating
* The current user's rating.
* @param $average
* The average rating.
* @param $votes
* The total number of votes.
* @param $stars
* The number of stars being displayed.
* @param $feedback
* A toggle that enables AJAX indicator message when a vote is being saved.
* @return
* A themed HTML string representing the star widget.
*/
function theme_fivestar_summary($user_rating, $average_rating, $votes, $stars = 5, $feedback = TRUE) {
$output = '';
$div_class = '';
if (isset($user_rating)) {
$div_class = isset($votes) ? 'user-count' : 'user';
$user_stars = round(($user_rating * $stars) / 100, 1);
$output .= ''. t('Your rating: !stars', array('!stars' => $user_rating ? $user_stars : t('None'))) .'';
}
if (isset($user_rating) && isset($average_rating)) {
$output .= ' ';
}
if (isset($average_rating)) {
$div_class = isset($votes) ? 'average-count' : 'average';
$average_stars = round(($average_rating * $stars) / 100, 1);
$output .= ''. t('Average: !stars', array('!stars' => $average_stars)) .'';
}
if (isset($user_rating) && isset($average_rating)) {
$div_class = 'combo';
}
if (isset($votes) && !(isset($user_rating) || isset($average_rating))) {
$output .= ' '. format_plural($votes, '@count vote', '@count votes') .'';
$div_class = 'count';
}
elseif (isset($votes)) {
$output .= ' ('. format_plural($votes, '@count vote', '@count votes') .')';
}
if ($votes === 0) {
$output = ''. t('No votes yet') .'';
}
$output = '
'. $output .'
';
return $output;
}
/**
* Display a static fivestar value as stars with a title and description.
*/
function theme_fivestar_static_element($value, $title = NULL, $description = NULL) {
$output = '';
$output .= '