The function poll_view_results (API documentation: "Generates a graphical representation of the results of a poll") does not contain any html code, but I think it should be implemented as a theme function, so it can be overridden. Right now, I cannot control the output of the poll results as much as I'd like to. Overriding poll_view_results would allow me to add 'presentation logic' such as ordering the results from high to low, or scaling the width of the result bars so that the widest bar is always 100px wide (regardless of the percentage it represents).

I'm not experienced in module development; Would this be as easy as renaming poll_view_results to theme_poll_view_results and changing the references to poll_view_results accordingly?

Comments

marcvangend’s picture

marcvangend
he/him
Primary language Dutch
Location Amsterdam
commented

If anyone's interested: I wrote some lines of Javascript (jQuery) to achieve the scaling of the graph bars (as mentioned in my post above). I'd still prefer to have this in php, but this works.

/* scale the graph bars to 100% width */

$(document).ready(function(){

  maxvalue = 0;

  // Compare the bars and store the higest width value
  $(".block-poll .foreground").each(function () {
    if (parseInt($(this).css("width")) > maxvalue) {
      maxvalue = parseInt($(this).css("width"));
    }
  });
  
  // Calculate the scale factor
  factor = 100 / maxvalue;
  
  // Calculate the new size for every bar and apply the new value
  $(".block-poll .foreground").each(function () {
    newsize = Math.round( parseInt($(this).css("width")) * factor ) + "%";
    $(this).css("width",newsize);
  });

});

This example illustrates perfectly why poll_view_results should be a theme function: you can't control the output completely if you can't process all values first (in this case: search the max value and calculate the scale factor).

sun’s picture

sun
Primary language German
Location Karlsruhe
commented
Title: make poll_view_results a theme function » poll_view_results() should be a theme function
Category: feature » task

Makes totally sense. As poll module is quite self-contained and there are almost no contrib modules extending on it, I guess this can still be done for D7.

Can you roll a patch? Ideally, most of the preparation and hard logic should be moved into a preprocess function, so the (wrapping) theme function is easily alterable for themers.

marcvangend’s picture

marcvangend
he/him
Primary language Dutch
Location Amsterdam
commented

Wow, this issue is old... I'm surprised that you dug it up, Daniel :-)
Fortunately I'm much more experienced in module development now, so if time permits (poll module is not on top of my priority list) I'll roll a patch.

amateescu’s picture

amateescu commented
Version: 7.x-dev » 8.x-dev

We should definitely do this in D8.

maxmendez’s picture

maxmendez commented
Status: Active » Closed (fixed)

This issue has been resolved.

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 = array();
  foreach ($node->choice as $i => $choice) {
    $chvotes = isset($choice['chvotes']) ? $choice['chvotes'] : NULL;
    $percentage = round($chvotes * 100 / max($total_votes, 1));
    $display_votes = !$block ? ' (' . format_plural($chvotes, '1 vote', '@count votes') . ')' : '';

    $poll_results[] = array(
      '#theme' => 'meter',
      '#prefix' => '<dt class="choice-title">' . check_plain($choice['chtext']) . "</dt>\n" . '<dd class="choice-result">',
      '#suffix' => "</dd>\n",
      '#display_value' =>  t('!percentage%', array('!percentage' => $percentage)) . $display_votes,
      '#min' => 0,
      '#max' => $total_votes,
      '#value' => $chvotes,
      '#percentage' => $percentage,
      '#attributes' => array('class' => 'bar'),
    );
  }

  return theme('poll_results', array('raw_title' => $node->title, 'results' => drupal_render($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));
}
marcvangend’s picture

marcvangend
he/him
Primary language Dutch
Location Amsterdam
commented
Status: Closed (fixed) » Active

@MaxMendez can you elaborate? I see there have been some changes, in #1229442: Convert poll tpls and markup to HTML5 for instance, and looking at the code it seems to solve the specific use case from #1.

However, this issue is not merely about scaling the largest bar to 100%. This issue is about giving the themer control over the calculations that are made before the values are passed on to the theme function or template. As far as I can see, that is still not possible.

sun’s picture

sun
Primary language German
Location Karlsruhe
commented
Issue tags: +Novice

At minimum, the poll_view_results() should return a render array instead of calling theme() directly.

Second, no premature drupal_render(). This means the poll_results theme function/template needs to deal with a render array in $results instead.

Lastly, @marcvangend should clarify which variables (and thus calculations) in poll_view_results() he wants to adjust. Those variables (and affected calculations) need to happen in a template_preprocess_poll_results() preprocessor instead then.

That clarification and this (my) comment should also be copied into the issue summary.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Project: Drupal core » Poll
Version: 8.x-dev » 8.x-1.x-dev
Component: poll.module » Code

Poll is no longer part of core

berdir’s picture

berdir
Primary language German
Location Switzerland
commented
Issue summary: View changes
Status: Active » Closed (won't fix)

I don't think there's any point in keeping this. polls are an entity now and use a view builder + form + template to display results, there should be plenty of ways to customize the output. If not, then we can open a new, more specific issue.