'), $form);
$form = preg_replace('/( method=".*?")|( action=".*?")|('. $content .'
';
}
/**
* 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') .' ';
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 .= ''. $value .' ';
$output .= ''. $type .' ';
$output .= ''. $cid .' ';
$output .= ''. $tag .' ';
$output .= '
';
}
elseif ($element['#labels_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 ''. form_select_options($element) .' ';
}
/**
* 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 the 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;
}
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 .= '';
$element = array(
'#type' => 'item',
'#title' => $title,
'#description' => $description,
);
$output .= theme('form_element', $element, $value);
$output .= '
';
return $output;
}
/**
* Fetch the necessary CSS files to render the fivestar widget.
*/
function fivestar_add_css($widget_css = NULL) {
// Add fivestar CSS.
drupal_add_css(drupal_get_path('module', 'fivestar') .'/css/fivestar.css');
// Add widget specific CSS.
if (!isset($widget_css)) {
$widget_css = variable_get('fivestar_widget', 'default');
}
if ($widget_css != 'default') {
drupal_add_css($widget_css);
}
}
/**
* Add necessary JS files and settings to render the fivestar widget.
*/
function fivestar_add_js() {
static $js_added = FALSE;
// Add necessary javascript only once per page.
if (!$js_added) {
$settings = array(
'titleUser' => t('Your rating') .': ',
'titleAverage' => t('Average') .': ',
'feedbackSavingVote' => t('Saving your vote...'),
'feedbackVoteSaved' => t('Your vote has been saved.'),
'feedbackDeletingVote' => t('Deleting your vote...'),
'feedbackVoteDeleted' => t('Your vote has been deleted.'),
);
drupal_add_js(drupal_get_path('module', 'fivestar') .'/js/fivestar.js');
drupal_add_js(array('fivestar' => $settings), 'setting');
$js_added = TRUE;
}
}
/**
* Add Inline CSS to the page, only used on admin/settings/fivestar page.
*/
function fivestar_add_inline_css($widget_key = NULL, $css = NULL, $reset = FALSE) {
static $inline_css;
if (!isset($inline_css) || $reset) {
$inline_css = array();
}
if (isset($widget_key) && isset($inline_css)) {
$inline_css[$widget_key] = $css;
}
return $inline_css;
}
/**
* Retrieve a list of all inline CSS to be added to the page.
*/
function fivestar_get_inline_css() {
$inline_css = fivestar_add_inline_css();
return implode("\n", $inline_css);
}
/**
* Process callback for fivestar_element -- see fivestar_element()
*/
function fivestar_expand($element) {
if (isset($element['#vote_count'])) {
$element['vote_count'] = array(
'#type' => 'hidden',
'#value' => $element['#vote_count'],
);
}
if (isset($element['#vote_average'])) {
$element['vote_average'] = array(
'#type' => 'hidden',
'#value' => $element['#vote_average'],
);
}
if ($element['#auto_submit'] && !empty($element['#auto_submit_path'])) {
$element['auto_submit_path'] = array(
'#type' => 'hidden',
'#value' => url($element['#auto_submit_path']),
'#attributes' => array('class' => 'fivestar-path'),
);
$element['auto_submit_token'] = array(
'#type' => 'hidden',
'#value' => fivestar_get_token($element['#auto_submit_path']),
'#attributes' => array('class' => 'fivestar-token'),
);
}
if (!isset($element['#default_value'])) {
$element['#default_value'] = 0;
}
$options = array('-' => t('Select rating'));
$default_value = $element['#default_value'];
for ($i = 0; $i <= $element['#stars']; $i++) {
$this_value = ceil($i * 100/$element['#stars']);
$next_value = ceil(($i+1) * 100/$element['#stars']);
// Display clear button only if enabled.
if ($element['#allow_clear'] == TRUE && $i == 0) {
$options[$this_value] = isset($element['#labels'][$i]) ? t(filter_xss_admin($element['#labels'][$i])) : t('Cancel rating');
}
// Display a normal star value.
if ($i > 0) {
if (isset($element['#labels'][$i])) {
$options[$this_value] = $element['#labels'][$i] == '' ? $i : t(filter_xss_admin($element['#labels'][$i]), array('@star' => $i, '@count' => $element['#stars']));
}
else {
$options[$this_value] = t('Give it @star/@count', array('@star' => $i, '@count' => $element['#stars']));
}
}
// Round up the default value to the next exact star value if needed.
if ($this_value < $element['#default_value'] && $next_value > $element['#default_value']) {
$default_value = $next_value;
}
}
$element['vote'] = array(
'#type' => 'select',
'#options' => $options,
'#required' => $element['#required'],
'#default_value' => $default_value,
'#parents' => $element['#parents'],
'#theme' => 'fivestar_select',
'#weight' => $element['#weight'],
);
// If a default value is not exactly on a radio value, round up to the next one
if ($element['#default_value'] > $this_value && $element['#default_value'] <= $next_value) {
$element['vote']['#default_value'] = $next_value;
}
// Set a class for the display of label text on hover.
$label_class = $element['#labels_enable'] ? ' fivestar-labels-hover' : '';
$element['#prefix'] = '';
$element['#suffix'] = '
';
// Add validation function that considers a 0 value as empty.
$element['#element_validate'] = array('fivestar_validate');
return $element;
}
function fivestar_validate($element, &$form_state) {
if ($element['#required'] && (empty($element['#value']) || $element['#value'] == '-')) {
form_error($element, t('!name field is required.', array('!name' => $element['#title'])));
}
}
/**
* Implementation of hook_votingapi_views_formatters().
*/
function fivestar_votingapi_views_formatters($details = array()) {
if ($details->field == 'value') {
return array(
'fivestar_views_value_display_handler' => t('Fivestar Stars (display only)'),
'fivestar_views_value_text_handler' => t('Fivestar Stars (text star count)'),
'fivestar_views_widget_compact_handler' => t('Fivestar Stars (clickable, no text)'),
'fivestar_views_widget_normal_handler' => t('Fivestar Stars (clickable, with text)'),
);
}
}
/**
* VotingAPI Views formatter for displaying static stars.
*/
function fivestar_views_value_display_handler($value, $field, $columns) {
// Determine number of stars to display
if ($field->view->base_table == 'node') {
if (isset($columns->node_type)) {
$stars = variable_get('fivestar_stars_'. $columns->node_type, 5);
}
else {
$node_type = db_result(db_query("SELECT type FROM {node} WHERE nid = %d", $columns->nid));
$stars = variable_get('fivestar_stars_'. (!isset($node_type) ? 'default' : $node_type), 5);
}
// Find the VotingAPI tag for this field.
foreach ($field->query->table_queue[$field->relationship]['join']->extra as $votingapi_setting) {
if ($votingapi_setting['field'] == 'tag') {
$tag = $votingapi_setting['value'];
}
}
}
else {
$stars = 5;
$tag = 'vote';
}
return theme('fivestar_static', $value, $stars, $tag);
}
/**
* VotingAPI Views formatter for displaying number of stars as text.
*/
function fivestar_views_value_text_handler($value, $field, $columns) {
// Get the number of stars for this node type.
$node_type = isset($columns->node_type) ? $columns->node_type : db_result(db_query("SELECT type FROM {node} WHERE nid = %d", $columns->nid));
$stars = variable_get('fivestar_stars_'. $node_type, 5);
// If displaying a user's vote, always display a whole value.
if ($field->table == 'votingapi_vote') {
return ceil(($value / 100) * $stars);
}
else {
return round(($value / 100) * $stars, 1);
}
}
/**
* VotingAPI Views formatter for displaying rating widget without text.
*/
function fivestar_views_widget_compact_handler($value, $field, $columns) {
return fivestar_views_widget_handler($value, $field, $columns, FALSE);
}
/**
* VotingAPI Views formatter for displaying rating widget with text.
*/
function fivestar_views_widget_normal_handler($value, $field, $columns) {
return fivestar_views_widget_handler($value, $field, $columns, TRUE);
}
/**
* Generic VotingAPI Views formatter for displaying rating widget.
*/
function fivestar_views_widget_handler($value, $field, $columns, $summary) {
// If the user can't rate, use the display handler.
if (!user_access('rate content')) {
return fivestar_views_value_display_handler($value, $field, $columns);
}
if ($field->view->base_table == 'node') {
// Find the VotingAPI tag for this field.
foreach ($field->query->table_queue[$field->relationship]['join']->extra as $votingapi_setting) {
if ($votingapi_setting['field'] == 'tag') {
$tag = $votingapi_setting['value'];
}
}
$content_type = 'node';
$content_id = $columns->nid;
$node_type = isset($columns->node_type) ? $columns->node_type : db_result(db_query("SELECT type FROM {node} WHERE nid = %d", $columns->nid));
$values = array(
'user' => 0,
'average' => 0,
'count' => 0,
);
if ($field->table == 'votingapi_vote') {
$values['user'] = $value;
}
if ($field->table == 'votingapi_cache') {
$values['average'] = $value;
}
// Only pull in all the votes if we need to display the summary text.
if ($summary) {
$votes = fivestar_get_votes($content_type, $content_id, $tag);
if ($field->table != 'votingapi_vote') {
$values['user'] = isset($votes['user']['value']) ? $votes['user']['value'] : 0;
}
if ($field->table != 'votingapi_cache') {
$values['average'] = isset($votes['average']['value']) ? $votes['average']['value'] : 0;
}
$values['count'] = isset($votes['count']['value']) ? $votes['count']['value'] : 0;
}
$settings = array(
'stars' => variable_get('fivestar_stars_'. $node_type, 5),
'allow_clear' => variable_get('fivestar_unvote_'. $node_type, FALSE),
'style' => $field->table == 'votingapi_vote' ? 'user' : 'average',
'text' => $summary ? variable_get('fivestar_text_'. $node_type, 'dual') : 'none',
'content_type' => $content_type,
'content_id' => $content_id,
'tag' => $tag,
'autosubmit' => TRUE,
'title' => FALSE,
'feedback_enable' => $summary ? variable_get('fivestar_feedback_'. $node_type, 1) : FALSE,
'labels_enable' => $summary ? variable_get('fivestar_labels_enable_'. $node_type, 1) : FALSE,
'labels' => $summary ? variable_get('fivestar_labels_'. $node_type, array()) : array(),
);
return drupal_get_form('fivestar_custom_widget', $values, $settings);
}
else {
return theme('fivestar_static', $value, 5);
}
}