danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  * Webform module multiple select component.
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements _webform_defaults_component().
danielebarchiesi@0:  */
danielebarchiesi@0: function _webform_defaults_select() {
danielebarchiesi@0:   return array(
danielebarchiesi@0:     'name' => '',
danielebarchiesi@0:     'form_key' => NULL,
danielebarchiesi@0:     'mandatory' => 0,
danielebarchiesi@0:     'pid' => 0,
danielebarchiesi@0:     'weight' => 0,
danielebarchiesi@0:     'value' => '',
danielebarchiesi@0:     'extra' => array(
danielebarchiesi@0:       'items' => '',
danielebarchiesi@0:       'multiple' => NULL,
danielebarchiesi@0:       'aslist' => NULL,
danielebarchiesi@0:       'optrand' => 0,
danielebarchiesi@0:       'other_option' => NULL,
danielebarchiesi@0:       'other_text' => t('Other...'),
danielebarchiesi@0:       'title_display' => 0,
danielebarchiesi@0:       'description' => '',
danielebarchiesi@0:       'custom_keys' => FALSE,
danielebarchiesi@0:       'options_source' => '',
danielebarchiesi@0:       'private' => FALSE,
danielebarchiesi@0:     ),
danielebarchiesi@0:   );
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements _webform_theme_component().
danielebarchiesi@0:  */
danielebarchiesi@0: function _webform_theme_select() {
danielebarchiesi@0:   return array(
danielebarchiesi@0:     'webform_display_select' => array(
danielebarchiesi@0:       'render element' => 'element',
danielebarchiesi@0:       'file' => 'components/select.inc',
danielebarchiesi@0:     ),
danielebarchiesi@0:   );
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements _webform_edit_component().
danielebarchiesi@0:  */
danielebarchiesi@0: function _webform_edit_select($component) {
danielebarchiesi@0:   $form = array(
danielebarchiesi@0:     '#attached' => array(
danielebarchiesi@0:       'js' => array(
danielebarchiesi@0:         drupal_get_path('module', 'webform') . '/js/select-admin.js' => array('preprocess' => FALSE),
danielebarchiesi@0:         array('data' => array('webform' => array('selectOptionsUrl' => url('webform/ajax/options/' . $component['nid']))), 'type' => 'setting'),
danielebarchiesi@0:       ),
danielebarchiesi@0:     ),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $other = array();
danielebarchiesi@0:   if ($info = _webform_select_options_info()) {
danielebarchiesi@0:     $options = array('' => t('None'));
danielebarchiesi@0:     foreach ($info as $name => $source) {
danielebarchiesi@0:       $options[$name] = $source['title'];
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $other['options_source'] = array(
danielebarchiesi@0:       '#title' => t('Load a pre-built option list'),
danielebarchiesi@0:       '#type' => 'select',
danielebarchiesi@0:       '#options' => $options,
danielebarchiesi@0:       '#default_value' => $component['extra']['options_source'],
danielebarchiesi@0:       '#weight' => 1,
danielebarchiesi@0:       '#description' => t('Use a pre-built list of options rather than entering options manually. Options will not be editable if using pre-built list.'),
danielebarchiesi@0:       '#parents' => array('extra', 'options_source'),
danielebarchiesi@0:       '#weight' => 5,
danielebarchiesi@0:     );
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (module_exists('select_or_other')) {
danielebarchiesi@0:     $other['other_option'] = array(
danielebarchiesi@0:       '#type' => 'checkbox',
danielebarchiesi@0:       '#title' => t('Allow "Other..." option'),
danielebarchiesi@0:       '#default_value' => $component['extra']['other_option'],
danielebarchiesi@0:       '#description' => t('Check this option if you want to allow users to enter an option not on the list.'),
danielebarchiesi@0:       '#parents' => array('extra', 'other_option'),
danielebarchiesi@0:       '#weight' => 2,
danielebarchiesi@0:     );
danielebarchiesi@0:     $other['other_text'] = array(
danielebarchiesi@0:       '#type' => 'textfield',
danielebarchiesi@0:       '#title' => t('Text for "Other..." option'),
danielebarchiesi@0:       '#default_value' => $component['extra']['other_text'],
danielebarchiesi@0:       '#description' => t('If allowing other options, enter text to be used for other-enabling option.'),
danielebarchiesi@0:       '#parents' => array('extra', 'other_text'),
danielebarchiesi@0:       '#weight' => 3,
danielebarchiesi@0:     );
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (module_exists('options_element')) {
danielebarchiesi@0:     $options = _webform_select_options($component, FALSE, FALSE);
danielebarchiesi@0: 
danielebarchiesi@0:     $form['items'] = array(
danielebarchiesi@0:       '#type' => 'fieldset',
danielebarchiesi@0:       '#title' => t('Options'),
danielebarchiesi@0:       '#collapsible' => TRUE,
danielebarchiesi@0:       '#attributes' => array('class' => array('webform-options-element')),
danielebarchiesi@0:       '#element_validate' => array('_webform_edit_validate_options'),
danielebarchiesi@0:       '#weight' => 2,
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     $form['items']['options'] = array(
danielebarchiesi@0:       '#type' => 'options',
danielebarchiesi@0:       '#limit' => 500,
danielebarchiesi@0:       '#optgroups' => $component['extra']['aslist'],
danielebarchiesi@0:       '#multiple' => $component['extra']['multiple'],
danielebarchiesi@0:       '#multiple_toggle' => t('Multiple'),
danielebarchiesi@0:       '#default_value' => $component['value'],
danielebarchiesi@0:       '#options' => $options,
danielebarchiesi@0:       '#options_readonly' => !empty($component['extra']['options_source']),
danielebarchiesi@0:       '#key_type' => 'mixed',
danielebarchiesi@0:       '#key_type_toggle' => t('Customize keys (Advanced)'),
danielebarchiesi@0:       '#key_type_toggled' => $component['extra']['custom_keys'],
danielebarchiesi@0:       '#default_value_pattern' => '^%.+\[.+\]$',
danielebarchiesi@0:       '#weight' => 1,
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     $form['items']['options']['option_settings'] = $other;
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     $form['extra']['items'] = array(
danielebarchiesi@0:       '#type' => 'textarea',
danielebarchiesi@0:       '#title' => t('Options'),
danielebarchiesi@0:       '#default_value' => $component['extra']['items'],
danielebarchiesi@0:       '#description' => t('<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. One option per line. Option groups may be specified with &lt;Group Name&gt;. &lt;&gt; can be used to insert items at the root of the menu after specifying a group.') . theme('webform_token_help'),
danielebarchiesi@0:       '#cols' => 60,
danielebarchiesi@0:       '#rows' => 5,
danielebarchiesi@0:       '#weight' => 0,
danielebarchiesi@0:       '#required' => TRUE,
danielebarchiesi@0:       '#wysiwyg' => FALSE,
danielebarchiesi@0:       '#element_validate' => array('_webform_edit_validate_select'),
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     if (!empty($component['extra']['options_source'])) {
danielebarchiesi@0:       $form['extra']['items']['#attributes'] = array('readonly' => 'readonly');
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $form['extra'] = array_merge($form['extra'], $other);
danielebarchiesi@0:     $form['value'] = array(
danielebarchiesi@0:       '#type' => 'textfield',
danielebarchiesi@0:       '#title' => t('Default value'),
danielebarchiesi@0:       '#default_value' => $component['value'],
danielebarchiesi@0:       '#description' => t('The default value of the field identified by its key. For multiple selects use commas to separate multiple defaults.') . theme('webform_token_help'),
danielebarchiesi@0:       '#size' => 60,
danielebarchiesi@0:       '#maxlength' => 1024,
danielebarchiesi@0:       '#weight' => 0,
danielebarchiesi@0:     );
danielebarchiesi@0:     $form['extra']['multiple'] = array(
danielebarchiesi@0:       '#type' => 'checkbox',
danielebarchiesi@0:       '#title' => t('Multiple'),
danielebarchiesi@0:       '#default_value' => $component['extra']['multiple'],
danielebarchiesi@0:       '#description' => t('Check this option if the user should be allowed to choose multiple values.'),
danielebarchiesi@0:       '#weight' => 0,
danielebarchiesi@0:     );
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $form['display']['aslist'] = array(
danielebarchiesi@0:     '#type' => 'checkbox',
danielebarchiesi@0:     '#title' => t('Listbox'),
danielebarchiesi@0:     '#default_value' => $component['extra']['aslist'],
danielebarchiesi@0:     '#description' => t('Check this option if you want the select component to be displayed as a select list box instead of radio buttons or checkboxes. Option groups (nested options) are only supported with listbox components.'),
danielebarchiesi@0:     '#parents' => array('extra', 'aslist'),
danielebarchiesi@0:   );
danielebarchiesi@0:   $form['display']['optrand'] = array(
danielebarchiesi@0:     '#type' => 'checkbox',
danielebarchiesi@0:     '#title' => t('Randomize options'),
danielebarchiesi@0:     '#default_value' => $component['extra']['optrand'],
danielebarchiesi@0:     '#description' => t('Randomizes the order of the options when they are displayed in the form.'),
danielebarchiesi@0:     '#parents' => array('extra', 'optrand'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   return $form;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Element validation callback. Ensure keys are not duplicated.
danielebarchiesi@0:  */
danielebarchiesi@0: function _webform_edit_validate_select($element, &$form_state) {
danielebarchiesi@0:   // Check for duplicate key values to prevent unexpected data loss. Require
danielebarchiesi@0:   // all options to include a safe_key.
danielebarchiesi@0:   if (!empty($element['#value'])) {
danielebarchiesi@0:     $lines = explode("\n", trim($element['#value']));
danielebarchiesi@0:     $existing_keys = array();
danielebarchiesi@0:     $duplicate_keys = array();
danielebarchiesi@0:     $missing_keys = array();
danielebarchiesi@0:     $long_keys = array();
danielebarchiesi@0:     $group = '';
danielebarchiesi@0:     foreach ($lines as $line) {
danielebarchiesi@0:       $matches = array();
danielebarchiesi@0:       $line = trim($line);
danielebarchiesi@0:       if (preg_match('/^\<([^>]*)\>$/', $line, $matches)) {
danielebarchiesi@0:         $group = $matches[1];
danielebarchiesi@0:         $key = NULL; // No need to store group names.
danielebarchiesi@0:       }
danielebarchiesi@0:       elseif (preg_match('/^([^|]*)\|(.*)$/', $line, $matches)) {
danielebarchiesi@0:         $key = $matches[1];
danielebarchiesi@0:         if (strlen($key) > 128) {
danielebarchiesi@0:           $long_keys[] = $key;
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0:       else {
danielebarchiesi@0:         $missing_keys[] = $line;
danielebarchiesi@0:       }
danielebarchiesi@0: 
danielebarchiesi@0:       if (isset($key)) {
danielebarchiesi@0:         if (isset($existing_keys[$group][$key])) {
danielebarchiesi@0:           $duplicate_keys[$key] = $key;
danielebarchiesi@0:         }
danielebarchiesi@0:         else {
danielebarchiesi@0:           $existing_keys[$group][$key] = $key;
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (!empty($missing_keys)) {
danielebarchiesi@0:       form_error($element, t('Every option must have a key specified. Specify each option as "safe_key|Some readable option".'));
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (!empty($long_keys)) {
danielebarchiesi@0:       form_error($element, t('Option keys must be less than 128 characters. The following keys exceed this limit:') . theme('item_list', $long_keys));
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (!empty($duplicate_keys)) {
danielebarchiesi@0:       form_error($element, t('Options within the select list must be unique. The following keys have been used multiple times:') . theme('item_list', array('items' => $duplicate_keys)));
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Set the listbox option if needed.
danielebarchiesi@0:     if (empty($missing_keys) && empty($long_keys) && empty($duplicate_keys)) {
danielebarchiesi@0:       $options = _webform_select_options_from_text($element['#value']);
danielebarchiesi@0:       _webform_edit_validate_set_aslist($options, $form_state);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return TRUE;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Set the appropriate webform values when using the options element module.
danielebarchiesi@0:  */
danielebarchiesi@0: function _webform_edit_validate_options($element, &$form_state) {
danielebarchiesi@0:   $key = end($element['#parents']);
danielebarchiesi@0:   $element_options = $form_state['values'][$key]['options'];
danielebarchiesi@0:   unset($form_state['values'][$key]);
danielebarchiesi@0: 
danielebarchiesi@0:   $form_state['values']['extra'][$key] = form_options_to_text($element_options['options'], 'custom');
danielebarchiesi@0: 
danielebarchiesi@0:   // Options saved for select components.
danielebarchiesi@0:   if ($key == 'items') {
danielebarchiesi@0:     $form_state['values']['extra']['multiple'] = $element_options['multiple'];
danielebarchiesi@0:     $form_state['values']['extra']['custom_keys'] = $element_options['custom_keys'];
danielebarchiesi@0:     $form_state['values']['value'] = is_array($element_options['default_value']) ? implode(', ', $element_options['default_value']) : $element_options['default_value'];
danielebarchiesi@0: 
danielebarchiesi@0:     // Set the listbox option if needed.
danielebarchiesi@0:     _webform_edit_validate_set_aslist($element_options['options'], $form_state);
danielebarchiesi@0:   }
danielebarchiesi@0:   // Options saved for grid components.
danielebarchiesi@0:   else {
danielebarchiesi@0:     $form_state['values']['extra']['custom_' . rtrim($key, 's') . '_keys'] = $element_options['custom_keys'];
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Ensure "aslist" is used for option groups. Called from options validations.
danielebarchiesi@0:  */
danielebarchiesi@0: function _webform_edit_validate_set_aslist($options, &$form_state) {
danielebarchiesi@0:   if (empty($form_state['values']['extra']['aslist']) && !empty($options)) {
danielebarchiesi@0:     foreach ($options as $option) {
danielebarchiesi@0:       if (is_array($option)) {
danielebarchiesi@0:         $form_state['values']['extra']['aslist'] = 1;
danielebarchiesi@0:         drupal_set_message(t('The component %name has automatically been set to display as a listbox in order to support option groups.', array('%name' => $form_state['values']['name'])), 'warning');
danielebarchiesi@0:         break;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements _webform_render_component().
danielebarchiesi@0:  */
danielebarchiesi@0: function _webform_render_select($component, $value = NULL, $filter = TRUE) {
danielebarchiesi@0:   $node = isset($component['nid']) ? node_load($component['nid']) : NULL;
danielebarchiesi@0: 
danielebarchiesi@0:   $element = array(
danielebarchiesi@0:     '#title' => $filter ? _webform_filter_xss($component['name']) : $component['name'],
danielebarchiesi@0:     '#title_display' => $component['extra']['title_display'] ? $component['extra']['title_display'] : 'before',
danielebarchiesi@0:     '#required' => $component['mandatory'],
danielebarchiesi@0:     '#weight' => $component['weight'],
danielebarchiesi@0:     '#description' => $filter ? _webform_filter_descriptions($component['extra']['description'], $node) : $component['extra']['description'],
danielebarchiesi@0:     '#theme_wrappers' => array('webform_element'),
danielebarchiesi@0:     '#pre_render' => array(), // Needed to disable double-wrapping of radios and checkboxes.
danielebarchiesi@0:     '#translatable' => array('title', 'description', 'options'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // Convert the user-entered options list into an array.
danielebarchiesi@0:   $default_value = $filter ? _webform_filter_values($component['value'], $node, NULL, NULL, FALSE) : $component['value'];
danielebarchiesi@0:   $options = _webform_select_options($component, !$component['extra']['aslist'], $filter);
danielebarchiesi@0: 
danielebarchiesi@0:   if ($component['extra']['optrand']) {
danielebarchiesi@0:     _webform_shuffle_options($options);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Add default options if using a select list with no default. This trigger's
danielebarchiesi@0:   // Drupal 7's adding of the option for us. See @form_process_select().
danielebarchiesi@0:   if ($component['extra']['aslist'] && !$component['extra']['multiple'] && $default_value === '') {
danielebarchiesi@0:     $element['#empty_value'] = '';
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Set the component options.
danielebarchiesi@0:   $element['#options'] = $options;
danielebarchiesi@0: 
danielebarchiesi@0:   // Set the default value.
danielebarchiesi@0:   if (isset($value)) {
danielebarchiesi@0:     if ($component['extra']['multiple']) {
danielebarchiesi@0:       // Set the value as an array.
danielebarchiesi@0:       $element['#default_value'] = array();
danielebarchiesi@0:       foreach ((array) $value as $key => $option_value) {
danielebarchiesi@0:         $element['#default_value'][] = $option_value;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       // Set the value as a single string.
danielebarchiesi@0:       $element['#default_value'] = '';
danielebarchiesi@0:       foreach ((array) $value as $option_value) {
danielebarchiesi@0:         $element['#default_value'] = $option_value;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   elseif ($default_value !== '') {
danielebarchiesi@0:     // Convert default value to a list if necessary.
danielebarchiesi@0:     if ($component['extra']['multiple']) {
danielebarchiesi@0:       $varray = explode(',', $default_value);
danielebarchiesi@0:       foreach ($varray as $key => $v) {
danielebarchiesi@0:         $v = trim($v);
danielebarchiesi@0:         if ($v !== '') {
danielebarchiesi@0:           $element['#default_value'][] = $v;
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $element['#default_value'] = $default_value;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   elseif ($component['extra']['multiple']) {
danielebarchiesi@0:     $element['#default_value'] = array();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if ($component['extra']['other_option'] && module_exists('select_or_other')) {
danielebarchiesi@0:     // Set display as a select_or_other element:
danielebarchiesi@0:     $element['#type'] = 'select_or_other';
danielebarchiesi@0:     $element['#other'] = !empty($component['extra']['other_text']) ? check_plain($component['extra']['other_text']) : t('Other...');
danielebarchiesi@0:     $element['#other_title'] = $element['#title'] . ' ' . $element['#other'];
danielebarchiesi@0:     $element['#other_title_display'] = 'invisible';
danielebarchiesi@0:     $element['#other_unknown_defaults'] = 'other';
danielebarchiesi@0:     $element['#other_delimiter'] = ', ';
danielebarchiesi@0:     // Merge in Webform's #process function for Select or other.
danielebarchiesi@0:     $element['#process'] = array_merge(element_info_property('select_or_other', '#process'), array('webform_expand_select_or_other'));
danielebarchiesi@0: 
danielebarchiesi@0:     if ($component['extra']['multiple']) {
danielebarchiesi@0:       $element['#multiple'] = TRUE;
danielebarchiesi@0:       $element['#select_type'] = 'checkboxes';
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $element['#multiple'] = FALSE;
danielebarchiesi@0:       $element['#select_type'] = 'radios';
danielebarchiesi@0:     }
danielebarchiesi@0:     if ($component['extra']['aslist']) {
danielebarchiesi@0:       $element['#select_type'] = 'select';
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   elseif ($component['extra']['aslist']) {
danielebarchiesi@0:     // Set display as a select list:
danielebarchiesi@0:     $element['#type'] = 'select';
danielebarchiesi@0:     if ($component['extra']['multiple']) {
danielebarchiesi@0:       $element['#size'] = 4;
danielebarchiesi@0:       $element['#multiple'] = TRUE;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     if ($component['extra']['multiple']) {
danielebarchiesi@0:       // Set display as a checkbox set.
danielebarchiesi@0:       $element['#type'] = 'checkboxes';
danielebarchiesi@0:       $element['#theme_wrappers'] = array_merge(array('checkboxes'), $element['#theme_wrappers']);
danielebarchiesi@0:       $element['#process'] = array_merge(element_info_property('checkboxes', '#process'), array('webform_expand_select_ids'));
danielebarchiesi@0: 
danielebarchiesi@0:       // Entirely replace the normal expand checkboxes with our custom version.
danielebarchiesi@0:       // This helps render checkboxes in multipage forms.
danielebarchiesi@0:       $process_key = array_search('form_process_checkboxes', $element['#process']);
danielebarchiesi@0:       $element['#process'][$process_key] = 'webform_expand_checkboxes';
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       // Set display as a radio set.
danielebarchiesi@0:       $element['#type'] = 'radios';
danielebarchiesi@0:       $element['#theme_wrappers'] = array_merge(array('radios'), $element['#theme_wrappers']);
danielebarchiesi@0:       $element['#process'] = array_merge(element_info_property('radios', '#process'), array('webform_expand_select_ids'));
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $element;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Process function to ensure select_or_other elements validate properly.
danielebarchiesi@0:  */
danielebarchiesi@0: function webform_expand_select_or_other($element) {
danielebarchiesi@0:   // Disable validation for back-button and save draft.
danielebarchiesi@0:   $element['select']['#validated'] = TRUE;
danielebarchiesi@0:   $element['select']['#webform_validated'] = FALSE;
danielebarchiesi@0: 
danielebarchiesi@0:   $element['other']['#validated'] = TRUE;
danielebarchiesi@0:   $element['other']['#webform_validated'] = FALSE;
danielebarchiesi@0: 
danielebarchiesi@0:   // The Drupal FAPI does not support #title_display inline so we need to move
danielebarchiesi@0:   // to a supported value here to be compatible with select_or_other.
danielebarchiesi@0:   $element['select']['#title_display'] = $element['#title_display'] === 'inline' ? 'before' : $element['#title_display'];
danielebarchiesi@0: 
danielebarchiesi@0:   // If the default value contains "select_or_other" (the key of the select
danielebarchiesi@0:   // element for the "other..." choice), discard it and set the "other" value.
danielebarchiesi@0:   if (is_array($element['#default_value']) && in_array('select_or_other', $element['#default_value'])) {
danielebarchiesi@0:     $key = array_search('select_or_other', $element['#default_value']);
danielebarchiesi@0:     unset($element['#default_value'][$key]);
danielebarchiesi@0:     $element['#default_value'] = array_values($element['#default_value']);
danielebarchiesi@0:     $element['other']['#default_value'] = implode(', ', $element['#default_value']);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Sanitize the options in Select or other check boxes and radio buttons.
danielebarchiesi@0:   if ($element['#select_type'] == 'checkboxes' || $element['#select_type'] == 'radios') {
danielebarchiesi@0:     $element['select']['#process'] = array_merge(element_info_property($element['#select_type'], '#process'), array('webform_expand_select_ids'));
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $element;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Drupal 6 hack that properly *renders* checkboxes in multistep forms. This is
danielebarchiesi@0:  * different than the value hack needed in Drupal 5, which is no longer needed.
danielebarchiesi@0:  */
danielebarchiesi@0: function webform_expand_checkboxes($element) {
danielebarchiesi@0:   // Elements that have a value set are already in the form structure cause
danielebarchiesi@0:   // them not to be written when the expand_checkboxes function is called.
danielebarchiesi@0:   $default_value = array();
danielebarchiesi@0:   foreach (element_children($element) as $key) {
danielebarchiesi@0:     if (isset($element[$key]['#default_value'])) {
danielebarchiesi@0:       $default_value[$key] = $element[$key]['#default_value'];
danielebarchiesi@0:       unset($element[$key]);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $element = form_process_checkboxes($element);
danielebarchiesi@0: 
danielebarchiesi@0:   // Escape the values of checkboxes.
danielebarchiesi@0:   foreach (element_children($element) as $key) {
danielebarchiesi@0:     $element[$key]['#return_value'] = check_plain($element[$key]['#return_value']);
danielebarchiesi@0:     $element[$key]['#name'] = $element['#name'] . '[' . $element[$key]['#return_value'] . ']';
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   foreach ($default_value as $key => $val) {
danielebarchiesi@0:     $element[$key]['#default_value'] = $val;
danielebarchiesi@0:   }
danielebarchiesi@0:   return $element;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * FAPI process function to rename IDs attached to checkboxes and radios.
danielebarchiesi@0:  */
danielebarchiesi@0: function webform_expand_select_ids($element) {
danielebarchiesi@0:   $id = $element['#id'] = str_replace('_', '-', _webform_safe_name(strip_tags($element['#id'])));
danielebarchiesi@0:   $delta = 0;
danielebarchiesi@0:   foreach (element_children($element) as $key) {
danielebarchiesi@0:     $delta++;
danielebarchiesi@0:     // Convert the #id for each child to a safe name, regardless of key.
danielebarchiesi@0:     $element[$key]['#id'] = $id . '-' . $delta;
danielebarchiesi@0: 
danielebarchiesi@0:     // Prevent scripts or CSS in the labels for each checkbox or radio.
danielebarchiesi@0:     $element[$key]['#title'] = _webform_filter_xss($element[$key]['#title']);
danielebarchiesi@0:   }
danielebarchiesi@0:   return $element;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements _webform_display_component().
danielebarchiesi@0:  */
danielebarchiesi@0: function _webform_display_select($component, $value, $format = 'html') {
danielebarchiesi@0:   return array(
danielebarchiesi@0:     '#title' => $component['name'],
danielebarchiesi@0:     '#weight' => $component['weight'],
danielebarchiesi@0:     '#multiple' => $component['extra']['multiple'],
danielebarchiesi@0:     '#theme' => 'webform_display_select',
danielebarchiesi@0:     '#theme_wrappers' => $format == 'html' ? array('webform_element') : array('webform_element_text'),
danielebarchiesi@0:     '#format' => $format,
danielebarchiesi@0:     '#options' => _webform_select_options($component, !$component['extra']['aslist']),
danielebarchiesi@0:     '#value' => (array) $value,
danielebarchiesi@0:     '#translatable' => array('title', 'options'),
danielebarchiesi@0:   );
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements _webform_submit_component().
danielebarchiesi@0:  *
danielebarchiesi@0:  * Convert FAPI 0/1 values into something saveable.
danielebarchiesi@0:  */
danielebarchiesi@0: function _webform_submit_select($component, $value) {
danielebarchiesi@0:   // Build a list of all valid keys expected to be submitted.
danielebarchiesi@0:   $options = _webform_select_options($component, TRUE);
danielebarchiesi@0: 
danielebarchiesi@0:   $return = NULL;
danielebarchiesi@0:   if (is_array($value)) {
danielebarchiesi@0:     $return = array();
danielebarchiesi@0:     foreach ($value as $key => $option_value) {
danielebarchiesi@0:       // Handle options that are specified options.
danielebarchiesi@0:       if ($option_value !== '' && isset($options[$option_value])) {
danielebarchiesi@0:         // Checkboxes submit an integer value of 0 when unchecked. A checkbox
danielebarchiesi@0:         // with a value of '0' is valid, so we can't use empty() here.
danielebarchiesi@0:         if ($option_value === 0 && !$component['extra']['aslist'] && $component['extra']['multiple']) {
danielebarchiesi@0:           unset($value[$option_value]);
danielebarchiesi@0:         }
danielebarchiesi@0:         else {
danielebarchiesi@0:           $return[] = $option_value;
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0:       // Handle options that are added through the "other" field. Specifically
danielebarchiesi@0:       // exclude the "select_or_other" value, which is added by the select list.
danielebarchiesi@0:       elseif ($component['extra']['other_option'] && module_exists('select_or_other') && $option_value != 'select_or_other') {
danielebarchiesi@0:         $return[] = $option_value;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   elseif (is_string($value)) {
danielebarchiesi@0:     $return = $value;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $return;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Format the text output for this component.
danielebarchiesi@0:  */
danielebarchiesi@0: function theme_webform_display_select($variables) {
danielebarchiesi@0:   $element = $variables['element'];
danielebarchiesi@0: 
danielebarchiesi@0:   // Flatten the list of options so we can get values easily. These options
danielebarchiesi@0:   // may be translated by hook_webform_display_component_alter().
danielebarchiesi@0:   $options = array();
danielebarchiesi@0:   foreach ($element['#options'] as $key => $value) {
danielebarchiesi@0:     if (is_array($value)) {
danielebarchiesi@0:       foreach ($value as $subkey => $subvalue) {
danielebarchiesi@0:         $options[$subkey] = $subvalue;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $options[$key] = $value;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $items = array();
danielebarchiesi@0:   if ($element['#multiple']) {
danielebarchiesi@0:     foreach ((array) $element['#value'] as $option_value) {
danielebarchiesi@0:       if ($option_value !== '') {
danielebarchiesi@0:         // Administer provided values.
danielebarchiesi@0:         if (isset($options[$option_value])) {
danielebarchiesi@0:           $items[] = $element['#format'] == 'html' ? _webform_filter_xss($options[$option_value]) : $options[$option_value];
danielebarchiesi@0:         }
danielebarchiesi@0:         // User-specified in the "other" field.
danielebarchiesi@0:         else {
danielebarchiesi@0:           $items[] = $element['#format'] == 'html' ? check_plain($option_value) : $option_value;
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     if (isset($element['#value'][0]) && $element['#value'][0] !== '') {
danielebarchiesi@0:       // Administer provided values.
danielebarchiesi@0:       if (isset($options[$element['#value'][0]])) {
danielebarchiesi@0:         $items[] = $element['#format'] == 'html' ? _webform_filter_xss($options[$element['#value'][0]]) : $options[$element['#value'][0]];
danielebarchiesi@0:       }
danielebarchiesi@0:       // User-specified in the "other" field.
danielebarchiesi@0:       else {
danielebarchiesi@0:         $items[] = $element['#format'] == 'html' ? check_plain($element['#value'][0]) : $element['#value'][0];
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if ($element['#format'] == 'html') {
danielebarchiesi@0:     $output = count($items) > 1 ? theme('item_list', array('items' => $items)) : (isset($items[0]) ? $items[0] : ' ');
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     if (count($items) > 1) {
danielebarchiesi@0:       foreach ($items as $key => $item) {
danielebarchiesi@0:         $items[$key] = ' - ' . $item;
danielebarchiesi@0:       }
danielebarchiesi@0:       $output = implode("\n", $items);
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $output = isset($items[0]) ? $items[0] : ' ';
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $output;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements _webform_analysis_component().
danielebarchiesi@0:  */
danielebarchiesi@0: function _webform_analysis_select($component, $sids = array(), $single = FALSE) {
danielebarchiesi@0:   $options = _webform_select_options($component, TRUE);
danielebarchiesi@0:   $show_other_results = $single;
danielebarchiesi@0: 
danielebarchiesi@0:   $sid_placeholders = count($sids) ? array_fill(0, count($sids), "'%s'") : array();
danielebarchiesi@0:   $sid_filter = count($sids) ? " AND sid IN (" . implode(",", $sid_placeholders) . ")" : "";
danielebarchiesi@0: 
danielebarchiesi@0:   $option_operator = $show_other_results ? 'NOT IN' : 'IN';
danielebarchiesi@0:   $query = db_select('webform_submitted_data', 'wsd', array('fetch' => PDO::FETCH_ASSOC))
danielebarchiesi@0:     ->fields('wsd', array('data'))
danielebarchiesi@0:     ->condition('nid', $component['nid'])
danielebarchiesi@0:     ->condition('cid', $component['cid'])
danielebarchiesi@0:     ->condition('data', '', '<>')
danielebarchiesi@0:     ->condition('data', array_keys($options), $option_operator)
danielebarchiesi@0:     ->groupBy('data');
danielebarchiesi@0:   $query->addExpression('COUNT(data)', 'datacount');
danielebarchiesi@0: 
danielebarchiesi@0:   if (count($sids)) {
danielebarchiesi@0:     $query->condition('sid', $sids, 'IN');
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $count_query = db_select('webform_submitted_data', 'wsd', array('fetch' => PDO::FETCH_ASSOC))
danielebarchiesi@0:     ->condition('nid', $component['nid'])
danielebarchiesi@0:     ->condition('cid', $component['cid'])
danielebarchiesi@0:     ->condition('data', '', '<>');
danielebarchiesi@0:   $count_query->addExpression('COUNT(*)', 'datacount');
danielebarchiesi@0:   if (count($sids)) {
danielebarchiesi@0:     $count_query->condition('sid', $sids, 'IN');
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $result = $query->execute();
danielebarchiesi@0:   $rows = array();
danielebarchiesi@0:   $normal_count = 0;
danielebarchiesi@0:   foreach ($result as $data) {
danielebarchiesi@0:     $display_option = $single ? $data['data'] : $options[$data['data']];
danielebarchiesi@0:     $rows[$data['data']] = array(_webform_filter_xss($display_option), $data['datacount']);
danielebarchiesi@0:     $normal_count += $data['datacount'];
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (!$show_other_results) {
danielebarchiesi@0:     // Order the results according to the normal options array.
danielebarchiesi@0:     $ordered_rows = array();
danielebarchiesi@0:     foreach (array_intersect_key($options, $rows) as $key => $label) {
danielebarchiesi@0:       $ordered_rows[] = $rows[$key];
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Add a row for any unknown or user-entered values.
danielebarchiesi@0:     if ($component['extra']['other_option']) {
danielebarchiesi@0:       $full_count = $count_query->execute()->fetchField();
danielebarchiesi@0:       $other_count = $full_count - $normal_count;
danielebarchiesi@0:       $display_option = !empty($component['extra']['other_text']) ? check_plain($component['extra']['other_text']) : t('Other...');
danielebarchiesi@0:       $other_text = $other_count ? $other_count . ' (' . l(t('view'), 'node/' . $component['nid'] . '/webform-results/analysis/' . $component['cid']) . ')' : $other_count;
danielebarchiesi@0:       $ordered_rows[] = array($display_option, $other_text);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $rows = $ordered_rows;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $rows;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements _webform_table_component().
danielebarchiesi@0:  */
danielebarchiesi@0: function _webform_table_select($component, $value) {
danielebarchiesi@0:   // Convert submitted 'safe' values to un-edited, original form.
danielebarchiesi@0:   $options = _webform_select_options($component, TRUE);
danielebarchiesi@0: 
danielebarchiesi@0:   $value = (array) $value;
danielebarchiesi@0:   $items = array();
danielebarchiesi@0:   // Set the value as a single string.
danielebarchiesi@0:   foreach ($value as $option_value) {
danielebarchiesi@0:     if ($option_value !== '') {
danielebarchiesi@0:       if (isset($options[$option_value])) {
danielebarchiesi@0:         $items[] = _webform_filter_xss($options[$option_value]);
danielebarchiesi@0:       }
danielebarchiesi@0:       else {
danielebarchiesi@0:         $items[] = check_plain($option_value);
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return implode('<br />', $items);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements _webform_csv_headers_component().
danielebarchiesi@0:  */
danielebarchiesi@0: function _webform_csv_headers_select($component, $export_options) {
danielebarchiesi@0:   $headers = array(
danielebarchiesi@0:     0 => array(),
danielebarchiesi@0:     1 => array(),
danielebarchiesi@0:     2 => array(),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   if ($component['extra']['multiple'] && $export_options['select_format'] == 'separate') {
danielebarchiesi@0:     $headers[0][] = '';
danielebarchiesi@0:     $headers[1][] = $component['name'];
danielebarchiesi@0:     $items = _webform_select_options($component, TRUE, FALSE);
danielebarchiesi@0:     if ($component['extra']['other_option']) {
danielebarchiesi@0:       $other_label = !empty($component['extra']['other_text']) ? check_plain($component['extra']['other_text']) : t('Other...');
danielebarchiesi@0:       $items[$other_label] = $other_label;
danielebarchiesi@0:     }
danielebarchiesi@0:     $count = 0;
danielebarchiesi@0:     foreach ($items as $key => $item) {
danielebarchiesi@0:       // Empty column per sub-field in main header.
danielebarchiesi@0:       if ($count != 0) {
danielebarchiesi@0:         $headers[0][] = '';
danielebarchiesi@0:         $headers[1][] = '';
danielebarchiesi@0:       }
danielebarchiesi@0:       if ($export_options['select_keys']) {
danielebarchiesi@0:         $headers[2][] = $key;
danielebarchiesi@0:       }
danielebarchiesi@0:       else {
danielebarchiesi@0:         $headers[2][] = $item;
danielebarchiesi@0:       }
danielebarchiesi@0:       $count++;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     $headers[0][] = '';
danielebarchiesi@0:     $headers[1][] = '';
danielebarchiesi@0:     $headers[2][] = $component['name'];
danielebarchiesi@0:   }
danielebarchiesi@0:   return $headers;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements _webform_csv_data_component().
danielebarchiesi@0:  */
danielebarchiesi@0: function _webform_csv_data_select($component, $export_options, $value) {
danielebarchiesi@0:   $options = _webform_select_options($component, TRUE, FALSE);
danielebarchiesi@0:   $return = array();
danielebarchiesi@0: 
danielebarchiesi@0:   if ($component['extra']['multiple']) {
danielebarchiesi@0:     foreach ($options as $key => $item) {
danielebarchiesi@0:       $index = array_search($key, (array) $value);
danielebarchiesi@0:       if ($index !== FALSE) {
danielebarchiesi@0:         if ($export_options['select_format'] == 'separate') {
danielebarchiesi@0:           $return[] = 'X';
danielebarchiesi@0:         }
danielebarchiesi@0:         else {
danielebarchiesi@0:           $return[] = $export_options['select_keys'] ? $key : $item;
danielebarchiesi@0:         }
danielebarchiesi@0:         unset($value[$index]);
danielebarchiesi@0:       }
danielebarchiesi@0:       elseif ($export_options['select_format'] == 'separate') {
danielebarchiesi@0:         $return[] = '';
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Any remaining items in the $value array will be user-added options.
danielebarchiesi@0:     if ($component['extra']['other_option']) {
danielebarchiesi@0:       $return[] = count($value) ? implode(',', $value) : '';
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     $key = $value[0];
danielebarchiesi@0:     if ($export_options['select_keys']) {
danielebarchiesi@0:       $return = $key;
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $return = isset($options[$key]) ? $options[$key] : $key;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if ($component['extra']['multiple'] && $export_options['select_format'] == 'compact') {
danielebarchiesi@0:     $return = implode(',', (array) $return);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $return;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Menu callback; Return a predefined list of select options as JSON.
danielebarchiesi@0:  */
danielebarchiesi@0: function webform_select_options_ajax($source_name = '') {
danielebarchiesi@0:   $info = _webform_select_options_info();
danielebarchiesi@0: 
danielebarchiesi@0:   $component['extra']['options_source'] = $source_name;
danielebarchiesi@0:   if ($source_name && isset($info[$source_name])) {
danielebarchiesi@0:     $options = _webform_select_options_to_text(_webform_select_options($component, !$component['extra']['aslist'], FALSE));
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     $options = '';
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $return = array(
danielebarchiesi@0:     'elementId' => module_exists('options_element') ? 'edit-items-options-options-field-widget' : 'edit-extra-items',
danielebarchiesi@0:     'options' => $options,
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   drupal_json_output($return);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Generate a list of options for a select list.
danielebarchiesi@0:  */
danielebarchiesi@0: function _webform_select_options($component, $flat = FALSE, $filter = TRUE) {
danielebarchiesi@0:   if ($component['extra']['options_source']) {
danielebarchiesi@0:     $options = _webform_select_options_callback($component['extra']['options_source'], $component, $flat, $filter);
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     $options = _webform_select_options_from_text($component['extra']['items'], $flat, $filter);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return isset($options) ? $options : array();
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Load Webform select option info from 3rd party modules.
danielebarchiesi@0:  */
danielebarchiesi@0: function _webform_select_options_info() {
danielebarchiesi@0:   static $info;
danielebarchiesi@0:   if (!isset($info)) {
danielebarchiesi@0:     $info = array();
danielebarchiesi@0: 
danielebarchiesi@0:     foreach (module_implements('webform_select_options_info') as $module) {
danielebarchiesi@0:       $additions = module_invoke($module, 'webform_select_options_info');
danielebarchiesi@0:       foreach ($additions as $key => $addition) {
danielebarchiesi@0:         $additions[$key]['module'] = $module;
danielebarchiesi@0:       }
danielebarchiesi@0:       $info = array_merge($info, $additions);
danielebarchiesi@0:     }
danielebarchiesi@0:     drupal_alter('webform_select_options_info', $info);
danielebarchiesi@0:   }
danielebarchiesi@0:   return $info;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Execute a select option callback.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $name
danielebarchiesi@0:  *   The name of the options group.
danielebarchiesi@0:  * @param $component
danielebarchiesi@0:  *   The full Webform component.
danielebarchiesi@0:  * @param $flat
danielebarchiesi@0:  *   Whether the information returned should exclude any nested groups.
danielebarchiesi@0:  * @param $filter
danielebarchiesi@0:  *   Whether information returned should be sanitized. Defaults to TRUE.
danielebarchiesi@0:  */
danielebarchiesi@0: function _webform_select_options_callback($name, $component, $flat = FALSE, $filter = TRUE) {
danielebarchiesi@0:   $info = _webform_select_options_info();
danielebarchiesi@0: 
danielebarchiesi@0:   // Include any necessary files.
danielebarchiesi@0:   if (isset($info[$name]['file'])) {
danielebarchiesi@0:     $pathinfo = pathinfo($info[$name]['file']);
danielebarchiesi@0:     $path = ($pathinfo['dirname'] ? $pathinfo['dirname'] . '/' : '') . basename($pathinfo['basename'], '.' . $pathinfo['extension']);
danielebarchiesi@0:     module_load_include($pathinfo['extension'], $info[$name]['module'], $path);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Execute the callback function.
danielebarchiesi@0:   if (isset($info[$name]['options callback']) && function_exists($info[$name]['options callback'])) {
danielebarchiesi@0:     $function = $info[$name]['options callback'];
danielebarchiesi@0: 
danielebarchiesi@0:     $arguments = array();
danielebarchiesi@0:     if (isset($info[$name]['options arguments'])) {
danielebarchiesi@0:       $arguments = $info[$name]['options arguments'];
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     return $function($component, $flat, $filter, $arguments);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Utility function to split user-entered values from new-line separated
danielebarchiesi@0:  * text into an array of options.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $text
danielebarchiesi@0:  *   Text to be converted into a select option array.
danielebarchiesi@0:  * @param $flat
danielebarchiesi@0:  *   Optional. If specified, return the option array and exclude any optgroups.
danielebarchiesi@0:  * @param $filter
danielebarchiesi@0:  *   Optional. Whether or not to filter returned values.
danielebarchiesi@0:  */
danielebarchiesi@0: function _webform_select_options_from_text($text, $flat = FALSE, $filter = TRUE) {
danielebarchiesi@0:   static $option_cache = array();
danielebarchiesi@0: 
danielebarchiesi@0:   // Keep each processed option block in an array indexed by the MD5 hash of
danielebarchiesi@0:   // the option text and the value of the $flat variable.
danielebarchiesi@0:   $md5 = md5($text);
danielebarchiesi@0: 
danielebarchiesi@0:   // Check if this option block has been previously processed.
danielebarchiesi@0:   if (!isset($option_cache[$flat][$md5])) {
danielebarchiesi@0:     $options = array();
danielebarchiesi@0:     $rows = array_filter(explode("\n", trim($text)));
danielebarchiesi@0:     $group = NULL;
danielebarchiesi@0:     foreach ($rows as $option) {
danielebarchiesi@0:       $option = trim($option);
danielebarchiesi@0:       /**
danielebarchiesi@0:        * If the Key of the option is within < >, treat as an optgroup
danielebarchiesi@0:        *
danielebarchiesi@0:        * <Group 1>
danielebarchiesi@0:        *   creates an optgroup with the label "Group 1"
danielebarchiesi@0:        *
danielebarchiesi@0:        * <>
danielebarchiesi@0:        *   Unsets the current group, allowing items to be inserted at the root element.
danielebarchiesi@0:        */
danielebarchiesi@0:       if (preg_match('/^\<([^>]*)\>$/', $option, $matches)) {
danielebarchiesi@0:         if (empty($matches[1])) {
danielebarchiesi@0:           unset($group);
danielebarchiesi@0:         }
danielebarchiesi@0:         elseif (!$flat) {
danielebarchiesi@0:           $group = $filter ? _webform_filter_values($matches[1], NULL, NULL, NULL, FALSE) : $matches[1];
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0:       elseif (preg_match('/^([^|]+)\|(.*)$/', $option, $matches)) {
danielebarchiesi@0:         $key = $filter ? _webform_filter_values($matches[1], NULL, NULL, NULL, FALSE) : $matches[1];
danielebarchiesi@0:         $value = $filter ? _webform_filter_values($matches[2], NULL, NULL, NULL, FALSE) : $matches[2];
danielebarchiesi@0:         isset($group) ? $options[$group][$key] = $value : $options[$key] = $value;
danielebarchiesi@0:       }
danielebarchiesi@0:       else {
danielebarchiesi@0:         $filtered_option = $filter ? _webform_filter_values($option, NULL, NULL, NULL, FALSE) : $option;
danielebarchiesi@0:         isset($group) ? $options[$group][$filtered_option] = $filtered_option : $options[$filtered_option] = $filtered_option;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $option_cache[$flat][$md5] = $options;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Return our options from the option_cache array.
danielebarchiesi@0:   return $option_cache[$flat][$md5];
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Convert an array of options into text.
danielebarchiesi@0:  */
danielebarchiesi@0: function _webform_select_options_to_text($options) {
danielebarchiesi@0:   $output = '';
danielebarchiesi@0:   $previous_key = FALSE;
danielebarchiesi@0: 
danielebarchiesi@0:   foreach ($options as $key => $value) {
danielebarchiesi@0:     // Convert groups.
danielebarchiesi@0:     if (is_array($value)) {
danielebarchiesi@0:       $output .= '<' . $key . '>' . "\n";
danielebarchiesi@0:       foreach ($value as $subkey => $subvalue) {
danielebarchiesi@0:         $output .= $subkey . '|' . $subvalue . "\n";
danielebarchiesi@0:       }
danielebarchiesi@0:       $previous_key = $key;
danielebarchiesi@0:     }
danielebarchiesi@0:     // Typical key|value pairs.
danielebarchiesi@0:     else {
danielebarchiesi@0:       // Exit out of any groups.
danielebarchiesi@0:       if (isset($options[$previous_key]) && is_array($options[$previous_key])) {
danielebarchiesi@0:         $output .= "<>\n";
danielebarchiesi@0:       }
danielebarchiesi@0:       // Skip empty rows.
danielebarchiesi@0:       if ($options[$key] !== '') {
danielebarchiesi@0:         $output .= $key . '|' . $value . "\n";
danielebarchiesi@0:       }
danielebarchiesi@0:       $previous_key = $key;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $output;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Utility function to shuffle an array while preserving key-value pairs.
danielebarchiesi@0:  */
danielebarchiesi@0: function _webform_shuffle_options(&$array) {
danielebarchiesi@0:   // First shuffle the array keys, then use them as the basis for ordering
danielebarchiesi@0:   // the options.
danielebarchiesi@0:   $aux = array();
danielebarchiesi@0:   $keys = array_keys($array);
danielebarchiesi@0:   shuffle($keys);
danielebarchiesi@0:   foreach ($keys as $key) {
danielebarchiesi@0:     $aux[$key] = $array[$key];
danielebarchiesi@0:   }
danielebarchiesi@0:   $array = $aux;
danielebarchiesi@0: }