rate.hooks.inc in Rate 7

Defines module hooks.

File

rate.hooks.inc

<?php

/**
 * @file
 * Defines module hooks.
 */

/**
 * Define templates for rate widgets.
 *
 * @return array
 */
function hook_rate_templates() {
  $templates = array();
  $templates['thumbs_up_down'] = new stdClass();
  $templates['thumbs_up_down']->value_type = 'points';
  $templates['thumbs_up_down']->options = array(
    array(
      1,
      'up',
    ),
    array(
      -1,
      'down',
    ),
  );
  $templates['thumbs_up_down']->theme = 'rate_template_thumbs_up_down';
  $templates['thumbs_up_down']->css = drupal_get_path('module', 'rate') . '/templates/thumbs-up-down/thumbs-up-down.css';
  $templates['thumbs_up_down']->customizable = FALSE;
  $templates['thumbs_up_down']->translate = TRUE;
  $templates['thumbs_up_down']->template_title = t('Thumbs up / down');
  $templates['fivestar'] = new stdClass();
  $templates['fivestar']->value_type = 'percent';
  $templates['fivestar']->options = array(
    array(
      0,
      '1',
    ),
    array(
      25,
      '2',
    ),
    array(
      50,
      '3',
    ),
    array(
      75,
      '4',
    ),
    array(
      100,
      '5',
    ),
  );
  $templates['fivestar']->theme = 'rate_template_fivestar';
  $templates['fivestar']->css = drupal_get_path('module', 'rate') . '/templates/fivestar/fivestar.css';
  $templates['fivestar']->js = drupal_get_path('module', 'rate') . '/templates/fivestar/fivestar.js';
  $templates['fivestar']->customizable = FALSE;
  $templates['fivestar']->translate = FALSE;
  $templates['fivestar']->template_title = t('Fivestar');
  return $templates;
}

/**
 * Alter the rate widget before display.
 *
 * @param object $widget Widget object
 * @param array $context
 *   array(
 *     'content_type' => $content_type,
 *     'content_id' => $content_id,
 *   );
 */
function hook_rate_widget_alter(&$widget, $context) {
}

/**
 * Take actions before saving rate widget to the database.
 *
 * @param object $widget Widget object
 * @param array $values Values from $form_state['values']
 */
function hook_rate_widget_insert(&$widget, $values) {
}

/**
 * Take actions before updating rate widget.
 *
 * @param object $widget Widget object
 * @param array $values Values from $form_state['values']
 */
function hook_rate_widget_update(&$widget, $values) {
}

/**
 * Take action after deleting rate widget.
 *
 * @param object $widget Widget object
 */
function hook_rate_widget_delete(&$widget) {
}

/**
 * Alter the vote before it is saved.
 * 
 * @param array $vote
 *   array(
 *     'entity_type' => $content_type,
 *     'entity_id' => $content_id,
 *     'value_type' => $widget->value_type,
 *     'value' => $value,
 *     'tag' => $widget->tag,
 *   );
 * @param array $context
 *   array(
 *     'redirect' => &$redirect, // Path. Alter to redirect the user.
 *     'save' => &$save, // Boolean indicating whether the vote must be saved.
 *     'widget' => $widget, // Widget object, unalterable.
 *   );
 */
function hook_rate_vote_alter($vote, $context) {

  // Redirect users to the feedback page when they click on thumbs down.
  if ($context['widget']->name == 'thumbs_up_down' && $vote['value'] == -1) {
    $context['redirect'] = 'feedback';
  }
}

Functions

Name	Description
hook_rate_templates	Define templates for rate widgets.
hook_rate_vote_alter	Alter the vote before it is saved.
hook_rate_widget_alter	Alter the rate widget before display.
hook_rate_widget_delete	Take action after deleting rate widget.
hook_rate_widget_insert	Take actions before saving rate widget to the database.
hook_rate_widget_update	Take actions before updating rate widget.