You are here

Home » API reference » Fivestar 6

fivestar_field.inc in Fivestar 6

Same filename and directory in other branches
  1. 5 fivestar_field.inc

Provides CCK integration for fivestar module

File

fivestar_field.inc
View source 
<?php

/**
 * @file
 * Provides CCK integration for fivestar module
 */

/**
 * Implementation of hook_field_info().
 */
function fivestar_field_info() {
  return array(
    'fivestar' => array(
      'label' => t('Fivestar Rating'),
      'description' => t('Store a rating for this piece of content.'),
    ),
  );
}

/**
 * Implementation of hook_field_settings().
 */
function fivestar_field_settings($op, $field) {
  switch ($op) {
    case 'form':

      // Multiple is not supported with Fivestar.
      $form['multiple'] = array(
        '#type' => 'value',
        '#value' => 0,
      );
      $form['stars'] = array(
        '#type' => 'select',
        '#title' => $field['widget']['type'] == 'stars' ? t('Number of Stars') : t('Number of Options'),
        '#options' => drupal_map_assoc(range(1, 10)),
        '#default_value' => $field['stars'] ? $field['stars'] : 5,
      );
      $dynamic_options = array();
      if (module_exists('nodecomment')) {
        $dynamic_options['comment_target_nid'] = t('Node Comment Parent');
      }
      if (module_exists('nodereference')) {
        $fields = content_fields();
        foreach ($fields as $field_name => $content_field) {

          // Make sure that this field exists for this type.
          if ($content_field['type'] == 'nodereference' && ($content_field = content_fields($field_name, $field['type_name']))) {
            $dynamic_options[$content_field['field_name']] = t('Node reference: @field', array(
              '@field' => $content_field['field_name'],
            ));
          }
        }
      }
      if (empty($dynamic_options)) {
        drupal_set_message(t('No potential target fields are available for the %type type. Create a node reference field in this node type to make it easier to assign a vote to a node.', array(
          '%type' => node_get_types('name', $field['type_name']),
        )), 'warning');
      }
      $dynamic_options = array(
        '' => '<' . t('none') . '>',
      ) + $dynamic_options;
      $form['dynamic_target'] = array(
        '#title' => t('Voting target'),
        '#type' => 'select',
        '#default_value' => $field['dynamic_target'],
        '#options' => $dynamic_options,
        '#description' => t('The voting target will make the value of this field cast a vote on another node. Use node reference fields (part of CCK core) or <a href="http://drupal.org/project/nodecomment">Node Comments</a> module to create advanced reviews. More information available on the <a href="http://drupal.org/handbook/modules/fivestar">Fivestar handbook page</a>.'),
      );
      if (user_access('use PHP for fivestar target')) {
        $form['php_target'] = array(
          '#type' => 'fieldset',
          '#title' => t('Voting target PHP code'),
          '#collapsible' => TRUE,
          '#collapsed' => empty($field['php_target']),
        );
        $form['php_target']['php_target'] = array(
          '#title' => t('Code'),
          '#type' => 'textarea',
          '#default_value' => $field['php_target'] ? $field['php_target'] : '',
          '#description' => t('Advanced usage only: PHP code that returns a target node ID. Should not include &lt;?php ?&gt; delimiters. If this field is filled out, the value returned by this code will override any value specified above. Note that executing incorrect PHP-code can break your Drupal site.'),
        );
      }
      else {
        $form['php_target'] = array(
          '#type' => 'value',
          '#value' => $field['php_target'] ? $field['php_target'] : '',
        );
      }
      $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 <em>quality</em>, <em>satisfaction</em>, <em>overall</em>, etc. If no axis is entered, the default axis <em>vote</em> 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',
        'php_target',
        'axis',
      );
    case 'database columns':
      return array(
        'rating' => array(
          'type' => 'int',
          'unsigned' => TRUE,
          'not null' => FALSE,
          'sortable' => TRUE,
        ),
        'target' => array(
          'type' => 'int',
          'unsigned' => TRUE,
          'not null' => FALSE,
        ),
      );
  }
}

/**
 * Implementation of hook_field().
 */
function fivestar_field($op, &$node, $field, &$items, $teaser, $page) {
  $fieldname = $field['field_name'];
  switch ($op) {
    case 'insert':
    case 'update':
    case 'delete':
      foreach ($items as $delta => $item) {
        if ($node->status == 0 || $op == 'delete') {
          $rating = 0;
        }
        else {
          $rating = $items[$delta]['rating'];
        }
        $items[$delta]['target'] = fivestar_field_target($node, $field, $item);
        if (is_numeric($items[$delta]['target'])) {
          _fivestar_cast_vote('node', $items[$delta]['target'], $rating, $field['axis'], $node->uid, FALSE, TRUE);
          votingapi_recalculate_results('node', $items[$delta]['target']);
        }
      }
      break;
    case 'sanitize':
      $items[0]['stars'] = $field['stars'];
      break;
  }
}

/**
 * Helper function to find the nid that should be rated when a field is changed.
 */
function fivestar_field_target($node, $field, $item) {
  $target = FALSE;
  if (!empty($field['php_target'])) {

    // Use eval rather than drupal_eval to allow access to local variables.
    $target = eval($field['php_target']);
  }
  elseif ($field['dynamic_target'] && !empty($node->{$field}['dynamic_target'])) {
    if (is_array($node->{$field}['dynamic_target']) && is_numeric($node->{$field['dynamic_target']}[0]['nid'])) {
      $target = $node->{$field['dynamic_target']}[0]['nid'];
    }
    elseif (is_numeric($node->{$field}['dynamic_target'])) {
      $target = $node->{$field}['dynamic_target'];
    }
  }
  elseif (isset($item['target'][0]['nid'])) {
    $target = $item['target'][0]['nid'];
  }
  return $target;
}

/**
 * Implementation of hook_content_is_empty().
 */
function fivestar_content_is_empty($item, $field) {
  if (empty($item['rating'])) {
    return TRUE;
  }
  return FALSE;
}

/**
 * Implementation of hook_widget_info().
 */
function fivestar_widget_info() {
  return array(
    'stars' => array(
      'label' => t('Stars'),
      'field types' => array(
        'fivestar',
      ),
      'multiple values' => CONTENT_HANDLE_MODULE,
    ),
    'radios' => array(
      'label' => t('Select list'),
      'field types' => array(
        'fivestar',
      ),
      'multiple values' => CONTENT_HANDLE_MODULE,
    ),
  );
}

/**
 * Implementation of hook_widget_settings().
 */
function fivestar_widget_settings($op, $widget) {
  switch ($op) {
    case 'form':
      $form = array();
      $form['allow_clear'] = array(
        '#type' => 'checkbox',
        '#title' => t('Allow user to clear value'),
        '#default_value' => isset($widget['allow_clear']) ? $widget['allow_clear'] : 1,
      );
      return $form;
    case 'save':
      return array(
        'allow_clear',
      );
  }
}

/**
 * Implementation of hook_widget().
 */
function fivestar_widget(&$form, &$form_state, $field, $items) {
  $element = array(
    '#tree' => TRUE,
  );
  $element['rating'] = array(
    '#type' => 'fivestar',
    '#title' => t($field['widget']['label']),
    '#default_value' => isset($items[0]['rating']) ? $items[0]['rating'] : NULL,
    '#stars' => is_numeric($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'],
    '#labels_enable' => FALSE,
  );
  $element['target'] = array(
    '#type' => 'value',
    '#value' => $field['target'],
  );
  $element['axis'] = array(
    '#type' => 'value',
    '#value' => $field['axis'],
  );

  // CCK likes to always have a 2D array for form elements.
  $element = array(
    $element,
  );
  return $element;
}

/**
 * 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',
      ),
    ),
  );
}

/**
 * Theme function for 'default' fivestar field formatter.
 */
function theme_fivestar_formatter_default($element) {
  if (!isset($element['#item']['rating'])) {
    $element['#item']['rating'] = 0;
  }
  if (empty($element['#item']['stars'])) {
    $element['#item']['stars'] = 5;
  }
  return theme('fivestar_static', $element['#item']['rating'], $element['#item']['stars']);
}

/**
 * Theme function for 'rating' fivestar field formatter.
 */
function theme_fivestar_formatter_rating($element) {
  if (!isset($element['#item']['rating'])) {
    $element['#item']['rating'] = 0;
  }
  return $element['#item']['rating'];
}

/**
 * Theme function for 'percentage' fivestar field formatter.
 */
function theme_fivestar_formatter_percentage($element) {
  if (empty($element['#item']['rating']) || empty($element['#field']['stars'])) {
    return 0;
  }
  return round(100 / $element['#item']['rating'], 1) / $element['#field']['stars'];
}

Functions

Namesort descending Description
fivestar_content_is_empty Implementation of hook_content_is_empty().
fivestar_field Implementation of hook_field().
fivestar_field_formatter_info Implementation of hook_field_formatter_info().
fivestar_field_info Implementation of hook_field_info().
fivestar_field_settings Implementation of hook_field_settings().
fivestar_field_target Helper function to find the nid that should be rated when a field is changed.
fivestar_widget Implementation of hook_widget().
fivestar_widget_info Implementation of hook_widget_info().
fivestar_widget_settings Implementation of hook_widget_settings().
theme_fivestar_formatter_default Theme function for 'default' fivestar field formatter.
theme_fivestar_formatter_percentage Theme function for 'percentage' fivestar field formatter.
theme_fivestar_formatter_rating Theme function for 'rating' fivestar field formatter.