5 * Webform module grid component.
8 // Grid depends on functions provided by select.
9 webform_component_include('select');
12 * Implements _webform_defaults_component().
14 function _webform_defaults_grid() {
29 'custom_option_keys' => 0,
30 'custom_question_keys' => 0,
33 'description_above' => FALSE,
41 * Implements _webform_theme_component().
43 function _webform_theme_grid() {
45 'webform_grid' => array(
46 'render element' => 'element',
47 'file' => 'components/grid.inc',
49 'webform_display_grid' => array(
50 'render element' => 'element',
51 'file' => 'components/grid.inc',
57 * Implements _webform_edit_component().
59 function _webform_edit_grid($component) {
62 $form['help'] = array(
63 '#type' => 'fieldset',
64 '#collapsible' => TRUE,
65 '#collapsed' => !empty($component['cid']),
66 '#title' => t('About options and questions…'),
67 '#description' => t('Options and questions may be configured here, in additional nested Select Options components, or even both.'),
69 'pros_and_cons' => array(
71 '#header' => array('', t('Options and questions configured <strong>here</strong>'), t('Configured in additional <strong>nested</strong> components'), t('Both')),
73 array(t('Questions'), t('Enter the questions below.'), t('Configure and save this grid, then add additional Select Options components nested (indented) below this grid.'), t('Additional questions from nested components will be displayed below any questions configured here.')),
74 array(t('Options'), t('Enter options below.'), t('May be different for each question. Initially the same as defined below.'), t('Options from additional nested components will be merged with any options configured here.')),
75 array(t('Checkboxes'), t('No. Radio buttons only.'), t('Yes. Some or all questions may be multiple choice with check boxes.'), ''),
76 array(t('Default'), t('Yes. Must be same for all questions.'), t('Yes. May all be the same or different.'), ''),
77 array(t('Pre-built option lists'), t('No.'), t('Yes.'), ''),
78 array(t('Required'), t('Yes. Must be same for all questions.'), t('Yes. May all be the same or different.'), ''),
79 array(t('Question conditionals'), t('No.'), t('Yes. Individual questions may be used in conditional rules and/or actions.'), t('The whole grid may be conditionally shown or required.')),
80 array(t('Other types of nested components'), t('No.'), t('Yes. Other component types may also be included in the grid. They will be displayed where the options would normally be.'), ''),
85 if (module_exists('options_element')) {
86 $form['options'] = array(
87 '#type' => 'fieldset',
88 '#title' => t('Options'),
89 '#collapsible' => TRUE,
90 '#attributes' => array('class' => array('webform-options-element')),
91 '#element_validate' => array('_webform_edit_validate_options'),
94 $form['options']['options'] = array(
96 '#options' => _webform_select_options_from_text($component['extra']['options'], TRUE),
97 '#default_value' => $component['value'],
98 '#default_value_allowed' => TRUE,
99 '#optgroups' => FALSE,
100 '#key_type' => 'mixed',
101 '#key_type_toggle' => t('Customize option keys (Advanced)'),
102 '#key_type_toggled' => $component['extra']['custom_option_keys'],
103 '#default_value_pattern' => '^%.+\[.+\]$',
104 '#description' => t('<strong>Options to select across the top</strong>, such as "Poor" through "Excellent". Indicate the default to the left of the desired item. Use of only alphanumeric characters and underscores is recommended in keys.') . ' ' . theme('webform_token_help'),
107 $form['questions'] = array(
108 '#type' => 'fieldset',
109 '#title' => t('Questions'),
110 '#collapsible' => TRUE,
111 '#attributes' => array('class' => array('webform-options-element')),
112 '#element_validate' => array('_webform_edit_validate_options'),
115 $form['questions']['options'] = array(
116 '#type' => 'options',
117 '#options' => _webform_select_options_from_text($component['extra']['questions'], TRUE),
118 '#optgroups' => FALSE,
119 '#default_value' => FALSE,
120 '#default_value_allowed' => FALSE,
121 '#key_type' => 'mixed',
122 '#key_type_toggle' => t('Customize question keys (Advanced)'),
123 '#key_type_toggled' => $component['extra']['custom_question_keys'],
124 '#description' => t('<strong>Questions list down the side of the grid.</strong> For a heading column on the right, append "|" and the right-side heading. Use of only alphanumeric characters and underscores is recommended in keys.') . ' ' . theme('webform_token_help'),
128 $form['extra']['options'] = array(
129 '#type' => 'textarea',
130 '#title' => t('Options'),
131 '#default_value' => $component['extra']['options'],
132 '#description' => t('Options to select across the top, such as "Poor" through "Excellent" or "Stronly Disagree" through "Strongly Agree".') .
133 '<p>' . t('One key-value option per line. <strong>Key-value pairs MUST be specified as "safe_key|Some readable option"</strong>. Use of only alphanumeric characters and underscores is recommended in keys.') . '</p>' . theme('webform_token_help'),
138 '#element_validate' => array('_webform_edit_validate_select'),
140 $form['extra']['questions'] = array(
141 '#type' => 'textarea',
142 '#title' => t('Questions'),
143 '#default_value' => $component['extra']['questions'],
144 '#description' => t('Questions list down the side of the grid. One question per line. <strong>Key-value pairs MUST be specified as "safe_key|Some readable question"</strong>. For a heading column on the right, append "|" and the right-side heading. Use of only alphanumeric characters and underscores is recommended in keys.') . ' ' . theme('webform_token_help') . ' ' .
145 '<p>' . t('<strong>Or for more control</strong> over the appearance and configuration, create additional additional Select Options or other type components nested under this grid. They will operate as separate components, but be displayed within this grid.') . '</p>',
150 '#element_validate' => array('_webform_edit_validate_select'),
152 $form['value'] = array(
153 '#type' => 'textfield',
154 '#title' => t('Default value'),
155 '#default_value' => $component['value'],
156 '#description' => t('The default option of the grid identified by its key.') . ' ' . theme('webform_token_help'),
158 '#maxlength' => 1024,
163 $form['display']['optrand'] = array(
164 '#type' => 'checkbox',
165 '#title' => t('Randomize Options'),
166 '#default_value' => $component['extra']['optrand'],
167 '#description' => t('Randomizes the order of options on the top when they are displayed in the form.'),
168 '#parents' => array('extra', 'optrand')
170 $form['display']['qrand'] = array(
171 '#type' => 'checkbox',
172 '#title' => t('Randomize Questions'),
173 '#default_value' => $component['extra']['qrand'],
174 '#description' => t('Randomize the order of the questions on the side when they are displayed in the form.'),
175 '#parents' => array('extra', 'qrand')
177 $form['display']['sticky'] = array(
178 '#type' => 'checkbox',
179 '#title' => t('Sticky table header'),
180 '#default_value' => $component['extra']['sticky'],
181 '#description' => t('Use a sticky (non-scrolling) table header.'),
182 '#parents' => array('extra', 'sticky')
185 $form['validation']['unique'] = array(
186 '#type' => 'checkbox',
187 '#title' => t('Unique'),
188 '#return_value' => 1,
189 '#description' => t('Check that all entered values for this field are unique. The same value is not allowed to be used twice.'),
191 '#default_value' => $component['extra']['unique'],
192 '#parents' => array('extra', 'unique'),
199 * Implements _webform_render_component().
201 function _webform_render_grid($component, $value = NULL, $filter = TRUE, $submission = NULL) {
202 $node = isset($component['nid']) ? node_load($component['nid']) : NULL;
204 $questions = _webform_select_options_from_text($component['extra']['questions'], TRUE);
205 $options = _webform_select_options_from_text($component['extra']['options'], TRUE);
207 $questions = _webform_select_replace_tokens($questions, $node);
208 $options = _webform_select_replace_tokens($options, $node);
212 '#type' => 'webform_grid',
213 '#title' => $filter ? webform_filter_xss($component['name']) : $component['name'],
214 '#title_display' => $component['extra']['title_display'] ? $component['extra']['title_display'] : 'before',
215 '#required' => $component['required'],
216 '#weight' => $component['weight'],
217 '#description' => $filter ? webform_filter_descriptions($component['extra']['description'], $node) : $component['extra']['description'],
218 '#grid_questions' => $questions,
219 '#grid_options' => $options,
220 '#default_value' => isset($value) || !strlen($component['value']) ? $value : array_fill_keys(array_keys($questions), $component['value']),
221 '#grid_default' => $component['value'],
222 '#optrand' => $component['extra']['optrand'],
223 '#qrand' => $component['extra']['qrand'],
224 '#sticky' => $component['extra']['sticky'],
225 '#theme' => 'webform_grid',
226 '#theme_wrappers' => array('webform_element'),
227 '#process' => array('webform_expand_grid'),
228 '#translatable' => array('title', 'description', 'grid_options', 'grid_questions'),
231 // Enforce uniqueness.
232 if ($component['extra']['unique']) {
233 $element['#element_validate'][] = '_webform_edit_grid_unique_validate';
240 * A Form API #process function for Webform grid fields.
242 function webform_expand_grid($element) {
243 $options = $element['#grid_options'];
244 $questions = $element['#grid_questions'];
247 // Process questions and options from nested components.
248 foreach (element_children($element) as $key) {
249 $question = $element[$key];
250 // Both forms and grid displays have #webform_component.
251 if (isset($question['#webform_component']) &&
252 $question['#webform_component']['type'] == 'select' &&
253 !$question['#webform_component']['extra']['aslist'] &&
254 !$question['#webform_component']['extra']['other_option']) {
255 $options = webform_grid_merge_options($options, $question['#options']);
256 $weights[$key] = $question['#weight'];
260 // Add the internal grid questions.
262 $value = isset($element['#default_value']) ? $element['#default_value'] : array();
263 foreach ($questions as $key => $question) {
264 if ($question != '') {
265 $question_value = isset($value[$key]) && $value[$key] !== '' ? $value[$key] : NULL;
266 $element[$key] = array(
267 '#grid_question' => TRUE,
268 '#title' => $question,
269 '#required' => $element['#required'],
270 '#options' => $element['#grid_options'],
272 '#default_value' => $question_value,
273 '#value' => $question_value,
274 '#process' => array('form_process_radios', 'webform_expand_select_ids'),
276 // Webform handles validation manually.
277 '#validated' => TRUE,
278 '#webform_validated' => FALSE,
279 '#translatable' => array('title'),
280 '#weight' => $weight,
283 // Add HTML5 required attribute, if needed.
284 if ($element['#required']) {
285 $element[$key]['#attributes']['required'] = 'required';
288 $weights[$key] = $weight;
293 if (!empty($element['#optrand'])) {
294 _webform_shuffle_options($options);
296 $element['#grid_options'] = $options;
299 if (!empty($element['#qrand'])) {
300 _webform_shuffle_options($weights);
302 $weight = min($weights);
303 foreach ($weights as $key => $old_weight) {
304 $element[$key]['#options'] = webform_grid_remove_options($options, $element[$key]['#options']);
305 $element[$key]['#weight'] = $weight++;
306 $element['#grid_questions'][$key] = $element[$key]['#title'];
313 * Helper. Merge select component options in order.
315 * @param array $existing
316 * An array of existing values into which any values from $new that aren't in
317 * $existing are inserted.
319 * Values to be inserted into $existing.
323 function webform_grid_merge_options($existing, $new) {
326 foreach ($new as $key => $value) {
327 if (isset($existing[$key])) {
328 // Insert the queue before the found item.
329 $insert = array_search($key, array_keys($existing));
331 $existing = array_slice($existing, 0, $insert, TRUE) +
333 array_slice($existing, $insert, NULL, TRUE);
334 $insert += count($queue);
339 elseif (is_null($insert)) {
340 // It is not yet clear yet where to put this item. Add it to the queue.
341 $queue[$key] = $value;
344 // PHP array_splice does not preserved the keys of the inserted array,
345 // but array_slice does (if the preserve keys parameter is TRUE).
346 $existing = array_slice($existing, 0, $insert, TRUE) +
347 array($key => $value) +
348 array_slice($existing, $insert, NULL, TRUE);
352 // Append any left over queued items.
358 * Helper. Replace missing options with empty values.
360 * @param array $header
361 * An array of options to be used at the grid table header.
362 * @param array $row_options
363 * An array of options to be used for this row.
365 * The $row_options with any missing options replaced with empty values.
367 function webform_grid_remove_options($header, $row_options) {
368 foreach ($header as $key => $value) {
369 if (!isset($row_options[$key])) {
377 * Implements _webform_display_component().
379 function _webform_display_grid($component, $value, $format = 'html', $submission = array()) {
380 $node = node_load($component['nid']);
381 $questions = _webform_select_options_from_text($component['extra']['questions'], TRUE);
382 $questions = _webform_select_replace_tokens($questions, $node);
383 $options = _webform_select_options_from_text($component['extra']['options'], TRUE);
384 $options = _webform_select_replace_tokens($options, $node);
387 '#title' => $component['name'],
388 '#title_display' => $component['extra']['title_display'] ? $component['extra']['title_display'] : 'before',
389 '#weight' => $component['weight'],
390 '#format' => $format,
391 '#grid_questions' => $questions,
392 '#grid_options' => $options,
393 '#default_value' => $value,
394 '#sticky' => $component['extra']['sticky'],
395 '#theme' => 'webform_display_grid',
396 '#theme_wrappers' => $format == 'html' ? array('webform_element') : array('webform_element_text'),
398 '#translatable' => array('#title', '#grid_questions', '#grid_options'),
401 foreach ($questions as $key => $question) {
402 if ($question !== '') {
403 $element[$key] = array(
404 '#title' => $question,
405 '#value' => isset($value[$key]) ? $value[$key] : NULL,
406 '#translatable' => array('#title', '#value'),
415 * Preprocess function for displaying a grid component.
417 function template_preprocess_webform_display_grid(&$variables) {
418 $element =& $variables['element'];
419 // Expand the grid, suppressing randomization. This builds the grid
420 // questions and options.
421 $element['#qrand'] = FALSE;
422 $element['#optrand'] = FALSE;
423 $element['#required'] = FALSE;
424 $element = webform_expand_grid($element);
428 * Format the text output for this component.
430 function theme_webform_display_grid($variables) {
431 $element = $variables['element'];
433 $component = $element['#webform_component'];
434 $format = $element['#format'];
436 if ($format == 'html') {
437 $right_titles = _webform_grid_right_titles($element);
440 // Set the header for the table.
441 $header = _webform_grid_header($element, $right_titles);
443 foreach (element_children($element) as $question_key) {
444 $question_element = $element[$question_key];
446 $questions = explode('|', $question_element['#title'], 2);
447 $values = $question_element['#value'];
448 $values = is_array($values) ? $values : array($values);
449 $row[] = array('data' => webform_filter_xss($questions[0]), 'class' => array('webform-grid-question'));
450 if (isset($element['#grid_questions'][$question_key])) {
451 foreach ($element['#grid_options'] as $option_value => $option_label) {
452 if (in_array($option_value, $values)) {
453 $row[] = array('data' => '<strong>X</strong>', 'class' => array('checkbox', 'webform-grid-option'));
456 $row[] = array('data' => ' ', 'class' => array('checkbox', 'webform-grid-option'));
461 $question_element['#title_display'] = 'none';
463 'data' => drupal_render($question_element),
464 'colspan' => count($element['#grid_options']),
468 $row[] = array('data' => isset($questions[1]) ? webform_filter_xss($questions[1]) : '', 'class' => array('webform-grid-question'));
473 $option_count = count($header) - 1;
474 $output = theme('table', array('header' => $header, 'rows' => $rows, 'sticky' => $element['#sticky'], 'attributes' => array('class' => array('webform-grid', 'webform-grid-' . $option_count))));
478 foreach (element_children($element) as $question_key) {
479 $question_element = $element[$question_key];
480 if (isset($element['#grid_questions'][$question_key])) {
481 $values = $question_element['#value'];
482 $values = is_array($values) ? $values : array($values);
483 foreach ($values as $value_key => $value) {
484 if (isset($element['#grid_options'][$value])) {
485 $values[$value_key] = $element['#grid_options'][$value];
488 unset($values[$value_key]);
491 $value = implode(', ', $values);
494 $element[$question_key]['#title'] = '';
495 $value = drupal_render($element[$question_key]);
497 $items[] = ' - ' . _webform_grid_question_header($question_element['#title']) . ': ' . $value;
499 $output = implode("\n", $items);
506 * Implements _webform_analysis_component().
508 function _webform_analysis_grid($component, $sids = array(), $single = FALSE, $join = NULL) {
509 // Generate the list of options and questions.
510 $node = node_load($component['nid']);
511 $questions = _webform_select_options_from_text($component['extra']['questions'], TRUE);
512 $questions = _webform_select_replace_tokens($questions, $node);
513 $options = _webform_select_options_from_text($component['extra']['options'], TRUE);
514 $options = _webform_select_replace_tokens($options, $node);
516 // Generate a lookup table of results.
517 $query = db_select('webform_submitted_data', 'wsd')
518 ->fields('wsd', array('no', 'data'))
519 ->condition('wsd.nid', $component['nid'])
520 ->condition('wsd.cid', $component['cid'])
521 ->condition('wsd.data', '', '<>')
523 ->groupBy('wsd.data');
524 $query->addExpression('COUNT(wsd.sid)', 'datacount');
527 $query->condition('wsd.sid', $sids, 'IN');
531 $query->innerJoin($join, 'ws2_', 'wsd.sid = ws2_.sid');
534 $result = $query->execute();
536 foreach ($result as $data) {
537 $counts[$data->no][$data->data] = $data->datacount;
540 // Create an entire table to be put into the returned row.
544 // Add options as a header row.
545 foreach ($options as $option) {
546 $header[] = webform_filter_xss($option);
549 // Add questions as each row.
550 foreach ($questions as $qkey => $question) {
551 $row = array(webform_filter_xss($question));
552 foreach ($options as $okey => $option) {
553 $row[] = !empty($counts[$qkey][$okey]) ? $counts[$qkey][$okey] : 0;
558 // Return return the table unless there are no internal questions in the grid.
561 'table_header' => $header,
562 'table_rows' => $rows,
568 * Implements _webform_table_component().
570 function _webform_table_grid($component, $value) {
571 $node = node_load($component['nid']);
572 $questions = _webform_select_options_from_text($component['extra']['questions'], TRUE);
573 $questions = _webform_select_replace_tokens($questions, $node);
574 $options = _webform_select_options_from_text($component['extra']['options'], TRUE);
575 $options = _webform_select_replace_tokens($options, $node);
578 // Set the value as a single string.
579 foreach ($questions as $key => $label) {
580 if (isset($value[$key]) && isset($options[$value[$key]])) {
581 $output .= webform_filter_xss(_webform_grid_question_header($label)) . ': ' . webform_filter_xss($options[$value[$key]]) . '<br />';
585 // Return output if the grid contains internal questions.
586 if (count($questions)) {
592 * Implements _webform_csv_headers_component().
594 function _webform_csv_headers_grid($component, $export_options) {
595 $node = node_load($component['nid']);
596 $items = _webform_select_options_from_text($component['extra']['questions'], TRUE);
597 $items = _webform_select_replace_tokens($items, $node);
600 $header[0] = array('');
601 $header[1] = array($export_options['header_keys'] ? $component['form_key'] : $component['name']);
603 foreach ($items as $key => $item) {
604 // Empty column per sub-field in main header.
609 // The value for this option.
610 $header[2][] = $export_options['header_keys'] ? $key : _webform_grid_question_header($item);
618 * Implements _webform_csv_data_component().
620 function _webform_csv_data_grid($component, $export_options, $value) {
621 $node = node_load($component['nid']);
622 $questions = _webform_select_options_from_text($component['extra']['questions'], TRUE);
623 $questions = _webform_select_replace_tokens($questions, $node);
624 $options = _webform_select_options_from_text($component['extra']['options'], TRUE);
625 $options = _webform_select_replace_tokens($options, $node);
628 foreach ($questions as $key => $question) {
629 if (isset($value[$key]) && isset($options[$value[$key]])) {
630 $return[] = $export_options['select_keys'] ? $value[$key] : $options[$value[$key]];
640 * A Form API element validate function to check that all choices are unique.
642 function _webform_edit_grid_unique_validate($element) {
643 // Grids may contain nested multiple value select components.
644 // Create a flat array of values.
646 array_walk_recursive($element['#value'], function($a) use (&$values) { $values[] = $a; });
648 $nr_unique = count(array_unique($values));
649 $nr_values = count($values);
650 $nr_possible = count($element['#grid_options']);
651 if (strlen($element['#grid_default']) && isset($element['#grid_options'][$element['#grid_default']])) {
652 // A default is defined and is one of the options. Don't count default values
653 // toward uniqueness.
654 $nr_defaults = count(array_keys($element['#value'], $element['#grid_default']));
656 $nr_values -= $nr_defaults;
660 if ($nr_unique < $nr_values && $nr_unique < $nr_possible) {
661 // Fewer unique values than values means that at least one value is duplicated.
662 // Fewer unique values than possible values means that there is a possible choice
664 form_error($element, t('!title is not allowed to have the same answer for more than one question.', array('!title' => $element['#title'])));
668 function theme_webform_grid($variables) {
669 $element = $variables['element'];
670 $right_titles = _webform_grid_right_titles($element);
674 // Set the header for the table.
675 $header = _webform_grid_header($element, $right_titles);
677 foreach (element_children($element) as $key) {
678 $question_element = $element[$key];
679 $title_element =& $question_element;
680 if ($question_element['#type'] == 'select_or_other') {
681 $title_element =& $question_element['select'];
683 $question_titles = explode('|', $title_element['#title'], 2);
685 // Create a row with the question title.
686 $required = !empty($question_element['#required']) ? theme('form_required_marker', array('element' => $question_element)) : '';
687 $row = array(array('data' => t('!title !required', array('!title' => webform_filter_xss($question_titles[0]), '!required' => $required)), 'class' => array('webform-grid-question')));
689 // Render each radio button in the row.
690 if ($question_element['#type'] == 'radios' || $question_element['#type'] == 'checkboxes') {
691 $radios = form_process_radios($question_element);
692 foreach (element_children($radios) as $key) {
693 $radio_title = $radios[$key]['#title'];
694 if (!strlen($radio_title)) {
698 $radios[$key]['#title'] = $question_element['#title'] . ' - ' . $radio_title;
699 $radios[$key]['#title_display'] = 'invisible';
700 $row[] = array('data' => drupal_render($radios[$key]), 'class' => array('checkbox', 'webform-grid-option'), 'data-label' => array($radio_title));
705 $title_element['#title_display'] = 'none';
707 'data' => drupal_render($question_element),
708 'colspan' => count($element['#grid_options']),
712 $row[] = array('data' => isset($question_titles[1]) ? webform_filter_xss($question_titles[1]) : '', 'class' => array('webform-grid-question'));
715 // Convert the parents array into a string, excluding the "submitted" wrapper.
716 $nested_level = $question_element['#parents'][0] == 'submitted' ? 1 : 0;
717 $parents = str_replace('_', '-', implode('--', array_slice($question_element['#parents'], $nested_level)));
721 'class' => empty($question_element['#grid_question'])
722 ? array('webform-component', 'webform-component-' . str_replace('_', '-', $question_element['#type']), 'webform-component--' . $parents)
727 $option_count = count($header) - 1;
728 return theme('table', array('header' => $header, 'rows' => $rows, 'sticky' => $element['#sticky'], 'attributes' => array('class' => array('webform-grid', 'webform-grid-' . $option_count))));
732 * Generate a table header suitable for form or html display.
734 function _webform_grid_header($element, $right_titles) {
735 $titles = explode('|', $element['#title'], 2);
736 $header = array(array('data' => _webform_grid_header_title($element, $titles[0]), 'class' => array('webform-grid-question')));
737 foreach ($element['#grid_options'] as $option) {
738 $header[] = array('data' => webform_filter_xss($option), 'class' => array('checkbox', 'webform-grid-option'));
741 $header[] = array('data' => _webform_grid_header_title($element, isset($titles[1]) ? $titles[1] : ''), 'class' => array('webform-grid-question'));
747 * Create internal component title for table header, if any.
749 function _webform_grid_header_title($element, $title) {
751 if ($element['#title_display'] == 'internal') {
752 $variables = array('element' => $element);
753 $variables['element']['#title_display'] = 'before';
754 $variables['element']['#title'] = $title;
755 $header_title = theme('form_element_label', $variables);
757 return $header_title;
761 * Determine if a right-side title column has been specified.
763 function _webform_grid_right_titles($element) {
764 if ($element['#title_display'] == 'internal' && substr_count($element['#title'], '|')) {
767 foreach ($element['#grid_questions'] as $question_key => $question) {
768 if (substr_count($question, '|')) {
776 * Create a question header for left, right or left/right question headers.
778 function _webform_grid_question_header($text) {
779 return implode('/', array_filter(explode('|', $text)));