array('label' => t('Fivestar Rating')),
);
}
/**
* Implementation of hook_field_settings().
*/
function fivestar_field_settings($op, $field) {
switch ($op) {
case 'form':
$form['multiple'] = array(); // Multiple not supported
$form['stars'] = array(
'#type' => 'select',
'#title' => t('Number of Options'),
'#options' => drupal_map_assoc(array(1,2,3,4,5,6,7,8,9,10)),
'#default_value' => $field['stars'] ? $field['stars'] : 5,
'#description' => t('The number of stars or radio buttons to display.'),
);
if (module_exists('nodecomment')) {
$form['dynamic_target'] = array(
'#title' => t('Use Node Comment Parent as Target'),
'#type' => 'checkbox',
'#default_value' => $field['dynamic_target'],
'#return_value' => 'comment_target_nid',
'#description' => t('Use this option to easily make a Fivestar field affect the comment parent for nodes of this content type.')
);
}
$form['target'] = array(
'#type' => 'textarea',
'#title' => t('Target Node ID'),
'#default_value' => $field['target'] ? $field['target'] : '',
'#description' => t(
'A single node ID on which this field will register the vote. If no NID is specified, the field\'s value will be saved, but no vote will be registered with the Voting API.'
),
);
if (user_access('use PHP for fivestar target')) {
$form['target']['#description'] .= ' ' . t(
' Return the target node ID or use plain text. Enter PHP code between <?php ?>. Note that executing incorrect PHP-code can break your Drupal site.'
);
$form['php'] = array(
'#type' => 'value',
'#value' => 1,
);
}
$form['axis'] = array(
'#type' => 'textfield',
'#title' => 'Voting Axis',
'#description' => t('The axis this rating will affect. Enter a property on which that this rating will affect, such as quality, satisfaction, overall, etc. If no axis is entered, the default axis vote will be used. Warning: changing this value will not update existing votes to the new axis.'),
'#default_value' => $field['axis'],
);
return $form;
case 'save':
return array('stars', 'dynamic_target', 'target', 'php', 'axis');
case 'database columns':
$columns = array(
'target' => array('type' => 'int', 'default' => 'NULL'),
'rating' => array('type' => 'int', 'default' => 'NULL'),
);
return $columns;
}
}
/**
* Implementation of hook_field().
*/
function fivestar_field($op, &$node, $field, &$items, $teaser, $page) {
$fieldname = $field['field_name'];
switch ($op) {
case 'view':
foreach ($items as $delta => $item) {
$items[$delta]['view'] = content_format($field, $item);
}
return theme('field', $node, $field, $items, $teaser, $page);
case 'insert':
case 'update':
foreach($items as $delta => $item) {
if ($field['dynamic_target'] && !empty($node->$field['dynamic_target'])) {
$items[$delta]['target'] = $node->$field['dynamic_target'];
}
elseif ($field['php'] && !empty($item['target'])) {
$items[$delta]['target'] = drupal_eval($item['target']);
}
if (is_numeric($items[$delta]['target'])) {
if ($item['rating'] == 0) {
votingapi_unset_vote('node', $items[$delta]['target']);
}
else {
_fivestar_cast_vote('node', $items[$delta]['target'], $item['rating'], $items[$delta]['axis']);
}
}
}
break;
case 'delete':
foreach($items as $delta => $item) {
if ($field['php'] && !empty($item['target'])) {
$items[$delta]['target'] = drupal_eval($item['target']);
}
if (is_numeric($items[$delta]['target'])) {
votingapi_unset_vote('node', $items[$delta]['target']);
}
}
break;
}
}
/**
* Implementation of hook_widget_info().
*/
function fivestar_widget_info() {
return array(
'radios' => array(
'label' => t('Radio Buttons'),
'field types' => array('fivestar'),
),
'stars' => array(
'label' => t('Stars'),
'field types' => array('fivestar'),
),
);
}
/**
* Implementation of hook_widget_settings().
*/
function fivestar_widget_settings($op, $widget) {
switch ($op) {
case 'form':
$form = array();
$form['allow_clear'] = array(
'#type' => 'select',
'#title' => t('Allow Clearing'),
'#options' => array(1 => t('True'), 0 => t('False')),
'#default_value' => $widget['allow_clear'] ? $widget['allow_clear'] : 1,
'#description' => t("Display a button to clear the user's current vote."),
);
return $form;
case 'save':
return array('allow_clear');
}
}
/**
* Implementation of hook_widget().
*/
function fivestar_widget($op, &$node, $field, &$items) {
switch ($op) {
case 'form':
$form = array();
$form[$field['field_name']] = array('#tree' => TRUE);
$form[$field['field_name']][0]['rating'] = array(
'#type' => 'fivestar',
'#title' => $field['widget']['label'],
'#default_value' => $items[0]['rating'],
'#stars' => $field['stars'] ? $field['stars'] : 5,
'#allow_clear' => $field['widget']['allow_clear'],
'#description' => $field['widget']['description'],
'#weight' => $field['widget']['weight'],
'#auto_submit' => false,
'#widget' => $field['widget']['type'],
'#required' => $field['required'],
);
$form[$field['field_name']][0]['target'] = array(
'#type' => 'value',
'#value' => $field['target'],
);
$form[$field['field_name']][0]['axis'] = array(
'#type' => 'value',
'#value' => $field['axis'],
);
return $form;
}
}
/**
* Implementation of hook_field_formatter_info().
*/
function fivestar_field_formatter_info() {
return array(
'default' => array(
'label' => t('As Stars'),
'field types' => array('fivestar'),
),
'rating' => array(
'label' => t('Rating (i.e. 4.2/5)'),
'field types' => array('fivestar'),
),
'percentage' => array(
'label' => t('Percentage (i.e. 92)'),
'field types' => array('fivestar'),
),
);
}
/**
* Implementation of hook_field_formatter().
*
* The $node argument is necessary so that filter access can be checked on
* node preview.
*/
function fivestar_field_formatter($field, $item, $formatter, $node) {
if (!isset($item['rating'])) {
return '';
}
switch ($formatter) {
case 'rating':
return round(100/$item['rating'], 1)/$field['stars'];
case 'percentage':
return $item['rating'];
default:
return theme('fivestar_static', $item['rating'], $field['stars']);
}
}