poll.module in Drupal 7
Same filename and directory in other branches
Enables your site to capture votes on different topics in the form of multiple choice questions.
File
modules/poll/poll.moduleView source
<?php
/**
* @file
* Enables your site to capture votes on different topics in the form of multiple
* choice questions.
*/
/**
* Implements hook_help().
*/
function poll_help($path, $arg) {
switch ($path) {
case 'admin/help#poll':
$output = '';
$output .= '<h3>' . t('About') . '</h3>';
$output .= '<p>' . t('The Poll module can be used to create simple surveys or questionnaires that display cumulative results. A poll is a good way to receive feedback from site users and community members. For more information, see the online handbook entry for the <a href="@poll">Poll module</a>.', array(
'@poll' => 'http://drupal.org/documentation/modules/poll/',
)) . '</p>';
$output .= '<h3>' . t('Uses') . '</h3>';
$output .= '<dl>';
$output .= '<dt>' . t('Creating a poll') . '</dt>';
$output .= '<dd>' . t('Users can create a poll by clicking on Poll on the <a href="@add-content">Add new content</a> page, and entering the question being posed, the answer choices, and beginning vote counts for each choice. The status (closed or active) and duration (length of time the poll remains active for new votes) can also be specified.', array(
'@add-content' => url('node/add'),
)) . '</dd>';
$output .= '<dt>' . t('Viewing polls') . '</dt>';
$output .= '<dd>' . t('You can visit the <a href="@poll">Polls</a> page to view all current polls, or alternately enable the <em>Most recent poll</em> block on the <a href="@blocks">Blocks administration page</a>. To vote in or view the results of a specific poll, you can click on the poll itself.', array(
'@poll' => url('poll'),
'@blocks' => url('admin/structure/block'),
)) . '</dd>';
$output .= '</dl>';
return $output;
}
}
/**
* Implements hook_theme().
*/
function poll_theme() {
$theme_hooks = array(
'poll_vote' => array(
'template' => 'poll-vote',
'render element' => 'form',
),
'poll_choices' => array(
'render element' => 'form',
),
'poll_results' => array(
'template' => 'poll-results',
'variables' => array(
'raw_title' => NULL,
'results' => NULL,
'votes' => NULL,
'raw_links' => NULL,
'block' => NULL,
'nid' => NULL,
'vote' => NULL,
),
),
'poll_bar' => array(
'template' => 'poll-bar',
'variables' => array(
'title' => NULL,
'votes' => NULL,
'total_votes' => NULL,
'vote' => NULL,
'block' => NULL,
),
),
);
// The theme system automatically discovers the theme's functions and
// templates that implement more targeted "suggestions" of generic theme
// hooks. But suggestions implemented by a module must be explicitly
// registered.
$theme_hooks += array(
'poll_results__block' => array(
'template' => 'poll-results--block',
'variables' => $theme_hooks['poll_results']['variables'],
),
'poll_bar__block' => array(
'template' => 'poll-bar--block',
'variables' => $theme_hooks['poll_bar']['variables'],
),
);
return $theme_hooks;
}
/**
* Implements hook_permission().
*/
function poll_permission() {
$perms = array(
'vote on polls' => array(
'title' => t('Vote on polls'),
),
'cancel own vote' => array(
'title' => t('Cancel and change own votes'),
),
'inspect all votes' => array(
'title' => t('View details for all votes'),
),
);
return $perms;
}
/**
* Implements hook_menu().
*/
function poll_menu() {
$items['poll'] = array(
'title' => 'Polls',
'page callback' => 'poll_page',
'access arguments' => array(
'access content',
),
'type' => MENU_SUGGESTED_ITEM,
'file' => 'poll.pages.inc',
);
$items['node/%node/votes'] = array(
'title' => 'Votes',
'page callback' => 'poll_votes',
'page arguments' => array(
1,
),
'access callback' => '_poll_menu_access',
'access arguments' => array(
1,
'inspect all votes',
FALSE,
),
'weight' => 3,
'type' => MENU_LOCAL_TASK,
'file' => 'poll.pages.inc',
);
$items['node/%node/results'] = array(
'title' => 'Results',
'page callback' => 'poll_results',
'page arguments' => array(
1,
),
'access callback' => '_poll_menu_access',
'access arguments' => array(
1,
'access content',
TRUE,
),
'weight' => 3,
'type' => MENU_LOCAL_TASK,
'file' => 'poll.pages.inc',
);
return $items;
}
/**
* Callback function to see if a node is acceptable for poll menu items.
*/
function _poll_menu_access($node, $perm, $inspect_allowvotes) {
return user_access($perm) && $node->type == 'poll' && ($node->allowvotes || !$inspect_allowvotes);
}
/**
* Implements hook_block_info().
*/
function poll_block_info() {
$blocks['recent']['info'] = t('Most recent poll');
$blocks['recent']['properties']['administrative'] = TRUE;
return $blocks;
}
/**
* Implements hook_block_view().
*
* Generates a block containing the latest poll.
*/
function poll_block_view($delta = '') {
if (user_access('access content')) {
// Retrieve the latest poll.
$select = db_select('node', 'n');
$select
->join('poll', 'p', 'p.nid = n.nid');
$select
->fields('n', array(
'nid',
))
->condition('n.status', 1)
->condition('p.active', 1)
->orderBy('n.created', 'DESC')
->range(0, 1)
->addTag('node_access');
$record = $select
->execute()
->fetchObject();
if ($record) {
$poll = node_load($record->nid);
if ($poll->nid) {
$poll = poll_block_latest_poll_view($poll);
$block['subject'] = t('Poll');
$block['content'] = $poll->content;
return $block;
}
}
}
}
/**
* Implements hook_cron().
*
* Closes polls that have exceeded their allowed runtime.
*/
function poll_cron() {
$nids = db_query('SELECT p.nid FROM {poll} p INNER JOIN {node} n ON p.nid = n.nid WHERE (n.created + p.runtime) < :request_time AND p.active = :active AND p.runtime <> :runtime', array(
':request_time' => REQUEST_TIME,
':active' => 1,
':runtime' => 0,
))
->fetchCol();
if (!empty($nids)) {
db_update('poll')
->fields(array(
'active' => 0,
))
->condition('nid', $nids, 'IN')
->execute();
}
}
/**
* Implements hook_node_info().
*/
function poll_node_info() {
return array(
'poll' => array(
'name' => t('Poll'),
'base' => 'poll',
'description' => t('A <em>poll</em> is a question with a set of possible responses. A <em>poll</em>, once created, automatically provides a simple running count of the number of votes received for each response.'),
'title_label' => t('Question'),
),
);
}
/**
* Implements hook_field_extra_fields().
*/
function poll_field_extra_fields() {
$extra['node']['poll'] = array(
'form' => array(
'choice_wrapper' => array(
'label' => t('Poll choices'),
'description' => t('Poll choices'),
'weight' => -4,
),
'settings' => array(
'label' => t('Poll settings'),
'description' => t('Poll module settings'),
'weight' => -3,
),
),
'display' => array(
'poll_view_voting' => array(
'label' => t('Poll vote'),
'description' => t('Poll vote'),
'weight' => 0,
),
'poll_view_results' => array(
'label' => t('Poll results'),
'description' => t('Poll results'),
'weight' => 0,
),
),
);
return $extra;
}
/**
* Implements hook_form().
*/
function poll_form($node, &$form_state) {
global $user;
$admin = user_access('bypass node access') || user_access('edit any poll content') || user_access('edit own poll content') && $user->uid == $node->uid;
$type = node_type_get_type($node);
// The submit handlers to add more poll choices require that this form is
// cached, regardless of whether Ajax is used.
$form_state['cache'] = TRUE;
$form['title'] = array(
'#type' => 'textfield',
'#title' => check_plain($type->title_label),
'#required' => TRUE,
'#default_value' => $node->title,
'#maxlength' => 255,
'#weight' => -5,
);
if (isset($form_state['choice_count'])) {
$choice_count = $form_state['choice_count'];
}
else {
$choice_count = max(2, empty($node->choice) ? 2 : count($node->choice));
}
// Add a wrapper for the choices and more button.
$form['choice_wrapper'] = array(
'#tree' => FALSE,
'#weight' => -4,
'#prefix' => '<div class="clearfix" id="poll-choice-wrapper">',
'#suffix' => '</div>',
);
// Container for just the poll choices.
$form['choice_wrapper']['choice'] = array(
'#prefix' => '<div id="poll-choices">',
'#suffix' => '</div>',
'#theme' => 'poll_choices',
);
// Add the current choices to the form.
$delta = 0;
$weight = 0;
if (isset($node->choice)) {
$delta = count($node->choice);
foreach ($node->choice as $chid => $choice) {
$key = 'chid:' . $chid;
$form['choice_wrapper']['choice'][$key] = _poll_choice_form($key, $choice['chid'], $choice['chtext'], $choice['chvotes'], $choice['weight'], $choice_count);
$weight = max($choice['weight'], $weight);
}
}
// Add initial or additional choices.
$existing_delta = $delta;
for ($delta; $delta < $choice_count; $delta++) {
$key = 'new:' . ($delta - $existing_delta);
// Increase the weight of each new choice.
$weight++;
$form['choice_wrapper']['choice'][$key] = _poll_choice_form($key, NULL, '', 0, $weight, $choice_count);
}
// We name our button 'poll_more' to avoid conflicts with other modules using
// Ajax-enabled buttons with the id 'more'.
$form['choice_wrapper']['poll_more'] = array(
'#type' => 'submit',
'#value' => t('More choices'),
'#attributes' => array(
'title' => t("If the amount of boxes above isn't enough, click here to add more choices."),
),
'#weight' => 1,
'#limit_validation_errors' => array(
array(
'choice',
),
),
'#submit' => array(
'poll_more_choices_submit',
),
'#ajax' => array(
'callback' => 'poll_choice_js',
'wrapper' => 'poll-choices',
'effect' => 'fade',
),
);
// Poll attributes
$duration = array(
// 1-6 days.
86400,
2 * 86400,
3 * 86400,
4 * 86400,
5 * 86400,
6 * 86400,
// 1-3 weeks (7 days).
604800,
2 * 604800,
3 * 604800,
// 1-3,6,9 months (30 days).
2592000,
2 * 2592000,
3 * 2592000,
6 * 2592000,
9 * 2592000,
// 1 year (365 days).
31536000,
);
$duration = array(
0 => t('Unlimited'),
) + drupal_map_assoc($duration, 'format_interval');
$active = array(
0 => t('Closed'),
1 => t('Active'),
);
$form['settings'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#title' => t('Poll settings'),
'#weight' => -3,
'#access' => $admin,
);
$form['settings']['active'] = array(
'#type' => 'radios',
'#title' => t('Poll status'),
'#default_value' => isset($node->active) ? $node->active : 1,
'#options' => $active,
'#description' => t('When a poll is closed, visitors can no longer vote for it.'),
'#access' => $admin,
);
$form['settings']['runtime'] = array(
'#type' => 'select',
'#title' => t('Poll duration'),
'#default_value' => isset($node->runtime) ? $node->runtime : 0,
'#options' => $duration,
'#description' => t('After this period, the poll will be closed automatically.'),
);
return $form;
}
/**
* Submit handler to add more choices to a poll form.
*
* This handler is run regardless of whether JS is enabled or not. It makes
* changes to the form state. If the button was clicked with JS disabled, then
* the page is reloaded with the complete rebuilt form. If the button was
* clicked with JS enabled, then ajax_form_callback() calls poll_choice_js() to
* return just the changed part of the form.
*/
function poll_more_choices_submit($form, &$form_state) {
// If this is a Ajax POST, add 1, otherwise add 5 more choices to the form.
if ($form_state['values']['poll_more']) {
$n = $_GET['q'] == 'system/ajax' ? 1 : 5;
$form_state['choice_count'] = count($form_state['values']['choice']) + $n;
}
// Renumber the choices. This invalidates the corresponding key/value
// associations in $form_state['input'], so clear that out. This requires
// poll_form() to rebuild the choices with the values in
// $form_state['node']->choice, which it does.
$form_state['node']->choice = array_values($form_state['values']['choice']);
unset($form_state['input']['choice']);
$form_state['rebuild'] = TRUE;
}
function _poll_choice_form($key, $chid = NULL, $value = '', $votes = 0, $weight = 0, $size = 10) {
$form = array(
'#tree' => TRUE,
'#weight' => $weight,
);
// We'll manually set the #parents property of these fields so that
// their values appear in the $form_state['values']['choice'] array.
$form['chid'] = array(
'#type' => 'value',
'#value' => $chid,
'#parents' => array(
'choice',
$key,
'chid',
),
);
$form['chtext'] = array(
'#type' => 'textfield',
'#title' => $value !== '' ? t('Choice label') : t('New choice label'),
'#title_display' => 'invisible',
'#default_value' => $value,
'#parents' => array(
'choice',
$key,
'chtext',
),
);
$form['chvotes'] = array(
'#type' => 'textfield',
'#title' => $value !== '' ? t('Vote count for choice @label', array(
'@label' => $value,
)) : t('Vote count for new choice'),
'#title_display' => 'invisible',
'#default_value' => $votes,
'#size' => 5,
'#maxlength' => 7,
'#parents' => array(
'choice',
$key,
'chvotes',
),
'#access' => user_access('administer nodes'),
'#element_validate' => array(
'element_validate_integer',
),
);
$form['weight'] = array(
'#type' => 'weight',
'#title' => $value !== '' ? t('Weight for choice @label', array(
'@label' => $value,
)) : t('Weight for new choice'),
'#title_display' => 'invisible',
'#default_value' => $weight,
'#delta' => $size,
'#parents' => array(
'choice',
$key,
'weight',
),
);
return $form;
}
/**
* Ajax callback in response to new choices being added to the form.
*
* This returns the new page content to replace the page content made obsolete
* by the form submission.
*
* @see poll_more_choices_submit()
*/
function poll_choice_js($form, $form_state) {
return $form['choice_wrapper']['choice'];
}
/**
* Form submit handler for node_form().
*
* Upon preview and final submission, we need to renumber poll choices and
* create a teaser output.
*/
function poll_node_form_submit(&$form, &$form_state) {
// Renumber choices.
$form_state['values']['choice'] = array_values($form_state['values']['choice']);
$form_state['values']['teaser'] = poll_teaser((object) $form_state['values']);
}
/**
* Implements hook_validate().
*/
function poll_validate($node, $form) {
if (isset($node->title)) {
// Check for at least two options and validate amount of votes.
$realchoices = 0;
foreach ($node->choice as $i => $choice) {
if ($choice['chtext'] != '') {
$realchoices++;
}
if (isset($choice['chvotes']) && $choice['chvotes'] < 0) {
form_set_error("choice][{$i}][chvotes", t('Negative values are not allowed.'));
}
}
if ($realchoices < 2) {
form_set_error("choice][{$realchoices}][chtext", t('You must fill in at least two choices.'));
}
}
}
/**
* Implements hook_field_attach_prepare_translation_alter().
*/
function poll_field_attach_prepare_translation_alter(&$entity, $context) {
if ($context['entity_type'] == 'node' && $entity->type == 'poll') {
$entity->choice = $context['source_entity']->choice;
foreach ($entity->choice as $i => $options) {
$entity->choice[$i]['chvotes'] = 0;
}
}
}
/**
* Implements hook_load().
*/
function poll_load($nodes) {
global $user;
foreach ($nodes as $node) {
$poll = db_query("SELECT runtime, active FROM {poll} WHERE nid = :nid", array(
':nid' => $node->nid,
))
->fetchObject();
if (empty($poll)) {
$poll = new stdClass();
}
// Load the appropriate choices into the $poll object.
$poll->choice = db_select('poll_choice', 'c')
->addTag('translatable')
->fields('c', array(
'chid',
'chtext',
'chvotes',
'weight',
))
->condition('c.nid', $node->nid)
->orderBy('weight')
->execute()
->fetchAllAssoc('chid', PDO::FETCH_ASSOC);
// Determine whether or not this user is allowed to vote.
$poll->allowvotes = FALSE;
if (user_access('vote on polls') && $poll->active) {
if ($user->uid) {
// If authenticated, find existing vote based on uid.
$poll->vote = db_query('SELECT chid FROM {poll_vote} WHERE nid = :nid AND uid = :uid', array(
':nid' => $node->nid,
':uid' => $user->uid,
))
->fetchField();
if (empty($poll->vote)) {
$poll->vote = -1;
$poll->allowvotes = TRUE;
}
}
elseif (!empty($_SESSION['poll_vote'][$node->nid])) {
// Otherwise the user is anonymous. Look for an existing vote in the
// user's session.
$poll->vote = $_SESSION['poll_vote'][$node->nid];
}
else {
// Finally, query the database for an existing vote based on anonymous
// user's hostname.
$poll->allowvotes = !db_query("SELECT 1 FROM {poll_vote} WHERE nid = :nid AND hostname = :hostname AND uid = 0", array(
':nid' => $node->nid,
':hostname' => ip_address(),
))
->fetchField();
}
}
foreach ($poll as $key => $value) {
$nodes[$node->nid]->{$key} = $value;
}
}
}
/**
* Implements hook_insert().
*/
function poll_insert($node) {
if (!user_access('administer nodes')) {
// Make sure all votes are 0 initially
foreach ($node->choice as $i => $choice) {
$node->choice[$i]['chvotes'] = 0;
}
$node->active = 1;
}
db_insert('poll')
->fields(array(
'nid' => $node->nid,
'runtime' => $node->runtime,
'active' => $node->active,
))
->execute();
foreach ($node->choice as $choice) {
if ($choice['chtext'] != '') {
db_insert('poll_choice')
->fields(array(
'nid' => $node->nid,
'chtext' => $choice['chtext'],
'chvotes' => $choice['chvotes'],
'weight' => $choice['weight'],
))
->execute();
}
}
}
/**
* Implements hook_update().
*/
function poll_update($node) {
// Update poll settings.
db_update('poll')
->fields(array(
'runtime' => $node->runtime,
'active' => $node->active,
))
->condition('nid', $node->nid)
->execute();
// Poll choices with empty titles signifies removal. We remove all votes to
// the removed options, so people who voted on them can vote again.
foreach ($node->choice as $key => $choice) {
if (!empty($choice['chtext'])) {
db_merge('poll_choice')
->key(array(
'chid' => $choice['chid'],
))
->fields(array(
'chtext' => $choice['chtext'],
'chvotes' => (int) $choice['chvotes'],
'weight' => $choice['weight'],
))
->insertFields(array(
'nid' => $node->nid,
'chtext' => $choice['chtext'],
'chvotes' => (int) $choice['chvotes'],
'weight' => $choice['weight'],
))
->execute();
}
else {
db_delete('poll_vote')
->condition('nid', $node->nid)
->condition('chid', $key)
->execute();
db_delete('poll_choice')
->condition('nid', $node->nid)
->condition('chid', $choice['chid'])
->execute();
}
}
}
/**
* Implements hook_delete().
*/
function poll_delete($node) {
db_delete('poll')
->condition('nid', $node->nid)
->execute();
db_delete('poll_choice')
->condition('nid', $node->nid)
->execute();
db_delete('poll_vote')
->condition('nid', $node->nid)
->execute();
}
/**
* Return content for 'latest poll' block.
*
* @param $node
* The node object to load.
*/
function poll_block_latest_poll_view($node) {
// This is necessary for shared objects because PHP doesn't copy objects, but
// passes them by reference. So when the objects are cached it can result in
// the wrong output being displayed on subsequent calls. The cloning and
// unsetting of $node->content prevents the block output from being the same
// as the node output.
$node = clone $node;
unset($node->content);
// No 'read more' link.
$node->readmore = FALSE;
$node->teaser = '';
$links = array();
$links[] = array(
'title' => t('Older polls'),
'href' => 'poll',
'attributes' => array(
'title' => t('View the list of polls on this site.'),
),
);
if ($node->allowvotes) {
$links[] = array(
'title' => t('Results'),
'href' => 'node/' . $node->nid . '/results',
'attributes' => array(
'title' => t('View the current poll results.'),
),
);
}
$node->links = $links;
if (!empty($node->allowvotes)) {
$node->content['poll_view_voting'] = drupal_get_form('poll_view_voting', $node, TRUE);
$node->content['links'] = array(
'#theme' => 'links',
'#links' => $node->links,
'#weight' => 5,
);
}
else {
$node->content['poll_view_results'] = array(
'#markup' => poll_view_results($node, TRUE, TRUE),
);
}
return $node;
}
/**
* Implements hook_view().
*/
function poll_view($node, $view_mode) {
if (!empty($node->allowvotes) && empty($node->show_results)) {
$node->content['poll_view_voting'] = drupal_get_form('poll_view_voting', $node);
}
else {
$node->content['poll_view_results'] = array(
'#markup' => poll_view_results($node, $view_mode),
);
}
return $node;
}
/**
* Creates a simple teaser that lists all the choices.
*
* This is primarily used for RSS.
*/
function poll_teaser($node) {
$teaser = NULL;
if (is_array($node->choice)) {
foreach ($node->choice as $choice) {
if ($choice['chtext'] != '') {
$teaser .= '* ' . check_plain($choice['chtext']) . "\n";
}
}
}
return $teaser;
}
/**
* Generates the voting form for a poll.
*
* @ingroup forms
* @see poll_vote()
* @see phptemplate_preprocess_poll_vote()
*/
function poll_view_voting($form, &$form_state, $node, $block = FALSE) {
if ($node->choice) {
$list = array();
foreach ($node->choice as $i => $choice) {
$list[$i] = check_plain($choice['chtext']);
}
$form['choice'] = array(
'#type' => 'radios',
'#title' => t('Choices'),
'#title_display' => 'invisible',
'#options' => $list,
);
}
$form['vote'] = array(
'#type' => 'submit',
'#value' => t('Vote'),
'#submit' => array(
'poll_vote',
),
);
// Store the node so we can get to it in submit functions.
$form['#node'] = $node;
$form['#block'] = $block;
// Set form caching because we could have multiple of these forms on
// the same page, and we want to ensure the right one gets picked.
$form_state['cache'] = TRUE;
// Provide a more cleanly named voting form theme.
$form['#theme'] = 'poll_vote';
return $form;
}
/**
* Validation function for processing votes
*/
function poll_view_voting_validate($form, &$form_state) {
if (empty($form_state['values']['choice'])) {
form_set_error('choice', t('Your vote could not be recorded because you did not select any of the choices.'));
}
}
/**
* Submit handler for processing a vote.
*/
function poll_vote($form, &$form_state) {
$node = $form['#node'];
$choice = $form_state['values']['choice'];
global $user;
db_insert('poll_vote')
->fields(array(
'nid' => $node->nid,
'chid' => $choice,
'uid' => $user->uid,
'hostname' => ip_address(),
'timestamp' => REQUEST_TIME,
))
->execute();
// Add one to the votes.
db_update('poll_choice')
->expression('chvotes', 'chvotes + 1')
->condition('chid', $choice)
->execute();
cache_clear_all();
if (!$user->uid) {
// The vote is recorded so the user gets the result view instead of the
// voting form when viewing the poll. Saving a value in $_SESSION has the
// convenient side effect of preventing the user from hitting the page
// cache. When anonymous voting is allowed, the page cache should only
// contain the voting form, not the results.
$_SESSION['poll_vote'][$node->nid] = $choice;
}
drupal_set_message(t('Your vote was recorded.'));
// Return the user to whatever page they voted from.
}
/**
* Themes the voting form for a poll.
*
* Inputs: $form
*/
function template_preprocess_poll_vote(&$variables) {
$form = $variables['form'];
$variables['choice'] = drupal_render($form['choice']);
$variables['title'] = check_plain($form['#node']->title);
$variables['vote'] = drupal_render($form['vote']);
$variables['rest'] = drupal_render_children($form);
$variables['block'] = $form['#block'];
if ($variables['block']) {
$variables['theme_hook_suggestions'][] = 'poll_vote__block';
}
}
/**
* Generates a graphical representation of the results of a poll.
*/
function poll_view_results($node, $view_mode, $block = FALSE) {
// Make sure that choices are ordered by their weight.
uasort($node->choice, 'drupal_sort_weight');
// Count the votes and find the maximum.
$total_votes = 0;
$max_votes = 0;
foreach ($node->choice as $choice) {
if (isset($choice['chvotes'])) {
$total_votes += $choice['chvotes'];
$max_votes = max($max_votes, $choice['chvotes']);
}
}
$poll_results = '';
foreach ($node->choice as $i => $choice) {
if (!empty($choice['chtext'])) {
$chvotes = isset($choice['chvotes']) ? $choice['chvotes'] : NULL;
$poll_results .= theme('poll_bar', array(
'title' => $choice['chtext'],
'votes' => $chvotes,
'total_votes' => $total_votes,
'vote' => isset($node->vote) && $node->vote == $i,
'block' => $block,
));
}
}
return theme('poll_results', array(
'raw_title' => $node->title,
'results' => $poll_results,
'votes' => $total_votes,
'raw_links' => isset($node->links) ? $node->links : array(),
'block' => $block,
'nid' => $node->nid,
'vote' => isset($node->vote) ? $node->vote : NULL,
));
}
/**
* Returns HTML for an admin poll form for choices.
*
* @param $variables
* An associative array containing:
* - form: A render element representing the form.
*
* @ingroup themeable
*/
function theme_poll_choices($variables) {
$form = $variables['form'];
drupal_add_tabledrag('poll-choice-table', 'order', 'sibling', 'poll-weight');
$is_admin = user_access('administer nodes');
$delta = 0;
$rows = array();
$headers = array(
'',
t('Choice'),
);
if ($is_admin) {
$headers[] = t('Vote count');
}
$headers[] = t('Weight');
foreach (element_children($form) as $key) {
$delta++;
// Set special classes for drag and drop updating.
$form[$key]['weight']['#attributes']['class'] = array(
'poll-weight',
);
// Build the table row.
$row = array(
'data' => array(
array(
'class' => array(
'choice-flag',
),
),
drupal_render($form[$key]['chtext']),
),
'class' => array(
'draggable',
),
);
if ($is_admin) {
$row['data'][] = drupal_render($form[$key]['chvotes']);
}
$row['data'][] = drupal_render($form[$key]['weight']);
// Add any additional classes set on the row.
if (!empty($form[$key]['#attributes']['class'])) {
$row['class'] = array_merge($row['class'], $form[$key]['#attributes']['class']);
}
$rows[] = $row;
}
$output = theme('table', array(
'header' => $headers,
'rows' => $rows,
'attributes' => array(
'id' => 'poll-choice-table',
),
));
$output .= drupal_render_children($form);
return $output;
}
/**
* Preprocess the poll_results theme hook.
*
* Inputs: $raw_title, $results, $votes, $raw_links, $block, $nid, $vote. The
* $raw_* inputs to this are naturally unsafe; often safe versions are
* made to simply overwrite the raw version, but in this case it seems likely
* that the title and the links may be overridden by the theme layer, so they
* are left in with a different name for that purpose.
*
* @see poll-results.tpl.php
* @see poll-results--block.tpl.php
*/
function template_preprocess_poll_results(&$variables) {
$variables['links'] = theme('links__poll_results', array(
'links' => $variables['raw_links'],
));
if (isset($variables['vote']) && $variables['vote'] > -1 && user_access('cancel own vote')) {
$elements = drupal_get_form('poll_cancel_form', $variables['nid']);
$variables['cancel_form'] = drupal_render($elements);
}
$variables['title'] = check_plain($variables['raw_title']);
if ($variables['block']) {
$variables['theme_hook_suggestions'][] = 'poll_results__block';
}
}
/**
* Preprocess the poll_bar theme hook.
*
* Inputs: $title, $votes, $total_votes, $voted, $block
*
* @see poll-bar.tpl.php
* @see poll-bar--block.tpl.php
*/
function template_preprocess_poll_bar(&$variables) {
if ($variables['block']) {
$variables['theme_hook_suggestions'][] = 'poll_bar__block';
}
$variables['title'] = check_plain($variables['title']);
$variables['percentage'] = round($variables['votes'] * 100 / max($variables['total_votes'], 1));
}
/**
* Builds the cancel form for a poll.
*
* @ingroup forms
* @see poll_cancel()
*/
function poll_cancel_form($form, &$form_state, $nid) {
$form_state['cache'] = TRUE;
// Store the nid so we can get to it in submit functions.
$form['#nid'] = $nid;
$form['actions'] = array(
'#type' => 'actions',
);
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Cancel your vote'),
'#submit' => array(
'poll_cancel',
),
);
return $form;
}
/**
* Submit callback for poll_cancel_form().
*/
function poll_cancel($form, &$form_state) {
global $user;
$node = node_load($form['#nid']);
db_delete('poll_vote')
->condition('nid', $node->nid)
->condition($user->uid ? 'uid' : 'hostname', $user->uid ? $user->uid : ip_address())
->execute();
// Subtract from the votes.
db_update('poll_choice')
->expression('chvotes', 'chvotes - 1')
->condition('chid', $node->vote)
->execute();
unset($_SESSION['poll_vote'][$node->nid]);
drupal_set_message(t('Your vote was cancelled.'));
}
/**
* Implements hook_user_cancel().
*/
function poll_user_cancel($edit, $account, $method) {
switch ($method) {
case 'user_cancel_reassign':
db_update('poll_vote')
->fields(array(
'uid' => 0,
))
->condition('uid', $account->uid)
->execute();
break;
}
}
/**
* Implements hook_user_delete().
*/
function poll_user_delete($account) {
db_delete('poll_vote')
->condition('uid', $account->uid)
->execute();
}
/**
* Implements hook_rdf_mapping().
*/
function poll_rdf_mapping() {
return array(
array(
'type' => 'node',
'bundle' => 'poll',
'mapping' => array(
'rdftype' => array(
'sioc:Post',
'sioct:Poll',
),
),
),
);
}Functions
Name |
Description |
|---|---|
| poll_block_info | Implements hook_block_info(). |
| poll_block_latest_poll_view | Return content for 'latest poll' block. |
| poll_block_view | Implements hook_block_view(). |
| poll_cancel | Submit callback for poll_cancel_form(). |
| poll_cancel_form | Builds the cancel form for a poll. |
| poll_choice_js | Ajax callback in response to new choices being added to the form. |
| poll_cron | Implements hook_cron(). |
| poll_delete | Implements hook_delete(). |
| poll_field_attach_prepare_translation_alter | Implements hook_field_attach_prepare_translation_alter(). |
| poll_field_extra_fields | Implements hook_field_extra_fields(). |
| poll_form | Implements hook_form(). |
| poll_help | Implements hook_help(). |
| poll_insert | Implements hook_insert(). |
| poll_load | Implements hook_load(). |
| poll_menu | Implements hook_menu(). |
| poll_more_choices_submit | Submit handler to add more choices to a poll form. |
| poll_node_form_submit | Form submit handler for node_form(). |
| poll_node_info | Implements hook_node_info(). |
| poll_permission | Implements hook_permission(). |
| poll_rdf_mapping | Implements hook_rdf_mapping(). |
| poll_teaser | Creates a simple teaser that lists all the choices. |
| poll_theme | Implements hook_theme(). |
| poll_update | Implements hook_update(). |
| poll_user_cancel | Implements hook_user_cancel(). |
| poll_user_delete | Implements hook_user_delete(). |
| poll_validate | Implements hook_validate(). |
| poll_view | Implements hook_view(). |
| poll_view_results | Generates a graphical representation of the results of a poll. |
| poll_view_voting | Generates the voting form for a poll. |
| poll_view_voting_validate | Validation function for processing votes |
| poll_vote | Submit handler for processing a vote. |
| template_preprocess_poll_bar | Preprocess the poll_bar theme hook. |
| template_preprocess_poll_results | Preprocess the poll_results theme hook. |
| template_preprocess_poll_vote | Themes the voting form for a poll. |
| theme_poll_choices | Returns HTML for an admin poll form for choices. |
| _poll_choice_form | |
| _poll_menu_access | Callback function to see if a node is acceptable for poll menu items. |