's original ID.
+ $properties = array(
+ '#required' => FALSE,
+ '#id' => $id,
+ '#type' => 'bef-checkbox',
+ '#name' => $id,
+ '#description' => isset($element['#bef_term_descriptions'][$value]) ? $element['#bef_term_descriptions'][$value] :
+ '',
+ );
+
+ // Prevent the select-all-none class from cascading to all checkboxes.
+ if (!empty($element['#attributes']['class'])
+ && FALSE !== ($key = array_search('bef-select-all-none', $element['#attributes']['class']))) {
+ unset($element['#attributes']['class'][$key]);
+ }
+
+ // Unset the name attribute as we are setting it manually.
+ unset($element['#attributes']['name']);
+
+ // Unset the multiple attribute as it doesn't apply for checkboxes.
+ unset ($element['#attributes']['multiple']);
+
+ $checkbox = '$label ";
+ $output = theme('form_element', array('element' => $properties));
+ return $output;
+}
+
+/**
+ * Replaces/adds a given query string argument to the current URL.
+ *
+ * @param string $key
+ * Query string key (argument).
+ * @param string $value
+ * Query string value.
+ * @param bool $multiple
+ * (optional) TRUE if this key/value pair allows multiple values.
+ * @param bool $remove
+ * (optional) TRUE if this key/value should be a link to remove/unset the
+ * filter.
+ * @param string $path
+ * (optional) Use this specify the View results page when the exposed form
+ * is displayed as a block and may be a different URL from the results.
+ * Defaults to the current path if unspecified.
+ *
+ * @return string
+ * URL.
+ */
+function bef_replace_query_string_arg($key, $value, $multiple = FALSE, $remove = FALSE, $path = '') {
+ if (!$path) {
+ $path = implode('/', arg());
+ }
+
+ // Prevents us from having to check for each index from parse_url that we may
+ // use.
+ $urllist = array('path' => '', 'fragment' => '', 'query' => '');
+ $urllist = array_merge($urllist, parse_url(request_uri()));
+ $fragment = urldecode($urllist['fragment']);
+ $query = array();
+ parse_str($urllist['query'], $query);
+ if (isset($query[$key]) && is_array($query[$key])) {
+ // Multiple values allowed for this existing key.
+ if ($remove && ($key_remove = array_search($value, $query[$key])) !== FALSE) {
+ unset($query[$key][$key_remove]);
+ }
+ else {
+ $query[$key][] = $value;
+ }
+ }
+ else {
+ // Create a new key.
+ if ($multiple && !$remove) {
+ $query[$key] = array($value);
+ }
+ elseif (!$remove) {
+ $query[$key] = $value;
+ }
+ }
+ // Unset page arg so we don't land on an empty page off the end of the newly
+ // filtered listing.
+ unset($query['page']);
+ return url(ltrim($path, '/'), array(
+ 'query' => $query,
+ 'fragment' => $fragment,
+ 'absolute' => TRUE,
+ ));
+}
diff --git a/sites/all/modules/better_exposed_filters/better_exposed_filters.views.inc b/sites/all/modules/better_exposed_filters/better_exposed_filters.views.inc
new file mode 100644
index 0000000..d91d2f5
--- /dev/null
+++ b/sites/all/modules/better_exposed_filters/better_exposed_filters.views.inc
@@ -0,0 +1,31 @@
+ array(
+ 'better_exposed_filters' => array(
+ 'title' => t('Better Exposed Filters'),
+ 'help' => t('Allow use of checkboxes/radio buttons for exposed filters'),
+ 'handler' => 'better_exposed_filters_exposed_form_plugin',
+ 'uses row plugin' => FALSE,
+ 'uses fields' => TRUE,
+ 'uses options' => TRUE,
+ 'help topic' => 'exposed-form-basic',
+ 'type' => 'normal',
+ 'parent' => 'basic',
+ ),
+ ),
+ );
+}
diff --git a/sites/all/modules/better_exposed_filters/better_exposed_filters_exposed_form_plugin.inc b/sites/all/modules/better_exposed_filters/better_exposed_filters_exposed_form_plugin.inc
new file mode 100644
index 0000000..ca3d9c6
--- /dev/null
+++ b/sites/all/modules/better_exposed_filters/better_exposed_filters_exposed_form_plugin.inc
@@ -0,0 +1,2156 @@
+view = &$view;
+ $this->display = &$display;
+
+ $this->localization_keys = $this->unpack_translatable_keys();
+
+ $this->unpack_options($this->options, $options);
+ //$this->unpack_options($this->options, $options, NULL, FALSE);
+ }
+
+ function summary_title() {
+ return t('BEF Settings');
+ }
+
+ function option_definition() {
+ $options = parent::option_definition();
+
+ // Add Better Exposed Filters options to those saved by Views.
+ $options['bef'] = array(
+ 'default' => array(),
+ 'translatable' => TRUE,
+ 'unpack_translatable' => 'unpack_translatable_options',
+ );
+
+ return $options;
+ }
+
+ function options_form(&$form, &$form_state) {
+ parent::options_form($form, $form_state);
+
+ $bef_options = array();
+
+ // Get current settings and default values for new filters.
+ $existing = $this->_bef_get_settings();
+
+ /*
+ * Add general options for exposed form items.
+ */
+ $bef_options['general']['input_required'] = array(
+ '#type' => 'checkbox',
+ '#default_value' => $existing['general']['input_required'],
+ '#title' => t('Require input before results are shown'),
+ '#description' => t("Emulates the built in Input Required exposed filter handler")
+ );
+
+ $bef_options['general']['text_input_required'] = array(
+ '#type' => 'container',
+ // Indent dependent options.
+ '#prefix' => '',
+ '#suffix' => '
',
+ '#states' => array(
+ // Hide this field when the input_required checkbox is disabled.
+ 'invisible' => array(
+ ':input[name="exposed_form_options[bef][general][input_required]"]' => array('checked' => FALSE),
+ ),
+ ),
+ );
+
+ $bef_options['general']['text_input_required']['text_input_required'] = array(
+ '#type' => 'text_format',
+ '#title' => t('Text on demand'),
+ '#description' => t('Text to display instead of results until the user selects and applies an exposed filter.'),
+ '#default_value' => $existing['general']['text_input_required']['text_input_required']['value'],
+ '#format' => $existing['general']['text_input_required']['text_input_required']['format'],
+ '#wysiwyg' => FALSE,
+ );
+
+ $bef_options['general']['allow_secondary'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Enable secondary exposed form options'),
+ '#default_value' => $existing['general']['allow_secondary'],
+ '#description' => t('Allows you to specify some exposed form elements as being secondary options and places those elements in a collapsible fieldset. Use this option to place some exposed filters in an "Advanced Search" area of the form, for example.'),
+ );
+ $bef_options['general']['secondary_label'] = array(
+ '#type' => 'textfield',
+ '#default_value' => $existing['general']['secondary_label'],
+ '#title' => t('Secondary options label'),
+ '#description' => t(
+ 'The name of the fieldset to hold secondary options. This cannot be left blank or there will be no way to show/hide these options.'
+ ),
+ // Indent dependent options.
+ '#prefix' => '',
+ '#suffix' => '
',
+ '#states' => array(
+ 'required' => array(
+ ':input[name="exposed_form_options[bef][general][allow_secondary]"]' => array('checked' => TRUE),
+ ),
+ 'visible' => array(
+ ':input[name="exposed_form_options[bef][general][allow_secondary]"]' => array('checked' => TRUE),
+ ),
+ ),
+ );
+ $bef_options['general']['secondary_collapse_override'] = array(
+ '#type' => 'select',
+ '#title' => t('Override secondary options fieldset'),
+ '#default_value' => $existing['general']['secondary_collapse_override'],
+ '#description' => t(
+ 'This setting overrides the secondary options fieldset collapsed value. By default the fieldset renders opened if a value within is selected and closed otherwise.'
+ ),
+ '#options' => array(
+ 0 => t('Default'),
+ 1 => t('Always open'),
+ 2 => t('Always closed'),
+ ),
+ // Indent dependent options.
+ '#prefix' => '',
+ '#suffix' => '
',
+ '#states' => array(
+ 'visible' => array(
+ ':input[name="exposed_form_options[bef][general][allow_secondary]"]' => array('checked' => TRUE),
+ ),
+ ),
+ );
+
+ /*
+ * Add options for exposed sorts.
+ */
+ $exposed = FALSE;
+ foreach ($this->display->handler->get_handlers('sort') as $label => $sort) {
+ if ($sort->options['exposed']) {
+ $exposed = TRUE;
+ break;
+ }
+ }
+ if ($exposed) {
+ $bef_options['sort']['bef_format'] = array(
+ '#type' => 'select',
+ '#title' => t('Display exposed sort options as'),
+ '#default_value' => $existing['sort']['bef_format'],
+ '#options' => array(
+ 'default' => t('Default select list'),
+ 'bef' => t('Radio Buttons'),
+ 'bef_links' => t('Links'),
+ 'bef_toggle_links' => t('Toggle Links'),
+ ),
+ '#description' => t('Select a format for the exposed sort options. Note: the "toggle links" option will only work correctly if "Combine sort order with sort by" is checked in the "Advanced Sort Options" section.'),
+ );
+ $bef_options['sort']['advanced'] = array(
+ '#type' => 'fieldset',
+ '#title' => t('Advanced sort options'),
+ '#collapsible' => TRUE,
+ '#collapsed' => TRUE,
+ );
+ $bef_options['sort']['advanced']['collapsible'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Make sort options collapsible'),
+ '#default_value' => $existing['sort']['advanced']['collapsible'],
+ '#description' => t(
+ 'Puts the sort options in a collapsible fieldset'
+ ),
+ );
+ $bef_options['sort']['advanced']['collapsible_label'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Collapsible fieldset title'),
+ '#default_value' => empty($existing['sort']['advanced']['collapsible_label']) ? t('Sort options') : $existing['sort']['advanced']['collapsible_label'],
+ '#description' => t('This cannot be left blank or there will be no way to show/hide sort options.'),
+ // Indent dependent options.
+ '#prefix' => '',
+ '#suffix' => '
',
+ '#states' => array(
+ 'visible' => array(
+ 'input[name="exposed_form_options[bef][sort][advanced][collapsible]"]' => array('checked' => TRUE)
+ ),
+ ),
+ );
+ $bef_options['sort']['advanced']['combine'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Combine sort order with sort by'),
+ '#default_value' => $existing['sort']['advanced']['combine'],
+ '#description' => t('Combines the sort by options and order (ascending or decending) into a single list. Use this to display "Option1 Desc", "Option1 Asc", "Option2 Desc", "Option2 Asc" in a single form element. "Expose sort order" must be checked to enable this option.'),
+ '#states' => array(
+ 'disabled' => array(
+ 'input[name="exposed_form_options[expose_sort_order]"]' => array('checked' => FALSE)
+ ),
+ ),
+ );
+ $bef_options['sort']['advanced']['combine_param'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Enter a query parameter to use for combined sorts'),
+ '#default_value' => $existing['sort']['advanced']['combine_param'],
+ '#description' => t('This will be the $_GET parameter used in query strings. Useful for preventing collisions between exposed filters when there are multiple instances of BEF on the page. Use only UTF-8 letters, numbers, and the dash (-), underscore (_), asterisk (*), and period(.) characters.'),
+ '#default_value' => empty($existing['sort']['advanced']['combine_param']) ? 'sort_bef_combine' : $existing['sort']['advanced']['combine_param'],
+ '#required' => TRUE,
+ // Indent dependent options -- closing is in combine_rewrite.
+ '#prefix' => '',
+ '#states' => array(
+ 'visible' => array(
+ 'input[name="exposed_form_options[bef][sort][advanced][combine]"]' => array('checked' => TRUE),
+ 'input[name="exposed_form_options[expose_sort_order]"]' => array('checked' => TRUE),
+ ),
+ ),
+ );
+ $bef_options['sort']['advanced']['combine_rewrite'] = array(
+ '#type' => 'textarea',
+ '#title' => t('Rewrite the text displayed'),
+ '#default_value' => $existing['sort']['advanced']['combine_rewrite'],
+ '#description' => t('Use this field to rewrite the text displayed for combined sort options and sort order. Use the format of current_text|replacement_text, one replacement per line. For example:
+Post date Asc|Oldest first
+Post date Desc|Newest first
+Title Asc|A -> Z
+Title Desc|Z -> A Leave the replacement text blank to remove an option altogether.'),
+ '#suffix' => '
',
+ '#suffix' => '
',
+ '#states' => array(
+ 'required' => array(
+ 'input[name="exposed_form_options[bef][sort][advanced][reset]"]' => array('checked' => TRUE),
+ ),
+ 'visible' => array(
+ 'input[name="exposed_form_options[bef][sort][advanced][reset]"]' => array('checked' => TRUE),
+ ),
+ ),
+ );
+
+ $bef_options['sort']['advanced']['is_secondary'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('This is a secondary option'),
+ '#default_value' => $existing['sort']['advanced']['is_secondary'],
+ '#states' => array(
+ 'visible' => array(
+ ':input[name="exposed_form_options[bef][general][allow_secondary]"]' => array('checked' => TRUE),
+ ),
+ ),
+ '#description' => t('Places this element in the secondary options portion of the exposed form.'),
+ );
+
+ $bef_options['sort']['advanced']['autosubmit'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Autosubmit'),
+ '#default_value' => $existing['sort']['advanced']['autosubmit'],
+ '#states' => array(
+ 'disabled' => array(
+ ':input[name="exposed_form_options[autosubmit]"]' => array('checked' => TRUE),
+ ),
+ ),
+ '#description' => t('Automatically submit the form once a sort element is changed. This option is not available if you enabled autosubmit option for the whole form.'),
+ );
+ }
+
+ /*
+ * Add options for exposed pager.
+ */
+ $pager_exposed = FALSE;
+ $current_display = $this->display->handler->view->display[$this->display->handler->view->current_display];
+ $default_display = $this->display->handler->view->display['default'];
+ if (!empty($current_display->handler->options['defaults']["pager"])) {
+ $pager_exposed = isset($default_display->handler->options['pager']) && !empty($default_display->handler->options['pager']['options']['expose']['items_per_page']);
+ }
+ else {
+ $pager_exposed = isset($current_display->handler->options['pager']) && !empty($current_display->handler->options['pager']['options']['expose']['items_per_page']);
+ }
+ if ($pager_exposed) {
+ $bef_options['pager']['bef_format'] = array(
+ '#type' => 'select',
+ '#title' => t('Display exposed pager options as'),
+ '#default_value' => $existing['pager']['bef_format'],
+ '#options' => array(
+ 'default' => t('Default select list'),
+ 'bef' => t('Radio Buttons'),
+ 'bef_links' => t('Links'),
+ ),
+ '#description' => t('Select a format for the exposed pager options.'),
+ );
+ $bef_options['pager']['is_secondary'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('This is a secondary option'),
+ '#default_value' => $existing['pager']['is_secondary'],
+ '#states' => array(
+ 'visible' => array(
+ ':input[name="exposed_form_options[bef][general][allow_secondary]"]' => array('checked' => TRUE),
+ ),
+ ),
+ '#description' => t('Places this element in the secondary options portion of the exposed form.'),
+ );
+ }
+
+ // Only add the description text once -- it was getting a little long to be
+ // added to each filter.
+ $bef_filter_intro = FALSE;
+
+ // Go through each filter and add BEF options.
+ foreach ($this->display->handler->get_handlers('filter') as $label => $filter) {
+ if (!$filter->options['exposed']) {
+ continue;
+ }
+
+ // If we're adding BEF filter options, add an intro to explain what's
+ // going on.
+ if (!$bef_filter_intro) {
+ $link = l(t('BEF settings documentation'), 'http://drupal.org/node/1701012');
+ $bef_options['bef_intro'] = array(
+ '#markup' => ''
+ . t('Exposed Filter Settings')
+ . ' '
+ . t('This section lets you select additional options for exposed filters. Some options are only available in certain situations. If you do not see the options you expect, please see the !link page for more details.',
+ array('!link' => $link))
+ . '
',
+ );
+ $bef_filter_intro = TRUE;
+ }
+
+ // These filter operators get our standard options: radio or checkboxes.
+ $bef_standard = FALSE;
+
+ // Allows a filter to be rendered as a hidden '
+ . t('Enable the !token module to use replacement values.', array('!token' => l(t('Token'), 'http://drupal.org/project/token')))
+ . '
',
+ );
+ }
+ else {
+ // Collect a list of token types that make sense for this filter.
+ $available = array('global_types');
+ if (!empty($filter->options['vocabulary'])) {
+ $available[] = 'vocabulary';
+ }
+ /* @TODO: Other token types? */
+
+ $filter_specific = array_diff($available, array('global_types'));
+ if (empty($filter_specific)) {
+ $bef_options[$label]['more_options']['tokens']['nothing_specific'] = array(
+ '#markup' => '' . t('There are no filter-specific tokens for this filter. See the "Global replacement tokens" at the bottom of this dialog for additional token replacement options.') . '
',
+ );
+ }
+ else {
+ $bef_options[$label]['more_options']['tokens']['list'] = array(
+ //'#title' => t('Filter-specific tokens'),
+ '#theme' => 'token_tree',
+ '#token_types' => $filter_specific,
+ '#global_types' => FALSE,
+ );
+ }
+
+ $bef_options[$label]['more_options']['tokens']['available'] = array(
+ // Save us from parsing available tokens again.
+ '#type' => 'value',
+ '#value' => $available,
+ );
+ }
+
+ // Allow rewriting of filter options for any filter.
+ $bef_options[$label]['more_options']['rewrite'] = array(
+ '#title' => t('Rewrite filter options'),
+ '#type' => 'fieldset',
+ '#collapsible' => TRUE,
+ '#collapsed' => TRUE,
+ );
+ $bef_options[$label]['more_options']['rewrite']['filter_rewrite_values'] = array(
+ '#type' => 'textarea',
+ '#title' => t('Rewrite the text displayed'),
+ '#default_value' => $existing[$label]['more_options']['rewrite']['filter_rewrite_values'],
+ '#description' => t('
+ Use this field to rewrite the filter options displayed. Use the format
+ of current_text|replacement_text, one replacement per line. For
+ example:
+Current|Replacement
+On|Yes
+Off|No
+ Leave the replacement text blank to remove an option altogether. If using hierarchical taxonomy filters, do not including leading hyphens in the current value.
+ '),
+ );
+
+ // Add an option to override defaults for the jQuery UI Datepicker.
+ if ($bef_datepicker) {
+ $bef_options[$label]['more_options']['datepicker_options'] = array(
+ '#type' => 'textarea',
+ '#title' => t('jQuery UI Datepicker option'),
+ '#default_value' => $existing[$label]['more_options']['datepicker_options'],
+ '#description' => t('Use this field to override the default options for the Datepicker widget. Options should be in the form of option_name: option_value, one setting per line. For example, to set the days of the week and date format to French:
+dayNamesMin: [ "Di", "Lu", "Ma", "Me", "Je", "Ve", "Sa" ]
+dateFormat: "dd-mm-yy"
+ More information about datepicker options can be found on the jQuery UI website . This field is translatable so you can specify different options for different languages. See the BEF localization documentation for more details.',
+ array(
+ '!link' => 'http://api.jqueryui.com/datepicker/',
+ '!docs_link' => 'https://www.drupal.org/node/2460797',
+ )
+ ),
+ );
+ }
+ }
+ /* Ends: foreach ($filters as $filter) { */
+
+ // Add global token replacements, if available.
+ if (module_exists('token')) {
+ $bef_options['global_replacement_tokens'] = array(
+ '#title' => t('Global replacement patterns'),
+ '#type' => 'fieldset',
+ '#collapsible' => TRUE,
+ '#collapsed' => TRUE,
+ );
+ $bef_options['global_replacement_tokens']['list'] = array(
+ '#theme' => 'token_tree',
+ '#token_types' => array('global_types'),
+ );
+ }
+
+ // Add BEF form elements to the exposed form options form.
+ $form['bef'] = $bef_options;
+ }
+
+ /**
+ * Tweak the exposed filter form to show Better Exposed Filter options.
+ *
+ * @param array $form
+ * Exposed form array
+ * @param array $form_state
+ * Current state of form variables
+ */
+ function exposed_form_alter(&$form, &$form_state) {
+ parent::exposed_form_alter($form, $form_state);
+
+ // If we have no visible elements, we don't show the Apply button.
+ $show_apply = FALSE;
+
+ // Collect BEF's Javascript settings, add to Drupal.settings at the end.
+ // Historical note: We used to only add BEF's Javascript when absolutely
+ // needed. Eventually, much of that functionality worked its way into the
+ // normal usage of BEF so that we now turn those Jvaascript behaviors on
+ // by default. (See https://drupal.org/node/1807114).
+ $bef_add_js = TRUE;
+ $bef_js = array(
+ 'datepicker' => FALSE,
+ 'slider' => FALSE,
+ 'settings' => array(),
+ 'autosubmit' => FALSE,
+ );
+
+ // Some widgets will require additional CSS.
+ $bef_add_css = FALSE;
+
+ // Grab BEF settings.
+ $settings = $this->_bef_get_settings();
+
+ // Allow modules/themes to alter BEF settings before they are passed to the
+ // exposed form widgets.
+ $context['view'] = $this->view;
+ $context['display'] = $this->display;
+ drupal_alter('better_exposed_filters_settings', $settings, $context);
+
+ // Adds view's arguments (if any) to the path to be used use for #bef_path.
+ $view_path = $this->view->args ? implode('/', array_merge(array($this->view->get_path()), $this->view->args)) : $this->view->get_path();
+
+ // Some elements may be placed in a secondary fieldset (eg: "Advanced
+ // search options"). Place this after the exposed filters and before the
+ // rest of the items in the exposed form.
+ if ($allow_secondary = $settings['general']['allow_secondary']) {
+ // If one of the secondary widgets has exposed input, do not collapse the
+ // secondary fieldset. Or is the "always open" or "always closed" option
+ // is selected, use that instead.
+ $secondary_collapse = TRUE;
+ if ($settings['general']['secondary_collapse_override']) {
+ $secondary_collapse = $settings['general']['secondary_collapse_override'] == 2;
+ }
+ else {
+ $exposed_input = $this->view->get_exposed_input();
+ foreach ($this->display->handler->get_handlers('filter') as $label => $filter) {
+ if (!$filter->options['exposed']) {
+ continue;
+ }
+ if (!empty($exposed_input[$filter->options['expose']['identifier']]) && $settings[$label]['more_options']['is_secondary']) {
+ $secondary_collapse = FALSE;
+ break;
+ }
+ }
+ }
+
+ $secondary = array(
+ '#type' => 'fieldset',
+ '#title' => $settings['general']['secondary_label'],
+ '#collapsible' => TRUE,
+ '#collapsed' => $secondary_collapse,
+ '#theme' => 'secondary_exposed_elements',
+ );
+ }
+
+ /*
+ * Handle exposed sort elements.
+ */
+ if (isset($settings['sort']) && !empty($form['sort_by']) && !empty($form['sort_order'])) {
+ $show_apply = TRUE;
+
+ // If selected, collect all sort-related form elements and put them
+ // in a collapsible fieldset.
+ $collapse = $settings['sort']['advanced']['collapsible']
+ && !empty($settings['sort']['advanced']['collapsible_label']);
+ $sort_elems = array();
+
+ // Check for combined sort_by and sort_order.
+ if ($settings['sort']['advanced']['combine']) {
+ $form_state['#combine_param'] = $settings['sort']['advanced']['combine_param'];
+ // Combine sort_by and sort_order into a single element.
+ $form[$settings['sort']['advanced']['combine_param']] = array(
+ '#type' => 'radios',
+ // Already sanitized by Views.
+ '#title' => $form['sort_by']['#title'],
+ );
+ $options = array();
+ // If using the bef_toggle_links format, determine which links should
+ // not be shown.
+ $hidden_options = array();
+
+ // Add reset sort option at the top of the list.
+ if ($settings['sort']['advanced']['reset']) {
+ $options[' '] = t($settings['sort']['advanced']['reset_label']);
+ }
+ else {
+ $form[$settings['sort']['advanced']['combine_param']]['#default_value'] = '';
+ }
+
+ $selected = '';
+ $used_sort_keys = array();
+ foreach ($form['sort_by']['#options'] as $by_key => $by_val) {
+ foreach ($form['sort_order']['#options'] as $order_key => $order_val) {
+ // Use a space to separate the two keys, we'll unpack them in our
+ // submit handler.
+ $options["$by_key $order_key"] = "$by_val $order_val";
+
+ if ($form['sort_order']['#default_value'] == $order_key && empty($selected)) {
+ // Respect default sort order set in Views. The default sort field
+ // will be the first one if there are multiple sort criteria.
+ $selected = "$by_key $order_key";
+ }
+ if ($settings['sort']['bef_format'] == 'bef_toggle_links') {
+ if (isset($used_sort_keys[$by_key])
+ || (!empty($form_state['input'][$settings['sort']['advanced']['combine_param']]) && $form_state['input'][$settings['sort']['advanced']['combine_param']] == "$by_key $order_key")
+ || (empty($form_state['input'][$settings['sort']['advanced']['combine_param']]) && $selected == "$by_key $order_key")
+ ) {
+ $hidden_options["$by_key $order_key"] = "$by_val $order_val";
+ }
+ else {
+ $used_sort_keys[$by_key] = $order_key;
+ }
+ }
+ }
+ }
+
+ // Rewrite the option values if any were specified.
+ if (!empty($settings['sort']['advanced']['combine_rewrite'])) {
+ $lines = explode("\n", trim($settings['sort']['advanced']['combine_rewrite']));
+ $rewrite = array();
+ foreach ($lines as $line) {
+ list($search, $replace) = explode('|', $line);
+ if (isset($search)) {
+ $rewrite[$search] = $replace;
+ }
+ }
+ foreach ($options as $index => $option) {
+ if (isset($rewrite[$option])) {
+ if ('' == $rewrite[$option]) {
+ unset($options[$index]);
+ if ($selected == $index) {
+ // Avoid "Illegal choice" errors.
+ $selected = NULL;
+ }
+ }
+ else {
+ $options[$index] = $rewrite[$option];
+ }
+ }
+ }
+ }
+
+ $form[$settings['sort']['advanced']['combine_param']] = array(
+ '#type' => 'radios',
+ '#options' => $options,
+ '#hidden_options' => $hidden_options,
+ '#settings' => array(
+ 'toggle_links' => ($settings['sort']['bef_format'] == 'bef_toggle_links'),
+ 'combine_param' => $settings['sort']['advanced']['combine_param'],
+ ),
+ '#default_value' => $selected,
+ // Already sanitized by Views.
+ '#title' => $form['sort_by']['#title'],
+ );
+
+ // Handle display-specific details.
+ switch ($settings['sort']['bef_format']) {
+ case 'bef':
+ $form[$settings['sort']['advanced']['combine_param']]['#prefix'] = '';
+ $form[$settings['sort']['advanced']['combine_param']]['#suffix'] = '
';
+ break;
+
+ case 'bef_links':
+ case 'bef_toggle_links':
+ $bef_add_js = TRUE;
+ $form[$settings['sort']['advanced']['combine_param']]['#theme'] = 'select_as_links';
+
+ // Exposed form displayed as blocks can appear on pages other than
+ // the view results appear on. This can cause problems with
+ // select_as_links options as they will use the wrong path. We
+ // provide a hint for theme functions to correct this.
+ if (!empty($this->display->display_options['exposed_block'])) {
+ $form[$settings['sort']['advanced']['combine_param']]['#bef_path'] = $view_path;
+ }
+ break;
+
+ case 'default':
+ $form[$settings['sort']['advanced']['combine_param']]['#type'] = 'select';
+ break;
+ }
+
+ // Add our submit routine to process.
+ $form['#submit'][] = 'bef_sort_combine_submit';
+
+ // Pretend we're another exposed form widget.
+ $form['#info']['sort-sort_bef_combine'] = array(
+ 'value' => $settings['sort']['advanced']['combine_param'],
+ );
+
+ // Remove the existing sort_by and sort_order elements.
+ unset($form['sort_by']);
+ unset($form['sort_order']);
+
+ if ($collapse) {
+ $sort_elems[] = $settings['sort']['advanced']['combine_param'];
+ }
+ }
+ /* if ($settings['sort']['advanced']['combine']) { } */
+ else {
+ // Leave sort_by and sort_order as separate elements.
+ if ('bef' == $settings['sort']['bef_format']) {
+ $form['sort_by']['#type'] = 'radios';
+ if (empty($form['sort_by']['#process'])) {
+ $form['sort_by']['#process'] = array();
+ }
+ array_unshift($form['sort_by']['#process'], 'form_process_radios');
+ $form['sort_by']['#prefix'] = '';
+ $form['sort_by']['#suffix'] = '
';
+
+ $form['sort_order']['#type'] = 'radios';
+ if (empty($form['sort_order']['#process'])) {
+ $form['sort_order']['#process'] = array();
+ }
+ array_unshift($form['sort_order']['#process'], 'form_process_radios');
+ $form['sort_order']['#prefix'] = '';
+ $form['sort_order']['#suffix'] = '
';
+ }
+ elseif ('bef_links' == $settings['sort']['bef_format']) {
+ $form['sort_by']['#theme'] = 'select_as_links';
+ $form['sort_order']['#theme'] = 'select_as_links';
+
+ // Exposed form displayed as blocks can appear on pages other than the
+ // view results appear on. This can cause problems with
+ // select_as_links options as they will use the wrong path. We provide
+ // a hint for theme functions to correct this.
+ if (!empty($this->display->display_options['exposed_block'])) {
+ $form['sort_by']['#bef_path'] = $form['sort_order']['#bef_path'] = $view_path;
+ }
+ }
+
+ if ($collapse) {
+ $sort_elems[] = 'sort_by';
+ $sort_elems[] = 'sort_order';
+ }
+
+ // Add reset sort option if selected.
+ if ($settings['sort']['advanced']['reset']) {
+ array_unshift($form['sort_by']['#options'], $settings['sort']['advanced']['reset_label']);
+ }
+ }
+ /* Ends: if ($settings['sort']['advanced']['combine']) { ... } else { */
+
+ if ($collapse) {
+ $form['bef_sort_options'] = array(
+ '#type' => 'fieldset',
+ '#collapsible' => TRUE,
+ '#collapsed' => TRUE,
+ '#title' => $settings['sort']['advanced']['collapsible_label'],
+ );
+ foreach ($sort_elems as $elem) {
+ $form['bef_sort_options'][$elem] = $form[$elem];
+ unset($form[$elem]);
+ }
+ }
+
+ // Check if this is a secondary form element.
+ if ($allow_secondary && $settings['sort']['advanced']['is_secondary']) {
+ foreach (array($settings['sort']['advanced']['combine_param'], 'sort_by', 'sort_order') as $elem) {
+ if (!empty($form[$elem])) {
+ $secondary[$elem] = $form[$elem];
+ unset($form[$elem]);
+ }
+ }
+ }
+ }
+ elseif (isset($settings['sort']) && !empty($form['sort_by'])) {
+ if ('bef_links' == $settings['sort']['bef_format']) {
+ $bef_add_js = TRUE;
+ $form['sort_by']['#theme'] = 'select_as_links';
+
+ // Exposed form displayed as blocks can appear on pages other than
+ // the view results appear on. This can cause problems with
+ // select_as_links options as they will use the wrong path. We
+ // provide a hint for theme functions to correct this.
+ if (!empty($this->display->display_options['exposed_block'])) {
+ $form['sort_by']['#bef_path'] = $view_path;
+ }
+ }
+ }
+
+ // Apply autosubmit sort values.
+ if (empty($this->options['autosubmit']) && !empty($settings['sort']['advanced']['autosubmit'])) {
+ $bef_js['autosubmit'] = TRUE;
+ foreach (array($settings['sort']['advanced']['combine_param'], 'sort_by', 'sort_order') as $elem) {
+ if (!empty($form[$elem])) {
+ $form[$elem] = array_merge_recursive($form[$elem], array('#attributes' => array('class' => array('ctools-auto-submit'))));
+ }
+ }
+ }
+ /* Ends: if (isset($settings['sort'])) { */
+
+ /*
+ * Handle exposed pager elements.
+ */
+ if (isset($settings['pager'])) {
+ switch ($settings['pager']['bef_format']) {
+ case 'bef':
+ $show_apply = TRUE;
+ $form['items_per_page']['#type'] = 'radios';
+ if (empty($form['items_per_page']['#process'])) {
+ $form['items_per_page']['#process'] = array();
+ }
+ array_unshift($form['items_per_page']['#process'], 'form_process_radios');
+ $form['items_per_page']['#prefix'] = '';
+ $form['items_per_page']['#suffix'] = '
';
+ break;
+
+ case 'bef_links':
+ if (count($form['items_per_page']['#options']) > 1) {
+ $bef_add_js = TRUE;
+ $form['items_per_page']['#theme'] = 'select_as_links';
+ $form['items_per_page']['#items_per_page'] = max($form['items_per_page']['#default_value'], key($form['items_per_page']['#options']));
+
+ // Exposed form displayed as blocks can appear on pages other than
+ // the view results appear on. This can cause problems with
+ // select_as_links options as they will use the wrong path. We
+ // provide a hint for theme functions to correct this.
+ if (!empty($this->display->display_options['exposed_block'])) {
+ $form['items_per_page']['#bef_path'] = $view_path;
+ }
+ }
+ break;
+ }
+
+ // Check if this is a secondary form element.
+ if ($allow_secondary && $settings['pager']['is_secondary']) {
+ foreach (array('items_per_page', 'offset') as $elem) {
+ if (!empty($form[$elem])) {
+ $secondary[$elem] = $form[$elem];
+ unset($form[$elem]);
+ }
+ }
+ }
+ }
+
+ // Shorthand for all filters in this view.
+ $filters = $form_state['view']->display_handler->handlers['filter'];
+
+ // Go through each saved option looking for Better Exposed Filter settings.
+ foreach ($settings as $label => $options) {
+ // Sanity check: Ensure this filter is an exposed filter.
+ if (empty($filters[$label]) || !$filters[$label]->options['exposed']) {
+ continue;
+ }
+
+ // Form element is designated by the element ID which is user-
+ // configurable.
+ $filter_key = 'filter-' . (!empty($filters[$label]->options['is_grouped']) ? $filters[$label]->options['group_info']['identifier'] : $label);
+ $filter_id = $form['#info'][$filter_key]['value'];
+
+ // Token replacement on BEF Description fields.
+ if (!empty($options['more_options']['bef_filter_description'])) {
+ // Collect replacement data.
+ $data = array();
+ $available = $options['more_options']['tokens']['available'];
+ if (in_array('vocabulary', $available) && isset($filters[$label]->definition['vocabulary'])) {
+ $data['vocabulary'] = taxonomy_vocabulary_machine_name_load($filters[$label]->definition['vocabulary']);
+ }
+ /* Others? */
+
+ // Replace tokens.
+ $options['more_options']['bef_filter_description'] = token_replace(
+ $options['more_options']['bef_filter_description'], $data
+ );
+ $form[$filter_id]['#bef_description'] = $options['more_options']['bef_filter_description'];
+ }
+
+ // Handle filter value rewrites.
+ if (!empty($options['more_options']['rewrite']['filter_rewrite_values'])) {
+ $lines = explode("\n", trim($options['more_options']['rewrite']['filter_rewrite_values']));
+ $rewrite = array();
+ foreach ($lines as $line) {
+ list($search, $replace) = explode('|', $line);
+ if (isset($search)) {
+ $rewrite[$search] = $replace;
+ }
+ }
+
+ foreach ($form[$filter_id]['#options'] as $index => $option) {
+ $is_object = FALSE;
+ if (is_object($option)) {
+ // Taxonomy filters use objects instead of text.
+ $is_object = TRUE;
+ $option = reset($option->option);
+
+ // Hierarchical filters prepend hyphens to indicate depth. We need
+ // to remove them for comparison, but keep them after replacement to
+ // ensure nested options display correctly.
+ $option = ltrim($option, '-');
+ }
+
+ if (isset($rewrite[$option])) {
+ if ('' == $rewrite[$option]) {
+ unset($form[$filter_id]['#options'][$index]);
+ }
+ else {
+ if ($is_object) {
+ // dsm($form[$filter_id]['#options'][$index]->option, "$filter_id at $index");
+ // Taxonomy term filters are stored as objects. Use str_replace
+ // to ensure that keep hyphens for hierarchical filters.
+ list($tid, $original) = each($form[$filter_id]['#options'][$index]->option);
+ $form[$filter_id]['#options'][$index]->option[$tid] = str_replace($option, $rewrite[$option], $original);
+ }
+ else {
+ $form[$filter_id]['#options'][$index] = $rewrite[$option];
+ }
+ }
+ }
+ }
+ }
+
+ // @TODO: Is this conditional needed anymore after the existing settings
+ // array default values were added?
+ if (!isset($options['bef_format'])) {
+ $options['bef_format'] = '';
+ }
+
+ // These BEF options require a set of given options to work (namely,
+ // $form[$filter_id]['#options'] needs to set). But it is possible to
+ // adjust settings elsewhere in the view that removes these options from
+ // the form (eg: changing a taxonomy term filter from dropdown to
+ // autocomplete). Check for that here and revert to Views' default filter
+ // in those cases.
+ $requires_options = array('bef', 'bef_ul', 'bef_links');
+ if (in_array($options['bef_format'], $requires_options) && !array_key_exists('#options', $form[$filter_id])) {
+ $options['bef_format'] = 'default';
+ }
+
+ switch ($options['bef_format']) {
+ case 'bef_datepicker':
+ $show_apply = TRUE;
+ $bef_add_js = TRUE;
+ $bef_js['datepicker'] = TRUE;
+ $bef_js['datepicker_options'] = array();
+
+ if ((
+ // Single Date API-based input element.
+ isset($form[$filter_id]['value']['#type'])
+ && 'date_text' == $form[$filter_id]['value']['#type']
+ )
+ // Double Date-API-based input elements such as "in-between".
+ || (isset($form[$filter_id]['min']) && isset($form[$filter_id]['max'])
+ && 'date_text' == $form[$filter_id]['min']['#type']
+ && 'date_text' == $form[$filter_id]['max']['#type']
+ )) {
+ /*
+ * Convert Date API formatting to jQuery formatDate formatting.
+ *
+ * @TODO: To be honest, I'm not sure this is needed. Can you set a
+ * Date API field to accept anything other than Y-m-d? Well, better
+ * safe than sorry...
+ *
+ * @see http://us3.php.net/manual/en/function.date.php
+ * @see http://docs.jquery.com/UI/Datepicker/formatDate
+ *
+ * Array format: PHP date format => jQuery formatDate format
+ * (comments are for the PHP format, lines that are commented out do
+ * not have a jQuery formatDate equivalent, but maybe someday they
+ * will...)
+ */
+ $convert = array(
+ /* Day */
+
+ // Day of the month, 2 digits with leading zeros 01 to 31.
+ 'd' => 'dd',
+ // A textual representation of a day, three letters Mon through
+ // Sun.
+ 'D' => 'D',
+ // Day of the month without leading zeros 1 to 31.
+ 'j' => 'd',
+ // (lowercase 'L') A full textual representation of the day of the
+ // week Sunday through Saturday.
+ 'l' => 'DD',
+ // ISO-8601 numeric representation of the day of the week (added
+ // in PHP 5.1.0) 1 (for Monday) through 7 (for Sunday).
+ // 'N' => ' ',
+ // English ordinal suffix for the day of the month, 2 characters
+ // st, nd, rd or th. Works well with j.
+ // 'S' => ' ',
+ // Numeric representation of the day of the week 0 (for Sunday)
+ // through 6 (for Saturday).
+ // 'w' => ' ',
+ // The day of the year (starting from 0) 0 through 365.
+ 'z' => 'o',
+
+ /* Week */
+ // ISO-8601 week number of year, weeks starting on Monday (added
+ // in PHP 4.1.0) Example: 42 (the 42nd week in the year).
+ // 'W' => ' ',
+ //
+ /* Month */
+ // A full textual representation of a month, such as January or
+ // March January through December.
+ 'F' => 'MM',
+ // Numeric representation of a month, with leading zeros 01
+ // through 12.
+ 'm' => 'mm',
+ // A short textual representation of a month, three letters Jan
+ // through Dec.
+ 'M' => 'M',
+ // Numeric representation of a month, without leading zeros 1
+ // through 12.
+ 'n' => 'm',
+ // Number of days in the given month 28 through 31.
+ // 't' => ' ',
+ //
+ /* Year */
+ // Whether it's a leap year 1 if it is a leap year, 0 otherwise.
+ // 'L' => ' ',
+ // ISO-8601 year number. This has the same value as Y, except that
+ // if the ISO week number (W) belongs to the previous or next
+ // year, that year is used instead. (added in PHP 5.1.0).
+ // Examples: 1999 or 2003.
+ // 'o' => ' ',
+ // A full numeric representation of a year, 4 digits Examples:
+ // 1999 or 2003.
+ 'Y' => 'yy',
+ // A two digit representation of a year Examples: 99 or 03.
+ 'y' => 'y',
+
+ /* Time */
+ // Lowercase Ante meridiem and Post meridiem am or pm.
+ // 'a' => ' ',
+ // Uppercase Ante meridiem and Post meridiem AM or PM.
+ // 'A' => ' ',
+ // Swatch Internet time 000 through 999.
+ // 'B' => ' ',
+ // 12-hour format of an hour without leading zeros 1 through 12.
+ // 'g' => ' ',
+ // 24-hour format of an hour without leading zeros 0 through 23.
+ // 'G' => ' ',
+ // 12-hour format of an hour with leading zeros 01 through 12.
+ // 'h' => ' ',
+ // 24-hour format of an hour with leading zeros 00 through 23.
+ // 'H' => ' ',
+ // Minutes with leading zeros 00 to 59.
+ // 'i' => ' ',
+ // Seconds, with leading zeros 00 through 59.
+ // 's' => ' ',
+ // Microseconds (added in PHP 5.2.2) Example: 654321.
+ // 'u' => ' ',
+ );
+
+ $format = '';
+ if (isset($form[$filter_id]['value'])) {
+ $format = $form[$filter_id]['value']['#date_format'];
+ $form[$filter_id]['value']['#attributes']['class'][] = 'bef-datepicker';
+
+ // This element renders via Drupal's FormAPI so we can use
+ // #description instead of passing the description along to BEF's
+ // theme functions.
+ if (!empty($form[$filter_id]['#bef_description'])) {
+ $form[$filter_id]['#description'] = $form[$filter_id]['#bef_description'];
+ }
+ }
+ else {
+ // Both min and max share the same format.
+ $format = $form[$filter_id]['min']['#date_format'];
+ $form[$filter_id]['min']['#attributes']['class'][] = 'bef-datepicker';
+ $form[$filter_id]['max']['#attributes']['class'][] = 'bef-datepicker';
+
+ // Description goes with the second field for in-between filters.
+ if (!empty($form[$filter_id]['#bef_description'])) {
+ $form[$filter_id]['max']['#description'] = $form[$filter_id]['#bef_description'];
+ }
+ }
+ $bef_js['datepicker_options']['dateFormat'] = json_encode(str_replace(array_keys($convert), array_values($convert), $format));
+ }
+ else {
+ $bef_js['datepicker_options']['dateFormat'] = '';
+ /*
+ * Standard Drupal date field. Depending on the settings, the field
+ * can be at $form[$filter_id] (single field) or
+ * $form[$filter_id][subfield] for two-value date fields or filters
+ * with exposed operators.
+ */
+ $fields = array('min', 'max', 'value');
+ if (count(array_intersect($fields, array_keys($form[$filter_id])))) {
+ $final = '';
+ foreach ($fields as $field) {
+ if (isset($form[$filter_id][$field])) {
+ $form[$filter_id][$field]['#attributes']['class'][] = 'bef-datepicker';
+ $final = $field;
+ }
+ }
+ // Description goes with the second field for in-between filters.
+ if (!empty($form[$filter_id]['#bef_description'])) {
+ $form[$filter_id][$final]['#description'] = $form[$filter_id]['#bef_description'];
+ }
+ }
+ else {
+ $form[$filter_id]['#attributes']['class'][] = 'bef-datepicker';
+
+ // This element renders via Drupal's FormAPI so we can use
+ // #description instead of passing the description along to BEF's
+ // theme functions.
+ if (!empty($form[$filter_id]['#bef_description'])) {
+ $form[$filter_id]['#description'] = $form[$filter_id]['#bef_description'];
+ }
+ }
+ }
+
+ if (!empty($options['more_options']['datepicker_options'])) {
+ foreach (explode("\n", $options['more_options']['datepicker_options']) as $setting) {
+ list ($key, $val) = explode(':', trim($setting), 2);
+ // No need to json_encode() this value like we do other datepicker
+ // options as it should already be entered in JSON format in the
+ // UI. While having an admin enter JSON in a text field is not
+ // ideal, it is how the jQueryUI widget documentation shows it in
+ // their examples.
+ $bef_js['datepicker_options'][$key] = $val;
+ }
+ }
+ break;
+
+ case 'bef_slider':
+ $show_apply = TRUE;
+ $bef_add_js = TRUE;
+ $bef_add_css = TRUE;
+ $bef_js['slider'] = TRUE;
+
+ // Add js options for the slider for this filter.
+ $bef_js['slider_options'][$filter_id] = array(
+ 'min' => $options['slider_options']['bef_slider_min'],
+ 'max' => $options['slider_options']['bef_slider_max'],
+ 'step' => $options['slider_options']['bef_slider_step'],
+ 'animate' => $options['slider_options']['bef_slider_animate'],
+ 'orientation' => $options['slider_options']['bef_slider_orientation'],
+ 'id' => drupal_html_id($filter_id),
+ 'viewId' => $form['#id'],
+ );
+
+ // We need a wrapping element that covers all elements in the
+ // slider -- not just the text fields, but descriptions as well. When
+ // placed in the secondary fieldset, we lose what we usually get from
+ // the FormAPI.
+ if ($options['more_options']['is_secondary']) {
+ $form[$filter_id]['#prefix'] = '';
+ $form[$filter_id]['#suffix'] = '
';
+ }
+
+ // This element renders via Drupal's FormAPI so we can use
+ // #description instead of passing the description along to BEF's
+ // theme functions.
+ if (!empty($form[$filter_id]['#bef_description'])) {
+ $children = element_children($form[$filter_id]);
+ if (count($children) > 1) {
+ // Put the description on the last child or this element.
+ $form[$filter_id][end($children)]['#description'] = $form[$filter_id]['#bef_description'];
+ }
+ else {
+ $form[$filter_id]['#description'] = $form[$filter_id]['#bef_description'];
+ }
+ }
+ break;
+
+ case 'bef_links':
+ $bef_add_js = TRUE;
+ $form[$filter_id]['#theme'] = 'select_as_links';
+
+ // Exposed form displayed as blocks can appear on pages other than
+ // the view results appear on. This can cause problems with
+ // select_as_links options as they will use the wrong path. We provide
+ // a hint for theme functions to correct this.
+ if (!empty($this->display->display_options['exposed_block'])) {
+ $form[$filter_id]['#bef_path'] = $view_path;
+ }
+ break;
+
+ case 'bef_single':
+ $show_apply = TRUE;
+
+ // Use filter label as checkbox label.
+ $form[$filter_id]['#title'] = $filters[$label]->options['expose']['label'];
+ $form[$filter_id]['#description'] = $options['more_options']['bef_filter_description'];
+ $form[$filter_id]['#return_value'] = 1;
+ $form[$filter_id]['#type'] = 'checkbox';
+ // Views populates missing values in $form_state['input'] with the
+ // defaults and a checkbox does not appear in $_GET (or $_POST) so it
+ // will appear to be missing when a user submits a form. Because of
+ // this, instead of unchecking the checkbox value will revert to the
+ // default. More, the default value for select values is reused which
+ // results in the checkbox always checked. So we need to add a form
+ // element to see whether the form is submitted or not and then we
+ // need to look at $_GET directly to see whether the checkbox is
+ // there. For security reasons, we must not copy the $_GET value.
+
+ // First, let's figure out a short name for the signal element and
+ // then add it.
+ if (empty($signal)) {
+ for ($signal = 'a'; isset($form[$signal]); $signal++);
+ // This is all the signal element needs.
+ $form[$signal]['#type'] = 'hidden';
+ }
+ $checked = isset($form_state['input'][$signal]) ? isset($_GET[$filter_id]) : $form[$filter_id]['#default_value'];
+ // Now we know whether the checkbox is checked or not, set #value
+ // accordingly.
+ $form[$filter_id]['#value'] = $checked ? $form[$filter_id]['#return_value'] : 0;
+ // Handoff to the theme layer.
+ $form[$filter_id]['#theme'] = 'checkbox';
+ break;
+
+ case 'bef_ul':
+ $show_apply = TRUE;
+
+ $form[$filter_id]['#bef_nested'] = TRUE;
+ /* Intentionally falling through to case 'bef'. */
+
+ case 'bef':
+ $show_apply = TRUE;
+
+ if (empty($form[$filter_id]['#multiple'])) {
+ // Single-select -- display as radio buttons.
+ $form[$filter_id]['#type'] = 'radios';
+ if (empty($form[$filter_id]['#process'])) {
+ $form[$filter_id]['#process'] = array();
+ }
+ array_unshift($form[$filter_id]['#process'], 'form_process_radios');
+
+ // Add description
+ if (!empty($form[$filter_id]['#bef_description'])) {
+ $form[$filter_id]['#description'] = $form[$filter_id]['#bef_description'];
+ }
+
+ // Clean up objects from the options array (happens for taxonomy-
+ // based filters).
+ $opts = $form[$filter_id]['#options'];
+ $form[$filter_id]['#options'] = array();
+ foreach ($opts as $index => $opt) {
+ if (is_object($opt)) {
+ reset($opt->option);
+ list($key, $val) = each($opt->option);
+ $form[$filter_id]['#options'][$key] = $val;
+ }
+ else {
+ $form[$filter_id]['#options'][$index] = $opt;
+ }
+ }
+
+ if (isset($form[$filter_id]['#options']['All'])) {
+ // @TODO: The terms 'All' and 'Any' are customizable in Views.
+ if ($filters[$label]->options['expose']['multiple']) {
+ // Some third-party filter handlers still add the "Any" option
+ // even if this is not an optional filter. Zap it here if they
+ // do.
+ unset($form[$filter_id]['#options']['All']);
+ }
+ else {
+ // Otherwise, make sure the "Any" text is clean.
+ $form[$filter_id]['#options']['All'] = check_plain($form[$filter_id]['#options']['All']);
+ }
+ }
+
+ // Render as radio buttons or radio buttons in a collapsible
+ // fieldset.
+ if (!empty($options['more_options']['bef_collapsible'])) {
+ // Pass the description and title along in a way such that it
+ // doesn't get rendered as part of the exposed form widget. We'll
+ // render them as part of the fieldset.
+ if (isset($form['#info'][$filter_key]['label'])) {
+ $form[$filter_id]['#bef_title'] = $form['#info'][$filter_key]['label'];
+ unset($form['#info'][$filter_key]['label']);
+ }
+ if (!empty($options['more_options']['bef_filter_description'])) {
+ $form[$filter_id]['#bef_description'] = $options['more_options']['bef_filter_description'];
+ if (isset($form[$filter_id]['#description'])) {
+ unset($form[$filter_id]['#description']);
+ }
+ }
+
+ // If the operator is exposed as well, put it inside the fieldset.
+ if ($filters[$label]->options['expose']['use_operator']) {
+ $operator_id = $filters[$label]->options['expose']['operator_id'];
+ $form[$filter_id]['#bef_operator'] = $form[$operator_id];
+ unset ($form[$operator_id]);
+ }
+
+ // Add collapse/expand Javascript and BEF CSS to prevent collapsed
+ // fieldset from disappearing.
+ if (empty($form[$filter_id]['#attached']['js'])) {
+ $form[$filter_id]['#attached']['js'] = array();
+ }
+ $form[$filter_id]['#attached']['js'][] = 'misc/form.js';
+ $form[$filter_id]['#attached']['js'][] = 'misc/collapse.js';
+
+ if (empty($form[$filter_id]['#attached']['css'])) {
+ $form[$filter_id]['#attached']['css'] = array();
+ }
+ $form[$filter_id]['#attached']['css'][] = drupal_get_path('module', 'better_exposed_filters') . '/better_exposed_filters.css';
+
+ // Take care of adding the fieldset in the theme layer.
+ $form[$filter_id]['#theme'] = 'select_as_radios_fieldset';
+ }
+ /* if (!empty($options['more_options']['bef_collapsible'])) { */
+ else {
+ // Render select element as radio buttons.
+ $form[$filter_id]['#attributes']['class'][] = 'bef-select-as-radios';
+ $form[$filter_id]['#theme'] = 'select_as_radios';
+ }
+ }
+ /* if (empty($form[$filter_id]['#multiple'])) { */
+ else {
+ // Render as checkboxes or checkboxes enclosed in a collapsible
+ // fieldset.
+ if (!empty($options['more_options']['bef_collapsible'])) {
+ // Pass the description and title along in a way such that it
+ // doesn't get rendered as part of the exposed form widget. We'll
+ // render them as part of the fieldset.
+ if (isset($form['#info'][$filter_key]['label'])) {
+ $form[$filter_id]['#bef_title'] = $form['#info'][$filter_key]['label'];
+ unset($form['#info'][$filter_key]['label']);
+ }
+ if (!empty($options['more_options']['bef_filter_description'])) {
+ $form[$filter_id]['#bef_description'] = $options['more_options']['bef_filter_description'];
+ if (isset($form[$filter_id]['#description'])) {
+ unset($form[$filter_id]['#description']);
+ }
+ }
+
+ // If the operator is exposed as well, put it inside the fieldset.
+ if ($filters[$label]->options['expose']['use_operator']) {
+ $operator_id = $filters[$label]->options['expose']['operator_id'];
+ $form[$filter_id]['#bef_operator'] = $form[$operator_id];
+ unset ($form[$operator_id]);
+ }
+
+ // Add collapse/expand Javascript and BEF CSS to prevent collapsed
+ // fieldset from disappearing.
+ if (empty($form[$filter_id]['#attached']['js'])) {
+ $form[$filter_id]['#attached']['js'] = array();
+ }
+ $form[$filter_id]['#attached']['js'][] = 'misc/form.js';
+ $form[$filter_id]['#attached']['js'][] = 'misc/collapse.js';
+
+ if (empty($form[$filter_id]['#attached']['css'])) {
+ $form[$filter_id]['#attached']['css'] = array();
+ }
+ $form[$filter_id]['#attached']['css'][] = drupal_get_path('module', 'better_exposed_filters') . '/better_exposed_filters.css';
+
+ // Take care of adding the fieldset in the theme layer.
+ $form[$filter_id]['#theme'] = 'select_as_checkboxes_fieldset';
+ }
+ else {
+ $form[$filter_id]['#theme'] = 'select_as_checkboxes';
+ }
+
+ if ($options['more_options']['bef_select_all_none'] || $options['more_options']['bef_select_all_none_nested']) {
+ $bef_add_js = TRUE;
+
+ if ($options['more_options']['bef_select_all_none']) {
+ $form[$filter_id]['#bef_select_all_none'] = TRUE;
+ }
+ if ($options['more_options']['bef_select_all_none_nested']) {
+ $form[$filter_id]['#bef_select_all_none_nested'] = TRUE;
+ }
+ }
+ }
+ /* Ends: if (empty($form[$filter_id]['#multiple'])) { ... } else { */
+
+ // Add term descriptions, if appropriate. Pass along to theme
+ // functions for rendering.
+ if ($options['more_options']['bef_term_description'] && $filters[$filter_id] instanceof views_handler_filter_term_node_tid) {
+ $tids = array();
+ foreach ($form[$filter_id]['#options'] as $tid => $option) {
+ if (is_object($option)) {
+ reset($option->option);
+ list ($tid, ) = each($option->option);
+ }
+ $tids[] = $tid;
+ }
+ $terms = taxonomy_term_load_multiple($tids);
+ foreach ($terms as $tid => $term) {
+ $form[$filter_id]['#bef_term_descriptions'][$tid] = $term->description;
+ }
+ }
+ break;
+
+ case 'bef_hidden':
+ // Hide the label.
+ $form['#info'][$filter_key]['label'] = '';
+ if (empty($form[$filter_id]['#multiple'])) {
+ $form[$filter_id]['#type'] = 'hidden';
+ }
+ else {
+ $form[$filter_id]['#theme'] = 'select_as_hidden';
+ }
+ break;
+
+ default:
+ // Handles functionality for exposed filters that are not rendered
+ // using BEF.
+ $show_apply = TRUE;
+
+ // Add a description to the exposed filter.
+ if (!empty($options['more_options']['bef_filter_description'])) {
+ $children = element_children($form[$filter_id]);
+ if (count($children) > 1) {
+ // A filter may have multiple children if it's a in-between
+ // filter. In this case, put the description on the last item.
+ $form[$filter_id][end($children)]['#description'] = t($options['more_options']['bef_filter_description']);
+ }
+ else {
+ $form[$filter_id]['#description'] = t($options['more_options']['bef_filter_description']);
+ }
+ }
+ break;
+ }
+ /* Ends switch ($options['bef_format']) */
+
+ // Apply autosubmit filter values.
+ if (empty($this->options['autosubmit']) && !empty($options['more_options']['autosubmit'])) {
+ $bef_js['autosubmit'] = TRUE;
+
+ // Check type form element.
+ if (isset($form[$filter_id]['value'])) {
+ $form[$filter_id]['value'] = array_merge_recursive($form[$filter_id]['value'], array('#attributes' => array('class' => array('ctools-auto-submit'))));
+ }
+ else {
+ $form[$filter_id] = array_merge_recursive($form[$filter_id], array('#attributes' => array('class' => array('ctools-auto-submit'))));
+ }
+ }
+
+ // Override "Any" label, if applicable.
+ if (!empty($options['more_options']['any_label']) && !empty($form[$filter_id]['#options']['All'])) {
+ $form[$filter_id]['#options']['All'] = $options['more_options']['any_label'];
+ }
+
+ // Check if this is a secondary form element.
+ if ($allow_secondary && $settings[$label]['more_options']['is_secondary']) {
+ $identifier = $form['#info'][$filter_key]['value'];
+ if (!empty($form[$identifier])) {
+ // Move from the main form to the secondary options fieldset.
+ $children = element_children($form[$identifier]);
+ $secondary[$identifier] = $form[$identifier];
+ unset($form[$identifier]);
+
+ if (1 < count($children)) {
+ // Some elements can have multiple children, for example min/max
+ // fields on an in-between filter. In those cases Add the label
+ // to the first element.
+ $secondary[$identifier][$children[0]]['#title'] = isset($form['#info'][$filter_key]['label']) ? $form['#info'][$filter_key]['label'] : '';
+ unset($form['#info'][$filter_key]);
+ }
+ else {
+ $secondary[$identifier]['#title'] = isset($form['#info'][$filter_key]['label']) ? $form['#info'][$filter_key]['label'] : '';
+ unset($form['#info'][$filter_key]);
+ }
+
+ // Ensure secondary options respect ordering of filters. Pass this
+ // along to the theme function for rendering. Multiply existing
+ // position by 2 so that we have room to stick the exposed operator
+ // before the filter.
+ if (isset($filters[$identifier]->position)) {
+ $secondary[$identifier]['#bef_position'] = $filters[$identifier]->position * 2;
+ }
+
+ // Move exposed operators with exposed filters
+ if (!empty($filters[$label]->options['expose']['use_operator'])) {
+ $op_id = $filters[$label]->options['expose']['operator_id'];
+ $secondary[$op_id] = $form[$op_id];
+ unset($form[$op_id]);
+
+ // Make sure operators appear just before the filter they are
+ // associated with.
+ if (isset($filters[$identifier]->position)) {
+ $secondary[$op_id]['#bef_position'] = ($filters[$identifier]->position * 2) - 1;
+ }
+ }
+ }
+ }
+ }
+
+ // If our form has no visible filters, hide the submit button.
+ if (!$show_apply) {
+ if (isset($form['submit'])) {
+ $form['submit']['#attributes']['class'][] = 'element-hidden';
+ }
+ if (isset($form['reset'])) {
+ $form['reset']['#attributes']['class'][] = 'element-hidden';
+ }
+ }
+
+ // Add Javascript as needed.
+ if ($bef_add_js) {
+ // Add jQuery UI library code as needed.
+ if ($bef_js['datepicker']) {
+ drupal_add_library('system', 'ui.datepicker');
+ }
+ if ($bef_js['slider']) {
+ drupal_add_library('system', 'ui.slider');
+ }
+ if ($bef_js['autosubmit']) {
+ $form['submit']['#attributes']['class'][] = 'ctools-use-ajax';
+ $form['submit']['#attributes']['class'][] = 'ctools-auto-submit-click';
+ $form['#attached']['js'][] = drupal_get_path('module', 'ctools') . '/js/auto-submit.js';
+ }
+
+ drupal_add_js(array('better_exposed_filters' => $bef_js), 'setting');
+ drupal_add_js(drupal_get_path('module', 'better_exposed_filters') . '/better_exposed_filters.js');
+ }
+ if ($bef_add_css) {
+ drupal_add_css(drupal_get_path('module', 'better_exposed_filters') . '/better_exposed_filters.css');
+ }
+
+ // Check for secondary elements.
+ if ($allow_secondary && !empty($secondary)) {
+ // Add secondary elements after regular exposed filter elements.
+ $remaining = array_splice($form, count($form['#info']) + 1);
+ $form['secondary'] = $secondary;
+ $form = array_merge($form, $remaining);
+ $form['#info']['filter-secondary']['value'] = 'secondary';
+ }
+ }
+
+ /**
+ * Fills in missing settings with default values.
+ *
+ * Similar to array_merge_recursive, but later numeric keys overwrites earlier
+ * values. Use this to set defaults for missing values in a multi-dimensional
+ * array. Eg:
+ *
+ * $existing = $this->_bef_set_defaults($defaults, $existing);
+ *
+ * @return array
+ * The resulting settings array
+ */
+ function _bef_set_defaults() {
+ $count = func_num_args();
+ if (!$count) {
+ return;
+ }
+ elseif (1 == $count) {
+ return (func_get_arg(0));
+ }
+
+ // First array is the default values.
+ $params = func_get_args();
+ $return = array_shift($params);
+
+ // Merge the rest of the arrays onto the default array.
+ foreach ($params as $array) {
+ foreach ($array as $key => $value) {
+ // Numeric keyed values are added (unless already there).
+ if (is_numeric($key) && !in_array($value, $return)) {
+ if (is_array($value)) {
+ $return[] = $this->_bef_set_defaults($return[$key], $value);
+ }
+ else {
+ $return[] = $value;
+ }
+ }
+ // String keyed values are replaced.
+ else {
+ if (isset($return[$key]) && is_array($value) && is_array($return[$key])) {
+ $return[$key] = $this->_bef_set_defaults($return[$key], $value);
+ }
+ else {
+ $return[$key] = $value;
+ }
+ }
+ }
+ }
+ return $return;
+ }
+
+ /**
+ * Updates legacy settings to their current location.
+ *
+ * @param array $settings
+ * Array of BEF settings.
+ */
+ function _bef_update_legacy_settings($settings) {
+ // There has got to be a better way... But for now, this works.
+ if (isset($settings['sort']['collapsible'])) {
+ $settings['sort']['advanced']['collapsible'] = $settings['sort']['collapsible'];
+ unset($settings['sort']['collapsible']);
+ }
+ if (isset($settings['sort']['collapsible_label'])) {
+ $settings['sort']['advanced']['collapsible_label'] = $settings['sort']['collapsible_label'];
+ unset($settings['sort']['collapsible_label']);
+ }
+ if (isset($settings['sort']['combine'])) {
+ $settings['sort']['advanced']['combine'] = $settings['sort']['combine'];
+ unset($settings['sort']['combine']);
+ }
+ if (isset($settings['sort']['reset'])) {
+ $settings['sort']['advanced']['reset'] = $settings['sort']['reset'];
+ unset($settings['sort']['reset']);
+ }
+ if (isset($settings['sort']['reset_label'])) {
+ $settings['sort']['advanced']['reset_label'] = $settings['sort']['reset_label'];
+ unset($settings['sort']['reset_label']);
+ }
+
+ // Input required was originally stored in Views' options, not in BEF's
+ // settings.
+ if (isset($this->options['input_required'])) {
+ $settings['general']['input_required'] = $this->options['input_required'];
+ }
+ if (isset($this->options['input_required']['text_input_required'])) {
+ $settings['general']['input_required']['text_input_required']['text_input_required'] = $this->options['text_input_required'];
+ }
+ if (isset($this->options['input_required']['text_input_required_format'])) {
+ $settings['general']['input_required']['text_input_required']['text_input_required_format'] = $this->options['text_input_required_format'];
+ }
+
+ return $settings;
+ }
+
+ /**
+ * Returns an array of default or current existing values for BEF settings.
+ *
+ * This helps us as we add new options and prevents a lot of
+ * @code
+ * if (isset($settings['new_settings'])) { ... }
+ * @endcode
+ * as there will be a default value at all positions in the settings array.
+ * Also updates legacy settings to their new locations via
+ * _bef_update_legacy_settings().
+ *
+ * @return array
+ * Multi-dimensional settings array.
+ */
+ function _bef_get_settings() {
+ // General, sort, pagers, etc.
+ $defaults = array(
+ 'general' => array(
+ 'input_required' => FALSE,
+ 'text_input_required' => array(
+ 'text_input_required' => array(
+ 'value' => t('Select any filter and click on Apply to see results'),
+ 'format' => filter_default_format(),
+ ),
+ ),
+ 'allow_secondary' => FALSE,
+ 'secondary_label' => t('Advanced options'),
+ 'secondary_collapse_override' => 0,
+ ),
+ 'sort' => array(
+ 'bef_format' => 'default',
+ 'advanced' => array(
+ 'collapsible' => FALSE,
+ 'collapsible_label' => '',
+ 'combine' => FALSE,
+ 'combine_param' => 'sort_bef_combine',
+ 'combine_rewrite' => '',
+ 'reset' => FALSE,
+ 'reset_label' => '',
+ 'is_secondary' => FALSE,
+ 'autosubmit' => FALSE,
+ ),
+ ),
+ 'pager' => array(
+ 'bef_format' => 'default',
+ 'is_secondary' => FALSE,
+ ),
+ );
+
+ // Update legacy settings in the exposed form settings form. This
+ // keep us from losing settings when an option is put into an
+ // 'advanced options' fieldset.
+ $current = $this->_bef_update_legacy_settings($this->options['bef']);
+
+ // Collect existing values or use defaults.
+ $settings = $this->_bef_set_defaults($defaults, $current);
+
+ // Filter default values.
+ $filter_defaults = array(
+ 'bef_format' => 'default',
+ 'more_options' => array(
+ 'bef_select_all_none' => FALSE,
+ 'bef_select_all_none_nested' => FALSE,
+ 'bef_collapsible' => FALSE,
+ 'is_secondary' => FALSE,
+ 'bef_filter_description' => '',
+ 'any_label' => '',
+ 'bef_term_description' => FALSE,
+ 'autosubmit' => FALSE,
+ 'tokens' => array(
+ 'list' => array(),
+ 'available' => array(),
+ ),
+ 'rewrite' => array(
+ 'filter_rewrite_values' => '',
+ ),
+ 'datepicker_options' => '',
+ ),
+ 'slider_options' => array(
+ 'bef_slider_min' => 0,
+ 'bef_slider_max' => 99999,
+ 'bef_slider_step' => 1,
+ 'bef_slider_animate' => '',
+ 'bef_slider_orientation' => 'horizontal',
+ ),
+ );
+
+ // Go through each exposed filter and collect settings.
+ foreach ($this->display->handler->get_handlers('filter') as $label => $filter) {
+ if (!$filter->options['exposed']) {
+ continue;
+ }
+
+ // Get existing values or use defaults.
+ $filter_current = isset($this->options['bef'][$label]) ? $this->options['bef'][$label] : array();
+ $settings[$label] = $this->_bef_set_defaults($filter_defaults, $filter_current);
+ }
+ return $settings;
+ }
+
+ /**
+ * Utility function to determine if any filters have been applied.
+ * Borrowed from views_plugin_exposed_form_input_required
+ */
+ function exposed_filter_applied() {
+ static $cache = NULL;
+ if (!isset($cache)) {
+ $view = $this->view;
+ if (is_array($view->filter) && count($view->filter)) {
+ foreach ($view->filter as $filter_id => $filter) {
+ if ($filter->is_exposed()) {
+ $identifier = $filter->options['expose']['identifier'];
+ if (isset($view->exposed_input[$identifier])) {
+ if (!empty($view->exposed_input[$identifier])) {
+ $cache = TRUE;
+ return $cache;
+ }
+ }
+ }
+ }
+ }
+ $cache = FALSE;
+ }
+
+ return $cache;
+ }
+
+ /**
+ * Pre render callback to append the 'no values found' text if input required
+ * options is enabled.
+ */
+ function pre_render($values) {
+ $bef_settings = $this->_bef_get_settings();
+ if (!$this->exposed_filter_applied() && !empty($bef_settings['general']['input_required'])) {
+ $options = array(
+ 'id' => 'area',
+ 'table' => 'views',
+ 'field' => 'area',
+ 'label' => '',
+ 'relationship' => 'none',
+ 'group_type' => 'group',
+ 'content' => $bef_settings['general']['text_input_required']['text_input_required']['value'],
+ 'format' => $bef_settings['general']['text_input_required']['text_input_required']['format'],
+ 'empty' => TRUE,
+ );
+ $handler = views_get_handler('views', 'area', 'area');
+ $handler->init($this->view, $options);
+ $this->display->handler->handlers['empty'] = array(
+ 'area' => $handler,
+ );
+ $this->display->handler->set_option('empty', array('text' => $options));
+ }
+ }
+
+ /**
+ * Query callback, intervenes if no filters are applied and input is required.
+ */
+ function query() {
+ $bef_settings = $this->_bef_get_settings();
+ if (!$this->exposed_filter_applied() && !empty($bef_settings['general']['input_required'])) {
+ // We return with no query; this will force the empty text.
+ $this->view->built = TRUE;
+ $this->view->executed = TRUE;
+ $this->view->result = array();
+ }
+ else {
+ parent::query();
+ }
+ }
+
+ function unpack_translatable_options(&$translatable, $storage, $option, $definition, $parents) {
+ foreach ($this->unpack_translatable_keys() as $key) {
+ $value = drupal_array_get_nested_value($this->options, $key);
+ if (!empty($value)) {
+ $translatable[] = array(
+ 'value' => $value,
+ 'keys' => $key,
+ 'format' => NULL,
+ );
+ }
+ }
+ }
+
+ function unpack_translatable_keys() {
+ // Default options.
+ $keys = array(
+ // @TODO: Do we need to give this a better key so it makes more sense in
+ // the localization UI?
+ 'value' => array('bef', 'general', 'text_input_required', 'text_input_required', 'value'),
+
+ 'general_secondary_label' => array('bef', 'general', 'secondary_label'),
+ 'sort_collapsible_label' => array('bef', 'sort', 'advanced', 'collapsible_label'),
+ 'sort_combine_rewrite' => array('bef', 'sort', 'advanced', 'combine_rewrite'),
+ 'sort_reset_label' => array('bef', 'sort', 'advanced', 'reset_label'),
+ );
+
+ // Exposed filter options.
+ foreach ($this->display->handler->get_handlers('filter') as $label => $filter) {
+ if (!$filter->options['exposed']) {
+ continue;
+ }
+ $keys[$label . '_filter_description'] = array('bef', $label, 'more_options', 'bef_filter_description');
+ $keys[$label . '_any_label'] = array('bef', $label, 'more_options', 'any_label');
+ $keys[$label . '_rewrite_values'] = array('bef', $label, 'more_options', 'rewrite', 'filter_rewrite_values');
+ $keys[$label . '_datepicker_options'] = array('bef', $label, 'more_options', 'datepicker_options');
+ }
+
+ return $keys;
+ }
+
+ function unpack_options(&$storage, $options, $definition = NULL, $all = TRUE, $check = TRUE, $localization_keys = array()) {
+ parent::unpack_options($storage, $options, $definition, $all, $check, $localization_keys);
+
+ // Override the values.
+ foreach ($this->localization_keys as $key => $parents) {
+ $parent = end($parents);
+ $value = isset($options[$parent]) ? $options[$parent] : NULL;
+
+ // Don't localize strings during editing. When editing, we need to work with
+ // the original data, not the translated version.
+ if (empty($this->view->editing) && !empty($value)) {
+ if (!empty($this->view) && $this->view->is_translatable()) {
+ // Allow other modules to make changes to the string before it's
+ // sent for translation.
+ // The $keys array is built from the bef form array structure.
+ $format = NULL;
+ $translation_data = array(
+ 'value' => $value,
+ 'format' => $format,
+ 'keys' => $parents,
+ );
+ $storage[$parent] = $this->view->localization_plugin->translate($translation_data);
+ }
+ // Otherwise, this is a code-based string, so we can use t().
+ else {
+ $storage[$parent] = t($value);
+ }
+ }
+ else if (!empty($value)) {
+ $storage[$parent] = $value;
+ }
+ }
+ }
+}
diff --git a/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.features.field_base.inc b/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.features.field_base.inc
new file mode 100644
index 0000000..234588f
--- /dev/null
+++ b/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.features.field_base.inc
@@ -0,0 +1,184 @@
+ 1,
+ 'cardinality' => 1,
+ 'deleted' => 0,
+ 'entity_types' => array(),
+ 'field_name' => 'field_bef_test_body',
+ 'indexes' => array(
+ 'format' => array(
+ 0 => 'format',
+ ),
+ ),
+ 'locked' => 0,
+ 'module' => 'text',
+ 'settings' => array(),
+ 'translatable' => 0,
+ 'type' => 'text_with_summary',
+ );
+
+ // Exported field_base: 'field_bef_test_date'
+ $field_bases['field_bef_test_date'] = array(
+ 'active' => 1,
+ 'cardinality' => 1,
+ 'deleted' => 0,
+ 'entity_types' => array(),
+ 'field_name' => 'field_bef_test_date',
+ 'indexes' => array(),
+ 'locked' => 0,
+ 'module' => 'date',
+ 'settings' => array(
+ 'cache_count' => 4,
+ 'cache_enabled' => 0,
+ 'granularity' => array(
+ 'day' => 'day',
+ 'hour' => 0,
+ 'minute' => 0,
+ 'month' => 'month',
+ 'second' => 0,
+ 'year' => 'year',
+ ),
+ 'timezone_db' => '',
+ 'todate' => '',
+ 'tz_handling' => 'none',
+ ),
+ 'translatable' => 0,
+ 'type' => 'datetime',
+ );
+
+ // Exported field_base: 'field_bef_test_integer'
+ $field_bases['field_bef_test_integer'] = array(
+ 'active' => 1,
+ 'cardinality' => 1,
+ 'deleted' => 0,
+ 'entity_types' => array(),
+ 'field_name' => 'field_bef_test_integer',
+ 'indexes' => array(),
+ 'locked' => 0,
+ 'module' => 'number',
+ 'settings' => array(),
+ 'translatable' => 0,
+ 'type' => 'number_integer',
+ );
+
+ // Exported field_base: 'field_bef_test_letters'
+ $field_bases['field_bef_test_letters'] = array(
+ 'active' => 1,
+ 'cardinality' => -1,
+ 'deleted' => 0,
+ 'entity_types' => array(),
+ 'field_name' => 'field_bef_test_letters',
+ 'indexes' => array(
+ 'value' => array(
+ 0 => 'value',
+ ),
+ ),
+ 'locked' => 0,
+ 'module' => 'list',
+ 'settings' => array(
+ 'allowed_values' => array(
+ 'a' => 'Aardvark',
+ 'b' => 'Bumble-Bee',
+ 'c' => ' Caterpillar',
+ 'd' => 'Devil, Tasmanian',
+ 'e' => 'Elephant',
+ 'f' => 'Frigatebird',
+ 'g' => 'Giraffe',
+ 'h' => 'Horse',
+ ),
+ 'allowed_values_function' => '',
+ ),
+ 'translatable' => 0,
+ 'type' => 'list_text',
+ );
+
+ // Exported field_base: 'field_bef_test_location'
+ $field_bases['field_bef_test_location'] = array(
+ 'active' => 1,
+ 'cardinality' => 1,
+ 'deleted' => 0,
+ 'entity_types' => array(),
+ 'field_name' => 'field_bef_test_location',
+ 'indexes' => array(
+ 'tid' => array(
+ 0 => 'tid',
+ ),
+ ),
+ 'locked' => 0,
+ 'module' => 'taxonomy',
+ 'settings' => array(
+ 'allowed_values' => array(
+ 0 => array(
+ 'vocabulary' => 'taxonomy-bef_test-location',
+ 'parent' => 0,
+ ),
+ ),
+ ),
+ 'translatable' => 0,
+ 'type' => 'taxonomy_term_reference',
+ );
+
+ // Exported field_base: 'field_bef_test_numbers'
+ $field_bases['field_bef_test_numbers'] = array(
+ 'active' => 1,
+ 'cardinality' => 1,
+ 'deleted' => 0,
+ 'entity_types' => array(),
+ 'field_name' => 'field_bef_test_numbers',
+ 'indexes' => array(
+ 'value' => array(
+ 0 => 'value',
+ ),
+ ),
+ 'locked' => 0,
+ 'module' => 'list',
+ 'settings' => array(
+ 'allowed_values' => array(
+ 1 => 'One',
+ 2 => 'Two',
+ 3 => 'Three',
+ 4 => 'Four',
+ 5 => 'Five',
+ 6 => 'Six',
+ 7 => 'Seven',
+ 8 => 'Eight',
+ 9 => 'Nine',
+ 10 => 'Ten',
+ ),
+ 'allowed_values_function' => '',
+ ),
+ 'translatable' => 0,
+ 'type' => 'list_integer',
+ );
+
+ // Exported field_base: 'field_bef_test_price'
+ $field_bases['field_bef_test_price'] = array(
+ 'active' => 1,
+ 'cardinality' => 1,
+ 'deleted' => 0,
+ 'entity_types' => array(),
+ 'field_name' => 'field_bef_test_price',
+ 'indexes' => array(),
+ 'locked' => 0,
+ 'module' => 'number',
+ 'settings' => array(
+ 'decimal_separator' => '.',
+ ),
+ 'translatable' => 0,
+ 'type' => 'number_float',
+ );
+
+ return $field_bases;
+}
diff --git a/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.features.field_instance.inc b/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.features.field_instance.inc
new file mode 100644
index 0000000..72b897b
--- /dev/null
+++ b/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.features.field_instance.inc
@@ -0,0 +1,322 @@
+ 'bef_test',
+ 'default_value' => NULL,
+ 'deleted' => 0,
+ 'description' => '',
+ 'display' => array(
+ 'default' => array(
+ 'label' => 'above',
+ 'module' => 'text',
+ 'settings' => array(),
+ 'type' => 'text_default',
+ 'weight' => 12,
+ ),
+ 'teaser' => array(
+ 'label' => 'above',
+ 'settings' => array(),
+ 'type' => 'hidden',
+ 'weight' => 0,
+ ),
+ ),
+ 'entity_type' => 'node',
+ 'field_name' => 'field_bef_test_body',
+ 'label' => 'Body',
+ 'required' => 0,
+ 'settings' => array(
+ 'display_summary' => 0,
+ 'text_processing' => 1,
+ 'user_register_form' => FALSE,
+ ),
+ 'widget' => array(
+ 'active' => 1,
+ 'module' => 'text',
+ 'settings' => array(
+ 'rows' => 20,
+ 'summary_rows' => 5,
+ ),
+ 'type' => 'text_textarea_with_summary',
+ 'weight' => 7,
+ ),
+ );
+
+ // Exported field_instance: 'node-bef_test-field_bef_test_date'
+ $field_instances['node-bef_test-field_bef_test_date'] = array(
+ 'bundle' => 'bef_test',
+ 'deleted' => 0,
+ 'description' => '',
+ 'display' => array(
+ 'default' => array(
+ 'label' => 'above',
+ 'module' => 'date',
+ 'settings' => array(
+ 'format_type' => 'long',
+ 'fromto' => 'both',
+ 'multiple_from' => '',
+ 'multiple_number' => '',
+ 'multiple_to' => '',
+ ),
+ 'type' => 'date_default',
+ 'weight' => 11,
+ ),
+ 'teaser' => array(
+ 'label' => 'above',
+ 'settings' => array(),
+ 'type' => 'hidden',
+ 'weight' => 0,
+ ),
+ ),
+ 'entity_type' => 'node',
+ 'field_name' => 'field_bef_test_date',
+ 'label' => 'Date',
+ 'required' => 0,
+ 'settings' => array(
+ 'default_value' => 'now',
+ 'default_value2' => 'same',
+ 'default_value_code' => '',
+ 'default_value_code2' => '',
+ 'user_register_form' => FALSE,
+ ),
+ 'widget' => array(
+ 'active' => 1,
+ 'module' => 'date',
+ 'settings' => array(
+ 'increment' => 15,
+ 'input_format' => 'm/d/Y - H:i:s',
+ 'input_format_custom' => '',
+ 'label_position' => 'above',
+ 'text_parts' => array(),
+ 'year_range' => '-3:+3',
+ ),
+ 'type' => 'date_text',
+ 'weight' => 6,
+ ),
+ );
+
+ // Exported field_instance: 'node-bef_test-field_bef_test_integer'
+ $field_instances['node-bef_test-field_bef_test_integer'] = array(
+ 'bundle' => 'bef_test',
+ 'default_value' => NULL,
+ 'deleted' => 0,
+ 'description' => '',
+ 'display' => array(
+ 'default' => array(
+ 'label' => 'above',
+ 'module' => 'number',
+ 'settings' => array(
+ 'decimal_separator' => '.',
+ 'prefix_suffix' => TRUE,
+ 'scale' => 0,
+ 'thousand_separator' => ' ',
+ ),
+ 'type' => 'number_integer',
+ 'weight' => 10,
+ ),
+ 'teaser' => array(
+ 'label' => 'above',
+ 'settings' => array(),
+ 'type' => 'hidden',
+ 'weight' => 0,
+ ),
+ ),
+ 'entity_type' => 'node',
+ 'field_name' => 'field_bef_test_integer',
+ 'label' => 'Integer',
+ 'required' => 0,
+ 'settings' => array(
+ 'max' => 5000,
+ 'min' => 100,
+ 'prefix' => '',
+ 'suffix' => '',
+ 'user_register_form' => FALSE,
+ ),
+ 'widget' => array(
+ 'active' => 0,
+ 'module' => 'number',
+ 'settings' => array(),
+ 'type' => 'number',
+ 'weight' => 4,
+ ),
+ );
+
+ // Exported field_instance: 'node-bef_test-field_bef_test_letters'
+ $field_instances['node-bef_test-field_bef_test_letters'] = array(
+ 'bundle' => 'bef_test',
+ 'default_value' => NULL,
+ 'deleted' => 0,
+ 'description' => '',
+ 'display' => array(
+ 'default' => array(
+ 'label' => 'above',
+ 'module' => 'list',
+ 'settings' => array(),
+ 'type' => 'list_default',
+ 'weight' => 7,
+ ),
+ 'teaser' => array(
+ 'label' => 'above',
+ 'settings' => array(),
+ 'type' => 'hidden',
+ 'weight' => 0,
+ ),
+ ),
+ 'entity_type' => 'node',
+ 'field_name' => 'field_bef_test_letters',
+ 'label' => 'Letters',
+ 'required' => 0,
+ 'settings' => array(
+ 'user_register_form' => FALSE,
+ ),
+ 'widget' => array(
+ 'active' => 1,
+ 'module' => 'options',
+ 'settings' => array(),
+ 'type' => 'options_buttons',
+ 'weight' => 1,
+ ),
+ );
+
+ // Exported field_instance: 'node-bef_test-field_bef_test_location'
+ $field_instances['node-bef_test-field_bef_test_location'] = array(
+ 'bundle' => 'bef_test',
+ 'default_value' => NULL,
+ 'deleted' => 0,
+ 'description' => '',
+ 'display' => array(
+ 'default' => array(
+ 'label' => 'above',
+ 'module' => 'taxonomy',
+ 'settings' => array(),
+ 'type' => 'taxonomy_term_reference_link',
+ 'weight' => 9,
+ ),
+ 'teaser' => array(
+ 'label' => 'above',
+ 'settings' => array(),
+ 'type' => 'hidden',
+ 'weight' => 0,
+ ),
+ ),
+ 'entity_type' => 'node',
+ 'field_name' => 'field_bef_test_location',
+ 'label' => 'Location',
+ 'required' => 0,
+ 'settings' => array(
+ 'user_register_form' => FALSE,
+ ),
+ 'widget' => array(
+ 'active' => 1,
+ 'module' => 'options',
+ 'settings' => array(),
+ 'type' => 'options_buttons',
+ 'weight' => 3,
+ ),
+ );
+
+ // Exported field_instance: 'node-bef_test-field_bef_test_numbers'
+ $field_instances['node-bef_test-field_bef_test_numbers'] = array(
+ 'bundle' => 'bef_test',
+ 'default_value' => NULL,
+ 'deleted' => 0,
+ 'description' => '',
+ 'display' => array(
+ 'default' => array(
+ 'label' => 'above',
+ 'module' => 'list',
+ 'settings' => array(),
+ 'type' => 'list_default',
+ 'weight' => 8,
+ ),
+ 'teaser' => array(
+ 'label' => 'above',
+ 'settings' => array(),
+ 'type' => 'hidden',
+ 'weight' => 0,
+ ),
+ ),
+ 'entity_type' => 'node',
+ 'field_name' => 'field_bef_test_numbers',
+ 'label' => 'Numbers',
+ 'required' => 0,
+ 'settings' => array(
+ 'user_register_form' => FALSE,
+ ),
+ 'widget' => array(
+ 'active' => 1,
+ 'module' => 'options',
+ 'settings' => array(),
+ 'type' => 'options_select',
+ 'weight' => 2,
+ ),
+ );
+
+ // Exported field_instance: 'node-bef_test-field_bef_test_price'
+ $field_instances['node-bef_test-field_bef_test_price'] = array(
+ 'bundle' => 'bef_test',
+ 'default_value' => NULL,
+ 'deleted' => 0,
+ 'description' => '',
+ 'display' => array(
+ 'default' => array(
+ 'label' => 'above',
+ 'module' => 'number',
+ 'settings' => array(
+ 'decimal_separator' => '.',
+ 'prefix_suffix' => TRUE,
+ 'scale' => 2,
+ 'thousand_separator' => ' ',
+ ),
+ 'type' => 'number_decimal',
+ 'weight' => 13,
+ ),
+ 'teaser' => array(
+ 'label' => 'above',
+ 'settings' => array(),
+ 'type' => 'hidden',
+ 'weight' => 0,
+ ),
+ ),
+ 'entity_type' => 'node',
+ 'field_name' => 'field_bef_test_price',
+ 'label' => 'Price',
+ 'required' => 0,
+ 'settings' => array(
+ 'max' => '',
+ 'min' => '',
+ 'prefix' => '$',
+ 'suffix' => '',
+ 'user_register_form' => FALSE,
+ ),
+ 'widget' => array(
+ 'active' => 0,
+ 'module' => 'number',
+ 'settings' => array(),
+ 'type' => 'number',
+ 'weight' => 5,
+ ),
+ );
+
+ // Translatables
+ // Included for use with string extractors like potx.
+ t('Body');
+ t('Date');
+ t('Integer');
+ t('Letters');
+ t('Location');
+ t('Numbers');
+ t('Price');
+
+ return $field_instances;
+}
diff --git a/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.features.inc b/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.features.inc
new file mode 100644
index 0000000..ff5d275
--- /dev/null
+++ b/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.features.inc
@@ -0,0 +1,30 @@
+ "3.0");
+}
+
+/**
+ * Implements hook_node_info().
+ */
+function bef_test_content_node_info() {
+ $items = array(
+ 'bef_test' => array(
+ 'name' => t('bef_test'),
+ 'base' => 'node_content',
+ 'description' => '',
+ 'has_title' => '1',
+ 'title_label' => t('Title'),
+ 'help' => '',
+ ),
+ );
+ drupal_alter('node_info', $items);
+ return $items;
+}
diff --git a/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.features.taxonomy.inc b/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.features.taxonomy.inc
new file mode 100644
index 0000000..bbbe7ef
--- /dev/null
+++ b/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.features.taxonomy.inc
@@ -0,0 +1,36 @@
+ array(
+ 'name' => 'Location',
+ 'machine_name' => 'taxonomy-bef_test-location',
+ 'description' => '',
+ 'hierarchy' => 1,
+ 'module' => 'taxonomy',
+ 'weight' => 0,
+ 'rdf_mapping' => array(
+ 'rdftype' => array(
+ 0 => 'skos:ConceptScheme',
+ ),
+ 'name' => array(
+ 'predicates' => array(
+ 0 => 'dc:title',
+ ),
+ ),
+ 'description' => array(
+ 'predicates' => array(
+ 0 => 'rdfs:comment',
+ ),
+ ),
+ ),
+ ),
+ );
+}
diff --git a/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.info b/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.info
new file mode 100644
index 0000000..6305b8d
--- /dev/null
+++ b/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.info
@@ -0,0 +1,49 @@
+name = BEF Test Content
+description = Content and Views for testing Better Exposed Filters.
+core = 7.x
+package = BEF Tests
+dependencies[] = better_exposed_filters
+dependencies[] = date
+dependencies[] = features
+dependencies[] = list
+dependencies[] = number
+dependencies[] = taxonomy
+dependencies[] = text
+dependencies[] = views
+dependencies[] = views_content
+features[ctools][] = views:views_default:3.0
+features[features_api][] = api:2
+features[field_base][] = field_bef_test_body
+features[field_base][] = field_bef_test_date
+features[field_base][] = field_bef_test_integer
+features[field_base][] = field_bef_test_letters
+features[field_base][] = field_bef_test_location
+features[field_base][] = field_bef_test_numbers
+features[field_base][] = field_bef_test_price
+features[field_instance][] = node-bef_test-field_bef_test_body
+features[field_instance][] = node-bef_test-field_bef_test_date
+features[field_instance][] = node-bef_test-field_bef_test_integer
+features[field_instance][] = node-bef_test-field_bef_test_letters
+features[field_instance][] = node-bef_test-field_bef_test_location
+features[field_instance][] = node-bef_test-field_bef_test_numbers
+features[field_instance][] = node-bef_test-field_bef_test_price
+features[node][] = bef_test
+features[taxonomy][] = taxonomy-bef_test-location
+features[views_view][] = bef_test_view
+features_exclude[dependencies][ctools] = ctools
+features_exclude[dependencies][options] = options
+features_exclude[field][node-bef_test-body] = node-bef_test-body
+features_exclude[field][node-bef_test-field_letters] = node-bef_test-field_letters
+features_exclude[field][node-bef_test-field_numbers] = node-bef_test-field_numbers
+features_exclude[field][node-bef_test-field_location] = node-bef_test-field_location
+features_exclude[field][node-bef_test-field_integer] = node-bef_test-field_integer
+features_exclude[field][node-bef_test-field_price] = node-bef_test-field_price
+features_exclude[field][node-bef_test-field_date] = node-bef_test-field_date
+hidden = 1
+
+; Information added by Drupal.org packaging script on 2017-01-13
+version = "7.x-3.3"
+core = "7.x"
+project = "better_exposed_filters"
+datestamp = "1484287088"
+
diff --git a/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.install b/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.install
new file mode 100644
index 0000000..ed3b317
--- /dev/null
+++ b/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.install
@@ -0,0 +1,81 @@
+ array(
+ 'California' => array(
+ 'San Francisco',
+ 'San Diego',
+ 'Santa Barbara',
+ ),
+ 'Oregon' => array(
+ 'Portland',
+ 'Eugene',
+ ),
+ 'Washington' => array(
+ 'Seattle',
+ 'Spokane',
+ 'Walla Walla',
+ ),
+ ),
+ 'Canada' => array(
+ 'British Columbia' => array(
+ 'Vancouver',
+ 'Victoria',
+ 'Whistler',
+ ),
+ 'Alberta' => array(
+ 'Calgary',
+ 'Edmonton',
+ 'Lake Louise',
+ ),
+ ),
+ 'Mexico' => array(),
+ );
+ foreach ($locations as $country => $states) {
+ $country_tid = _bef_test_content_add_term($country);
+ if ($country_tid && !empty($states)) {
+ foreach ($states as $state => $cities) {
+ $state_tid = _bef_test_content_add_term($state, $country_tid);
+ if ($state_tid && !empty($cities)) {
+ foreach ($cities as $city) {
+ _bef_test_content_add_term($city, $state_tid);
+ }
+ }
+ }
+ }
+ }
+}
+
+/**
+ * Adds a new term to the bef_test-location vocabulary. If a TID is specified
+ * in $parent, the new term is added as a child of that term.
+ *
+ * @param string $name
+ * The name of the new term.
+ * @param int $parent
+ * The (optional) TID of the parent term.
+ *
+ * @return int
+ * TID of the newly created term or 0 on an error.
+ */
+function _bef_test_content_add_term($name, $parent = 0) {
+ $term = new stdClass();
+ // Features manages to create a vocab machine name that includes illegal
+ // characters (taxonomy-bef_test-location -- the hyphen is not allowed). So
+ // we use the VID of the vocab instead.
+ $term->vid = 2;
+ $term->parent = $parent;
+ $term->name = $name;
+ if (taxonomy_term_save($term) == SAVED_NEW) {
+ return $term->tid;
+ }
+ return 0;
+}
diff --git a/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.module b/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.module
new file mode 100644
index 0000000..785a248
--- /dev/null
+++ b/sites/all/modules/better_exposed_filters/tests/bef_test_content/bef_test_content.module
@@ -0,0 +1,7 @@
+name = 'bef_test_view';
+ $view->description = '';
+ $view->tag = 'default';
+ $view->base_table = 'node';
+ $view->human_name = 'BEF Test View';
+ $view->core = 7;
+ $view->api_version = '3.0';
+ $view->disabled = FALSE; /* Edit this to true to make a default view disabled initially */
+
+ /* Display: Master */
+ $handler = $view->new_display('default', 'Master', 'default');
+ $handler->display->display_options['title'] = 'BEF Test View';
+ $handler->display->display_options['use_more_always'] = FALSE;
+ $handler->display->display_options['access']['type'] = 'perm';
+ $handler->display->display_options['cache']['type'] = 'none';
+ $handler->display->display_options['query']['type'] = 'views_query';
+ $handler->display->display_options['exposed_form']['type'] = 'better_exposed_filters';
+ $handler->display->display_options['exposed_form']['options']['bef'] = array(
+ 'general' => array(
+ 'allow_secondary' => 0,
+ 'secondary_label' => 'Advanced options',
+ 'secondary_collapse_override' => 0,
+ ),
+ 'sort' => array(
+ 'bef_format' => 'bef_toggle_links',
+ 'advanced' => array(
+ 'collapsible' => 0,
+ 'collapsible_label' => 'Sort options',
+ 'combine' => 1,
+ 'combine_rewrite' => '',
+ 'reset' => 0,
+ 'reset_label' => '',
+ 'is_secondary' => 0,
+ ),
+ ),
+ 'pager' => array(
+ 'bef_format' => 'bef_links',
+ 'is_secondary' => 0,
+ ),
+ 'field_bef_test_letters_value' => array(
+ 'bef_format' => 'default',
+ 'more_options' => array(
+ 'bef_select_all_none' => FALSE,
+ 'bef_collapsible' => 0,
+ 'is_secondary' => 0,
+ 'any_label' => 'Any Letter',
+ 'bef_filter_description' => '',
+ 'tokens' => array(
+ 'available' => array(
+ 0 => 'global_types',
+ ),
+ ),
+ 'rewrite' => array(
+ 'filter_rewrite_values' => '',
+ ),
+ ),
+ ),
+ 'field_bef_test_numbers_value' => array(
+ 'bef_format' => 'default',
+ 'more_options' => array(
+ 'bef_select_all_none' => FALSE,
+ 'bef_collapsible' => 0,
+ 'is_secondary' => 0,
+ 'any_label' => 'Any Number',
+ 'bef_filter_description' => '',
+ 'tokens' => array(
+ 'available' => array(
+ 0 => 'global_types',
+ ),
+ ),
+ 'rewrite' => array(
+ 'filter_rewrite_values' => '',
+ ),
+ ),
+ ),
+ 'type' => array(
+ 'bef_format' => 'default',
+ 'more_options' => array(
+ 'bef_select_all_none' => FALSE,
+ 'bef_collapsible' => 0,
+ 'is_secondary' => 0,
+ 'any_label' => 'Any Type',
+ 'bef_filter_description' => '',
+ 'tokens' => array(
+ 'available' => array(
+ 0 => 'global_types',
+ ),
+ ),
+ 'rewrite' => array(
+ 'filter_rewrite_values' => '',
+ ),
+ ),
+ ),
+ 'field_bef_test_location_tid' => array(
+ 'bef_format' => 'default',
+ 'more_options' => array(
+ 'bef_select_all_none' => FALSE,
+ 'bef_select_all_none_nested' => FALSE,
+ 'bef_collapsible' => 0,
+ 'is_secondary' => 0,
+ 'any_label' => 'Anywhere',
+ 'bef_filter_description' => '',
+ 'tokens' => array(
+ 'available' => array(
+ 0 => 'global_types',
+ ),
+ ),
+ 'rewrite' => array(
+ 'filter_rewrite_values' => '',
+ ),
+ ),
+ ),
+ );
+ $handler->display->display_options['pager']['type'] = 'full';
+ $handler->display->display_options['pager']['options']['items_per_page'] = '10';
+ $handler->display->display_options['pager']['options']['offset'] = '0';
+ $handler->display->display_options['pager']['options']['id'] = '0';
+ $handler->display->display_options['pager']['options']['quantity'] = '9';
+ $handler->display->display_options['pager']['options']['expose']['items_per_page'] = TRUE;
+ $handler->display->display_options['pager']['options']['expose']['items_per_page_label'] = 'Yo! Show me';
+ $handler->display->display_options['pager']['options']['expose']['items_per_page_options_all'] = TRUE;
+ $handler->display->display_options['pager']['options']['expose']['items_per_page_options_all_label'] = 'All dem things!';
+ $handler->display->display_options['style_plugin'] = 'table';
+ $handler->display->display_options['style_options']['columns'] = array(
+ 'title' => 'title',
+ 'field_letters' => 'field_letters',
+ 'field_numbers' => 'field_numbers',
+ );
+ $handler->display->display_options['style_options']['default'] = '-1';
+ $handler->display->display_options['style_options']['info'] = array(
+ 'title' => array(
+ 'sortable' => 0,
+ 'default_sort_order' => 'asc',
+ 'align' => '',
+ 'separator' => '',
+ 'empty_column' => 0,
+ ),
+ 'field_letters' => array(
+ 'align' => '',
+ 'separator' => '',
+ 'empty_column' => 0,
+ ),
+ 'field_numbers' => array(
+ 'sortable' => 0,
+ 'default_sort_order' => 'asc',
+ 'align' => '',
+ 'separator' => '',
+ 'empty_column' => 0,
+ ),
+ );
+ /* Field: Content: Title */
+ $handler->display->display_options['fields']['title']['id'] = 'title';
+ $handler->display->display_options['fields']['title']['table'] = 'node';
+ $handler->display->display_options['fields']['title']['field'] = 'title';
+ $handler->display->display_options['fields']['title']['label'] = '';
+ $handler->display->display_options['fields']['title']['alter']['word_boundary'] = FALSE;
+ $handler->display->display_options['fields']['title']['alter']['ellipsis'] = FALSE;
+ /* Field: Content: Post date */
+ $handler->display->display_options['fields']['created']['id'] = 'created';
+ $handler->display->display_options['fields']['created']['table'] = 'node';
+ $handler->display->display_options['fields']['created']['field'] = 'created';
+ $handler->display->display_options['fields']['created']['date_format'] = 'short';
+ /* Field: Content: Integer */
+ $handler->display->display_options['fields']['field_bef_test_integer']['id'] = 'field_bef_test_integer';
+ $handler->display->display_options['fields']['field_bef_test_integer']['table'] = 'field_data_field_bef_test_integer';
+ $handler->display->display_options['fields']['field_bef_test_integer']['field'] = 'field_bef_test_integer';
+ $handler->display->display_options['fields']['field_bef_test_integer']['settings'] = array(
+ 'thousand_separator' => ' ',
+ 'prefix_suffix' => 1,
+ );
+ /* Field: Content: Letters */
+ $handler->display->display_options['fields']['field_bef_test_letters']['id'] = 'field_bef_test_letters';
+ $handler->display->display_options['fields']['field_bef_test_letters']['table'] = 'field_data_field_bef_test_letters';
+ $handler->display->display_options['fields']['field_bef_test_letters']['field'] = 'field_bef_test_letters';
+ $handler->display->display_options['fields']['field_bef_test_letters']['delta_offset'] = '0';
+ /* Field: Content: Numbers */
+ $handler->display->display_options['fields']['field_bef_test_numbers']['id'] = 'field_bef_test_numbers';
+ $handler->display->display_options['fields']['field_bef_test_numbers']['table'] = 'field_data_field_bef_test_numbers';
+ $handler->display->display_options['fields']['field_bef_test_numbers']['field'] = 'field_bef_test_numbers';
+ /* Sort criterion: Content: Post date */
+ $handler->display->display_options['sorts']['created']['id'] = 'created';
+ $handler->display->display_options['sorts']['created']['table'] = 'node';
+ $handler->display->display_options['sorts']['created']['field'] = 'created';
+ $handler->display->display_options['sorts']['created']['order'] = 'DESC';
+ $handler->display->display_options['sorts']['created']['exposed'] = TRUE;
+ $handler->display->display_options['sorts']['created']['expose']['label'] = 'Post date';
+ /* Filter criterion: Content: Letters (field_bef_test_letters) */
+ $handler->display->display_options['filters']['field_bef_test_letters_value']['id'] = 'field_bef_test_letters_value';
+ $handler->display->display_options['filters']['field_bef_test_letters_value']['table'] = 'field_data_field_bef_test_letters';
+ $handler->display->display_options['filters']['field_bef_test_letters_value']['field'] = 'field_bef_test_letters_value';
+ $handler->display->display_options['filters']['field_bef_test_letters_value']['exposed'] = TRUE;
+ $handler->display->display_options['filters']['field_bef_test_letters_value']['expose']['operator_id'] = 'field_bef_test_letters_value_op';
+ $handler->display->display_options['filters']['field_bef_test_letters_value']['expose']['label'] = 'Letters';
+ $handler->display->display_options['filters']['field_bef_test_letters_value']['expose']['operator'] = 'field_bef_test_letters_value_op';
+ $handler->display->display_options['filters']['field_bef_test_letters_value']['expose']['identifier'] = 'field_bef_test_letters_value';
+ $handler->display->display_options['filters']['field_bef_test_letters_value']['expose']['remember_roles'] = array(
+ 2 => '2',
+ 1 => 0,
+ 3 => 0,
+ );
+ /* Filter criterion: Content: Numbers (field_bef_test_numbers) */
+ $handler->display->display_options['filters']['field_bef_test_numbers_value']['id'] = 'field_bef_test_numbers_value';
+ $handler->display->display_options['filters']['field_bef_test_numbers_value']['table'] = 'field_data_field_bef_test_numbers';
+ $handler->display->display_options['filters']['field_bef_test_numbers_value']['field'] = 'field_bef_test_numbers_value';
+ $handler->display->display_options['filters']['field_bef_test_numbers_value']['exposed'] = TRUE;
+ $handler->display->display_options['filters']['field_bef_test_numbers_value']['expose']['operator_id'] = 'field_bef_test_numbers_value_op';
+ $handler->display->display_options['filters']['field_bef_test_numbers_value']['expose']['label'] = 'Numbers';
+ $handler->display->display_options['filters']['field_bef_test_numbers_value']['expose']['operator'] = 'field_bef_test_numbers_value_op';
+ $handler->display->display_options['filters']['field_bef_test_numbers_value']['expose']['identifier'] = 'field_bef_test_numbers_value';
+ $handler->display->display_options['filters']['field_bef_test_numbers_value']['expose']['remember_roles'] = array(
+ 2 => '2',
+ 1 => 0,
+ 3 => 0,
+ );
+ /* Filter criterion: Content: Type */
+ $handler->display->display_options['filters']['type']['id'] = 'type';
+ $handler->display->display_options['filters']['type']['table'] = 'node';
+ $handler->display->display_options['filters']['type']['field'] = 'type';
+ $handler->display->display_options['filters']['type']['exposed'] = TRUE;
+ $handler->display->display_options['filters']['type']['expose']['operator_id'] = 'type_op';
+ $handler->display->display_options['filters']['type']['expose']['label'] = 'Type';
+ $handler->display->display_options['filters']['type']['expose']['operator'] = 'type_op';
+ $handler->display->display_options['filters']['type']['expose']['identifier'] = 'type';
+ $handler->display->display_options['filters']['type']['expose']['remember_roles'] = array(
+ 2 => '2',
+ 1 => 0,
+ 3 => 0,
+ );
+ /* Filter criterion: Content: Location (field_bef_test_location) */
+ $handler->display->display_options['filters']['field_bef_test_location_tid']['id'] = 'field_bef_test_location_tid';
+ $handler->display->display_options['filters']['field_bef_test_location_tid']['table'] = 'field_data_field_bef_test_location';
+ $handler->display->display_options['filters']['field_bef_test_location_tid']['field'] = 'field_bef_test_location_tid';
+ $handler->display->display_options['filters']['field_bef_test_location_tid']['exposed'] = TRUE;
+ $handler->display->display_options['filters']['field_bef_test_location_tid']['expose']['operator_id'] = 'field_bef_test_location_tid_op';
+ $handler->display->display_options['filters']['field_bef_test_location_tid']['expose']['label'] = 'Location';
+ $handler->display->display_options['filters']['field_bef_test_location_tid']['expose']['operator'] = 'field_bef_test_location_tid_op';
+ $handler->display->display_options['filters']['field_bef_test_location_tid']['expose']['identifier'] = 'field_bef_test_location_tid';
+ $handler->display->display_options['filters']['field_bef_test_location_tid']['expose']['remember_roles'] = array(
+ 2 => '2',
+ 1 => 0,
+ 3 => 0,
+ );
+ $handler->display->display_options['filters']['field_bef_test_location_tid']['type'] = 'select';
+ $handler->display->display_options['filters']['field_bef_test_location_tid']['vocabulary'] = 'taxonomy-bef_test-location';
+ $handler->display->display_options['filters']['field_bef_test_location_tid']['hierarchy'] = 1;
+
+ /* Display: Page */
+ $handler = $view->new_display('page', 'Page', 'page');
+ $handler->display->display_options['path'] = 'test';
+
+ /* Display: Content pane */
+ $handler = $view->new_display('panel_pane', 'Content pane', 'panel_pane_1');
+ $handler->display->display_options['exposed_block'] = TRUE;
+ $export['bef_test_view'] = $view;
+
+ return $export;
+}
diff --git a/sites/all/modules/better_exposed_filters/tests/better_exposed_filters.test b/sites/all/modules/better_exposed_filters/tests/better_exposed_filters.test
new file mode 100644
index 0000000..9784b8c
--- /dev/null
+++ b/sites/all/modules/better_exposed_filters/tests/better_exposed_filters.test
@@ -0,0 +1,935 @@
+ 'BEF Options tests',
+ 'description' => 'Checks that BEF options appear when should.',
+ 'group' => 'Better Exposed Filters',
+ );
+ }
+
+ /**
+ * Verify BEF options display for binary and unlimited option fields
+ */
+ public function test_befOptionsExist() {
+ // Add filters to the default display
+ $this->addFilter('node.title');
+ $this->addFilter('node.status');
+ $this->addFilter('node.type');
+ $this->drupalGet($this->getBefSettingsUrl());
+
+ $settings = array(
+ 'status_1' => 'Published',
+ 'type' => 'Type',
+ 'title' => 'Title'
+ );
+
+ foreach ($settings as $id => $label) {
+ $translation = array(
+ '!id' => $id,
+ '!label' => $label,
+ );
+ $this->assertRaw(
+ htmlentities(t('Display "!id" (Filter label: "!label") exposed filter as', $translation)),
+ t('BEF options exist for exposed "!id" filter', $translation)
+ );
+ $this->assertRaw(
+ htmlentities(t('More options for "!id" (Filter label: "!label")', $translation)),
+ t('BEF "More options" fieldset exists for exposed "!id" filter', $translation)
+ );
+ $this->assertField(
+ 'edit-exposed-form-options-bef-' . str_replace('_', '-', $id) . '-bef-format',
+ t('BEF options dropdown exists for "!id"', $translation)
+ );
+ }
+ }
+
+ /**
+ * Verify BEF options are saved and redisplayed properly
+ */
+ public function test_befOptionsSave() {
+ // Add filters to the default display
+ $this->addFilter('node.status');
+ $this->addFilter('node.type');
+ $this->saveView();
+
+ // Ensure basic BEF settings are preserved on save.
+ $settings = array(
+ 'status_1' => 'Published',
+ 'type' => 'Type',
+ );
+ foreach ($settings as $id => $label) {
+ $edit = array(
+ "exposed_form_options[bef][$id][bef_format]" => 'bef',
+ "exposed_form_options[bef][$id][more_options][bef_filter_description]" => $this->randomName(16),
+ "exposed_form_options[bef][$id][more_options][bef_collapsible]" => TRUE,
+ );
+ $this->setBefSettings($edit);
+ $this->saveView();
+ $this->drupalGet($this->getBefSettingsUrl());
+ foreach ($edit as $name => $expected) {
+ $this->assertFieldByName($name, $expected);
+ }
+ }
+
+ // Ensure View-based settings are preserved on save.
+ $edit = array(
+ 'exposed_form_options[bef][general][input_required]' => 1,
+ 'exposed_form_options[bef][general][allow_secondary]' => 1,
+ );
+ $this->setBefSettings($edit);
+ $this->saveView();
+ $this->drupalGet($this->getBefSettingsUrl());
+ foreach ($edit as $name => $expected) {
+ $this->assertFieldByName($name, $expected);
+ }
+
+ // This filter cannot use BEF settings. Ensure only generic settings are
+ // available for open text filters.
+ $this->addFilter('node.title');
+ $this->saveView();
+ $this->drupalGet($this->getBefSettingsUrl());
+ $this->assertNoFieldByName('exposed_form_options[bef][title][bef_format]', 'bef');
+ $edit = array(
+ "exposed_form_options[bef][$id][more_options][bef_filter_description]" => $this->randomName(16),
+ "exposed_form_options[bef][$id][more_options][bef_collapsible]" => TRUE,
+ );
+ $this->setBefSettings($edit);
+ $this->saveView();
+ $this->drupalGet($this->getBefSettingsUrl());
+ foreach ($edit as $name => $expected) {
+ $this->assertFieldByName($name, $expected);
+ }
+ }
+}
+
+class BEF_TestRadios extends BEF_TestBase {
+
+ /**
+ * Describes these tests to the testing framework.
+ */
+ public static function getInfo() {
+ return array(
+ 'name' => 'BEF radio button tests',
+ 'description' => 'Verifies rendering filters as radio buttons.',
+ 'group' => 'Better Exposed Filters',
+ );
+ }
+
+ /**
+ * Verify BEF radio buttons are rendered correctly on a page view.
+ */
+ public function test_befPageDisplayRadios() {
+ // Create a page display to validate rendering.
+ $this->createDisplay('Page', array(
+ 'path' => array('path' => 'bef_test_page'),
+ ));
+
+ // Verify radio button rendering with the node type filter.
+ $this->addFilter('node.type');
+ $this->setBefSettings(array(
+ 'exposed_form_options[bef][type][bef_format]' => 'bef',
+ ));
+ $this->saveView();
+
+ $this->drupalGet('bef_test_page');
+ $this->assertText(t('Type'), 'Exposed "Type" filter title renders correctly.');
+
+ // Exposed filter options render as radio buttons.
+ $this->assertFieldByXpath('//input[@name="type" and @type="radio" and @id="edit-type-all"]');
+ $this->assertFieldByXpath('//input[@name="type" and @type="radio" and @id="edit-type-article"]');
+ $this->assertFieldByXpath('//input[@name="type" and @type="radio" and @id="edit-type-page"]');
+ $this->assertFieldByXpath('//input[@name="type" and @type="radio" and @id="edit-type-bef-test"]');
+
+ // Now try it in a with the collapsible option.
+ $this->setBefSettings(array(
+ 'exposed_form_options[bef][type][more_options][bef_collapsible]' => TRUE,
+ ));
+ $this->saveView();
+ $this->drupalGet('bef_test_page');
+
+ // Exposed filter is shown as radio buttons enclosed within a fieldset.
+ $this->assertFieldByXpath('//fieldset//input[@name="type" and @type="radio" and @id="edit-type-all"]');
+ $this->assertFieldByXpath('//fieldset//input[@name="type" and @type="radio" and @id="edit-type-article"]');
+ $this->assertFieldByXpath('//fieldset//input[@name="type" and @type="radio" and @id="edit-type-page"]');
+ $this->assertFieldByXpath('//fieldset//input[@name="type" and @type="radio" and @id="edit-type-bef-test"]');
+
+ // Filter label is used as the fieldset legend
+ $this->assertFieldByXpath('//fieldset//legend[* = "Type"]');
+ }
+}
+
+class BEF_TestCheckboxes extends BEF_TestBase {
+
+ /**
+ * Describes these tests to the testing framework.
+ */
+ public static function getInfo() {
+ return array(
+ 'name' => 'BEF checkbox tests',
+ 'description' => 'Verifies rendering filter options as checkboxes.',
+ 'group' => 'Better Exposed Filters',
+ );
+ }
+
+ /**
+ * Verify that checkboxes are rendered correctly on a page display
+ */
+ public function test_befPageDisplayCheckboxes() {
+ // Create a page display to validate rendering.
+ $this->createDisplay('Page', array(
+ 'path' => array('path' => 'bef_test_page'),
+ ));
+
+ // Verify checkbox rendering with the node type filter.
+ $this->addFilter('node.type', array(
+ 'options[expose][multiple]' => TRUE,
+ ));
+ $this->setBefSettings(array(
+ 'exposed_form_options[bef][type][bef_format]' => 'bef',
+ ));
+ $this->saveView();
+
+ $this->drupalGet('bef_test_page');
+ $this->assertText(t('Type'), 'Exposed "Type" filter title renders correctly.');
+
+ // Exposed filter option render as checkboxes.
+ $this->assertFieldByXpath('//input[@name="type[]" and @type="checkbox" and @id="edit-type-article"]');
+ $this->assertFieldByXpath('//input[@name="type[]" and @type="checkbox" and @id="edit-type-page"]');
+ $this->assertFieldByXpath('//input[@name="type[]" and @type="checkbox" and @id="edit-type-bef-test"]');
+
+ // Verify classes added for select all/none functionality.
+ $this->assertNoFieldByXpath('//div[contains(@class, "bef-select-all-none")]');
+ $this->setBefSettings(array(
+ 'exposed_form_options[bef][type][more_options][bef_select_all_none]' => TRUE,
+ ));
+ $this->saveView();
+ $this->drupalGet('bef_test_page');
+ $this->assertFieldByXpath('//div[contains(@class, "bef-select-all-none")]');
+
+ // Now try it in a with the collapsible option.
+ $this->setBefSettings(array(
+ 'exposed_form_options[bef][type][more_options][bef_collapsible]' => TRUE,
+ ));
+ $this->saveView();
+ $this->drupalGet('bef_test_page');
+
+ // Exposed filter is shown as checkboxes enclosed within a fieldset.
+ $this->assertFieldByXpath('//fieldset//input[@name="type[]" and @type="checkbox" and @id="edit-type-article"]');
+ $this->assertFieldByXpath('//fieldset//input[@name="type[]" and @type="checkbox" and @id="edit-type-page"]');
+ $this->assertFieldByXpath('//fieldset//input[@name="type[]" and @type="checkbox" and @id="edit-type-bef-test"]');
+
+ // Filter label is used as the fieldset legend
+ $this->assertFieldByXpath('//fieldset//legend[* = "Type"]');
+
+ // Test the select all/none option in fieldsets.
+ $this->assertFieldByXpath('//fieldset//div[contains(@class, "bef-select-all-none")]');
+ }
+}
+
+class BEF_TestHidden extends BEF_TestBase {
+
+ /**
+ * Describes these tests to the testing framework.
+ */
+ public static function getInfo() {
+ return array(
+ 'name' => 'BEF hidden tests',
+ 'description' => 'Verifies rendering filter options as hidden elements.',
+ 'group' => 'Better Exposed Filters',
+ );
+ }
+
+ /**
+ * Verify hidden exposed filters are rendered correctly on a page display
+ *
+ * @TODO: check the functionality of a multi-pass filter using hidden BEF
+ * settings.
+ */
+ public function test_befPageDisplayHidden() {
+ // Create a page display to validate rendering.
+ $this->createDisplay('Page', array(
+ 'path' => array('path' => 'bef_test_page'),
+ ));
+
+ // Verify multi-selection hidden elements with node->type.
+ $this->addFilter('node.type', array(
+ 'options[expose][multiple]' => TRUE,
+ ));
+
+ // Verify single-selection hidden elements with node->status.
+ $this->addFilter('node.status');
+
+ $this->setBefSettings(array(
+ 'exposed_form_options[bef][type][bef_format]' => 'bef_hidden',
+ 'exposed_form_options[bef][status_1][bef_format]' => 'bef_hidden',
+ ));
+ $this->saveView();
+
+ $this->drupalGet('bef_test_page');
+ $this->assertNoText(t('Type'), 'Exposed "Type" filter title does not show for hidden elements.');
+ $this->assertNoText(t('Published'), 'Exposed "Published" filter title does not show for hidden elements.');
+
+ // Exposed filter option render as checkboxes.
+ // @todo: Need to fix these.
+ // $this->assertFieldByXpath('//input[@name="type[]" and @type="hidden"]');
+ // $this->assertFieldByXpath('//input[@name="status_1" and @type="hidden"]');
+ }
+}
+
+class BEF_TestTaxonomyFilters extends BEF_TestBase {
+
+ /**
+ * Describes these tests to the testing framework.
+ */
+ public static function getInfo() {
+ return array(
+ 'name' => 'BEF taxonomy filter tests',
+ 'description' => 'Verifies rendering of taxonomy filters.',
+ 'group' => 'Better Exposed Filters',
+ );
+ }
+
+ /**
+ * Verify taxonomy-based exposed filters display correctly as both radio
+ * buttons and checkboxes
+ */
+ public function test_befTaxonomyFilters() {
+ // Create a page display to validate rendering.
+ $this->createDisplay('Page', array(
+ 'path' => array('path' => 'bef_test_page'),
+ ));
+
+ // Not sure why I can't get the Features-based functionality to work without
+ // pulling up the modules page, but it works...
+ $this->drupalGet('admin/modules');
+
+ // Add three terms with two children each to the vocab defined in
+ // bef_test_content.
+ $vocab = taxonomy_vocabulary_machine_name_load('taxonomy-bef_test-location');
+ $parents = array();
+ foreach (array('parent1', 'parent2', 'parent3') as $name) {
+ $term = new stdClass();
+ $term->vid = $vocab->vid;
+ $term->name = $name;
+ taxonomy_term_save($term);
+ $parents[$term->tid] = $term->name;
+ }
+ foreach (array('child1', 'child2') as $name) {
+ foreach ($parents as $pid => $pname) {
+ $term = new stdClass();
+ $term->vid = $vocab->vid;
+ $term->name = "$pname $name";
+ $term->parent = $pid;
+ taxonomy_term_save($term);
+ }
+ }
+
+ // Add a heirarchical taxonomy filter from the BEF test feature.
+ $this->addFilter(
+ 'field_data_field_bef_test_location.field_bef_test_location_tid',
+ array(),
+ array('options[type]' => 'select', 'options[hierarchy]' => TRUE)
+ );
+ $this->saveView();
+ $this->drupalGet($this->getBefSettingsUrl());
+
+ // Verify settings available to a heirarchical taxonomy filter.
+ $this->assertFieldByXpath('//select[@name="exposed_form_options[bef][field_bef_test_location_tid][bef_format]"]');
+ $this->assertFieldByXpath('//select[@name="exposed_form_options[bef][field_bef_test_location_tid][bef_format]"]/option[@value="default"]');
+ $this->assertFieldByXpath('//select[@name="exposed_form_options[bef][field_bef_test_location_tid][bef_format]"]/option[@value="bef"]');
+ $this->assertFieldByXpath('//select[@name="exposed_form_options[bef][field_bef_test_location_tid][bef_format]"]/option[@value="bef_ul"]');
+ $this->assertFieldByXpath('//select[@name="exposed_form_options[bef][field_bef_test_location_tid][bef_format]"]/option[@value="bef_links"]');
+ $this->assertFieldByXpath('//select[@name="exposed_form_options[bef][field_bef_test_location_tid][bef_format]"]/option[@value="bef_hidden"]');
+
+ $this->setBefSettings(array(
+ 'exposed_form_options[bef][field_bef_test_location_tid][bef_format]' => 'bef_ul',
+ ));
+ $this->saveView();
+
+ // Verify taxonomy filter as radio buttons
+ $this->drupalGet('bef_test_page');
+ $this->assertText(t('Location (field_bef_test_location)'), 'Verify exposed filter label');
+ $this->assertFieldByXpath('//input[@name="field_bef_test_location_tid" and @type="radio"]', NULL, 'Verify exposed filter is shown as radio buttons');
+ $this->assertFieldByXpath('//ul[@class="bef-tree"]/li//label[@for="edit-field-bef-test-location-tid-all"]', NULL, 'Verify "- Any -" is in the top level of heirarchy.');
+ $this->assertFieldByXpath('//ul[@class="bef-tree"]/li//label[@for="edit-field-bef-test-location-tid-1"]', NULL, 'Verify "parent1" is in the top level of heirarchy.');
+ $this->assertFieldByXpath('//ul[@class="bef-tree"]/li/ul/li//label[@for="edit-field-bef-test-location-tid-4"]', NULL, 'Verify "parent1 child1" is in the second level of heirarchy.');
+ }
+}
+
+class BEF_TestSort extends BEF_TestBase {
+
+ /**
+ * Describes these tests to the testing framework.
+ */
+ public static function getInfo() {
+ return array(
+ 'name' => 'BEF sort tests',
+ 'description' => 'Verifies rendering exposed sort options.',
+ 'group' => 'Better Exposed Filters',
+ );
+ }
+
+ /**
+ * Verify exposed sorts, including the combined sort/operator option and
+ * option rewriting, work with BEF.
+ */
+ public function test_befExposedSort() {
+ // Create a page display to validate rendering.
+ $this->createDisplay('Page', array(
+ 'path' => array('path' => 'bef_test_page'),
+ ));
+
+ // Add an exposed sort
+ $this->addSort('node.title');
+
+ // Double-check that expose sort order is checked.
+ $this->setBefSettings(array(
+ 'exposed_form_options[expose_sort_order]' => TRUE,
+ ));
+ $this->saveView();
+
+ // Verify basic options
+ $this->drupalGet($this->getBefSettingsUrl());
+ $this->assertFieldByXpath('//select[@name="exposed_form_options[bef][sort][bef_format]"]/option', 'Default select list');
+ $this->assertFieldByXpath('//select[@name="exposed_form_options[bef][sort][bef_format]"]/option', 'Radio Buttons');
+ $this->assertFieldByXpath('//select[@name="exposed_form_options[bef][sort][bef_format]"]/option', 'Links');
+ $this->assertFieldByXpath('//select[@name="exposed_form_options[bef][sort][bef_format]"]/option', 'Toggle Links');
+
+ // Verify combined sort order and sort by.
+ $this->setBefSettings(array(
+ 'exposed_form_options[bef][sort][advanced][combine]' => TRUE,
+ ));
+ $this->saveView();
+ $this->drupalGet('bef_test_page');
+ $this->assertFieldByXpath('//select[@name="sort_bef_combine"]/option', 'title DESC');
+ $this->assertFieldByXpath('//select[@name="sort_bef_combine"]/option', 'title ASC');
+
+ // And rewrite the combined sort options.
+ $this->setBefSettings(array(
+ 'exposed_form_options[bef][sort][advanced][combine]' => TRUE,
+ 'exposed_form_options[bef][sort][advanced][combine_rewrite]' => "Title Desc|Going down\nTitle Asc|Going up",
+ ));
+ $this->saveView();
+ $this->drupalGet('bef_test_page');
+ $this->assertFieldByXpath('//select[@name="sort_bef_combine"]/option', 'Going up');
+ $this->assertFieldByXpath('//select[@name="sort_bef_combine"]/option', 'Going down');
+
+ // @todo: add tests for correct rendering of Links and Toggle links options.
+ }
+}
+
+class BEF_TestSliders extends BEF_TestBase {
+
+ /**
+ * Describes these tests to the testing framework.
+ */
+ public static function getInfo() {
+ return array(
+ 'name' => 'BEF slider tests',
+ 'description' => 'Verifies rendering filters jQueryUI sliders.',
+ 'group' => 'Better Exposed Filters',
+ );
+ }
+
+ /**
+ * Verify the correct classes are placed on exposed form elements and
+ * correct JS files are loaded to display jQuery UI sliders.
+ */
+ public function test_befSliders() {
+ // Create a page display to validate rendering.
+ $this->createDisplay('Page', array(
+ 'path' => array('path' => 'bef_test_page'),
+ ));
+
+ // Not sure why I can't get the Features-based functionality to work without
+ // pulling up the modules page, but it works...
+ $this->drupalGet('admin/modules');
+
+ // Verify slider rendering using the Numbers field from the BEF test content
+ // type.
+ $this->addFilter('field_data_field_bef_test_integer.field_bef_test_integer_value');
+ $this->addFilter('field_data_field_bef_test_price.field_bef_test_price_value', array(
+ 'options[operator]' => 'between',
+ ));
+ $this->saveView();
+
+ // Verify the slider option appears for integer fields
+ $this->drupalGet($this->getBefSettingsUrl());
+ $this->assertFieldByXpath('//select[@name="exposed_form_options[bef][field_bef_test_integer_value][bef_format]"]/option', 'Default select list');
+ $this->assertFieldByXpath('//select[@name="exposed_form_options[bef][field_bef_test_integer_value][bef_format]"]/option', 'jQuery UI slider');
+ $this->assertFieldByXpath('//select[@name="exposed_form_options[bef][field_bef_test_price_value][bef_format]"]/option', 'Default select list');
+ $this->assertFieldByXpath('//select[@name="exposed_form_options[bef][field_bef_test_price_value][bef_format]"]/option', 'jQuery UI slider');
+
+ // Set both fields to use sliders using the default slider options. Integer
+ // should render as a single slider, Price should render as two because of
+ // the "between" operator. But we can't test the creation of the sliders as
+ // Simpletest ignores JavaScript, so we just verify the settings and
+ // necessary files are there.
+ $this->setBefSettings(array(
+ // Just use the default values for this one.
+ 'exposed_form_options[bef][field_bef_test_integer_value][bef_format]' => 'bef_slider',
+ // More complicated option for this one.
+ 'exposed_form_options[bef][field_bef_test_price_value][bef_format]' => 'bef_slider',
+ 'exposed_form_options[bef][field_bef_test_price_value][slider_options][bef_slider_min]' => 100,
+ 'exposed_form_options[bef][field_bef_test_price_value][slider_options][bef_slider_max]' => 5000,
+ 'exposed_form_options[bef][field_bef_test_price_value][slider_options][bef_slider_step]' => 250,
+ 'exposed_form_options[bef][field_bef_test_price_value][slider_options][bef_slider_animate]' => 'normal',
+ 'exposed_form_options[bef][field_bef_test_price_value][slider_options][bef_slider_orientation]' => 'vertical',
+ ), t('The range of the slider (Range maximum - Range minimum) should be evenly divisible by the step.'));
+ $this->drupalPost(NULL, array('exposed_form_options[bef][field_bef_test_price_value][slider_options][bef_slider_step]' => 100), 'Apply');
+ $this->saveView();
+
+ $this->drupalGet('bef_test_page');
+ $settings = $this->drupalGetSettings();
+ $settings = $settings['better_exposed_filters'];
+ $this->assertTrue($settings['slider'], 'BEF slider setting is TRUE');
+
+ // Check slider options are passed from the settings page to JavaScript.
+ // Note that we skip the
+ $this->assertEqual($settings['slider_options']['field_bef_test_integer_value'], array(
+ 'min' => '0',
+ 'max' => '99999',
+ 'step' => '1',
+ 'animate' => '',
+ 'orientation' => 'horizontal',
+ 'id' => 'field-bef-test-integer-value',
+ 'viewId' => 'views-exposed-form-' . $this->view['machine_name'] . '-page-1',
+ ));
+ $this->assertEqual($settings['slider_options']['field_bef_test_price_value'], array(
+ 'min' => '100',
+ 'max' => '5000',
+ 'step' => '100',
+ 'animate' => 'normal',
+ 'orientation' => 'vertical',
+ 'id' => 'field-bef-test-price-value',
+ 'viewId' => 'views-exposed-form-' . $this->view['machine_name'] . '-page-1',
+ ));
+ }
+}
+
+class BEF_TestDatepicker extends BEF_TestBase {
+
+ /**
+ * Describes these tests to the testing framework.
+ */
+ public static function getInfo() {
+ return array(
+ 'name' => 'BEF datepicker tests',
+ 'description' => 'Verifies rendering filter options as a jQueryUI Datepicker.',
+ 'group' => 'Better Exposed Filters',
+ );
+ }
+
+ /**
+ * Verifies Datepicker options using Drupal core date fields.
+ */
+ public function test_befDatepicker() {
+ // Create a page display to validate rendering.
+ $this->createDisplay('Page', array(
+ 'path' => array('path' => 'bef_test_page'),
+ ));
+
+ // Verify Datepicker rendering using the Numbers field from the BEF test
+ // content type.
+ $this->addFilter('node.created');
+ $this->saveView();
+
+ // Verify the datepicker option appears for core date fields.
+ $this->drupalGet($this->getBefSettingsUrl());
+ $this->assertFieldByXpath('//select[@name="exposed_form_options[bef][created][bef_format]"]/option', 'Default select list');
+ $this->assertFieldByXpath('//select[@name="exposed_form_options[bef][created][bef_format]"]/option', 'jQuery UI Datepicker');
+ $this->setBefSettings(array(
+ 'exposed_form_options[bef][created][bef_format]' => 'bef_datepicker',
+ ));
+ $this->saveView();
+
+ $this->drupalGet('bef_test_page');
+ $settings = $this->drupalGetSettings();
+ $settings = $settings['better_exposed_filters'];
+ $this->assertTrue($settings['datepicker'], 'BEF datepicker setting is TRUE');
+ $this->assertFieldByXpath('//div[@id="edit-created-wrapper"]//input[contains(@class,"bef-datepicker")]');
+ }
+
+ /**
+ * Verifies Datepicker options using a custom (Date module) date field.
+ */
+ public function test_befDatepickerCustom() {
+ // Create a page display to validate rendering.
+ $this->createDisplay('Page', array(
+ 'path' => array('path' => 'bef_test_page'),
+ ));
+
+ // Not sure why I can't get the Features-based functionality to work without
+ // pulling up the modules page, but it works...
+ $this->drupalGet('admin/modules');
+
+ // Verify datepicker rendering using the Numbers field from the BEF test
+ // content type.
+ $this->addFilter('field_data_field_bef_test_date.field_bef_test_date_value', array(), array(
+ 'options[form_type]' => 'date_text',
+ ));
+ $this->saveView();
+
+ // Verify the datepicker option appears for custom date fields.
+ $this->drupalGet($this->getBefSettingsUrl());
+ $this->assertFieldByXpath('//select[@name="exposed_form_options[bef][field_bef_test_date_value][bef_format]"]/option', 'Default select list');
+ $this->assertFieldByXpath('//select[@name="exposed_form_options[bef][field_bef_test_date_value][bef_format]"]/option', 'jQuery UI Datepicker');
+ $this->setBefSettings(array(
+ 'exposed_form_options[bef][field_bef_test_date_value][bef_format]' => 'bef_datepicker',
+ ));
+ $this->saveView();
+
+ $this->drupalGet('bef_test_page');
+ $settings = $this->drupalGetSettings();
+ $settings = $settings['better_exposed_filters'];
+ $this->assertTrue($settings['datepicker'], 'BEF datepicker setting is TRUE');
+ $this->assertTrue(!empty($settings['datepicker_options']['dateFormat']), 'BEF datepicker setting is TRUE');
+ $this->assertFieldByXpath('//div[@id="edit-field-bef-test-date-value-value"]//input[contains(@class,"bef-datepicker")]');
+ }
+}
+
+class BEF_TestLinks extends BEF_TestBase {
+
+ /**
+ * Describes these tests to the testing framework.
+ */
+ public static function getInfo() {
+ return array(
+ 'name' => 'BEF links tests',
+ 'description' => 'Verifies rendering filter options as toggle links.',
+ 'group' => 'Better Exposed Filters',
+ );
+ }
+
+ /**
+ * Verify filters rendered as links.
+ */
+ public function test_befFilterLinks() {
+ // Create a page display to validate rendering.
+ $this->createDisplay('Page', array(
+ 'path' => array('path' => 'bef_test_page'),
+ ));
+
+ // Verify link rendering with the node type filter.
+ $this->addFilter('node.type', array(
+ 'options[expose][multiple]' => TRUE,
+ ));
+ $this->addFilter('node.status');
+ $this->setBefSettings(array(
+ 'exposed_form_options[bef][type][bef_format]' => 'bef_links',
+ 'exposed_form_options[bef][status_1][bef_format]' => 'bef_links',
+ ));
+ $this->saveView();
+ $this->drupalGet('bef_test_page');
+
+ // Verify the type filter, which is multi-select.
+ $this->assertFieldByXpath('//div[@id="edit-type-wrapper"]//div[@id="edit-type-article"]/a[contains(@href, "?type[0]=article")]', NULL, 'Correct link for "article" filter');
+ $this->assertFieldByXpath('//div[@id="edit-type-wrapper"]//div[@id="edit-type-page"]/a[contains(@href, "?type[0]=page")]', NULL, 'Correct link for "page" filter');
+ $this->assertFieldByXpath('//div[@id="edit-type-wrapper"]//div[@id="edit-type-bef-test"]/a[contains(@href, "?type[0]=bef_test")]', NULL, 'Correct link for "bef test" filter');
+
+ // None of the type filter options should be marked as "active."
+ $this->assertNoFieldByXpath('//div[@id="edit-type-wrapper"]//a[contains(@class, "Active")]', NULL, 'No "type" link options are marked as "active"');
+
+ // Verify the status filter, which is single select.
+ $this->assertFieldByXpath('//div[@id="edit-status-1-wrapper"]//div[@id="edit-status-1-1"]/a[contains(@href, "?status_1=1")]', NULL, 'Correct link for "status: yes" filter');
+ $this->assertFieldByXpath('//div[@id="edit-status-1-wrapper"]//div[@id="edit-status-1-0"]/a[contains(@href, "?status_1=0")]', NULL, 'Correct link for "status: no" filter');
+
+ // None of the status filter options should be marked as "active."
+ $this->assertNoFieldByXpath('//div[@id="edit-status-1-wrapper"]//a[contains(@class, "Active")]', NULL, 'No "status" link options are marked as "active"');
+
+ // Click the published/yes link and verify the filter links update.
+ $this->clickLink('Yes');
+
+ // Verify the type filter, which is multi-select.
+ $this->assertFieldByXpath('//div[@id="edit-type-wrapper"]//div[@id="edit-type-article"]/a[contains(@href, "?status_1=1&type[0]=article")]', NULL, 'Correct link for "article" filter');
+ $this->assertFieldByXpath('//div[@id="edit-type-wrapper"]//div[@id="edit-type-page"]/a[contains(@href, "?status_1=1&type[0]=page")]', NULL, 'Correct link for "page" filter');
+ $this->assertFieldByXpath('//div[@id="edit-type-wrapper"]//div[@id="edit-type-bef-test"]/a[contains(@href, "?status_1=1&type[0]=bef_test")]', NULL, 'Correct link for "bef test" filter');
+
+ // None of the type filter options should be marked as "active."
+ $this->assertNoFieldByXpath('//div[@id="edit-type-wrapper"]//a[contains(@class, "Active")]', NULL, 'No "type" link options are marked as "active"');
+
+ // Verify the status filter, which is single select.
+ $this->assertFieldByXpath('//div[@id="edit-status-1-wrapper"]//div[@id="edit-status-1-1"]/a[contains(@href, "?status_1=1")]', NULL, 'Correct link for "status: yes" filter');
+ $this->assertFieldByXpath('//div[@id="edit-status-1-wrapper"]//div[@id="edit-status-1-0"]/a[contains(@href, "?status_1=0")]', NULL, 'Correct link for "status: no" filter');
+
+ // Just the "yes" option should be marked as "active."
+ $this->assertFieldByXpath('//div[@id="edit-status-1-wrapper"]//div[@id="edit-status-1-1"]/a[contains(@class, "active")]', NULL, 'Correct "active" setting for the "status: yes" filter');
+ $this->assertNoFieldByXpath('//div[@id="edit-status-1-wrapper"]//div[@id="edit-status-1-0"]/a[contains(@class, "active")]', NULL, 'Correct "active" setting for the "status: no" filter');
+
+ // Verify correct links and "active" settings for non-required, boolean
+ // filters. See https://www.drupal.org/node/2631804.
+ $this->editFilter('status_1', array(
+ 'options[expose][required]' => FALSE,
+ ));
+ $this->saveView();
+ $this->drupalGet('bef_test_page');
+
+ // No default filters so nothing should be marked as active.
+ // @TODO: Views is giving us an $element['#value'] = FALSE which leads to
+ // the "No" option being marked as active. There is no reason that #value
+ // should be set, as far as I can tell. Because I'm not sure if this is a
+ // Views bug or assumption, I'm leaving this test out for now.
+ //$this->assertNoFieldByXpath('//div[@id="edit-status-1-wrapper"]//a[contains(@class, "active")]', NULL, 'Nothing marked as "active"');
+
+ // Clicking "no" should mark that option as active.
+ $this->clickLink('No');
+ $this->assertNoFieldByXpath('//div[@id="edit-status-1-wrapper"]//div[@id="edit-status-1-all"]/a[contains(@class, "active")]', NULL, 'Correct "active" setting for the "status: any" filter');
+ $this->assertNoFieldByXpath('//div[@id="edit-status-1-wrapper"]//div[@id="edit-status-1-1"]/a[contains(@class, "active")]', NULL, 'Correct "active" setting for the "status: yes" filter');
+ $this->assertFieldByXpath('//div[@id="edit-status-1-wrapper"]//div[@id="edit-status-1-0"]/a[contains(@class, "active")]', NULL, 'Correct "active" setting for the "status: no" filter');
+
+ // Clicking "any" should mark that option as active.
+ $this->clickLink('- Any -');
+ $this->assertFieldByXpath('//div[@id="edit-status-1-wrapper"]//div[@id="edit-status-1-all"]/a[contains(@class, "active")]', NULL, 'Correct "active" setting for the "status: any" filter');
+ $this->assertNoFieldByXpath('//div[@id="edit-status-1-wrapper"]//div[@id="edit-status-1-1"]/a[contains(@class, "active")]', NULL, 'Correct "active" setting for the "status: yes" filter');
+ $this->assertNoFieldByXpath('//div[@id="edit-status-1-wrapper"]//div[@id="edit-status-1-0"]/a[contains(@class, "active")]', NULL, 'Correct "active" setting for the "status: no" filter');
+
+ // Verify correct "active" settings for filters with default values.
+ $this->editFilter('status_1', array(
+ 'options[expose][required]' => FALSE,
+ 'options[value]' => 0,
+ ));
+ $this->saveView();
+ $this->drupalGet('bef_test_page');
+ $this->assertNoFieldByXpath('//div[@id="edit-status-1-wrapper"]//div[@id="edit-status-1-all"]/a[contains(@class, "active")]', NULL, 'Correct "active" setting for the "status: any" filter');
+ $this->assertNoFieldByXpath('//div[@id="edit-status-1-wrapper"]//div[@id="edit-status-1-1"]/a[contains(@class, "active")]', NULL, 'Correct "active" setting for the "status: yes" filter');
+ $this->assertFieldByXpath('//div[@id="edit-status-1-wrapper"]//div[@id="edit-status-1-0"]/a[contains(@class, "active")]', NULL, 'Correct "active" setting for the "status: no" filter');
+ }
+
+}
+
+class BEF_TestSecondaryFilters extends BEF_TestBase {
+
+ /**
+ * Describes these tests to the testing framework.
+ */
+ public static function getInfo() {
+ return array(
+ 'name' => 'BEF secondary filter tests',
+ 'description' => 'Verifies rendering filter options within the secondary filter fieldset.',
+ 'group' => 'Better Exposed Filters',
+ );
+ }
+
+ /**
+ * Basic coverage for filters rendered in secondary options fieldsets. See
+ *
+ * @todo near the end of this test.
+ */
+ public function test_befSecondaryFilters() {
+ // Create a page display to validate rendering.
+ $this->createDisplay('Page', array(
+ 'path' => array('path' => 'bef_test_page'),
+ ));
+
+ // Add the node.type filter as a multi-select filter.
+ $this->addFilter('node.type', array(
+ 'options[expose][multiple]' => TRUE,
+ ));
+ $this->setBefSettings(array(
+ 'exposed_form_options[bef][general][allow_secondary]' => 1,
+ 'exposed_form_options[bef][general][secondary_label]' => 'Custom Label',
+ 'exposed_form_options[bef][general][secondary_collapse_override]' => 0,
+ 'exposed_form_options[bef][type][more_options][is_secondary]' => 1,
+ ));
+ $this->saveView();
+ $this->drupalGet('bef_test_page');
+
+ // Verify a collapsed fieldset exists with the correct label.
+ $this->assertFieldByXpath('//div[@id="edit-secondary-wrapper"]//fieldset[contains(@class, "collapsible") and contains(@class, "collapsed")]', NULL, 'Collapsible fieldset for secondary options starts collapsed/');
+ $this->assertFieldByXpath('//div[@id="edit-secondary-wrapper"]//fieldset/legend/span', 'Custom Label', 'Collapsible fieldset has the correct custom label');
+ $this->assertFieldByXpath('//div[@id="edit-secondary-wrapper"]//fieldset//select[@name="type[]"]', NULL, 'The node.type filter is within the secondary fieldset');
+
+ // Select an option and make sure the fieldset is expanded when rendered.
+ $this->drupalGet('bef_test_page', array('query' => array('type' => 'page')));
+ $this->assertFieldByXpath('//div[@id="edit-secondary-wrapper"]//fieldset[contains(@class, "collapsible") and not(contains(@class, "collapsed"))]', NULL, 'Collapsible fieldset starts open');
+
+ // Verify force-open and force-closed fieldset options.
+ $this->setBefSettings(array(
+ // Always render opened.
+ 'exposed_form_options[bef][general][secondary_collapse_override]' => 1,
+ ));
+ $this->saveView();
+ $this->drupalGet('bef_test_page');
+ $this->assertFieldByXpath('//div[@id="edit-secondary-wrapper"]//fieldset[contains(@class, "collapsible") and not(contains(@class, "collapsed"))]', NULL, 'Collapsible fieldset starts open');
+ $this->setBefSettings(array(
+ // Always render closed.
+ 'exposed_form_options[bef][general][secondary_collapse_override]' => 2,
+ ));
+ $this->saveView();
+ $this->drupalGet('bef_test_page', array('query' => array('type' => 'page')));
+ $this->assertFieldByXpath('//div[@id="edit-secondary-wrapper"]//fieldset[contains(@class, "collapsible") and contains(@class, "collapsed")]', NULL, 'Collapsible fieldset starts closed');
+
+ // https://drupal.org/node/2189321
+ // Verify fieldset is collapsed/expanded when a custom filter ID is set.
+ // @TODO: Consider refactoring so we can leverage all existing tests to use
+ // custom filter ID's...
+ $this->editFilter('node.type', array(
+ 'options[expose][identifier]' => 'custom_id',
+ ));
+ $this->setBefSettings(array(
+ // Use default open/closed rendering.
+ 'exposed_form_options[bef][general][secondary_collapse_override]' => 0,
+ ));
+ $this->saveView();
+ $this->drupalGet('bef_test_page');
+
+ // Verify a collapsed fieldset exists with the correct label.
+ $this->assertFieldByXpath('//div[@id="edit-secondary-wrapper"]//fieldset[contains(@class, "collapsible") and contains(@class, "collapsed")]', NULL, 'Collapsible fieldset for secondary options, starts collapsed.');
+ $this->assertFieldByXpath('//div[@id="edit-secondary-wrapper"]//fieldset//select[@name="custom_id[]"]', NULL, 'The node.type filter is within the secondary fieldset');
+
+ // Select an option and make sure the fieldset is expanded when rendered.
+ $this->drupalGet('bef_test_page', array('query' => array('custom_id' => 'page')));
+ $this->assertFieldByXpath('//div[@id="edit-secondary-wrapper"]//fieldset[contains(@class, "collapsible") and not(contains(@class, "collapsed"))]', NULL, 'Collapsible fieldset starts open');
+
+ // Add an in-between filter and verify it renders correctly.
+ $this->addFilter('field_data_field_bef_test_integer.field_bef_test_integer_value', array(
+ 'options[operator]' => 'between',
+ ));
+ $this->setBefSettings(array(
+ 'exposed_form_options[bef][general][allow_secondary]' => 1,
+ 'exposed_form_options[bef][general][secondary_label]' => 'Custom Label',
+ 'exposed_form_options[bef][general][secondary_collapse_override]' => 0,
+ 'exposed_form_options[bef][field_bef_test_integer_value][more_options][is_secondary]' => 1,
+ ));
+ $this->saveView();
+ $this->drupalGet('bef_test_page');
+
+ // Verify labels for the min and max fields.
+ // Note: Both labels have a trailing space which is added by Views... I
+ // assume to provide some visual whitespace between the label and widget if
+ // they are arranged horizontally. I imagine that'll change at some point as
+ // it's a terrible way to add some padding to an element!
+ $this->assertFieldByXpath('//label[@for="edit-field-bef-test-integer-value-min"]', 'Integer (field_bef_test_integer) ', 'Label appears for in-between filters in secondary fieldsets.');
+ $this->assertFieldByXpath('//label[@for="edit-field-bef-test-integer-value-max"]', 'And ', 'In-between filter has correct label between min and max inputs');
+ $this->assertFieldByXpath('//label[@for="edit-custom-id"]', 'Type ', 'Single input filter has correct label');
+ }
+}
+
+class BEF_TestRewrite extends BEF_TestBase {
+
+ /**
+ * Describes these tests to the testing framework.
+ */
+ public static function getInfo() {
+ return array(
+ 'name' => 'BEF rewrite tests',
+ 'description' => 'Verifies rewriting filter and sort options.',
+ 'group' => 'Better Exposed Filters',
+ );
+ }
+
+ /**
+ * Verify rewriting works for filter options
+ */
+ public function test_befFilterRewrite() {
+ // Create a page display to validate rendering.
+ $this->createDisplay('Page', array(
+ 'path' => array('path' => 'bef_test_page'),
+ ));
+
+ // Add a node type filter set to allow multiple selections.
+ $this->addFilter('node.type', array(
+ 'options[expose][multiple]' => TRUE,
+ ));
+
+ // Add a node status filter set to allow a single selection.
+ $this->addFilter('node.status');
+
+ // Add a few terms to the Tags vocab and a Tags filter to the view.
+ // Verify values that PHP equates to empty.
+ $term1 = new stdClass();
+ $term1->name = "0";
+ $term1->vid = 1;
+ taxonomy_term_save($term1);
+
+ // Verify values with accents.
+ $term2 = new stdClass();
+ $term2->name = "Tèstiñg Térm";
+ $term2->vid = 1;
+ taxonomy_term_save($term2);
+ $this->addFilter('field_data_field_tags.field_tags_tid', array(), array(
+ // Choose the dropdown option for term filter, without hierarchy shown.
+ 'options[type]' => 'select',
+ 'options[hierarchy]' => '0',
+ ));
+
+ // Add some exposed sort options.
+ $this->addSort('node.created');
+ $this->addSort('node.title');
+
+ // Set rewrite for single and multiple selection filters.
+ $this->setBefSettings(array(
+ 'exposed_form_options[bef][status_1][more_options][rewrite][filter_rewrite_values]' =>
+ "Yes|Hell yeah!\nNo|Booo...",
+ 'exposed_form_options[bef][type][more_options][rewrite][filter_rewrite_values]' =>
+ "bef_test|This is a test\nArticle|",
+ 'exposed_form_options[bef][field_tags_tid][more_options][rewrite][filter_rewrite_values]' =>
+ $term1->name . "|The first one\n" . $term2->name . '|' . $term2->name . ' rewritten',
+ 'exposed_form_options[bef][sort][advanced][combine]' => '1',
+ 'exposed_form_options[bef][sort][advanced][combine_rewrite]' =>
+ "Post date Asc|Oldest first\nPost date Desc|Newest first\nTitle Asc|A -> Z\nTitle Desc|",
+ ));
+ $this->saveView();
+
+ $this->drupalGet('bef_test_page');
+ $this->assertFieldByXpath('//select[@id="edit-type"]/option', 'This is a test', 'Rerwrite of the filter option "bef_test" in "Type" filter');
+ $this->assertNoFieldByXpath('//select[@id="edit-type"]/option', 'Article', 'Rerwrite of the filter option "article" to null in "Type" filter.');
+ $this->assertFieldByXpath('//select[@id="edit-status-1"]/option', 'Hell yeah!', 'Rerwrite of the filter option "Yes" in "Published" filter.');
+ $this->assertFieldByXpath('//select[@id="edit-status-1"]/option', 'Booo...', 'Rerwrite of the filter option "No" in "Published" filter.');
+ $this->assertFieldByXpath('//select[@id="edit-field-tags-tid"]/option', 'The first one', 'Rerwrite of the filter value "0" in "Tags (field_tags)" filter.');
+ $this->assertFieldByXpath('//select[@id="edit-field-tags-tid"]/option', $term2->name . ' rewritten', 'Rerwrite of a filter option with accents in "Tags (field_tags)" filter.');
+ $this->assertFieldByXpath('//select[@id="edit-sort-bef-combine"]/option', 'Oldest first', 'Rerwrite of an exposed combined sort option.');
+ $this->assertFieldByXpath('//select[@id="edit-sort-bef-combine"]/option', 'Newest first', 'Rerwrite of an exposed combined sort option.');
+ $this->assertFieldByXpath('//select[@id="edit-sort-bef-combine"]/option', 'A -> Z', 'Rerwrite of an exposed combined sort option.');
+ $this->assertNoFieldByXpath('//select[@id="edit-sort-bef-combine"]/option', 'Title Desc', 'Removal of an exposed combined sort option through rewriting it to NULL.');
+ }
+}
+
+class BEF_TestMisc extends BEF_TestBase {
+
+ /**
+ * Describes these tests to the testing framework.
+ */
+ public static function getInfo() {
+ return array(
+ 'name' => 'BEF miscellaneous tests',
+ 'description' => 'Verifies misc BEF functional.',
+ 'group' => 'Better Exposed Filters',
+ );
+ }
+
+ /**
+ * Verifies the "Require input..." option.
+ */
+ public function test_befRequireInput() {
+ // Create a page display to validate rendering.
+ $this->createDisplay('Page', array(
+ 'path' => array('path' => 'bef_test_page'),
+ ));
+
+ // Add the node.type filter as a multi-select filter.
+ $this->addFilter('node.type', array(
+ 'options[expose][multiple]' => TRUE,
+ ));
+ $this->setBefSettings(array(
+ 'exposed_form_options[bef][general][input_required]' => 1,
+ 'exposed_form_options[bef][general][allow_secondary]' => 1,
+ ));
+ $this->saveView();
+ $this->drupalGet('bef_test_page');
+
+ // Verify the "Text on demand" is shown.
+ $this->assertText(t('Select any filter and click on Apply to see results'), '"Empty" text should show on initial display.');
+ }
+}
diff --git a/sites/all/modules/better_exposed_filters/tests/better_exposed_filters_TestBase.php b/sites/all/modules/better_exposed_filters/tests/better_exposed_filters_TestBase.php
new file mode 100644
index 0000000..e7082ed
--- /dev/null
+++ b/sites/all/modules/better_exposed_filters/tests/better_exposed_filters_TestBase.php
@@ -0,0 +1,275 @@
+ 'BEF Basic functionality tests',
+ 'description' => 'Basic tests for Better Exposed Filters.',
+ 'group' => 'Better Exposed Filters',
+ );
+ }
+
+ public function setUp() {
+ // For benchmarking.
+ $this->start = time();
+
+ // Enable any modules required for the test.
+ parent::setUp(
+ 'better_exposed_filters',
+ 'date',
+ 'date_views',
+ 'list',
+ 'number',
+ 'taxonomy',
+ 'text',
+ 'views',
+ 'views_ui'
+ );
+
+ // One of these days I'll figure out why Features is breaking all my tests.
+ module_enable(array('bef_test_content'));
+
+ // User with edit views perms
+ $this->admin_user = $this->drupalCreateUser();
+ $role = user_role_load_by_name('administrator');
+ $this->assertTrue(!empty($role->rid), 'Found the "administrator" role.');
+ user_save($this->admin_user, array('roles' => array($role->rid => $role->rid)));
+ $this->drupalLogin($this->admin_user);
+
+ // Build a basic view for use in tests.
+ $this->createView();
+
+ // $this->createDisplay('Page', array('path' => array('path' => 'bef_test_page')));
+
+ // Add field to default display
+ // $this->addField('node.title');
+
+ // Turn of Better Exposed Filters
+ $this->setBefExposedForm();
+ }
+
+ public function tearDown() {
+ debug('This test run took ' . (time() - $this->start) . ' seconds.');
+ unset($this->view);
+ parent::tearDown();
+ }
+
+ /*******************************************************************************
+ * Helper functions
+ ******************************************************************************/
+
+ /**
+ * Returns the URL for the BEF exposed form settings page.
+ */
+ protected function getBefSettingsUrl() {
+ return 'admin/structure/views/nojs/display/' . $this->view['machine_name'] . '/default/exposed_form_options';
+ }
+
+ protected function createView($name = '') {
+ if (!empty($this->view)) {
+ debug('WARNING: createView called after view has already been created.');
+ return;
+ }
+
+ if (empty($name)) {
+ $name = $this->randomName(8);
+ }
+ $this->view['name'] = $name;
+ $this->view['machine_name'] = strtolower($name);
+
+ $edit = array(
+ 'human_name' => $this->view['name'],
+ 'name' => $this->view['machine_name'],
+ // Default is to create a page display.
+ 'page[create]' => FALSE,
+ );
+ $this->drupalPost('admin/structure/views/add', $edit, 'Save & exit');
+
+ // URL to edit this view.
+ $this->view['edit_url'] = 'admin/structure/views/view/' . $this->view['machine_name'] . '/edit';
+ }
+
+ /**
+ * Creates a display of $type. Currently supports:
+ * 'Page'
+ *
+ * @todo: support more types...
+ */
+ protected function createDisplay($type = 'Page', $settings = NULL) {
+ if (!isset($this->view['displays'])) {
+ $this->view['displays'] = array();
+ }
+
+ // Add a display of $type to the view
+ $this->drupalPost($this->view['edit_url'], array(), "Add $type");
+
+ // Grab the name of the newly created display and store some info about it.
+ $url = $this->getUrl();
+ $display_name = substr($url, strrpos($url, '/') + 1);
+ $this->view['displays'][$display_name] = array(
+ 'machine_name' => $display_name,
+ 'edit_url' => 'admin/structure/views/view/' . $this->view['machine_name'] . '/edit/' . $display_name,
+ 'settings_base_url' => 'admin/structure/views/nojs/display/' . $this->view['machine_name'] . '/' . $display_name,
+ );
+
+ // Settings should be in the form of 'path' => array_of_form_settings. Eg:
+ // to set the title for a new display as an override:
+ // 'title' => array(
+ // 'title' => 'This is an override title',
+ // 'override[dropdown]' => display_machine_name_goes_here,
+ // )
+ //
+ // If you navigate to
+ // admin/structure/views/nojs/display///title
+ // you will see the form in question.
+ foreach ($settings as $path => $values) {
+ $this->drupalPost($this->view['displays'][$display_name]['settings_base_url'] . "/$path", $values, 'Apply');
+ }
+ $this->saveView();
+ }
+
+ /**
+ * Adds a filter to a view display.
+ *
+ * $field: string in the form of node.status or
+ * field_data_field_example.field_example_value
+ * $settings: (array) Settings on the "Configure filter criterion" dialog.
+ * NOTE: called after the "Expose filter" button is pressed if $exposed
+ * is TRUE so you can set things like "Allow multiple items" or grouped
+ * filter options.
+ * $additional: (array) settings for any additional configuration forms such
+ * as taxonomy term settings.
+ * $display: machine name of the display to add this filter to. NOTE:
+ * Currently only allows filters on the master display, no overrides.
+ * @todo: fix that, if needed.
+ * $exposed: (bool) (optional, default: TRUE) Is this an exposed filter?
+ *
+ * Note: This routine expects the caller to save the view, as needed.
+ */
+ protected function addFilter($field, $settings = array(), $additional = array(), $exposed = TRUE, $display = 'default') {
+ $edit = array(
+ "name[$field]" => TRUE,
+ );
+ $url = 'admin/structure/views/nojs/add-item/' . $this->view['machine_name'] . "/$display/filter";
+ $this->drupalPost($url, $edit, 'Add and configure filter criteria');
+
+ if (!empty($additional)) {
+ // Handle filter-specific options screen.
+ $this->drupalPost(NULL, $additional, 'Apply');
+ }
+
+ if ($exposed) {
+ $this->drupalPost(NULL, array(), 'Expose filter');
+ }
+ $this->drupalPost(NULL, $settings, 'Apply');
+ }
+
+ /**
+ * Edits an existing filter in the current view. See addFilter for param
+ * definitions.
+ */
+ protected function editFilter($field, $settings, $additional = array(), $display = 'default') {
+ if (FALSE !== ($pos = strpos($field, '.'))) {
+ $field = substr($field, $pos + 1);
+ }
+ $url = 'admin/structure/views/nojs/config-item/' . $this->view['machine_name'] . "/$display/filter/$field";
+ $this->drupalPost($url, $settings, 'Apply');
+
+ if (!empty($additional)) {
+ // Handle filter-specific options screen.
+ $this->drupalPost(NULL, $additional, 'Apply');
+ }
+ }
+
+ /**
+ * Adds a sort to a view display. See addFilter for parameter options.
+ *
+ * Note: This routine expects the caller to save the view, as needed.
+ */
+ protected function addSort($field, $settings = array(), $additional = array(), $exposed = TRUE, $display = 'default') {
+ $edit = array(
+ "name[$field]" => TRUE,
+ );
+ $url = 'admin/structure/views/nojs/add-item/' . $this->view['machine_name'] . "/$display/sort";
+ $this->drupalPost($url, $edit, 'Add and configure sort criteria');
+
+ if (!empty($additional)) {
+ // Handle filter-specific options screen.
+ $this->drupalPost(NULL, $additional, 'Apply');
+ }
+
+ if ($exposed) {
+ $this->drupalPost(NULL, array(), 'Expose sort');
+ }
+ $this->drupalPost(NULL, $settings, 'Apply');
+ }
+
+ /**
+ * Adds a field to a view display. See addFilter for parameter options.
+ *
+ * Note: This routine expects the caller to save the view, as needed.
+ */
+ protected function addField($field, $settings = array(), $display = 'default') {
+ $edit = array(
+ "name[$field]" => TRUE,
+ );
+ $url = 'admin/structure/views/nojs/add-item/' . $this->view['machine_name'] . "/$display/field";
+ $this->drupalPost($url, $edit, 'Add and configure fields');
+ $this->drupalPost(NULL, $settings, 'Apply');
+ }
+
+ /**
+ * Ensures that BEF is selected as the exposed form option
+ *
+ * Note: This routine expects the caller to save the view, as needed.
+ */
+ protected function setBefExposedForm($display = 'default') {
+ $edit = array(
+ "exposed_form[type]" => 'better_exposed_filters',
+ );
+ $url = 'admin/structure/views/nojs/display/' . $this->view['machine_name'] . "/$display/exposed_form";
+ $this->drupalPost($url, $edit, 'Apply');
+
+ // BEF settings is covered under setBefSettings() so we just accept the
+ // default values and move on.
+ $this->drupalPost(NULL, array(), 'Apply');
+ }
+
+ /**
+ * Sets various BEF exposed form settings. If $error is specified it also
+ * asserts that the error text apepars when trying to apply $settings.
+ *
+ * Note: This routine expects the caller to save the view, as needed.
+ */
+ protected function setBefSettings($settings, $error = '') {
+ $this->drupalPost($this->getBefSettingsUrl(), $settings, 'Apply');
+ if (!empty($error)) {
+ $this->assertText($error);
+ }
+ }
+
+ /**
+ * Saves the view
+ */
+ protected function saveView() {
+ $this->drupalPost($this->view['edit_url'], array(), 'Save');
+ }
+}
diff --git a/sites/all/modules/ddf/LICENSE.txt b/sites/all/modules/ddf/LICENSE.txt
new file mode 100644
index 0000000..d159169
--- /dev/null
+++ b/sites/all/modules/ddf/LICENSE.txt
@@ -0,0 +1,339 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ , 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
diff --git a/sites/all/modules/ddf/README.txt b/sites/all/modules/ddf/README.txt
new file mode 100644
index 0000000..ed8d5fe
--- /dev/null
+++ b/sites/all/modules/ddf/README.txt
@@ -0,0 +1,7 @@
+Dynamic dependent fields
+==================================================
+
+The documentation is available online https://www.drupal.org/node/2532790
+Ask your questions and report bugs through the issue tracker https://www.drupal.org/project/issues/ddf
+
+Enjoy the module!
diff --git a/sites/all/modules/ddf/ddf.info b/sites/all/modules/ddf/ddf.info
new file mode 100644
index 0000000..84509e1
--- /dev/null
+++ b/sites/all/modules/ddf/ddf.info
@@ -0,0 +1,12 @@
+name = Dynamic dependent fields
+description = Makes field value or options depend on other field values when editing entity.
+core = 7.x
+package = Fields
+dependencies[] = entity
+
+; Information added by Drupal.org packaging script on 2015-08-13
+version = "7.x-1.8"
+core = "7.x"
+project = "ddf"
+datestamp = "1439462340"
+
diff --git a/sites/all/modules/ddf/ddf.install b/sites/all/modules/ddf/ddf.install
new file mode 100644
index 0000000..957d4d4
--- /dev/null
+++ b/sites/all/modules/ddf/ddf.install
@@ -0,0 +1,44 @@
+ 'Dynamic field dependencies.',
+ 'fields' => array(
+ 'field_name' => array(
+ 'type' => 'varchar',
+ 'length' => 32,
+ 'not null' => TRUE,
+ 'description' => 'The name of controlling field.',
+ ),
+ 'entity_type' => array(
+ 'type' => 'varchar',
+ 'length' => 32,
+ 'not null' => TRUE,
+ ),
+ 'bundle' => array(
+ 'type' => 'varchar',
+ 'length' => 128,
+ 'not null' => TRUE,
+ ),
+ 'dependent_field_name' => array(
+ 'type' => 'varchar',
+ 'length' => 32,
+ 'not null' => TRUE,
+ 'description' => 'The name of controlled field.',
+ ),
+ 'data' => array(
+ 'type' => 'text',
+ 'not null' => FALSE,
+ 'description' => 'Serialized data containing dependency properties.',
+ ),
+ ),
+ 'primary key' => array('field_name', 'entity_type', 'bundle', 'dependent_field_name'),
+ );
+
+ return $schema;
+}
diff --git a/sites/all/modules/ddf/ddf.js b/sites/all/modules/ddf/ddf.js
new file mode 100644
index 0000000..4e86b66
--- /dev/null
+++ b/sites/all/modules/ddf/ddf.js
@@ -0,0 +1,129 @@
+(function ($) {
+
+Drupal.behaviors.ddf = {
+ attach: function (context, settings) {
+ if (!settings.ddf) {
+ return;
+ }
+
+ $.each(settings.ddf, function(key, form_settings) {
+ var id = form_settings['form_id'];
+ var form = $('input[value="' + id + '"]', context).closest('form').not('.ddf-processed').addClass('ddf-processed');
+ if (form.length === 1) {
+ if (form_settings['dependent'] && form_settings['fields']) {
+ ddfForm(form, id, form_settings['dependent'], form_settings['fields'], form_settings);
+ }
+ }
+ });
+
+ function ddfForm(form, form_id, dependent, fields, form_settings) {
+ var controlling_elements = {};
+ var dependent_selectors = {};
+
+ $.each(dependent, function(field_name) {
+ var element = form.find('[name="' + dependent[field_name] + '"],[name="' + dependent[field_name] + '[]"]');
+ dependent_selectors[field_name] = '#' + form.attr('id') + ' [name="' + element.attr('name') + '"]';
+ if ((element.length === 1) && (element.attr('id'))) {
+ dependent_selectors[field_name] = '#' + element.attr('id');
+ }
+ });
+
+ $.each(fields, function(field_name, name_attr) {
+ var elements = form.find('[name="' + name_attr + '"],[name^="' + name_attr + '["]').not('.ddf-field-processed').addClass('ddf-field-processed');
+ if (elements.length > 0) {
+ controlling_elements[field_name] = elements;
+ elements.each(function() {
+ var element = $(this);
+ var url = settings['basePath'] + settings['pathPrefix'] + 'ddf/update/' + field_name + '/' +
+ ddfGetScalar(form_settings['entity_type']) + '/' +
+ ddfGetScalar(form_settings['bundle']) + '/' +
+ ddfGetScalar(form_settings['entity_id']);
+
+ element.attr('autocomplete', 'off');
+ var ajax = new Drupal.ajax(false, element, {event: 'change', url: url});
+ ajax.beforeSerialize = ddfBeforeSerialize;
+ });
+ }
+ });
+
+ function ddfBeforeSerialize(element, options) {
+ options.type = 'GET';
+ options.data = {};
+ options.data['form_build_id'] = form_id;
+
+ $.each(controlling_elements, function(field_name, controlling_element) {
+ var value = $(controlling_element).fieldValue();
+ options.data[field_name] = (value.length > 0) ? value.join('+') : 'NULL';
+ });
+
+ $.each(dependent_selectors, function(field_name, selector) {options.data['dep:' + field_name] = selector;});
+ }
+
+ function ddfGetScalar(value) {
+ return ($.isArray(value)) ? value[0] : value;
+ }
+ }
+ }
+};
+
+/**
+ * Command to insert new content into the DOM without wrapping in extra DIV element.
+ */
+Drupal.ajax.prototype.commands.ddf_insertnowrap = function (ajax, response, status) {
+ // Get information from the response. If it is not there, default to
+ // our presets.
+ var wrapper = response.selector ? $(response.selector) : $(ajax.wrapper);
+ var method = response.method || ajax.method;
+ var effect = ajax.getEffect(response);
+
+ // We don't know what response.data contains: it might be a string of text
+ // without HTML, so don't rely on jQuery correctly interpreting
+ // $(response.data) as new HTML rather than a CSS selector. Also, if
+ // response.data contains top-level text nodes, they get lost with either
+ // $(response.data) or $('
').replaceWith(response.data).
+ var new_content_wrapped = $('
').html(response.data);
+ var new_content = new_content_wrapped.contents();
+ var settings = {};
+
+ // If removing content from the wrapper, detach behaviors first.
+ switch (method) {
+ case 'html':
+ case 'replaceWith':
+ case 'replaceAll':
+ case 'empty':
+ case 'remove':
+ settings = response.settings || ajax.settings || Drupal.settings;
+ Drupal.detachBehaviors(wrapper, settings);
+ break;
+ }
+
+ // Add the new content to the page.
+ wrapper[method](new_content);
+
+ // Immediately hide the new content if we're using any effects.
+ if (effect.showEffect !== 'show') {
+ new_content.hide();
+ }
+
+ // Determine which effect to use and what content will receive the
+ // effect, then show the new content.
+ if ($('.ajax-new-content', new_content).length > 0) {
+ $('.ajax-new-content', new_content).hide();
+ new_content.show();
+ $('.ajax-new-content', new_content)[effect.showEffect](effect.showSpeed);
+ }
+ else if (effect.showEffect !== 'show') {
+ new_content[effect.showEffect](effect.showSpeed);
+ }
+
+ // Attach all JavaScript behaviors to the new content, if it was successfully
+ // added to the page, this if statement allows #ajax['wrapper'] to be
+ // optional.
+ if (new_content.parents('html').length > 0) {
+ // Apply any settings from the returned JSON if available.
+ settings = response.settings || ajax.settings || Drupal.settings;
+ Drupal.attachBehaviors(wrapper, settings);
+ }
+};
+
+})(jQuery);
diff --git a/sites/all/modules/ddf/ddf.module b/sites/all/modules/ddf/ddf.module
new file mode 100644
index 0000000..5080aa1
--- /dev/null
+++ b/sites/all/modules/ddf/ddf.module
@@ -0,0 +1,445 @@
+ 'Update dependent widget',
+ 'page callback' => 'ddf_update_callback',
+ 'page arguments' => array(2, 3, 4, 5),
+ 'access callback' => 'ddf_update_access_callback',
+ 'access arguments' => array(2, 3, 4, 5),
+ 'type' => MENU_CALLBACK,
+ 'delivery callback' => 'ajax_deliver',
+ );
+
+ return $items;
+}
+
+/**
+ * Ajax callback returning ajax commands to update dependent widgets.
+ */
+function ddf_update_callback($controlling_field_name, $entity_type, $bundle, $entity_id) {
+ $result = array('#type' => 'ajax', '#commands' => array());
+ $dependent_fields = db_select('ddf', 'd')
+ ->fields('d', array('dependent_field_name', 'data'))
+ ->condition('field_name', $controlling_field_name)
+ ->condition('entity_type', $entity_type)
+ ->condition('bundle', $bundle)
+ ->execute()
+ ->fetchAllKeyed();
+ if (empty($dependent_fields)) {
+ return $result;
+ }
+ if ($entity_id == 'NULL') {
+ $entity_id = NULL;
+ }
+ $parameters = drupal_get_query_parameters($_GET);
+ $entity = NULL;
+ if (!is_null($entity_id)) {
+ $entity = entity_load_single($entity_type, $entity_id);
+ }
+ if (empty($entity)) {
+ $entity = NULL;
+ }
+
+ // Replace '_none' => NULL for select widgets.
+ foreach ($parameters as $field_name => $value) {
+ if ($value === '_none') {
+ $instance = field_info_instance($entity_type, $field_name, $bundle);
+ if (($instance) && ($instance['widget']['type'] == 'options_select')) {
+ $parameters[$field_name] = NULL;
+ }
+ }
+ }
+
+ foreach ($dependent_fields as $dependent_field_name => $settings) {
+ if (!empty($settings)) {
+ $settings = unserialize($settings);
+ }
+ $dependent_field = field_info_field($dependent_field_name);
+ if (is_null($dependent_field)) {
+ continue;
+ }
+ $selector = '';
+ if (isset($parameters['dep:' . $dependent_field_name])) {
+ $selector = $parameters['dep:' . $dependent_field_name];
+ }
+ $commands = module_invoke_all('ddf_update_widget', $dependent_field, $parameters, $selector, $entity, $settings, $controlling_field_name, $entity_type, $bundle);
+ if (empty($commands)) {
+ continue;
+ }
+ $result['#commands'] = array_merge_recursive($result['#commands'], $commands);
+ }
+
+ return $result;
+}
+
+/**
+ * Access callback returning TRUE if the user can edit current entity.
+ */
+function ddf_update_access_callback($controlling_field_name, $entity_type, $bundle, $entity_id) {
+ $entity = NULL;
+
+ if ($entity_id === 'NULL') {
+ $entity_id = NULL;
+ }
+ else {
+ $entity = entity_load_single($entity_type, $entity_id);
+ if (empty($entity)) {
+ return FALSE;
+ }
+ }
+
+ $dependencies = ddf_load_dependencies($entity_type, $bundle);
+ if (empty($dependencies)) {
+ return FALSE;
+ }
+
+ $dependency_exists = FALSE;
+ foreach ($dependencies as $dependency) {
+ if ($dependency[0] == $controlling_field_name) {
+ $dependency_exists = TRUE;
+ break;
+ }
+ }
+ if (!$dependency_exists) {
+ return FALSE;
+ }
+
+ $field = field_info_field($controlling_field_name);
+ $instance = field_info_instance($entity_type, $controlling_field_name, $bundle);
+ if (!$field || !$instance || !field_access('edit', $field, $entity_type)) {
+ return FALSE;
+ }
+
+ switch ($entity_type) {
+ case 'node':
+ return empty($entity_id) ? node_access('create', $bundle) : node_access('update', $entity);
+
+ case 'taxonomy_term':
+ return empty($entity_id) ? user_access('administer taxonomy') : taxonomy_term_edit_access($entity);
+
+ case 'user':
+ return empty($entity_id) ? (user_access('administer users') || user_register_access()) : (user_access('administer users') || ($entity_id == $GLOBALS['user']->uid));
+
+ case 'comment':
+ return empty($entity_id) ? (user_access('administer comments') || user_access('post comments')) : comment_access('edit', $entity);
+ }
+
+ // Enable access for unknown entity types.
+ return TRUE;
+}
+
+/**
+ * Implements hook_field_delete_field().
+ */
+function ddf_field_delete_field($field) {
+ db_delete('ddf')
+ ->condition('field_name', $field['field_name'])
+ ->execute();
+
+ db_delete('ddf')
+ ->condition('dependent_field_name', $field['field_name'])
+ ->execute();
+}
+
+/**
+ * Implements hook_field_delete_instance().
+ */
+function ddf_field_delete_instance($instance) {
+ db_delete('ddf')
+ ->condition('field_name', $instance['field_name'])
+ ->condition('entity_type', $instance['entity_type'])
+ ->condition('bundle', $instance['bundle'])
+ ->execute();
+
+ db_delete('ddf')
+ ->condition('dependent_field_name', $instance['field_name'])
+ ->condition('entity_type', $instance['entity_type'])
+ ->condition('bundle', $instance['bundle'])
+ ->execute();
+}
+
+function ddf_add_dependency($controlling_field_name, $dependent_field_name, $entity_type, $bundle, $settings = NULL) {
+ $fields = array(
+ 'field_name' => $controlling_field_name,
+ 'entity_type' => $entity_type,
+ 'bundle' => $bundle,
+ 'dependent_field_name' => $dependent_field_name,
+ );
+ if (!is_null($settings)) {
+ $fields['data'] = serialize($settings);
+ }
+ db_insert('ddf')->fields($fields)->execute();
+}
+
+function ddf_remove_dependency($dependent_field_name, $entity_type, $bundle) {
+ db_delete('ddf')
+ ->condition('dependent_field_name', $dependent_field_name)
+ ->condition('entity_type', $entity_type)
+ ->condition('bundle', $bundle)
+ ->execute();
+}
+
+/**
+ * Loads dependencies from the database.
+ */
+function ddf_load_dependencies($entity_type, $bundle) {
+ // Use the advanced drupal_static() pattern.
+ static $dependencies = NULL;
+ if (!isset($dependencies)) {
+ $dependencies = &drupal_static(__FUNCTION__, array());
+ }
+
+ if (!isset($dependencies[$entity_type][$bundle])) {
+ $dependencies[$entity_type][$bundle] = array();
+
+ $result = db_select('ddf', 'd')
+ ->fields('d', array('field_name', 'dependent_field_name', 'data'))
+ ->condition('entity_type', $entity_type)
+ ->condition('bundle', $bundle)
+ ->execute();
+
+ foreach ($result as $dependency) {
+ if (strlen($dependency->data) > 0) {
+ $dependency->data = unserialize($dependency->data);
+ }
+ $dependencies[$entity_type][$bundle][] = array($dependency->field_name, $dependency->dependent_field_name, $dependency->data);
+ }
+ }
+
+ return $dependencies[$entity_type][$bundle];
+}
+
+/**
+ * Implements hook_element_info_alter().
+ * Adds an #after_build function to all form elements.
+ */
+function ddf_element_info_alter(&$types) {
+ foreach ($types as $type => $info) {
+ $types[$type]['#after_build'][] = 'ddf_element_after_build';
+ }
+}
+
+function ddf_element_after_build($element, &$form_state) {
+ // Ensure that the element is a field.
+ if (isset($element['#field_name'])) {
+ $field = &$element;
+ }
+ elseif (isset($element['#language'], $element[$element['#language']], $element[$element['#language']]['#field_name'])) {
+ // Some fields are wrapped in containers before processing.
+ $field = &$element[$element['#language']];
+ }
+ else {
+ return $element;
+ }
+
+ // Do not process hidden fields.
+ if ((isset($field['#access'])) && ($field['#access'] == FALSE)) {
+ return $element;
+ }
+
+ $form = &$form_state['complete form'];
+
+ // Avoid processing fields in fields_ui administration pages.
+ if (drupal_substr($form['#form_id'], 0, 9) == 'field_ui_') {
+ return $element;
+ }
+
+ $entity_type = NULL;
+ $bundle = NULL;
+ $entity = NULL;
+ $entity_id = NULL;
+ if (isset($field['#entity_type'], $field['#bundle'])) {
+ $entity_type = $field['#entity_type'];
+ $bundle = $field['#bundle'];
+ if (isset($field['#entity'])) {
+ $entity = $field['#entity'];
+ }
+ }
+ elseif (isset($form['#entity_type'], $form['#bundle'])) {
+ $entity_type = $form['#entity_type'];
+ $bundle = $form['#bundle'];
+ if (isset($form['#entity'])) {
+ $entity = $form['#entity'];
+ }
+ }
+ else {
+ return $element;
+ }
+
+ $dependencies = ddf_load_dependencies($entity_type, $bundle);
+ if (empty($dependencies)) {
+ return $element;
+ }
+
+ if (!empty($entity)) {
+ list($entity_id,,) = entity_extract_ids($entity_type, $entity);
+ }
+ if (empty($entity_id)) {
+ $entity_id = 'NULL';
+ }
+
+ foreach ($dependencies as $dependency) {
+ // Process dependent field.
+ if ($dependency[1] == $field['#field_name']) {
+ if (isset($field['#name'])) {
+ $settings = array(
+ 'ddf' => array(
+ $form['#build_id'] . ':' . $entity_type . ':' . $bundle => array(
+ 'form_id' => $form['#build_id'],
+ 'dependent' => array($field['#field_name'] => $field['#name']),
+ ),
+ ),
+ );
+ drupal_add_js($settings, 'setting');
+ }
+ }
+
+ // Process controlling field.
+ if ($dependency[0] == $field['#field_name']) {
+ if (isset($field['#name'])) {
+ $settings = array(
+ 'ddf' => array(
+ $form['#build_id'] . ':' . $entity_type . ':' . $bundle => array(
+ 'form_id' => $form['#build_id'],
+ 'entity_type' => $entity_type,
+ 'bundle' => $bundle,
+ 'entity_id' => $entity_id,
+ 'fields' => array($field['#field_name'] => $field['#name']),
+ ),
+ ),
+ );
+ drupal_add_js($settings, 'setting');
+ drupal_add_library('system', 'drupal.ajax');
+ drupal_add_library('system', 'jquery.form');
+ drupal_add_js(drupal_get_path('module', 'ddf') . '/ddf.js');
+ }
+ }
+ }
+
+ return $element;
+}
+
+/**
+ * Implements hook_field_widget_WIDGET_TYPE_form_alter().
+ */
+function ddf_field_widget_options_select_form_alter(&$element, &$form_state, $context) {
+ // Fix dependent fields with selects which loose multiple property for empty lists, see options_field_widget_form() function in options.module file.
+ $dependencies = ddf_load_dependencies($context['instance']['entity_type'], $context['instance']['bundle']);
+ if (empty($dependencies)) {
+ return;
+ }
+ $field = $context['field'];
+ foreach ($dependencies as $dependency) {
+ if ($dependency[1] == $field['field_name']) {
+ if ((is_array($dependency[2])) && (isset($dependency[2]['type'])) && ($dependency[2]['type'] != 'options')) {
+ // Not options-type dependency, no special processing is required.
+ continue;
+ }
+ $ddf_processor = array('ddf_selector_element_process');
+ if (empty($element['#process'])) {
+ $info = element_info($element['#type']);
+ if (!empty($info['#process'])) {
+ $element['#process'] = array_merge($info['#process'], $ddf_processor);
+ }
+ }
+ else {
+ $element['#process'] = $ddf_processor;
+ }
+ $element['#value_callback'] = 'ddf_selector_element_value';
+ if ((isset($element['#multiple'])) && (!$element['#multiple']) && ($field['cardinality'] != 1)) {
+ $element['#multiple'] = TRUE;
+ }
+ }
+ }
+}
+
+function ddf_selector_element_process($element, &$form_state, $form) {
+ // Do not process hidden fields.
+ if ((isset($field['#access'])) && ($field['#access'] == FALSE)) {
+ return $element;
+ }
+
+ if ($form_state['process_input']) {
+ $entity_type = $element['#entity_type'];
+ $bundle = $element['#bundle'];
+ $entity = $element['#entity'];
+ $properties = $element['#properties'];
+ $field_name = $element['#field_name'];
+ $dependencies = ddf_load_dependencies($entity_type, $bundle);
+ if (empty($dependencies)) {
+ return $element;
+ }
+ $field = field_info_field($field_name);
+ $instance = field_info_instance($entity_type, $field_name, $bundle);
+ $form_state_copy = $form_state;
+ $form_copy = $form;
+
+ foreach ($dependencies as $dependency) {
+ if ($dependency[1] == $field_name) {
+ $controlling_field_name = $dependency[0];
+ $controlling_field = field_info_field($controlling_field_name);
+ $columns = ($controlling_field['type'] === 'entityreference') ? array('target_id') : array_keys($controlling_field['columns']);
+ $available_languages = field_available_languages($entity_type, $controlling_field);
+ $languages = _field_language_suggestion($available_languages, NULL, $controlling_field_name);
+ foreach ($languages as $langcode) {
+ $path = array_merge($form_copy['#parents'], array($controlling_field['field_name'], $langcode));
+ $key_exists = NULL;
+ $items = drupal_array_get_nested_value($form_state_copy['values'], $path, $key_exists);
+ if ($key_exists) {
+ if (!is_array($items)) {
+ foreach ($columns as $column) {
+ $entity->{$controlling_field_name}[$langcode] = array(0 => array($column => $items));
+ }
+ }
+ elseif ($items !== array()) {
+ if (array_key_exists($columns[0], $items)) {
+ $entity->{$controlling_field_name}[$langcode] = array(0 => $items);
+ }
+ else {
+ $entity->{$controlling_field_name}[$langcode] = $items;
+ }
+ }
+ }
+ }
+ }
+ }
+ $options = _options_get_options($field, $instance, $properties, $entity_type, $entity);
+ $element_copy = $element;
+ $element_copy['#options'] = $options;
+ $default_items = field_get_default_value($entity_type, $entity, $field, $instance);
+ $context = array(
+ 'form' => $form_copy,
+ 'field' => $field,
+ 'instance' => $instance,
+ 'langcode' => LANGUAGE_NONE,
+ 'items' => $default_items,
+ 'delta' => 0,
+ );
+ drupal_alter(array('field_widget_form', 'field_widget_' . $instance['widget']['type'] . '_form'), $element_copy, $form_state_copy, $context);
+ $element['#options'] = $element_copy['#options'];
+ }
+
+ return $element;
+}
+
+/**
+ * Replacement for form_type_select_value() functions for selectors.
+ */
+function ddf_selector_element_value(&$element, $input, $form_state) {
+ $element['#after_build'][] = 'ddf_remove_validation';
+ return form_type_select_value($element, $input);
+}
+
+/**
+ * Disables field validation selectors.
+ */
+function ddf_remove_validation(&$element, &$form_state) {
+ unset($element['#needs_validation']);
+ return $element;
+}
diff --git a/sites/all/modules/ddf/modules/ddf_entityreference/ddf_entityreference.info b/sites/all/modules/ddf/modules/ddf_entityreference/ddf_entityreference.info
new file mode 100644
index 0000000..de82ac9
--- /dev/null
+++ b/sites/all/modules/ddf/modules/ddf_entityreference/ddf_entityreference.info
@@ -0,0 +1,15 @@
+name = DDF Entity Reference
+description = Supports dynamic dependency for entity reference fields.
+core = 7.x
+package = Fields
+dependencies[] = ddf
+dependencies[] = entityreference
+dependencies[] = views
+files[] = plugins/selection/ddf.inc
+
+; Information added by Drupal.org packaging script on 2015-08-13
+version = "7.x-1.8"
+core = "7.x"
+project = "ddf"
+datestamp = "1439462340"
+
diff --git a/sites/all/modules/ddf/modules/ddf_entityreference/ddf_entityreference.module b/sites/all/modules/ddf/modules/ddf_entityreference/ddf_entityreference.module
new file mode 100644
index 0000000..eb65bf5
--- /dev/null
+++ b/sites/all/modules/ddf/modules/ddf_entityreference/ddf_entityreference.module
@@ -0,0 +1,119 @@
+ $entity_type, '#entity' => $entity, '#required' => $instance['required']);
+ $element = options_field_widget_form($form, $form_state, $dependent_field, $instance, LANGUAGE_NONE, array(), 0, $element);
+
+ $default_items = field_get_default_value($entity_type, $entity, $field, $instance, LANGUAGE_NONE);
+ $context = array(
+ 'form' => $form,
+ 'field' => $field,
+ 'instance' => $instance,
+ 'langcode' => LANGUAGE_NONE,
+ 'items' => $default_items,
+ 'delta' => 0,
+ );
+ drupal_alter(array('field_widget_form', 'field_widget_' . $instance['widget']['type'] . '_form'), $element, $form_state, $context);
+
+ $result = '';
+ if (isset($element['#options'])) {
+ if (!empty($element['#properties'])) {
+ $position = NULL;
+ if ((isset($element['#properties']['empty_option'])) && ($element['#properties']['empty_option'] == 'option_select')) {
+ if (count($element['#options']) == 2) {
+ $position = 1;
+ }
+ }
+ elseif (!isset($element['#properties']['empty_option'])) {
+ if (count($element['#options']) == 1) {
+ $position = 0;
+ }
+ }
+ if (!is_null($position)) {
+ $keys = array_keys($element['#options']);
+ if (isset($keys[$position])) {
+ $element['#value'] = $keys[$position];
+ }
+ }
+ }
+ $result = form_select_options($element);
+ }
+
+ $commands = array();
+ $command = ajax_command_html($selector, $result);
+ $command['command'] = 'ddf_insertnowrap';
+ $commands[] = $command;
+
+ // If chosen is applied, it can't be updated by attachBehavior().
+ $commands[] = ajax_command_invoke($selector, 'trigger', array('liszt:updated'));
+ $commands[] = ajax_command_invoke($selector, 'trigger', array('chosen:updated'));
+
+ // Options are changed, so run 'change' handlers.
+ $commands[] = ajax_command_invoke($selector, 'trigger', array('change'));
+
+ return $commands;
+}
+
+/**
+ * Implements hook_field_update_field().
+ */
+function ddf_entityreference_field_update_field($field, $prior_field, $has_data) {
+ if ($field['type'] != 'entityreference') {
+ return;
+ }
+ // We need 'bundles' element of the field structure.
+ $field = field_info_field($field['field_name']);
+
+ // Remove old dependencies.
+ foreach ($field['bundles'] as $entity_type => $bundles) {
+ foreach ($bundles as $bundle) {
+ ddf_remove_dependency($field['field_name'], $entity_type, $bundle);
+ }
+ }
+ // Add new dependencies.
+ if (isset($field['settings']['handler_settings']['view']['args'])) {
+ $controlling_fields = array();
+ foreach ($field['settings']['handler_settings']['view']['args'] as $arg) {
+ $matches = array();
+ if (preg_match('/^\{([^{}]+)\}$/', $arg, $matches)) {
+ $field_name = $matches[1];
+ if (!empty($controlling_fields[$field_name])) {
+ // Do not try to re-add the same dependency.
+ continue;
+ }
+ $controlling_fields[$field_name] = TRUE;
+ foreach ($field['bundles'] as $entity_type => $bundles) {
+ foreach ($bundles as $bundle) {
+ if (field_info_instance($entity_type, $field_name, $bundle)) {
+ ddf_add_dependency($field_name, $field['field_name'], $entity_type, $bundle, array('type' => 'options'));
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/sites/all/modules/ddf/modules/ddf_entityreference/plugins/selection/EntityReference_SelectionHandler_DDF.class.php b/sites/all/modules/ddf/modules/ddf_entityreference/plugins/selection/EntityReference_SelectionHandler_DDF.class.php
new file mode 100644
index 0000000..bfa3411
--- /dev/null
+++ b/sites/all/modules/ddf/modules/ddf_entityreference/plugins/selection/EntityReference_SelectionHandler_DDF.class.php
@@ -0,0 +1,218 @@
+ $value) {
+ self::$controlling_field_values[$entity_type][$entity_id][$key] = $value;
+ }
+ }
+
+ /**
+ * Implements EntityReferenceHandler::getInstance().
+ */
+ public static function getInstance($field, $instance = NULL, $entity_type = NULL, $entity = NULL) {
+ return new EntityReference_SelectionHandler_DDF($field, $instance, $entity_type, $entity);
+ }
+
+ protected function __construct($field, $instance, $entity_type, $entity) {
+ $this->field = $field;
+ $this->instance = $instance;
+ $this->entity_type = $entity_type;
+ $this->entity = $entity;
+ // Get the entity token type of the entity type.
+ $entity_info = entity_get_info($entity_type);
+ $this->entity_type_token = isset($entity_info['token type']) ? $entity_info['token type'] : $entity_type;
+ }
+
+ /**
+ * Implements EntityReferenceHandler::settingsForm().
+ */
+ public static function settingsForm($field, $instance) {
+ $form = parent::settingsForm($field, $instance);
+
+ if (isset($form['view']['args'])) {
+ $master_fields = array();
+ $other_instances = field_info_instances($instance['entity_type'], $instance['bundle']);
+ foreach ($other_instances as $other_instance) {
+ if ($other_instance['field_name'] == $instance['field_name']) {
+ continue;
+ }
+ if (($other_instance['widget']['type'] != 'options_select') && ($other_instance['widget']['type'] != 'options_buttons')) {
+ continue;
+ }
+ $other_field = field_info_field($other_instance['field_name']);
+ if ($other_field['cardinality'] != 1) {
+ continue;
+ }
+ if (($other_field['type'] === 'entityreference') || (count($other_field['columns']) === 1)) {
+ $master_fields[$other_instance['field_name']] = htmlspecialchars($other_instance['label']);
+ }
+ }
+ if (!empty($master_fields)) {
+ $dynamic_token_list = '';
+ foreach ($master_fields as $master_field_name => $master_field_label) {
+ $dynamic_token_list .= '{' . $master_field_name . '} - ' . $master_field_label . '- ", e.g. "new region".
+
+ - editability['allowed_levels'] (optional, defaults to 1 for each level)
+ Only meaningful when editable is set to TRUE.
+ Specify in which levels the user is allowed to create new items. In the
+ example, the user is only allowed to create new items in the third level.
+ When a setting for a level is ommitted, it defaults to 1 (i.e. allowed for
+ that level). This means you only have to specify in which levels the user
+ is not allowed to create new items.
+ This only applies to *existing* levels: it does not affect the
+ allow_new_levels setting (the next setting).
+
+ - editability['allow_new_levels'] (optional, defaults to 0)
+ Only meaningful when editable is set to TRUE.
+ Allow the user to create new levels, i.e. when a certain item does not yet
+ have children, the user can create a first child for it (thus thereby
+ creating a new level).
+
+ - editability['max_levels'] (optional, defaults to 3)
+ Only meaningful when editable_settings['allow_new_levels'] is set to TRUE.
+ Limits the maximum number of levels. Don't set this too high or you'll end
+ up with very deep hierarchies. This only affects how deep new levels can be
+ created, it will not affect the existing hierarchy.
+
+ - entity_count['enabled'] (optional, defaults to 0)
+ Enables the display of entity counts, between parentheses, for each item in
+ the hierarchy.
+
+ - entity_count['require_entity'] (optional, defaults to 0)
+ Whether an item should only be displayed if it has at least one associated
+ entity.
+
+ - entity_count['settings']['count_children'] (optional, defaults to 0)
+ Whether the entity count should also count associated children of the entity.
+
+ - entity_count['settings']['entity_types'] (optional, defaults to array())
+ Which types of entities should be counted. This is a list of checkboxes that
+ allow the user to select entity types by bundles.
+
+ - animation_delay (optional, defaults to 400)
+ The delay of each animation (the drop in left and right animations), in ms.
+
+ - special_items (optional, defaults to the empty array)
+ Through this setting, you can mark each item with special properties it
+ possesses. There currently are two special properties: 'exclusive' and
+ 'none'.
+ Note: you should include these items in the hierarchy as if it were a
+ normal item and then you can mark them as special through this property.
+ * 'exclusive': Sometimes it's desirable to have exclusive lineages. When
+ such an option is selected, the user should not be able to
+ select anything else. This also means that nothing else in
+ the dropbox can be selected: if the dropbox contains
+ anything, it will be reset.
+ Can be applied to multiple items.
+ e.g. an 'entire_tree' item:
+ 'special_items' => array(
+ 'entire_tree' => array('exclusive'),
+ )
+ * 'none': Sometimes you want to replace the default '
' option by
+ something else. This replacement should of course also exist in
+ the root level.
+ Can be applied to only one item.
+ e.g. an 'any' item (used in hs_taxonomy_views):
+ 'special_items' => array(
+ 'any' => array('none', 'exclusive'),
+ )
+ And a final example for a better overview:
+ 'special_items' => array(
+ 'entire_tree' => array('exclusive'),
+ 'any' => array('none', 'exclusive'),
+ )
+
+ - render_flat_select (optional, defaults to 0)
+ Because the hierarchical_select form element consists of multiple form
+ items, it doesn't work well in GET forms. By enabling this setting, a flat
+ select will also be rendered, that contains only the selected lineages.
+ Combine that with Drupal.HierarchicalSelect.prepareGETSubmit in the JS code
+ (or, alternatively, the 'prepare-GET-submit' event that can be triggered,
+ see the JavaScript events section for details) and you have a work-around
+ (which, admittedly, only works when JS is enabled).
+
+3) We *don't* specify a list of options: Hierarchical Select automatically
+generates the options for us, thanks to the 'module' and 'params' settings.
+
+
+Concepts
+--------
+- Item Unicity: each item in the hierarchy must be *unique*. It doesn't have
+ to be numerical, it can also be a string.
+ If your hierarchy does not have unique items by nature or by
+ design (your items may be unique per level instead), that's
+ not a problem. You can simply prepend the item's ancestors to
+ get a unique item.
+ e.g. you have an item "foobar" at the first, second and third
+ levels. By prepending the ancestors using the dash as the
+ separator, you'd get an item "foobar-foobar-foobar" at the
+ third level.
+ Also see the "Reserved item values" section.
+- #options: it's gone, because it was the inherent cause for scalability
+ problems: if a hierarchy consists of 10,000 or even 100,000 items,
+ this results in huge HTML being generated. Huge HTML means more
+ processing power necessary, and more bandwidth necessary. So where
+ does Hierarchical Select get its "options"? It uses the hooks that
+ every implementation has to implement to only get what it needs.
+- The General Concept: you should think of Hierarchical Select as an abstract
+ widget that can represent *any* hierarchy. To be able
+ to display any hierarchy, you obviously need some
+ universal way to "browse" a hierarchy.
+ If you are familiar with C++ or Java iterators, this
+ should come natural: the hooks you have to implement
+ is what allows Hierarchical Select to iterate over your
+ hierarchy. Then the heart of the iterator would be the
+ root_level() and children() hooks. params() allows you
+ to define which information is necessary before you can
+ determine *which* hierarchy or which *part* of the
+ hierarchy is being browsed. lineage() must return the
+ lineage, i.e. the item itself and all its ancestors,
+ this allows a hierarchy to be generated from just one
+ (selected) item.
+
+
+Reserved item values
+--------------------
+- Ensure that your items don't have a "none", "all", "create_new_item" nor
+ "label_\d+" values (the latter means "label_" followed by one or more
+ digits). Your values should also not contain a pipe ("|"), since pipes are
+ used to separate the selection of values that are sent back to the server
+ in the callbacks.
+- Valid 'empty' selections (i.e. if you want to set the #default_value
+ property of your form item), are -1 and the empty array. The empty string is
+ also considered valid, because Drupal core's Taxonomy module uses this as
+ the empty selection.
+
+
+Developer mode
+--------------
+When you are writing your implementation of the Hierarchical Select API, you
+will often wonder what Hierarchical Select is doing internally with the data
+you're feeding it. That's why there's a developer mode: it will show you this
+data, even the data generated in AJAX callbacks. It'll also show you the time
+it took to generate the lineage, to fill up the levels and to calculate the
+child info, to track down badly performing code.
+Also, when you're just creating a new HS config and it doesn't quite work
+right, it can be helpful to enable the developer mode. It will perform some
+basic diagnostics that might help you track down the cause.
+To use this, you must have a browser with console.log() support. Install
+Firebug Lite (http://getfirebug.com/lite.html) if your browser does not
+suport this. Next, go to Hierarchical Select's .module file and set the define
+for the HS_DEVELOPER_MODE constant to TRUE.
+When you now open Firebug (Firefox) or the Web Inspector (Safari), you'll see
+the debug output. New output is added after each callback to the server.
+
+
+Hierarchical Select implementations: gotcha's
+---------------------------------------------
+- "warning: Missing argument 1 for drupal_retrieve_form() …"
+ This implies that your implementation's module weight is heavier than
+ hierarchical_select.module. In that case, Hierarchical Select will not be
+ able to detect hierarchical_select form items, preventing it from applying
+ some magic, and AJAX updates won't work.
+
+
+Hierarchical Select compatibility: gotcha's
+-------------------------------------------
+- "Invalid response from server"
+ This typically means that some functions could not be found when
+ Hierarchical Select does an AJAX callback to the server, which in turn means
+ that some code (some PHP file) has not been included, while it should have
+ been. Instead of using module_load_include() or even require_once, you
+ should use form_load_include(). This function is new in Drupal 7 and will
+ ensure that all required PHP files are included automatically.
+
+
+Hierarchical Select API Tutorial
+--------------------------------
+Written by Stephen Barker of Digital Frontiers Media
+(http://drupal.org/user/106070) and reviewed by Wim Leers:
+ http://drupal.org/node/532724
+
+
+Hierarchical Select Small Hierarchy
+-----------------------------------
+Hierarchical Select includes a Hierarchical Select API implementation that
+allows one to use a hardcoded hierarchy. When it becomes to slow, you should
+move the hierarchy into the database and write a proper implementation.
+Below you can find an example of how to use the hs_smallhierarchy module. Just
+change the $hierarchy array to suit your needs and off you go! Look at the
+code of hs_smallhierarchy.module for full details, but this code example
+should get you started.
+
+ $hierarchy = array(
+ 'win' => array(
+ 'label' => 'Windows',
+ 'children' => array(
+ 'xp' => array('label' => 'XP'),
+ 'vista' => array(
+ 'label' => 'Vista',
+ 'children' => array(
+ 'x86' => array('label' => '32-bits'),
+ 'x64' => array('label' => '64-bits'),
+ ),
+ ),
+ ),
+ ),
+ );
+
+ $form['select_some_term'] = array(
+ '#type' => 'hierarchical_select',
+ '#title' => t('Select the tag you wish to use.'),
+ '#size' => 1,
+ '#config' => array(
+ 'module' => 'hs_smallhierarchy',
+ 'params' => array(
+ 'hierarchy' => $hierarchy,
+ 'id' => 'my-hierarchy-about-windows',
+ 'separator' => '|',
+ ),
+ 'save_lineage' => 0,
+ 'enforce_deepest' => 0,
+ 'resizable' => 1,
+ 'level_labels' => array(
+ 'status' => 0,
+ 'labels' => array(
+ 0 => t('Main category'),
+ 1 => t('Subcategory'),
+ 2 => t('Third level category'),
+ ),
+ ),
+ 'dropbox' => array(
+ 'status' => 0,
+ 'title' => t('All selections'),
+ 'limit' => 0,
+ 'reset_hs' => 1,
+ 'sort' => 1,
+ ),
+ 'editability' => array(
+ 'status' => 0,
+ 'item_types' => array(),
+ 'allowed_levels' => array(
+ 0 => 0,
+ 1 => 0,
+ 2 => 1,
+ ),
+ 'allow_new_levels' => 0,
+ 'max_levels' => 3,
+ ),
+ 'entity_count' => array(
+ 'enabled' => 0,
+ 'require_entity' => 0,
+ 'settings' => array(
+ 'count_children' => 0,
+ 'entity_types' => array(),
+ ),
+ ),
+ // These settings cannot be configured through the UI: they can only be
+ // overridden through code.
+ 'animation_delay' => 400,
+ 'exclusive_lineages' => array(),
+ 'render_flat_select' => 0,
+ ),
+ '#description' => 'Put your description here',
+ '#default_value' => 'win|xp|x86',
+ );
+
+
+Hooks
+-----
+1) hook_hierarchical_select_params();
+ Returns an array with the names of all parameters that are necessary for
+ this implementation to work.
+
+2) hook_hierarchical_select_root_level($params, $dropbox = FALSE);
+ Returns the root level of the hierarchy: an array of (item, label) pairs.
+ The $dropbox parameter can is optional and can even ommitted, as it's only
+ necessary if you need the dropbox to influence your hierarchy.
+
+3) hook_hierarchical_select_children($parent, $params, $dropbox = FALSE);
+ Gets the children of $parent ($parent is an item in the hierarchy) and
+ returns them: an array of (item, label) pairs, or the empty array if the
+ given $parent has no children.
+ The $dropbox parameter can is optional and can even ommitted, as it's only
+ necessary if you need the dropbox to influence your hierarchy.
+
+4) hook_hierarchical_select_lineage($item, $params);
+ Calculates the lineage of $item (array of items, with $item the last) and
+ returns it. Necessary when the "enforce_deepest" option is enabled.
+
+5) hook_hierarchical_select_valid_item($item, $params);
+ Validates an item, returns TRUE if valid, FALSE if invalid.
+
+6) hook_hierarchical_select_item_get_label($item, $params);
+ Given a valid item, returns the label. Is only used for rendering the
+ selections in the dropbox.
+
+7) hook_hierarchical_select_create_item($label, $parent, $params);
+ Given a parent item and the label of a new item, create a new item as a
+ child of the parent item. When $parent == 0, this means a new item is being
+ created at the root level.
+ Optional hook. When this hook is not implemented, this functionality will
+ never be used, even when you configure it that way in code.
+
+8) hook_hierarchical_select_entity_count($item, $params);
+ Given a item, get the number of entities (most of the time the entity type
+ is 'node') that are related to the given item. Used for the entity_count
+ and require_entity settings.
+ Optional hook. When this hook is not implemented, this functionality will
+ never be used, even when you configure it that way (i.e. when you enable
+ the entity_count and require_entity settings).
+
+9) hook_hierarchical_select_implementation_info();
+ Return metadata about this implementation.
+ This information is used to generate the implementations overview at
+ admin/settings/hierarchical_select/implementations. The expected format is:
+
+ array(
+ 'hierarchy type' => t('Taxonomy'),
+ 'entity type' => t('Node'),
+ 'entity' => t('Story'),
+ 'context type' => t('Node form'),
+ 'context' => '',
+ );
+
+ another example:
+
+ array(
+ 'hierarchy type' => t('Taxonomy'),
+ 'entity type' => t('Node'),
+ 'entity' => '',
+ 'context type' => t('Views exposed filter'),
+ 'context' => t('some view'),
+ );
+
+10) hook_hierarchical_select_config_info();
+ Return metadata about each available user-editable configuration for this
+ implementation.
+ Optional hook. This information is used to generate the configurations
+ overview at admin/settings/hierarchical_select/configs. The expected
+ format is:
+
+ $config_info[$config_id] = array(
+ 'config_id' => $config_id,
+ 'hierarchy type' => t('Taxonomy'),
+ 'hierarchy' => t($vocabulary->name),
+ 'entity type' => t('Node'),
+ 'entity' => implode(', ', array_map('t', $entities)),
+ 'edit link' => "admin/content/taxonomy/edit/vocabulary/$vid",
+ );
+
+
+Standardized configuration form
+-------------------------------
+Hierarchical Select 3 comes with a standardized configuration form:
+hierarchical_select_common_config_form(). This function accepts a lot of
+parameters, which allows you to use names typical to your module's hierarchy
+(e.g. 'leaf' instead of 'term' and 'tree' instead of 'vocabulary'). A submit
+handler is also provided, of course.
+An example:
+
+ // I'm not configuring all parameters here. For an example of that, see one
+ // of the included modules.
+ $form['foobar_hierarchical_select_config'] = hierarchical_select_common_config_form($module, $params, $config_id, $defaults, $strings, $max_hierarchy_depth, $preview_is_required);
+
+ // Add the the submit handler for the Hierarchical Select config form.
+ $parents = array('foobar_hierarchical_select_config');
+ $form['#submit'][] = 'hierarchical_select_common_config_form_submit';
+ $form['#hs_common_config_form_parents'] = $parents;
+
+
+Configuration management
+------------------------
+It's now possible to export Hierarchical Select configurations, and there is a
+function to set the configuration of a certain Hierarchical Select. Combine
+the two and you can manage your Hierarchical Select configurations in code!
+An example:
+
+ // The exported configuration.
+ $config = array( … );
+ $config_id = $config['config_id];
+
+ // Apply the configuration.
+ require_once(drupal_get_path('module', 'hierarchical_select') .'/includes/common.inc');
+ hierarchical_select_common_config_set($config_id, $config);
+
+
+JavaScript events
+-----------------
+The Hierarchical Select module's JavaScript code triggers several events, to
+allow for advanced interactions.
+
+You can find all hierarchical_select form items using this selector:
+
+ $('.hierarchical-select-wrapper');
+
+You can find a *specific* hierarchical_select form item using this selector:
+
+ $('#hierarchical-select-x-wrapper');
+
+where x is a number, or more accurately: a hsid (hierarchical select id).
+Retrieving all hsids in the current document can be done like this:
+
+ for (var hsid in Drupal.settings.HierarchicalSelect.settings) {
+ // …
+ }
+
+Alternatively, you can use one of the transliterated class names. A wrapper
+for Hierarchical Select looks like this:
+
+ …
+
+Hence, you could also use selectors such as these, to achieve the same effect,
+but with more robust code:
+ $('.hierarchical-select-wrapper-for-config-taxonomy-1:first')
+ .trigger('enforce-update');
+ $('.hierarchical-select-wrapper-for-name-edit-taxonomy-1:first')
+ .trigger('enforce-update');
+
+The following events are triggered:
+ - change-hierarchical-select
+ - update-hierarchical-select
+ - create-new-item
+ - cancel-new-item
+ - add-to-dropbox (check https://www.drupal.org/node/1277068)
+ - remove-from-dropbox
+ - enforced-update
+ - prepared-GET-submit
+All events are triggered *after* the animations have completed.
+
+However, it's often useful to do something *before* an event (especially
+because all of the above events perform an AJAX request to the server). So,
+the equivalent "before" events exist as well:
+ - before-update-hierarchical-select
+ - before-create-new-item
+ - before-cancel-new-item
+ - before-add-to-dropbox
+ - before-remove-from-dropbox
+ - before-enforced-update
+There is one exception: when the cache is enabled, the "before update
+hierarchical select" event will not be triggered. This makes sense, because
+updates from the cache are instantaneous.
+
+An example of binding a function to the 'create-new-item' event of the second
+(hsid == 1) hierarchical_select form item on the page:
+
+ $('#hierarchical-select-1-wrapper')
+ .bind('create-new-item', function() {
+ // …
+ });
+
+And finally, you can trigger a special event to enforce an update (this can be
+useful when you have changed a hierarchy through another form item, or for
+live previews, or …). You can then also pass additional information that will
+be POSTed. You can even disable normal updates, to manage that completely
+yourself via enforced updates. This allows you to write a Hierarchical Select
+implementation that gets some of its information ($params) from another form
+item!
+Suppose you'd like to enforce an update of the first (hsid == 0)
+hierarchical_select form item on the page:
+
+ $('#hierarchical-select-0-wrapper')
+ .trigger('enforce-update');
+
+Now let's move on to a more advanced example, in which we will disable normal
+updates and let another form item (here a select) provide a part of the
+information that will be used to render the Hierarchical Select. Effectively,
+this other form item will *influence* the hierarchy that will be presented by
+Hierarchical Select!
+
+ $(document).ready(function() {
+ Drupal.settings.specialfilter = {};
+
+ // .specialfilter-first: a select form item
+ // .specialfilter-second: a hierarchical_select form item
+
+ update = function() {
+ var selection = Drupal.settings.specialfilter.currentSelection;
+
+ // Send an extra parameter via POST: dynamicParameter. This is the stored
+ // selection.
+ $('.specialfilter-second')
+ .trigger('enforce-update',
+ [
+ { name : 'dynamicParameter', value : selection }
+ ]
+ );
+ };
+
+ attachHSBindings = function() {
+ // When a user navigates the hierarchical_select form item, we still want to
+ // POST the the extra dynamicParameter, or otherwise we will no longer have
+ // a hierarchy in the hierarchical_select form item that really depends on
+ // the select.
+ $('.specialfilter-second .hierarchical-select > select')
+ .change(function() { update(); });
+
+ $('.specialfilter-second')
+ .unbind('enforced-update').bind('enforced-update', function() { return attachHSBindings(); });
+ };
+
+ // Initialize after 25 ms, because otherwise the event binding of HS will
+ // not yet be ready, and hence this won't have any effect
+ setTimeout(function() {
+ // Get the initial selection (before the user has changed anything).
+ Drupal.settings.specialfilter.currentSelection = $('.specialfilter-first').attr('value');
+
+ // When the select form item changes, we want to *store* that selection, and
+ // update the hierarchical_select form item.
+ $('.specialfilter-first')
+ .change(function() {
+ // Store the current selection.
+ Drupal.settings.specialfilter.currentSelection = $(this).attr('value');
+
+ update();
+ });
+
+ $('.specialfilter-second')
+ .trigger('disable-updates');
+
+ attachHSBindings();
+ }, 25);
+ });
+
+The 'enforced-update' (notice the past tense!) event is triggered upon
+completion.
+An even more rarely used special event can be triggered to prepare the
+hierarchical_select form element for a get submit: the 'prepare GET submit'
+event. To use this event, the 'render_flat_select' setting should be enabled
+in the config.
diff --git a/sites/all/modules/hierarchical_select/LICENSE.txt b/sites/all/modules/hierarchical_select/LICENSE.txt
new file mode 100644
index 0000000..d159169
--- /dev/null
+++ b/sites/all/modules/hierarchical_select/LICENSE.txt
@@ -0,0 +1,339 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ , 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
diff --git a/sites/all/modules/hierarchical_select/README.txt b/sites/all/modules/hierarchical_select/README.txt
new file mode 100644
index 0000000..39719dd
--- /dev/null
+++ b/sites/all/modules/hierarchical_select/README.txt
@@ -0,0 +1,200 @@
+
+Description
+-----------
+This module defines the "hierarchical_select" form element, which is a greatly
+enhanced way for letting the user select items in a hierarchy.
+
+Hierarchical Select has the ability to save the entire lineage of a selection
+or only the "deepest" selection. You can configure it to force the user to
+make a selection as deep as possible in the tree, or allow the user to select
+an item anywhere in the tree. Levels can be labeled, you can configure limit
+the number of items that can be selected, configure a title for the dropbox,
+choose a site-wide animation delay, and so on. You can even create new items
+and levels through Hierarchical Select!
+
+
+Integrates with
+---------------
+* Taxonomy (Drupal core)
+
+
+Installation
+------------
+1) Place this module directory in your "modules" folder (this will usually be
+"sites/all/modules/"). Don't install your module in Drupal core's "modules"
+folder, since that will cause problems and is bad practice in general. If
+"sites/all/modules" doesn't exist yet, just create it.
+
+2) Enable the Hierarchical Select and Hierarchical Select Taxonomy modules.
+
+3) If you want to use it for one or more of your vocabularies, go to
+admin/structure/types and click the "manage fields" link for a content type on
+which you're using a Term reference field. Click the "edit" link for this Term
+reference field and then go to the "widget type" tab in the upper right corner.
+There, you can choose the "Hierarchical Select" widget type, and when you do,
+the entire Hierarchical Select configuration UI will appear: here you'll find
+a whole range of Hierarchical Select settings. All settings are explained
+there as well!
+
+
+Troubleshooting
+---------------
+If you ever have problems, make sure to go through these steps:
+
+1) Go to admin/reports/status (i.e. the Status Report). Ensure that the status
+ of the Hierarchical Select module is ok.
+
+2) Ensure that the page isn't being served from your browser's cache. Use
+ CTRL+R in Windows/Linux browsers, CMD+R in Mac OS X browsers to enforce the
+ browser to reload everything, preventing it from using its cache.
+
+3) When you're getting a JS alert with the following message: "Received an
+ invalid response from the server.", ensure that the page (of which this
+ form is a part) is *not* being cached.
+
+4) When Hierarchical Select seems to be misbehaving in a certain use case in
+ which terms with multiple parents are being used, make sure to enable the
+ "Save term lineage" setting.
+ Note: you may have to repeat this for every configuration in which the
+ vocabulary with terms that have multiple parents are being used. E.g. if
+ such a vocabulary is called "A", then go to
+ admin/config/content/hierarchical_select/configs
+ and edit all configuration that have "A" in the "Hierarchy" column.
+
+In case of problems, don't forget to try a hard refresh in your browser!
+
+
+Limitations
+-----------
+- Creating new items in the hierarchy in a multiple parents hierarchy (more
+ scientifically: a directed acyclic graph) is *not* supported.
+- Not the entire scalability problem can be solved by installing this set of
+ modules; read the maximum scalability section for details.
+- The child indicators only work in Firefox. This *cannot* be supported in
+ Safari or IE. See http://drupal.org/node/180691#comment-1044691.
+- The special [save-lineage-termpath] token only works with content_taxonomy
+ fields as long as you have the "Save option" set to either "Tag" or "Both".
+- In hierarchies where items can have multiple parent items and where you have
+ enabled Hierarchical Select's "save lineage" setting, it is impossible to
+ remember individual hierarchies, unless the underlying module supports it.
+ So far, no module supports this. Hierarchical Select is just a form element,
+ not a system for storing hierarchies.
+ For example, if you have created a multiple parent vocabulary through the
+ Taxonomy module, and you have terms like this:
+ A -> C
+ A -> D
+ B -> C
+ B -> D
+ If you then save any two lineages in which all four terms exist, all four
+ lineages will be rendered by Hierarchical Select, because only the four
+ terms are stored and thus there is no way to recover the originally selected
+ two lineages.
+- You can NOT expect the Hierarchical Select Taxonomy module to automagically
+ fix all existing nodes when you enable or disable the "save lineage" setting
+ and neither can you expect it to keep working properly when you reorganize
+ the term hierarchy. There's nothing I can do about this. Hierarchical Select
+ is merely a form element, it can't be held responsible for features that
+ Drupal core lacks or supports poorly.
+ See the following issues:
+ * http://drupal.org/node/1023762#comment-4054386
+ * http://drupal.org/node/976394#comment-4054456
+
+
+Rendering hierarchy lineages when viewing content
+-------------------------------------------------
+Hierarchical Select is obviously only used for input. Hence it is only used on
+the create/edit forms of content.
+Combine that with the fact that Hierarchical Select is the only module capable
+of restoring the lineage of saved items (e.g. Taxonomy terms). None of the
+Drupal core modules is capable of storing the lineage, but Hierarchical Select
+can reconstruct it relatively efficiently. However, this lineage is only
+visible when creating/editing content, not when viewing it.
+To allow you to display the lineages of stored items, I have provided a
+theming function that you can call from within e.g. your node.tpl.php file:
+the theme_hierarchical_select_selection_as_lineages($selection, $config)
+function.
+
+Sample usage (using Taxonomy and Hierarchical Select Taxonomy):
+
+ taxonomy, $config); ?>
+
+
+This will automatically render all lineages for vocabulary 2 (meaning that if
+you want to render the lineages of multiple vocabularies, you'll have to clone
+this piece of code once for every vocabulary). It will also automatically get
+the current Hierarchical Select configuration for that vocabulary.
+
+Alternatively, you could provide the $config array yourself. Only three keys
+are required: 1) module, 2) params, 3) save_lineage. For example:
+
+ taxonomy, $config); ?>
+
+
+If you don't like how the lineage is displayed, simply override the
+theme_hierarchical_select_selection_as_lineages() function from within your
+theme, create e.g. garland_hierarchical_select_selection_as_lineages().
+
+It's also worth mentioning that the 'hs_taxonomy_tree' tag was added to the
+queries that build the term tree. As a result now you can easily change/filter
+the elements that are selected by the module (see hs_taxonomy.module for more
+info).
+
+
+Setting a fixed size
+--------------------
+When you don't want users to be able to resize a hierarchical select
+themselves, you can set a fixed size in advance yourself
+Setting #size to >1 does *not* generate #multiple = TRUE selects! And the
+opposite is also true. #multiple sets the "multiple" HTML attribute. This
+enables the user to select multiple options of a select. #size just controls
+the "size" HTML attribute. This increases the vertical size of selects,
+thereby showing more options.
+See http://www.w3.org/TR/html401/interact/forms.html#adef-size-SELECT.
+
+
+Sponsors
+--------
+* Initial development:
+ Paul Ektov of http://autobin.ru.
+* Abstraction, to let other modules than taxonomy hook in:
+ Etienne Leers of http://creditcalc.biz.
+* Support for saving the term lineage:
+ Paul Ektov of http://autobin.ru.
+* Multiple select support:
+ Marmaladesoul, http://marmaladesoul.com.
+* Taxonomy Subscriptions support:
+ Mr Bidster Inc.
+* Ability to create new items/levels:
+ The Worx Company, http://www.worxco.com.
+* Ability to only show items that are associated with at least one entity:
+ Merge, http://merge.nl.
+* Views 2 support:
+ Merge, http://merge.nl.
+* Initial Drupal 7 port + folow-up fixes:
+ PingV, http://pingv.com.
+* Port of "save lineage" functionality to Drupal 7:
+ Bancard Data Service
+
+
+Author
+------
+Wim Leers
+
+* website: http://wimleers.com/
+* contact: http://wimleers.com/contact
+
+The author can be contacted for paid development on this module. This can vary
+from new features to Hierarchical Select itself, to new implementations (i.e.
+support for new kinds of hierarchies).
diff --git a/sites/all/modules/hierarchical_select/TODO.txt b/sites/all/modules/hierarchical_select/TODO.txt
new file mode 100644
index 0000000..0e55ab5
--- /dev/null
+++ b/sites/all/modules/hierarchical_select/TODO.txt
@@ -0,0 +1,44 @@
+HS core:
+✓ port: initial port
+✓ fix: JS code cleanup (remove hardcoded hacks)
+✓ fix: title + description (i.e. something's off with the theme wrapper)
+✓ fix: #value_callback may be necessary? (see file.module) OR: ensure #return_value works
+✓ fix: #element_validate callback: _hierarchical_select_validate() — verify this still works
+✓ port: support multiple HS on the same page
+✓ port: admin UI
+✓ port: "dropbox" support
+✓ upgrade path: delete cache_hierarchical_select
+✓ upgrade path: documentation
+✓ port: "create new item" support — see http://drupal.org/node/1087620
+✓ port: status report
+- port: render_flat_select support
+- port: client-side caching (use _hierarchical_select_json_convert_hierarchy_to_cache())
+- feature: live preview of HS on the common config form
+- refactor: use the proper #value_callback -> #process callback -> #after_build callback pipeline as described in the documentation for form_builder() in form.inc
+
+Taxonomy:
+✓ port: admin UI
+✓ port: "dropbox" support
+✓ port: "save lineage" support (i.e. support multiple parents, automatic warning shown through hs_taxonomy_hierarchical_select_root_level())
+✓ port: field formatters (from content_taxonomy)
+✓ port: taxonomy term (create/edit) form should be altered to include HS
+✓ upgrade path: migrate settings (no migration necessary)
+✓ upgrade path: documentation (no migration, no docs)
+✓ port: "create new item" support — see http://drupal.org/node/1087620
+- port: "entity_count" support — see http://drupal.org/node/1068462
+- refactor: use the vocabulary machine name internally instead of the vid
+- port: token support — see http://drupal.org/node/1248908
+- port: forum support
+- refactor: optimize HS API implementation: take advantage of improvements in Taxonomy
+
+HS Taxonomy Views:
+- everything — see http://drupal.org/node/1170192
+
+Menu:
+✓ everything
+
+Flat List:
+✓ everything
+
+Small Hierarchy:
+✓ everything
diff --git a/sites/all/modules/hierarchical_select/UPGRADE.txt b/sites/all/modules/hierarchical_select/UPGRADE.txt
new file mode 100644
index 0000000..f3473ee
--- /dev/null
+++ b/sites/all/modules/hierarchical_select/UPGRADE.txt
@@ -0,0 +1,20 @@
+# Upgrading (from Drupal 6 to 7)
+
+1. **BE WARE THAT NOT ALL FUNCTIONALITY HAS BEEN PORTED!**
+
+ Make sure that you know if the part of Hierarchical Select's functionality
+ that you want to use has been ported. Otherwise, you may be in for a
+ frustrating upgrade experience.
+
+ See the included TODO.txt file for details. In a nutshell:
+
+ - Taxonomy support is almost complete, only "create new item", "entity count" and token support are missing
+ - Forum support has **not** yet been ported (but relies on Taxonomy, so this is trivial)
+ - Taxonomy Views support has **not** yet been ported
+ - Menu support has **not** yet been ported
+
+2. Upgrade this module just like any other: delete the old module, copy the
+ files of the new module and run update.php.
+ For details, see .
+
+3. That's it! :)
diff --git a/sites/all/modules/hierarchical_select/hierarchical_select-rtl.css b/sites/all/modules/hierarchical_select/hierarchical_select-rtl.css
new file mode 100644
index 0000000..6bc6c2f
--- /dev/null
+++ b/sites/all/modules/hierarchical_select/hierarchical_select-rtl.css
@@ -0,0 +1,57 @@
+
+
+/* The hierarchical select. */
+.hierarchical-select-wrapper .hierarchical-select .selects {
+ float: right; /* If a block is floated, it won't consume as much width as
+ available, only just enough. This allows the grippie to
+ perfectly scale with the with consumed by the selects. */
+}
+
+.hierarchical-select-wrapper .hierarchical-select .selects .grippie {
+ clear: right; /* clear: left; */
+ height: 9px;
+ overflow: hidden;
+ background: #eee url(images/grippie.png) no-repeat center 2px;
+ border: 1px solid #ddd;
+ border-top-width: 0;
+ cursor: s-resize;
+ margin-left: 0.5em; /* margin-right: 0.5em; */ /* Give the grippie the same margin as each select. */
+ min-width: 70px; /* Hack for IE, makes the grip usable, but not yet the same as in other browsers. */
+}
+
+.hierarchical-select-wrapper .hierarchical-select select,
+.hierarchical-select-wrapper .hierarchical-select .add-to-dropbox,
+.hierarchical-select-wrapper .hierarchical-select .create-new-item {
+ margin-left: .5em;
+ margin-right: 0; /* Reset ltr style */
+ float: right;
+}
+
+
+/* The pseudo-modal window for creating a new item or new level. */
+.hierarchical-select-wrapper .hierarchical-select .create-new-item-create,
+.hierarchical-select-wrapper .hierarchical-select .create-new-item-cancel {
+ float: left;
+ margin-right: .4em;
+ margin-left: 0; /* Reset ltr style */
+}
+
+.hierarchical-select-wrapper .hierarchical-select .create-new-item-input {
+ float: right;
+ clear: left;
+}
+
+
+/* Child level indicator. */
+.hierarchical-select-wrapper .hierarchical-select option.has-children {
+ background: url(images/arrow-rtl.png) no-repeat left center;
+ padding-left: 20px;
+ padding-right: 0;
+}
+
+
+/* Dropbox limit warning.*/
+p.hierarchical-select-dropbox-limit-warning {
+ padding-right: .5em;
+ padding-left: 0; /* Reset ltr style */
+}
diff --git a/sites/all/modules/hierarchical_select/hierarchical_select.admin.inc b/sites/all/modules/hierarchical_select/hierarchical_select.admin.inc
new file mode 100644
index 0000000..d52ee9f
--- /dev/null
+++ b/sites/all/modules/hierarchical_select/hierarchical_select.admin.inc
@@ -0,0 +1,328 @@
+ t('All settings below will be used as site-wide defaults.'),
+ '#prefix' => '',
+ '#suffix' => '
',
+ );
+ $form['hierarchical_select_animation_delay'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Animation delay'),
+ '#description' => t(
+ 'The delay that will be used for the "drop in/out" effect when a
+ hierarchical select is being updated (in milliseconds).'
+ ),
+ '#size' => 5,
+ '#maxlength' => 5,
+ '#default_value' => variable_get('hierarchical_select_animation_delay', 400),
+ );
+ $form['hierarchical_select_level_labels_style'] = array(
+ '#type' => 'select',
+ '#title' => t('Level labels style'),
+ '#description' => t(
+ 'The style that will be used for level labels. This is not supported by
+ all browsers! If you want a consistent interface, choose to use no
+ style.'
+ ),
+ '#options' => array(
+ 'none' => t('No style'),
+ 'bold' => t('Bold'),
+ 'inversed' => t('Inversed'),
+ 'underlined' => t('Underlined'),
+ ),
+ '#default_value' => variable_get('hierarchical_select_level_labels_style', 'none'),
+ );
+ // TODO: port the HS client-side cache system to Drupal 7.
+ /*
+ $form['hierarchical_select_js_cache_system'] = array(
+ '#type' => 'radios',
+ '#title' => t('Cache in a HTML 5 client-side database'),
+ '#description' => t(
+ 'This feature only works in browsers that support the
+ HTML 5 client-side database storage specification
+ .
+ After enabling this, you will notice (in supporting browsers) that
+ refreshing the hierarchical select will not require a request to the
+ server when a part is being requested that has been requested before.',
+ array('!spec-url' => url('http://www.whatwg.org/specs/web-apps/current-work/multipage/section-sql.html'))
+ ),
+ '#options' => array(
+ 0 => t('Disabled'),
+ 1 => t('Enabled'),
+ ),
+ '#default_value' => variable_get('hierarchical_select_js_cache_system', 0),
+ );
+ */
+
+ return system_settings_form($form);
+}
+
+/**
+ * Menu callback; a table that lists all Hierarchical Select configs.
+ */
+function hierarchical_select_admin_configs() {
+ $header = array(t('Hierarchy type'), t('Hierarchy'), t('Entity type'), t('Bundle'), t('Context type'), t('Context'), t('Actions'));
+
+ // Retrieve all information items
+ $info_items = array();
+ foreach (module_implements('hierarchical_select_config_info') as $module) {
+ $info_items = array_merge_recursive($info_items, module_invoke($module, 'hierarchical_select_config_info'));
+ }
+
+ // Process the retrieved information into rows.
+ $rows = array();
+ foreach ($info_items as $id => $item) {
+ $config_id = $item['config_id'];
+
+ $rows[$id] = array(
+ $item['hierarchy type'],
+ $item['hierarchy'],
+ $item['entity type'],
+ $item['bundle'],
+ $item['context type'],
+ $item['context'],
+ theme('links', array('links' => array(
+ array(
+ 'title' => t('Edit'),
+ 'href' => $item['edit link'],
+ 'fragment' => "hierarchical-select-config-form-$config_id",
+ ),
+ array(
+ 'title' => t('Export'),
+ 'href' => "admin/config/content/hierarchical_select/export/$config_id",
+ ),
+ array(
+ 'title' => t('Import'),
+ 'href' => "admin/config/content/hierarchical_select/import/$config_id",
+ ),
+ ))),
+ );
+ }
+
+ return theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array(), 'caption' => t('Overview of all Hierarchical Select configurations.')));
+}
+
+/**
+ * Menu callback; a table that lists all Hierarchical Select implementations
+ * and the features they support.
+ */
+function hierarchical_select_admin_implementations() {
+ $output = '';
+ $header = array(t('Implementation (module)'), t('Hierarchy type'), t('Entity type'), t('Create new items'), t('Entity count'));
+
+ // Retrieve all information items
+ $rows = array();
+ foreach (module_implements('hierarchical_select_root_level') as $module) {
+ $filename = db_query("SELECT filename FROM {system} WHERE type = :type AND name = :name", array(':type' => 'module', ':name' => $module))->fetchField();
+ $module_info = drupal_parse_info_file(dirname($filename) . "/$module.info");
+ // Try to extract the hierarchy type from the optional hook_hierarchical_select_config_info().
+ $hierarchy_type = $entity_type = t('unknown');
+ if (module_hook($module, 'hierarchical_select_implementation_info')) {
+ $implementation = module_invoke($module, 'hierarchical_select_implementation_info');
+ $hierarchy_type = $implementation['hierarchy type'];
+ $entity_type = $implementation['entity type'];
+ }
+
+ $rows[] = array(
+ $module_info['name'],
+ $hierarchy_type,
+ $entity_type,
+ (module_hook($module, 'hierarchical_select_create_item')) ? t('Yes') : t('No'),
+ (module_hook($module, 'hierarchical_select_entity_count')) ? t('Yes') : t('No'),
+ );
+ }
+
+ $output .= '';
+ $output .= t('
+ The table below allows you to find out which Hierarchical Select
+ features are supported by the implementations of the Hierarchical
+ Select API.not a reflection of some settings .
+ ');
+ $output .= '
';
+
+ $output .= theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array(), 'caption' => t('Overview of all installed Hierarchical Select implementations.')));
+
+ return $output;
+}
+
+/**
+ * Form definition; config export form.
+ */
+function hierarchical_select_admin_export($form, &$form_state, $config_id) {
+ require_once DRUPAL_ROOT . '/' . drupal_get_path('module', 'hierarchical_select') . '/includes/common.inc';
+
+ $config = hierarchical_select_common_config_get($config_id);
+ $code = _hierarchical_select_create_export_code($config);
+
+ drupal_add_css(drupal_get_path('module', 'hierarchical_select') . '/hierarchical_select.css');
+ drupal_add_js('$(document).ready(function() { $(".hierarchical-select-code").focus(); });', array('type' => 'inline', 'scope' => JS_DEFAULT));
+
+ $lines = substr_count($code, "\n") + 1;
+ $form['config'] = array(
+ '#type' => 'textarea',
+ '#title' => t('Hierarchical Select configuration %config_id', array('%config_id' => $config_id)),
+ '#default_value' => $code,
+ '#rows' => $lines,
+ '#attributes' => array('class' => array('hierarchical-select-config-code')),
+ );
+
+ return $form;
+}
+
+/**
+ * Form definition; config import form.
+ */
+function hierarchical_select_admin_import($form, &$form_state, $config_id) {
+ require_once DRUPAL_ROOT . '/' . drupal_get_path('module', 'hierarchical_select') . '/includes/common.inc';
+
+ drupal_add_css(drupal_get_path('module', 'hierarchical_select') . '/hierarchical_select.css');
+ drupal_add_js('$(document).ready(function() { $(".hierarchical-select-code").focus(); });', array('type' => 'inline', 'scope' => JS_DEFAULT));
+
+ $form['config'] = array(
+ '#type' => 'textarea',
+ '#title' => t('Import Hierarchical Select configuration code'),
+ '#cols' => 60,
+ '#rows' => 15,
+ '#description' => t('Copy and paste the results of an exported
+ Hierarchical Select configuration here.config id is set.'));
+ }
+}
+
+/**
+ * Submit callback; config import form.
+ */
+function hierarchical_select_admin_import_submit($form, &$form_state) {
+ $config = unserialize($form_state['values']['interpreted_config']);
+ $config_id = $config['config_id'];
+ hierarchical_select_common_config_set($config_id, $config);
+ drupal_set_message(t('Hierarchical Select configuration for %config_id imported!', array('%config_id' => $config_id)));
+}
+
+
+//----------------------------------------------------------------------------
+// Private functions.
+
+/**
+ * Given a config array, create the export code for it.
+ *
+ * @param array $config
+ * A Hierarchical Select config array, as described in API.txt
+ * @return string
+ * The code as it would appear in an editor.
+ */
+function _hierarchical_select_create_export_code($config) {
+ $output = '';
+
+ $output .= "\$config = array(\n";
+ $output .= " 'config_id' => '" . $config['config_id'] . "',\n";
+ $output .= " 'save_lineage' => " . $config['save_lineage'] . ",\n";
+ $output .= " 'enforce_deepest' => " . $config['enforce_deepest'] . ",\n";
+ $output .= " 'resizable' => " . $config['resizable'] . ",\n";
+ $output .= " 'level_labels' => array(\n";
+ $output .= " 'status' => " . $config['level_labels']['status'] . ",\n";
+ $output .= " 'labels' => array(\n";
+ if (isset($config['level_labels']['labels'])) {
+ foreach ($config['level_labels']['labels'] as $depth => $label) {
+ $label = str_replace("'", "\'", $label);
+ $output .= " $depth => '$label',\n";
+ }
+ }
+ $output .= " ),\n";
+ $output .= " ),\n";
+ $output .= " 'dropbox' => array(\n";
+ $output .= " 'status' => " . $config['dropbox']['status'] . ",\n";
+ $output .= " 'title' => '" . str_replace("'", "\'", $config['dropbox']['title']) . "',\n";
+ $output .= " 'limit' => " . $config['dropbox']['limit'] . ",\n";
+ $output .= " 'reset_hs' => " . $config['dropbox']['reset_hs'] . ",\n";
+ $output .= " 'sort' => " . $config['dropbox']['sort'] . ",\n";
+ $output .= " ),\n";
+ $output .= " 'editability' => array(\n";
+ $output .= " 'status' => " . $config['editability']['status'] . ",\n";
+ $output .= " 'item_types' => array(\n";
+ if (isset($config['editability']['item_types'])) {
+ foreach ($config['editability']['item_types'] as $depth => $item_type) {
+ $item_type = str_replace("'", "\'", $item_type);
+ $output .= " $depth => '$item_type',\n";
+ }
+ }
+ $output .= " ),\n";
+ $output .= " 'allowed_levels' => array(\n";
+ if (isset($config['editability']['allowed_levels'])) {
+ foreach ($config['editability']['allowed_levels'] as $depth => $allowed_level) {
+ $output .= " $depth => $allowed_level,\n";
+ }
+ }
+ $output .= " ),\n";
+ $output .= " 'allow_new_levels' => " . $config['editability']['allow_new_levels'] . ",\n";
+ $output .= " 'max_levels' => " . $config['editability']['max_levels'] . ",\n";
+ $output .= " ),\n";
+ $output .= " 'entity_count' => array(\n";
+ $output .= " 'enabled' => " . $config['entity_count']['enabled'] . ",\n";
+ $output .= " 'require_entity' => " . $config['entity_count']['require_entity'] . ",\n";
+ $output .= " 'settings' => array(\n";
+ $output .= " 'count_children' => " . $config['entity_count']['settings']['count_children'] . ",\n";
+ if (isset($config['entity_count']['settings']['entity_types'])) {
+ $output .= " 'entity_types' => array(\n";
+ foreach ($config['entity_count']['settings']['entity_types'] as $entity_type => $count) {
+ $output .= " '$entity_type' => array(\n";
+ foreach ($count as $delta => $bundles) {
+ $output .= " '$delta' => array(\n";
+ foreach ($bundles as $delta => $bundle) {
+ $output .= " '$delta' => '$bundle',\n";
+ }
+ $output .= " ),\n";
+ }
+ $output .= " ),\n";
+ }
+ }
+ $output .= " ),\n";
+ $output .= " ),\n";
+ $output .= " ),\n";
+ $output .= ");\n";
+
+ return $output;
+}
diff --git a/sites/all/modules/hierarchical_select/hierarchical_select.css b/sites/all/modules/hierarchical_select/hierarchical_select.css
new file mode 100644
index 0000000..5f20a75
--- /dev/null
+++ b/sites/all/modules/hierarchical_select/hierarchical_select.css
@@ -0,0 +1,226 @@
+
+
+/* The hierarchical select. */
+.hierarchical-select-wrapper .hierarchical-select .selects {
+ float: left; /* If a block is floated, it won't consume as much width as
+ available, only just enough. This allows the grippie to
+ perfectly scale with the with consumed by the selects. */
+}
+
+.hierarchical-select-wrapper .hierarchical-select .selects .grippie {
+ clear: left;
+ height: 9px;
+ overflow: hidden;
+ background: #eee url(images/grippie.png) no-repeat center 2px;
+ border: 1px solid #ddd;
+ border-top-width: 0;
+ cursor: s-resize;
+ margin-right: 0.5em; /* Give the grippie the same margin as each select. */
+ min-width: 50px; /* Hack for IE, makes the grip usable, but not yet the same as in other browsers. */
+}
+
+.hierarchical-select-wrapper .hierarchical-select select,
+.hierarchical-select-wrapper .hierarchical-select .add-to-dropbox,
+.hierarchical-select-wrapper .hierarchical-select .create-new-item {
+ margin: 0;
+ margin-right: .5em;
+ margin-bottom: 3px;
+ float: left;
+}
+
+
+/* The flat select (only used in GET forms). */
+.hierarchical-select-wrapper .flat-select {
+ display: none;
+}
+
+
+/* The pseudo-modal window for creating a new item or new level. */
+.hierarchical-select-wrapper .hierarchical-select .create-new-item {
+ padding: .7em;
+ border: 2px outset gray;
+}
+
+.hierarchical-select-wrapper .hierarchical-select .create-new-item {
+ width: 11em;
+}
+
+.hierarchical-select-wrapper .hierarchical-select .create-new-item-create,
+.hierarchical-select-wrapper .hierarchical-select .create-new-item-cancel {
+ float: right;
+ margin: 0;
+ margin-left: .4em;
+}
+
+.hierarchical-select-wrapper .hierarchical-select .create-new-item-input {
+ width: 10.5em;
+ margin: 0;
+ margin-bottom: 1em;
+ float: left;
+ clear: right;
+}
+
+
+/* Level labels styles. */
+.hierarchical-select-level-labels-style-bold .hierarchical-select select option.level-label {
+ font-weight: bold;
+}
+
+.hierarchical-select-level-labels-style-inversed .hierarchical-select select option.level-label {
+ background-color: #000000;
+ color: #FFFFFF;
+}
+
+.hierarchical-select-level-labels-style-underlined .hierarchical-select select option.level-label {
+ text-decoration: underline;
+}
+
+
+/* Child level indicator. */
+.hierarchical-select-wrapper .hierarchical-select option.has-children {
+ background: url(images/arrow.png) no-repeat right center;
+ padding-right: 20px;
+}
+
+
+/* Dropbox limit warning.*/
+p.hierarchical-select-dropbox-limit-warning {
+ padding: 0;
+ color: #F7A54F;
+ font-size: 110%;
+ padding-left: .5em;
+}
+
+
+/* The dropbox table. */
+.hierarchical-select-wrapper .dropbox-title {
+ font-size: 115%;
+ color: #898989;
+ margin-bottom: 0.2em;
+}
+
+.hierarchical-select-wrapper .dropbox {
+ display: inline-block;
+ margin: .5em 0;
+}
+
+.hierarchical-select-wrapper .dropbox table {
+ margin: 0;
+ width: auto;
+ max-width: 100%;
+ min-width: 20em;
+ color: gray;
+ font-size: 90%;
+ border: 1px solid gray;
+}
+
+tr.dropbox-entry {
+ line-height: 1.3em;
+ padding: .3em .6em;
+}
+
+tr.dropbox-entry.even {
+ background-color: transparent;
+ border-bottom: 1px solid #CCCCCC;
+}
+
+tr.dropbox-entry.odd {
+ background-color: #EDF5FA;
+ border-bottom: 1px solid #CCCCCC;
+}
+
+tr.dropbox-entry.first {
+ border-top: 1px solid gray;
+}
+
+tr.dropbox-entry.last {
+ border-bottom: 1px solid gray;
+}
+
+.dropbox-selected-item {
+ font-weight: bold;
+}
+
+.hierarchical-select-item-separator {
+ padding-left: .5em;
+ padding-right: .5em;
+}
+
+td.dropbox-remove *,
+td.dropbox-remove a:link,
+td.dropbox-remove a:visited {
+ color: #F7A54F;
+ text-decoration: none;
+}
+
+td.dropbox-remove a:hover {
+ text-decoration: underline;
+}
+
+tr.dropbox-is-empty {
+ padding: .5em 1em;
+}
+
+
+/* The "Update" button and help text (used when Javascript is disabled). */
+.hierarchical-select-wrapper .nojs .update-button {
+ margin: 0 0 1em;
+}
+
+.hierarchical-select-wrapper .nojs .help-text {
+ font-size: 90%;
+ color: transparent;
+ display: block;
+ border: 1px dotted black;
+ overflow: hidden;
+ width: 34em;
+ height: 1.2em;
+ padding: .6em;
+ line-height: normal;
+}
+
+.hierarchical-select-wrapper .nojs .help-text:hover {
+ height: auto;
+ width: auto;
+ min-width: 25em;
+ max-width: 45em;
+ color: gray;
+}
+
+.hierarchical-select-wrapper .nojs .help-text .ask-to-hover {
+ color: gray;
+ font-style: italic;
+}
+
+.hierarchical-select-wrapper .nojs .help-text:hover .ask-to-hover {
+ display: none;
+}
+
+.hierarchical-select-wrapper .nojs .help-text .highlight {
+ text-decoration: underline;
+}
+
+.hierarchical-select-wrapper .nojs .help-text .warning {
+ color: red;
+}
+
+.hierarchical-select-wrapper .nojs .help-text .solutions {
+ margin: 0;
+ padding: 0;
+}
+
+
+/* The 'waiting' class is set dynamically, during a callback to the server. */
+.hierarchical-select-wrapper.waiting {
+ opacity: 0.5;
+
+ /* IE doesn't support CSS 2 properly. */
+ zoom: 1;
+ filter: alpha(opacity=50);
+}
+
+
+/* Use a monospace font for the import/export config code text areas. */
+.hierarchical-select-config-code {
+ font-family: 'Monaco', 'Lucida Console', 'Consolas', monospace;
+}
diff --git a/sites/all/modules/hierarchical_select/hierarchical_select.features.inc b/sites/all/modules/hierarchical_select/hierarchical_select.features.inc
new file mode 100644
index 0000000..301e187
--- /dev/null
+++ b/sites/all/modules/hierarchical_select/hierarchical_select.features.inc
@@ -0,0 +1,99 @@
+ $config) {
+ $dependencies[$config_id] = $module;
+ }
+ }
+
+ // Add features and dependencies.
+ foreach ($data as $config_id) {
+ $export['features']['hierarchical_select'][$config_id] = $config_id;
+ if (isset($dependencies[$config_id])) {
+ $module = $dependencies[$config_id];
+ $export['dependencies'][$module] = $module;
+ }
+ }
+
+ return array();
+}
+
+/**
+ * Implements hook_features_export_options().
+ */
+function hierarchical_select_features_export_options() {
+ // Retrieve all information items.
+ $info_items = array();
+ foreach (module_implements('hierarchical_select_config_info') as $module) {
+ $info_items = array_merge_recursive($info_items, module_invoke($module, 'hierarchical_select_config_info'));
+ }
+
+ // Process the retrieved information into options.
+ $options = array();
+ foreach ($info_items as $id => $item) {
+ $config_id = $item['config_id'];
+ $options[$config_id] = $item['hierarchy type'] . ': ' . $item['hierarchy'] . ' - ' . $item['context type'] . (!empty($item['context']) ? ': ' . $item['context'] : '');
+ }
+
+ return $options;
+}
+
+/**
+ * Implements hook_features_export_render().
+ */
+function hierarchical_select_features_export_render($module, $data) {
+ module_load_include('inc', 'hierarchical_select', 'includes/common');
+ module_load_include('inc', 'hierarchical_select', 'hierarchical_select.admin');
+
+ $code = array();
+ $code[] = '$configs = array();';
+ foreach ($data as $config_id) {
+ $config = hierarchical_select_common_config_get($config_id);
+ $config['config_id'] = $config_id;
+
+ $code[] = _hierarchical_select_create_export_code($config);
+ $code[] = "\$configs['{$config_id}'] = \$config;";
+ }
+ $code[] = "return \$configs;";
+ $code = implode("\n", $code);
+
+ return array('hierarchical_select_default_configs' => $code);
+}
+
+/**
+ * Implements hook_features_revert().
+ */
+function hierarchical_select_features_revert($module) {
+ hierarchical_select_features_rebuild($module);
+}
+
+/**
+ * Implements hook_features_rebuild().
+ */
+function hierarchical_select_features_rebuild($module) {
+ module_load_include('inc', 'hierarchical_select', 'includes/common');
+ $configs = features_get_default('hierarchical_select', $module);
+ if (!empty($configs)) {
+ // Apply the configuration.
+ require_once(drupal_get_path('module', 'hierarchical_select') .'/includes/common.inc');
+
+ foreach ($configs as $config_id => $config) {
+ hierarchical_select_common_config_set($config_id, $config);
+ }
+ }
+}
diff --git a/sites/all/modules/hierarchical_select/hierarchical_select.info b/sites/all/modules/hierarchical_select/hierarchical_select.info
new file mode 100644
index 0000000..c796df3
--- /dev/null
+++ b/sites/all/modules/hierarchical_select/hierarchical_select.info
@@ -0,0 +1,14 @@
+name = Hierarchical Select
+description = Simplifies the selection of one or multiple items in a hierarchical tree.
+package = Form Elements
+
+core = 7.x
+configure = admin/config/content/hierarchical_select
+files[] = tests/internals.test
+
+; Information added by Drupal.org packaging script on 2016-06-03
+version = "7.x-3.0-beta7"
+core = "7.x"
+project = "hierarchical_select"
+datestamp = "1464981541"
+
diff --git a/sites/all/modules/hierarchical_select/hierarchical_select.install b/sites/all/modules/hierarchical_select/hierarchical_select.install
new file mode 100644
index 0000000..825c2a0
--- /dev/null
+++ b/sites/all/modules/hierarchical_select/hierarchical_select.install
@@ -0,0 +1,84 @@
+condition('name', 'hs_config_%', 'LIKE')
+ ->execute();
+
+ db_delete('variable')
+ ->condition('name', 'hierarchical_select_%', 'LIKE')
+ ->execute();
+}
+
+
+//----------------------------------------------------------------------------
+// Updates.
+
+/**
+ * Update Hierarchical Select to Drupal 7. Basically remove a lot of cruft.
+ */
+function hierarchical_select_update_7001() {
+ // Drop Hierarchical Select's cache table, which is now obsolete.
+ db_drop_table('cache_hierarchical_select');
+
+ // Undo Hierarchical Select module weight changes, because they're no longer
+ // necessary.
+ db_update('system')
+ ->fields(array(
+ 'weight' => 0,
+ ))
+ ->condition('name', 'hierarchical_select')
+ ->execute();
+}
+
+/**
+ * Update Hierarchical Select config to support improved "entity count".
+ */
+function hierarchical_select_update_7002() {
+ module_load_include('inc', 'hierarchical_select', 'includes/common');
+ // Retrieve all information items.
+ $info_items = array();
+ foreach (module_implements('hierarchical_select_config_info') as $module) {
+ $info_items = array_merge_recursive($info_items, module_invoke($module, 'hierarchical_select_config_info'));
+ }
+ foreach ($info_items as $info_item) {
+ // Load config.
+ $config = hierarchical_select_common_config_get($info_item['config_id']);
+
+ // Move old settings to new location.
+ $config['entity_count'] = array(
+ 'enabled' => $config['entity_count'],
+ 'require_entity' => $config['require_entity'],
+ );
+
+ // Remove old setting.
+ unset($config['require_entity']);
+
+ // Add entity types settings.
+ $entity_info = entity_get_info();
+ foreach ($entity_info as $entity => $entity_info) {
+ if (!empty($entity_info['bundles']) && $entity_info['fieldable'] === TRUE) {
+ foreach ($entity_info['bundles'] as $bundle => $bundle_info) {
+ if ($entity == 'node') {
+ $config['entity_count']['settings']['entity_types'][$entity]['count_' . $entity][$bundle] = $bundle;
+ }
+ else {
+ $config['entity_count']['settings']['entity_types'][$entity]['count_' . $entity][$bundle] = 0;
+ }
+ }
+ }
+ }
+
+ // Save new config.
+ hierarchical_select_common_config_set($info_item['config_id'], $config);
+ }
+}
diff --git a/sites/all/modules/hierarchical_select/hierarchical_select.js b/sites/all/modules/hierarchical_select/hierarchical_select.js
new file mode 100644
index 0000000..df98f65
--- /dev/null
+++ b/sites/all/modules/hierarchical_select/hierarchical_select.js
@@ -0,0 +1,702 @@
+
+(function($) {
+
+Drupal.behaviors.HierarchicalSelect = {
+ attach: function (context) {
+ $('.hierarchical-select-wrapper:not(.hierarchical-select-wrapper-processed)', context)
+ .addClass('hierarchical-select-wrapper-processed').each(function() {
+ var hsid = $(this).attr('id').replace(/^hierarchical-select-(.+)-wrapper$/, "$1");
+ Drupal.HierarchicalSelect.initialize(hsid);
+ });
+ }
+};
+
+Drupal.HierarchicalSelect = {};
+
+Drupal.HierarchicalSelect.state = [];
+
+Drupal.HierarchicalSelect.context = function() {
+ return $("form .hierarchical-select-wrapper");
+};
+
+Drupal.HierarchicalSelect.initialize = function(hsid) {
+ // Prevent JS errors when Hierarchical Select is loaded dynamically.
+ if (undefined == Drupal.settings.HierarchicalSelect || undefined == Drupal.settings.HierarchicalSelect.settings["hs-" + hsid]) {
+ return false;
+ }
+
+ // If you set Drupal.settings.HierarchicalSelect.pretendNoJS to *anything*,
+ // and as such, Hierarchical Select won't initialize its Javascript! It
+ // will seem as if your browser had Javascript disabled.
+ if (undefined != Drupal.settings.HierarchicalSelect.pretendNoJS) {
+ return false;
+ }
+
+ var form = $('#hierarchical-select-'+ hsid +'-wrapper').parents('form');
+
+ // Pressing the 'enter' key on a form that contains an HS widget, depending
+ // on which browser, usually causes the first submit button to be pressed
+ // (likely an HS button). This results in unpredictable behaviour. There is
+ // no way to determine the 'real' submit button, so disable the enter key.
+ form.find('input').keypress(function(event) {
+ if (event.keyCode == 13) {
+ event.preventDefault();
+ return false;
+ }
+ });
+
+ // Turn off Firefox' autocomplete feature. This causes Hierarchical Select
+ // form items to be disabled after a hard refresh.
+ // See http://drupal.org/node/453048 and
+ // http://www.ryancramer.com/journal/entries/radio_buttons_firefox/
+ if (navigator.userAgent.toLowerCase().indexOf('firefox') > -1) {
+ form.attr('autocomplete', 'off');
+ }
+
+ // Enable *all* submit buttons in this form, as well as all input-related
+ // elements of the current hierarchical select, in case we reloaded while
+ // they were disabled.
+ form.add('#hierarchical-select-' + hsid +'-wrapper .hierarchical-select .selects select')
+ .add('#hierarchical-select-' + hsid +'-wrapper .hierarchical-select input')
+ .attr('disabled', false);
+
+ if (this.cache != null) {
+ this.cache.initialize();
+ }
+
+ Drupal.settings.HierarchicalSelect.settings["hs-" + hsid]['updatesEnabled'] = true;
+ if (undefined == Drupal.HierarchicalSelect.state["hs-" + hsid]) {
+ Drupal.HierarchicalSelect.state["hs-" + hsid] = {};
+ }
+
+ this.transform(hsid);
+ if (Drupal.settings.HierarchicalSelect.settings["hs-" + hsid].resizable) {
+ this.resizable(hsid);
+ }
+ Drupal.HierarchicalSelect.attachBindings(hsid);
+
+ if (this.cache != null && this.cache.status()) {
+ this.cache.load(hsid);
+ }
+
+ Drupal.HierarchicalSelect.log(hsid);
+};
+
+Drupal.HierarchicalSelect.log = function(hsid, messages) {
+ // Only perform logging if logging is enabled.
+ if (Drupal.settings.HierarchicalSelect.initialLog == undefined || Drupal.settings.HierarchicalSelect.initialLog["hs-" + hsid] == undefined) {
+ return;
+ }
+ else {
+ Drupal.HierarchicalSelect.state["hs-" + hsid].log = [];
+ }
+
+ // Store the log messages. The first call to this function may not contain a
+ // message: the initial log included in the initial HTML rendering should be
+ // used instead..
+ if (Drupal.HierarchicalSelect.state["hs-" + hsid].log.length == 0) {
+ Drupal.HierarchicalSelect.state["hs-" + hsid].log.push(Drupal.settings.HierarchicalSelect.initialLog["hs-" + hsid]);
+ }
+ else {
+ Drupal.HierarchicalSelect.state["hs-" + hsid].log.push(messages);
+ }
+
+ // Print the log messages.
+ console.log("HIERARCHICAL SELECT " + hsid);
+ var logIndex = Drupal.HierarchicalSelect.state["hs-" + hsid].log.length - 1;
+ for (var i = 0; i < Drupal.HierarchicalSelect.state["hs-" + hsid].log[logIndex].length; i++) {
+ console.log(Drupal.HierarchicalSelect.state["hs-" + hsid].log[logIndex][i]);
+ }
+ console.log(' ');
+};
+
+Drupal.HierarchicalSelect.transform = function(hsid) {
+ var removeString = $('#hierarchical-select-'+ hsid +'-wrapper .dropbox .dropbox-remove:first', Drupal.HierarchicalSelect.context).text();
+
+ $('#hierarchical-select-'+ hsid +'-wrapper', Drupal.HierarchicalSelect.context)
+ // Remove the .nojs div.
+ .find('.nojs').hide().end()
+ // Find all .dropbox-remove cells in the dropbox table.
+ .find('.dropbox .dropbox-remove')
+ // Hide the children of these table cells. We're not removing them because
+ // we want to continue to use the "Remove" checkboxes.
+ .find('*').css('display', 'none').end() // We can't use .hide() because of collapse.js: http://drupal.org/node/351458#comment-1258303.
+ // Put a "Remove" link there instead.
+ .append(''+ removeString +' ');
+};
+
+Drupal.HierarchicalSelect.resizable = function(hsid) {
+ var $selectsWrapper = $('#hierarchical-select-' + hsid + '-wrapper .hierarchical-select .selects', Drupal.HierarchicalSelect.context);
+
+ // No select wrapper present: the user is creating a new item.
+ if ($selectsWrapper.length == 0) {
+ return;
+ }
+
+ // Append the drag handle ("grippie").
+ $selectsWrapper.append($('
'));
+
+ // jQuery object that contains all selects in the hierarchical select, to
+ // speed up DOM manipulation during dragging.
+ var $selects = $selectsWrapper.find('select');
+
+ var defaultPadding = parseInt($selects.slice(0, 1).css('padding-top').replace(/^(\d+)px$/, "$1")) + parseInt($selects.slice(0, 1).css('padding-bottom').replace(/^(\d+)px$/, "$1"));
+ var defaultHeight = Drupal.HierarchicalSelect.state["hs-" + hsid].defaultHeight = $selects.slice(0, 1).height() + defaultPadding;
+ var defaultSize = Drupal.HierarchicalSelect.state["hs-" + hsid].defaultSize = $selects.slice(0, 1).attr('size');
+ defaultSize = (defaultSize == 0) ? 1 : defaultSize;
+ var margin = Drupal.HierarchicalSelect.state["hs-" + hsid].margin = parseInt($selects.slice(0, 1).css('margin-bottom').replace(/^(\d+)px$/, "$1"));
+
+ // Bind the drag event.
+ $('.grippie', $selectsWrapper)
+ .mousedown(startDrag)
+ .dblclick(function() {
+ if (Drupal.HierarchicalSelect.state["hs-" + hsid].resizedHeight == undefined) {
+ Drupal.HierarchicalSelect.state["hs-" + hsid].resizedHeight = defaultHeight;
+ }
+ var resizedHeight = Drupal.HierarchicalSelect.state["hs-" + hsid].resizedHeight = (Drupal.HierarchicalSelect.state["hs-" + hsid].resizedHeight > defaultHeight + 2) ? defaultHeight : 4.6 / defaultSize * defaultHeight;
+ Drupal.HierarchicalSelect.resize($selects, defaultHeight, resizedHeight, defaultSize, margin);
+ });
+
+ function startDrag(e) {
+ staticOffset = $selects.slice(0, 1).height() - e.pageY;
+ $selects.css('opacity', 0.25);
+ $(document).mousemove(performDrag).mouseup(endDrag);
+ return false;
+ }
+
+ function performDrag(e) {
+ var resizedHeight = staticOffset + e.pageY;
+ Drupal.HierarchicalSelect.resize($selects, defaultHeight, resizedHeight, defaultSize, margin);
+ return false;
+ }
+
+ function endDrag(e) {
+ var height = $selects.slice(0, 1).height();
+
+ $(document).unbind("mousemove", performDrag).unbind("mouseup", endDrag);
+ $selects.css('opacity', 1);
+ if (height != Drupal.HierarchicalSelect.state["hs-" + hsid].resizedHeight) {
+ Drupal.HierarchicalSelect.state["hs-" + hsid].resizedHeight = (height > defaultHeight) ? height : defaultHeight;
+ }
+ }
+};
+
+Drupal.HierarchicalSelect.resize = function($selects, defaultHeight, resizedHeight, defaultSize, margin) {
+ if (resizedHeight == undefined) {
+ resizedHeight = defaultHeight;
+ }
+
+ $selects
+ .attr('size', (resizedHeight > defaultHeight) ? 2 : defaultSize)
+ .height(Math.max(defaultHeight + margin, resizedHeight)); // Without the margin component, the height() method would allow the select to be sized to low: defaultHeight - margin.
+};
+
+Drupal.HierarchicalSelect.disableForm = function(hsid) {
+ // Disable *all* submit buttons in this form, as well as all input-related
+ // elements of the current hierarchical select.
+ $('form:has(#hierarchical-select-' + hsid +'-wrapper) :submit')
+ .add('#hierarchical-select-' + hsid +'-wrapper .hierarchical-select .selects select')
+ .add('#hierarchical-select-' + hsid +'-wrapper .hierarchical-select :input')
+ .attr('disabled', true);
+
+ // Add the 'waiting' class. Default style: make everything transparent.
+ $('#hierarchical-select-' + hsid +'-wrapper').addClass('waiting');
+
+ // Indicate that the user has to wait.
+ $('body').css('cursor', 'wait');
+};
+
+Drupal.HierarchicalSelect.enableForm = function(hsid) {
+ // This method undoes everything the disableForm() method did.
+
+ $e = $('form:has(#hierarchical-select-' + hsid +'-wrapper) :submit')
+ .add('#hierarchical-select-' + hsid +'-wrapper .hierarchical-select :input:not(:submit)');
+
+ // Don't enable the selects again if they've been disabled because the
+ // dropbox limit was exceeded.
+ dropboxLimitExceeded = $('#hierarchical-select-' + hsid +'-wrapper .hierarchical-select-dropbox-limit-warning').length > 0;
+ if (!dropboxLimitExceeded) {
+ $e = $e.add($('#hierarchical-select-' + hsid +'-wrapper .hierarchical-select .selects select'));
+ }
+ $e.removeAttr("disabled");
+
+ // Don't enable the 'Add' button again if it's been disabled because the
+ // dropbox limit was exceeded.
+ if (dropboxLimitExceeded) {
+ $('#hierarchical-select-' + hsid +'-wrapper .hierarchical-select :submit')
+ .attr('disabled', true);
+ }
+
+ $('#hierarchical-select-' + hsid +'-wrapper').removeClass('waiting');
+
+ $('body').css('cursor', 'auto');
+};
+
+Drupal.HierarchicalSelect.throwError = function(hsid, message) {
+ // Show the error to the user.
+ alert(message);
+
+ // Log the error.
+ Drupal.HierarchicalSelect.log(hsid, [ message ]);
+
+ // Re-enable the form to allow the user to retry, but reset the selection to
+ // the level label if possible, otherwise the "" option if possible.
+ var $select = $('#hierarchical-select-' + hsid +'-wrapper .hierarchical-select .selects select:first');
+ var levelLabelOption = $('option[value^=label_]', $select).val();
+ if (levelLabelOption !== undefined) {
+ $select.val(levelLabelOption);
+ }
+ else {
+ var noneOption = $('option[value=none]', $select).val();
+ if (noneOption !== undefined) {
+ $select.val(noneOption);
+ }
+ }
+ Drupal.HierarchicalSelect.enableForm(hsid);
+};
+
+Drupal.HierarchicalSelect.prepareGETSubmit = function(hsid) {
+ // Remove the name attributes of all form elements that end up in GET,
+ // except for the "flat select" form element.
+ $('#hierarchical-select-'+ hsid +'-wrapper', Drupal.HierarchicalSelect.context)
+ .find('input, select')
+ .not('.flat-select')
+ .removeAttr('name');
+
+ // Update the name attribute of the "flat select" form element
+ var $flatSelect = $('#hierarchical-select-'+ hsid +'-wrapper .flat-select', Drupal.HierarchicalSelect.context);
+ var newName = $flatSelect.attr('name').replace(/^([a-zA-Z0-9_\-]*)(?:\[flat_select\]){1}(\[\])?$/, "$1$2");
+ $flatSelect.attr('name', newName);
+
+ Drupal.HierarchicalSelect.triggerEvents(hsid, 'prepared-GET-submit', {});
+};
+
+Drupal.HierarchicalSelect.attachBindings = function(hsid) {
+ var updateOpString = $('#hierarchical-select-'+ hsid +'-wrapper .update-button').val();
+ var addOpString = $('#hierarchical-select-'+ hsid +'-wrapper .hierarchical-select .add-to-dropbox', Drupal.HierarchicalSelect.context).val();
+ var createNewItemOpString = $('#hierarchical-select-'+ hsid +'-wrapper .hierarchical-select .create-new-item-create', Drupal.HierarchicalSelect.context).val();
+ var cancelNewItemOpString = $('#hierarchical-select-'+ hsid +'-wrapper .hierarchical-select .create-new-item-cancel', Drupal.HierarchicalSelect.context).val();
+
+ var data = {};
+ data.hsid = hsid;
+
+ $('#hierarchical-select-'+ hsid +'-wrapper', this.context)
+ // "disable-updates" event
+ .unbind('disable-updates').bind('disable-updates', data, function(e) {
+ Drupal.settings.HierarchicalSelect.settings["hs-" + e.data.hsid]['updatesEnabled'] = false;
+ })
+
+ // "enforce-update" event
+ .unbind('enforce-update').bind('enforce-update', data, function(e, extraPost) {
+ Drupal.HierarchicalSelect.update(e.data.hsid, 'enforced-update', { opString: updateOpString, extraPost: extraPost });
+ })
+
+ // "prepare-GET-submit" event
+ .unbind('prepare-GET-submit').bind('prepare-GET-submit', data, function(e) {
+ Drupal.HierarchicalSelect.prepareGETSubmit(e.data.hsid);
+ })
+
+ // "update-hierarchical-select" event
+ .find('.hierarchical-select .selects select').unbind().change(function(_hsid) {
+ return function() {
+ if (Drupal.settings.HierarchicalSelect.settings["hs-" + _hsid]['updatesEnabled']) {
+ Drupal.HierarchicalSelect.update(_hsid, 'update-hierarchical-select', { opString: updateOpString, select_id : $(this).attr('id') });
+ }
+ };
+ }(hsid)).end()
+
+ // "create-new-item" event
+ .find('.hierarchical-select .create-new-item .create-new-item-create').unbind().click(function(_hsid) {
+ return function() {
+ Drupal.HierarchicalSelect.update(_hsid, 'create-new-item', { opString : createNewItemOpString });
+ return false; // Prevent the browser from POSTing the page.
+ };
+ }(hsid)).end()
+
+ // "cancel-new-item" event"
+ .find('.hierarchical-select .create-new-item .create-new-item-cancel').unbind().click(function(_hsid) {
+ return function() {
+ Drupal.HierarchicalSelect.update(_hsid, 'cancel-new-item', { opString : cancelNewItemOpString });
+ return false; // Prevent the browser from POSTing the page (in case of the "Cancel" button).
+ };
+ }(hsid)).end()
+
+ // "add-to-dropbox" event
+ .find('.hierarchical-select .add-to-dropbox').unbind().click(function(_hsid) {
+ return function() {
+ Drupal.HierarchicalSelect.update(_hsid, 'add-to-dropbox', { opString : addOpString });
+ return false; // Prevent the browser from POSTing the page.
+ };
+ }(hsid)).end()
+
+ // "remove-from-dropbox" event
+ // (anchors in the .dropbox-remove cells in the .dropbox table)
+ .find('.dropbox .dropbox-remove a').unbind().click(function(_hsid) {
+ return function() {
+ var isDisabled = $('#hierarchical-select-'+ hsid +'-wrapper', Drupal.HierarchicalSelect.context).attr('disabled');
+
+ // If the hierarchical select is disabled, then ignore this click.
+ if (isDisabled) {
+ return false;
+ }
+
+ // Check the (hidden, because JS is enabled) checkbox that marks this
+ // dropbox entry for removal.
+ $(this).parent().find('input[type=checkbox]').attr('checked', true);
+ Drupal.HierarchicalSelect.update(_hsid, 'remove-from-dropbox', { opString: updateOpString });
+ return false; // Prevent the browser from POSTing the page.
+ };
+ }(hsid));
+};
+
+Drupal.HierarchicalSelect.preUpdateAnimations = function(hsid, updateType, lastUnchanged, callback) {
+ switch (updateType) {
+ case 'update-hierarchical-select':
+ // Drop out the selects of the levels deeper than the select of the
+ // level that just changed.
+ var animationDelay = Drupal.settings.HierarchicalSelect.settings["hs-" + hsid]['animationDelay'];
+ var $animatedSelects = $('#hierarchical-select-'+ hsid +'-wrapper .hierarchical-select .selects select', Drupal.HierarchicalSelect.context).slice(lastUnchanged);
+ if ($animatedSelects.size() > 0) {
+ $animatedSelects.hide();
+ for (var i = 0; i < $animatedSelects.size(); i++) {
+ if (i < $animatedSelects.size() - 1) {
+ $animatedSelects.slice(i, i + 1).hide("drop", { direction: "left" }, animationDelay);
+ }
+ else {
+ $animatedSelects.slice(i, i + 1).hide("drop", { direction: "left" }, animationDelay, callback);
+ }
+ }
+ }
+ else if (callback) {
+ callback();
+ }
+ break;
+ default:
+ if (callback) {
+ callback();
+ }
+ break;
+ }
+};
+
+Drupal.HierarchicalSelect.postUpdateAnimations = function(hsid, updateType, lastUnchanged, callback) {
+ if (Drupal.settings.HierarchicalSelect.settings["hs-" + hsid].resizable) {
+ // Restore the resize.
+ Drupal.HierarchicalSelect.resize(
+ $('#hierarchical-select-' + hsid + '-wrapper .hierarchical-select .selects select', Drupal.HierarchicalSelect.context),
+ Drupal.HierarchicalSelect.state["hs-" + hsid].defaultHeight,
+ Drupal.HierarchicalSelect.state["hs-" + hsid].resizedHeight,
+ Drupal.HierarchicalSelect.state["hs-" + hsid].defaultSize,
+ Drupal.HierarchicalSelect.state["hs-" + hsid].margin
+ );
+ }
+
+ switch (updateType) {
+ case 'update-hierarchical-select':
+ var $createNewItemInput = $('#hierarchical-select-'+ hsid +'-wrapper .hierarchical-select .create-new-item-input', Drupal.HierarchicalSelect.context);
+ // Hide the loaded selects after the one that was just changed, then
+ // drop them in.
+ var animationDelay = Drupal.settings.HierarchicalSelect.settings["hs-" + hsid]['animationDelay'];
+ var $animatedSelects = $('#hierarchical-select-'+ hsid +'-wrapper .hierarchical-select .selects select', Drupal.HierarchicalSelect.context).slice(lastUnchanged);
+ if ($animatedSelects.size() > 0) {
+ $animatedSelects.hide();
+ for (var i = 0; i < $animatedSelects.size(); i++) {
+ if (i < $animatedSelects.size() - 1) {
+ $animatedSelects.slice(i, i + 1).show("drop", { direction: "left" }, animationDelay);
+ }
+ else {
+ $animatedSelects.slice(i, i + 1).show("drop", { direction: "left" }, animationDelay, callback);
+ }
+ }
+ }
+ else if (callback) {
+ callback();
+ }
+ if ($createNewItemInput.size() == 0) {
+ // Give focus to the level below the one that has changed, if it
+ // exists.
+ setTimeout(
+ function() {
+ $('#hierarchical-select-'+ hsid +'-wrapper .hierarchical-select .selects select', Drupal.HierarchicalSelect.context)
+ .slice(lastUnchanged, lastUnchanged + 1)
+ .focus();
+ },
+ animationDelay + 100
+ );
+ }
+ else {
+ // Give focus to the input field of the "create new item/level"
+ // section, if it exists, and also select the existing text.
+ $createNewItemInput.focus();
+ $createNewItemInput[0].select();
+ }
+ break;
+
+ case 'create-new-item':
+ // Make sure that other Hierarchical Selects that represent the same
+ // hierarchy are also updated, to make sure that they have the newly
+ // created item!
+ var cacheId = Drupal.settings.HierarchicalSelect.settings["hs-" + hsid].cacheId;
+ for (var otherHsid in Drupal.settings.HierarchicalSelect.settings) {
+ if (Drupal.settings.HierarchicalSelect.settings[otherHsid].cacheId == cacheId) {
+ $('#hierarchical-select-'+ otherHsid +'-wrapper')
+ .trigger('enforce-update');
+ }
+ }
+ // TRICKY: NO BREAK HERE!
+
+ case 'cancel-new-item':
+ // After an item/level has been created/cancelled, reset focus to the
+ // beginning of the hierarchical select.
+ $('#hierarchical-select-'+ hsid +'-wrapper .hierarchical-select .selects select', Drupal.HierarchicalSelect.context)
+ .slice(0, 1)
+ .focus();
+
+ if (callback) {
+ callback();
+ }
+ break;
+
+ default:
+ if (callback) {
+ callback();
+ }
+ break;
+ }
+};
+
+Drupal.HierarchicalSelect.triggerEvents = function(hsid, updateType, settings) {
+ $('#hierarchical-select-'+ hsid +'-wrapper', Drupal.HierarchicalSelect.context)
+ .trigger(updateType, [ hsid, settings ]);
+};
+
+Drupal.HierarchicalSelect.update = function(hsid, updateType, settings) {
+ var post = $('form:has(#hierarchical-select-' + hsid +'-wrapper)', Drupal.HierarchicalSelect.context).formToArray();
+ var hs_current_language = Drupal.settings.HierarchicalSelect.hs_current_language;
+
+ // Pass the hierarchical_select id via POST.
+ post.push({ name : 'hsid', value : hsid });
+ // Send the current language so we can use the same language during the AJAX callback.
+ post.push({ name : 'hs_current_language', value : hs_current_language});
+ // Emulate the AJAX data sent normally so that we get the same theme.
+ post.push({ name : 'ajax_page_state[theme]', value : Drupal.settings.ajaxPageState.theme });
+ post.push({ name : 'ajax_page_state[theme_token]', value : Drupal.settings.ajaxPageState.theme_token });
+
+ // If a cache system is installed, let the server know if it's running
+ // properly. If it is running properly, the server will send back additional
+ // information to maintain a lazily-loaded cache.
+ if (Drupal.HierarchicalSelect.cache != null) {
+ post.push({ name : 'client_supports_caching', value : Drupal.HierarchicalSelect.cache.status() });
+ }
+
+ // updateType is one of:
+ // - 'none' (default)
+ // - 'update-hierarchical-select'
+ // - 'enforced-update'
+ // - 'create-new-item'
+ // - 'cancel-new-item'
+ // - 'add-to-dropbox'
+ // - 'remove-from-dropbox'
+ switch (updateType) {
+ case 'update-hierarchical-select':
+ var value = $('#'+ settings.select_id).val();
+ var lastUnchanged = parseInt(settings.select_id.replace(/^.*-hierarchical-select-selects-(\d+)/, "$1")) + 1;
+ var optionClass = $('#'+ settings.select_id).find('option[value="'+ value +'"]').attr('class');
+
+ // Don't do anything (also no callback to the server!) when the selected
+ // item is:
+ // - the '' option and the renderFlatSelect setting is disabled, or
+ // - a level label, or
+ // - an option of class 'has-no-children', and
+ // (the renderFlatSelect setting is disabled or the dropbox is enabled)
+ // and
+ // (the createNewLevels setting is disabled).
+ if ((value == 'none' && Drupal.settings.HierarchicalSelect.settings["hs-" + hsid]['renderFlatSelect'] == false)
+ || value.match(/^label_\d+$/)
+ || (optionClass == 'has-no-children'
+ &&
+ (
+ (Drupal.settings.HierarchicalSelect.settings["hs-" + hsid]['renderFlatSelect'] == false
+ || $('#hierarchical-select-'+ hsid +'-wrapper .dropbox').length > 0
+ )
+ &&
+ Drupal.settings.HierarchicalSelect.settings["hs-" + hsid]['createNewLevels'] == false
+ )
+ )
+ )
+ {
+ Drupal.HierarchicalSelect.preUpdateAnimations(hsid, updateType, lastUnchanged, function() {
+ // Remove the sublevels.
+ $('#hierarchical-select-'+ hsid +'-wrapper .hierarchical-select .selects select', Drupal.HierarchicalSelect.context)
+ .slice(lastUnchanged)
+ .remove();
+
+ // The selection of this hierarchical select has changed!
+ Drupal.HierarchicalSelect.triggerEvents(hsid, 'change-hierarchical-select', settings);
+ });
+ return;
+ }
+ post.push({ name : 'op', value : settings.opString });
+ break;
+
+ case 'enforced-update':
+ post.push({ name : 'op', value : settings.opString });
+ post = post.concat(settings.extraPost);
+ break;
+
+ case 'create-new-item':
+ case 'cancel-new-item':
+ case 'add-to-dropbox':
+ case 'remove-from-dropbox':
+ post.push({ name : 'op', value : settings.opString });
+ break;
+
+ default:
+ break;
+ }
+
+ // Construct the URL the request should be made to.
+ var url = Drupal.settings.HierarchicalSelect.settings["hs-" + hsid].ajax_url;
+
+ // Construct the object that contains the options for a callback to the
+ // server. If a client-side cache is found however, it's possible that this
+ // won't be used.
+ var ajaxOptions = $.extend({}, Drupal.ajax.prototype, {
+ url: url,
+ type: 'POST',
+ dataType: 'json',
+ data: post,
+ effect: 'fade',
+ wrapper: '#hierarchical-select-' + hsid + '-wrapper',
+ beforeSend: function() {
+ Drupal.HierarchicalSelect.triggerEvents(hsid, 'before-' + updateType, settings);
+ Drupal.HierarchicalSelect.disableForm(hsid);
+ },
+ error: function (XMLHttpRequest, textStatus, errorThrown) {
+ // When invalid HTML is received in Safari, jQuery calls this function.
+ Drupal.HierarchicalSelect.throwError(hsid, Drupal.t('Received an invalid response from the server.'));
+ },
+ success: function(response, status) {
+ // An invalid response may be returned by the server, in case of a PHP
+ // error. Detect this and let the user know.
+ if (response === null || response.length == 0) {
+ Drupal.HierarchicalSelect.throwError(hsid, Drupal.t('Received an invalid response from the server.'));
+ return;
+ }
+
+ // Execute all AJAX commands in the response. But pass an additional
+ // hsid parameter, which is then only used by the commands written
+ // for Hierarchical Select.
+
+ // This is another hack because of the non-Drupal ajax implementation
+ // of this module, one of the response that can come from a drupal
+ // ajax command is insert, which expects a Drupal.ajax object as the first
+ // arguments and assumes that certain functions/settings are available.
+ // Because we are calling a Drupal.ajax.command but providing the regular
+ // jQuery ajax object itself, we are allowing Drupal.ajax.prototype.commands
+ // to misserably fail.
+ //
+ // This hack attempts to fix one issue with an insert command,
+ // @see https://www.drupal.org/node/2393695, allowing it to work properly
+ // Other hacks might be necessary for other ajax commands if they are added
+ // by external modules.
+ this.effect = 'none';
+ this.getEffect = Drupal.ajax.prototype.getEffect;
+
+ for (var i in response) {
+ if (response[i]['command'] && Drupal.ajax.prototype.commands[response[i]['command']]) {
+ Drupal.ajax.prototype.commands[response[i]['command']](this, response[i], status, hsid);
+ }
+ }
+
+ // Attach behaviors. This is just after the HTML has been updated, so
+ // it's as soon as we can.
+ Drupal.attachBehaviors($('#hierarchical-select-' + hsid + '-wrapper').parents('div.form-type-hierarchical-select')[0]);
+
+ // Transform the hierarchical select and/or dropbox to the JS variant,
+ // make it resizable again and re-enable the disabled form items.
+ Drupal.HierarchicalSelect.enableForm(hsid);
+
+ Drupal.HierarchicalSelect.postUpdateAnimations(hsid, updateType, lastUnchanged, function() {
+ // Update the client-side cache when:
+ // - information for in the cache is provided in the response, and
+ // - the cache system is available, and
+ // - the cache system is running.
+ if (response.cache != null && Drupal.HierarchicalSelect.cache != null && Drupal.HierarchicalSelect.cache.status()) {
+ Drupal.HierarchicalSelect.cache.sync(hsid, response.cache);
+ }
+
+ if (response.log != undefined) {
+ Drupal.HierarchicalSelect.log(hsid, response.log);
+ }
+
+ Drupal.HierarchicalSelect.triggerEvents(hsid, updateType, settings);
+
+ if (updateType == 'update-hierarchical-select') {
+ // The selection of this hierarchical select has changed!
+ Drupal.HierarchicalSelect.triggerEvents(hsid, 'change-hierarchical-select', settings);
+ }
+ });
+ }
+ });
+
+ // Use the client-side cache to update the hierarchical select when:
+ // - the hierarchical select is being updated (i.e. no add/remove), and
+ // - the renderFlatSelect setting is disabled, and
+ // - the createNewItems setting is disabled, and
+ // - the cache system is available, and
+ // - the cache system is running.
+ // Otherwise, perform a normal dynamic form submit.
+ if (updateType == 'update-hierarchical-select'
+ && Drupal.settings.HierarchicalSelect.settings["hs-" + hsid]['renderFlatSelect'] == false
+ && Drupal.settings.HierarchicalSelect.settings["hs-" + hsid]['createNewItems'] == false
+ && Drupal.HierarchicalSelect.cache != null
+ && Drupal.HierarchicalSelect.cache.status())
+ {
+ Drupal.HierarchicalSelect.cache.updateHierarchicalSelect(hsid, value, settings, lastUnchanged, ajaxOptions);
+ }
+ else {
+ Drupal.HierarchicalSelect.preUpdateAnimations(hsid, updateType, lastUnchanged, function() {
+ // Adding current theme to prevent conflicts, @see ajax.js
+ // @TODO, try converting to use Drupal.ajax instead.
+
+ // Prevent duplicate HTML ids in the returned markup.
+ // @see drupal_html_id()
+ var ids = [];
+ $('[id]').each(function () {
+ ids.push(this.id);
+ });
+
+ ajaxOptions.data.push({ name : 'ajax_html_ids[]', value : ids });
+
+ ajaxOptions.data.push({ name : 'ajax_page_state[theme]', value : Drupal.settings.ajaxPageState.theme });
+ ajaxOptions.data.push({ name : 'ajax_page_state[theme_token]', value : Drupal.settings.ajaxPageState.theme_token });
+ for (var key in Drupal.settings.ajaxPageState.css) {
+ ajaxOptions.data.push({ name : 'ajax_page_state[css][' + key + ']', value : 1});
+ }
+ for (var key in Drupal.settings.ajaxPageState.js) {
+ ajaxOptions.data.push({ name : 'ajax_page_state[js][' + key + ']', value : 1});
+ }
+
+ // Make it work with jquery update
+ if (Drupal.settings.ajaxPageState.jquery_version) {
+ ajaxOptions.data.push({ name : 'ajax_page_state[jquery_version]', value : Drupal.settings.ajaxPageState.jquery_version });
+ }
+
+ $.ajax(ajaxOptions);
+ });
+ }
+};
+
+Drupal.ajax.prototype.commands.hierarchicalSelectUpdate = function(ajax, response, status, hsid) {
+ // Replace the old HTML with the (relevant part of) retrieved HTML.
+ $('#hierarchical-select-'+ hsid +'-wrapper', Drupal.HierarchicalSelect.context)
+ .parent('.form-item')
+ .replaceWith($(response.output));
+};
+
+Drupal.ajax.prototype.commands.hierarchicalSelectSettingsUpdate = function(ajax, response, status, hsid) {
+ Drupal.settings.HierarchicalSelect.settings["hs-" + response.hsid] = response.settings;
+};
+
+})(jQuery);
diff --git a/sites/all/modules/hierarchical_select/hierarchical_select.module b/sites/all/modules/hierarchical_select/hierarchical_select.module
new file mode 100644
index 0000000..aa074cf
--- /dev/null
+++ b/sites/all/modules/hierarchical_select/hierarchical_select.module
@@ -0,0 +1,2367 @@
+ 'hierarchical_select_ajax',
+ 'delivery callback' => 'ajax_deliver',
+ 'access arguments' => array('access content'),
+ 'theme callback' => 'ajax_base_page_theme',
+ 'type' => MENU_CALLBACK,
+ );
+
+ $items['admin/config/content/hierarchical_select'] = array(
+ 'title' => 'Hierarchical Select',
+ 'description' => 'Configure site-wide settings for the Hierarchical Select form element.',
+ 'access arguments' => array('administer site configuration'),
+ 'page callback' => 'drupal_get_form',
+ 'page arguments' => array('hierarchical_select_admin_settings'),
+ 'type' => MENU_NORMAL_ITEM,
+ 'file' => 'hierarchical_select.admin.inc',
+ );
+ $items['admin/config/content/hierarchical_select/settings'] = array(
+ 'title' => 'Site-wide settings',
+ 'access arguments' => array('administer site configuration'),
+ 'weight' => -10,
+ 'type' => MENU_DEFAULT_LOCAL_TASK,
+ 'file' => 'hierarchical_select.admin.inc',
+ );
+ $items['admin/config/content/hierarchical_select/configs'] = array(
+ 'title' => 'Configurations',
+ 'description' => 'All available Hierarchical Select configurations.',
+ 'access arguments' => array('administer site configuration'),
+ 'page callback' => 'hierarchical_select_admin_configs',
+ 'type' => MENU_LOCAL_TASK,
+ 'file' => 'hierarchical_select.admin.inc',
+ );
+ $items['admin/config/content/hierarchical_select/implementations'] = array(
+ 'title' => 'Implementations',
+ 'description' => 'Features of each Hierarchical Select implementation.',
+ 'access arguments' => array('administer site configuration'),
+ 'page callback' => 'hierarchical_select_admin_implementations',
+ 'type' => MENU_LOCAL_TASK,
+ 'file' => 'hierarchical_select.admin.inc',
+ );
+ $items['admin/config/content/hierarchical_select/export/%hierarchical_select_config_id'] = array(
+ 'title' => 'Export',
+ 'access arguments' => array('administer site configuration'),
+ 'page callback' => 'drupal_get_form',
+ 'page arguments' => array('hierarchical_select_admin_export', 5),
+ 'type' => MENU_LOCAL_TASK,
+ 'file' => 'hierarchical_select.admin.inc',
+ );
+ $items['admin/config/content/hierarchical_select/import/%hierarchical_select_config_id'] = array(
+ 'title' => 'Import',
+ 'access arguments' => array('administer site configuration'),
+ 'page callback' => 'drupal_get_form',
+ 'page arguments' => array('hierarchical_select_admin_import', 5),
+ 'type' => MENU_LOCAL_TASK,
+ 'file' => 'hierarchical_select.admin.inc',
+ );
+
+ return $items;
+}
+
+/**
+ * Implements hook_element_info().
+ */
+function hierarchical_select_element_info() {
+ $types['hierarchical_select'] = array(
+ '#input' => TRUE,
+ '#process' => array('form_hierarchical_select_process'),
+ '#theme' => array('hierarchical_select'),
+ '#theme_wrappers' => array('form_element'),
+ '#config' => array(
+ 'module' => 'some_module',
+ 'params' => array(),
+ 'save_lineage' => 0,
+ 'enforce_deepest' => 0,
+ 'resizable' => 1,
+ 'level_labels' => array(
+ 'status' => 0,
+ 'labels' => array(),
+ ),
+ 'dropbox' => array(
+ 'status' => 0,
+ 'title' => t('All selections'),
+ 'limit' => 0,
+ 'reset_hs' => 1,
+ 'sort' => 1,
+ ),
+ 'editability' => array(
+ 'status' => 0,
+ 'item_types' => array(),
+ 'allowed_levels' => array(),
+ 'allow_new_levels' => 0,
+ 'max_levels' => 3,
+ ),
+ 'entity_count' => array(
+ 'enabled' => 0,
+ 'require_entity' => 0,
+ 'settings' => array(
+ 'count_children' => 0,
+ 'entity_types' => array(),
+ ),
+ ),
+ 'animation_delay' => variable_get('hierarchical_select_animation_delay', 400),
+ 'special_items' => array(),
+ 'render_flat_select' => 0,
+ ),
+ '#default_value' => -1,
+ );
+ $types['hierarchical_select_item_separator'] = array(
+ '#theme' => 'hierarchical_select_item_separator',
+ );
+
+ return $types;
+}
+
+/**
+ * Implements hook_requirements().
+ */
+function hierarchical_select_requirements($phase) {
+ $requirements = array();
+
+ if ($phase == 'runtime') {
+ // Check if all hook_update_n() hooks have been executed.
+ require_once DRUPAL_ROOT . '/' . 'includes/install.inc';
+ drupal_load_updates();
+ $updates = drupal_get_schema_versions('hierarchical_select');
+ $current = drupal_get_installed_schema_version('hierarchical_select');
+
+ $up_to_date = (end($updates) == $current);
+
+ $hierarchical_select_weight = db_query("SELECT weight FROM {system} WHERE type = :type AND name = :name", array(':type' => 'module', ':name' => 'hierarchical_select'))->fetchField();
+ $core_overriding_modules = array('hs_book', 'hs_menu', 'hs_taxonomy');
+ $path_errors = array();
+ foreach ($core_overriding_modules as $module) {
+ $filename = db_query("SELECT filename FROM {system} WHERE type = :type AND name = :name", array(':type' => 'module', ':name' => $module))->fetchField();
+ if (strpos($filename, 'modules/') === 0) {
+ $module_info = drupal_parse_info_file(dirname($filename) . "/$module.info");
+ $path_errors[] = t('!module', array('!module' => $module_info['name']));
+ }
+ }
+
+ if ($up_to_date && !count($path_errors)) {
+ $value = t('All updates installed. HS API implementation modules correctly installed.');
+ $description = '';
+ $severity = REQUIREMENT_OK;
+ }
+ elseif ($path_errors) {
+ $value = t('Modules incorrectly installed!');
+ $description = t(
+ "The following modules implement Hierarchical Select module for Drupal
+ core modules, but are installed in the wrong location. They're
+ installed in core's modules directory, but should be
+ installed in either the sites/all/modules directory or a
+ sites/yoursite.com/modules directory"
+ ) . ':' . theme('item_list', array('items' => $path_errors));
+ $severity = REQUIREMENT_ERROR;
+ }
+ else {
+ $value = t('Not all updates installed!');
+ $description = t('Please run update.php to install the latest updates!
+ You have installed update !installed_update, but the latest update is
+ !latest_update!',
+ array(
+ '!installed_update' => $current,
+ '!latest_update' => end($updates),
+ )
+ );
+ $severity = REQUIREMENT_ERROR;
+ }
+
+ $requirements['hierarchical_select'] = array(
+ 'title' => t('Hierarchical Select'),
+ 'value' => $value,
+ 'description' => $description,
+ 'severity' => $severity,
+ );
+ }
+
+ return $requirements;
+}
+
+/**
+ * Implements hook_theme().
+ */
+function hierarchical_select_theme() {
+ return array(
+ 'hierarchical_select_form_element' => array(
+ 'file' => 'includes/theme.inc',
+ 'variables' => array('element' => NULL, 'value' => NULL),
+ ),
+ 'hierarchical_select' => array(
+ 'file' => 'includes/theme.inc',
+ 'render element' => 'element',
+ ),
+ 'hierarchical_select_selects_container' => array(
+ 'file' => 'includes/theme.inc',
+ 'render element' => 'element',
+ ),
+ 'hierarchical_select_select' => array(
+ 'file' => 'includes/theme.inc',
+ 'render element' => 'element',
+ ),
+ 'hierarchical_select_item_separator' => array(
+ 'file' => 'includes/theme.inc',
+ 'render element' => 'element',
+ ),
+ 'hierarchical_select_special_option' => array(
+ 'file' => 'includes/theme.inc',
+ 'variables' => array('option' => NULL),
+ ),
+ 'hierarchical_select_dropbox_table' => array(
+ 'file' => 'includes/theme.inc',
+ 'render element' => 'element',
+ ),
+ 'hierarchical_select_common_config_form_level_labels' => array(
+ 'file' => 'includes/theme.inc',
+ 'render element' => 'form',
+ ),
+ 'hierarchical_select_common_config_form_editability' => array(
+ 'file' => 'includes/theme.inc',
+ 'render element' => 'form',
+ ),
+ 'hierarchical_select_selection_as_lineages' => array(
+ 'file' => 'includes/theme.inc',
+ 'variables' => array(
+ 'selection' => NULL,
+ 'config' => NULL,
+ ),
+ ),
+ );
+}
+
+/**
+ * Implements hook_features_api().
+ */
+function hierarchical_select_features_api() {
+ return array(
+ 'hierarchical_select' => array(
+ 'name' => t('Hierarchical select configs'),
+ 'feature_source' => TRUE,
+ 'default_hook' => 'hierarchical_select_default_configs',
+ 'default_file' => FEATURES_DEFAULTS_INCLUDED,
+ 'file' => drupal_get_path('module', 'hierarchical_select') . '/hierarchical_select.features.inc',
+ ),
+ );
+}
+
+/**
+ * Implements hook_select_menu_site_status_alter().
+ *
+ * This will run straight after the bootstrap/hook_init(), and override the
+ * interface language there determined with the interface language from the
+ * previous request on the HS AJAX callback. We want the language to remain
+ * the same between requests so we can determine the "triggering element"
+ * correctly. If the button value changed because of a language change (as
+ * can happen with the admin_language module), the whole form would submit.
+ */
+function hierarchical_select_menu_site_status_alter(&$menu_site_status, $path) {
+ global $language;
+ // Make sure we are on the AJAX callback.
+ if (0 === strpos($_GET['q'], 'hierarchical_select_ajax') && !empty($_POST['hs_current_language'])) {
+ $languages = language_list();
+ if (isset($languages[$_POST['hs_current_language']])) {
+ // Override the language set during bootstrap with the language from the
+ // previous request.
+ $language = $languages[$_POST['hs_current_language']];
+ }
+ }
+}
+
+
+//----------------------------------------------------------------------------
+// Menu system callbacks.
+
+/**
+ * Wildcard loader for Hierarchical Select config ID's.
+ */
+function hierarchical_select_config_id_load($config_id) {
+ $config = variable_get('hs_config_' . $config_id, FALSE);
+ return ($config !== FALSE) ? $config['config_id'] : FALSE;
+}
+
+
+//----------------------------------------------------------------------------
+// Forms API callbacks.
+
+/**
+ * Ajax callback to render the select form elements.
+ *
+ * @see file_ajax_upload(), upon which this is strongly inspired.
+ * @see ajax_form_callback()
+ */
+function hierarchical_select_ajax() {
+ $form_parents = func_get_args();
+ list($form, $form_state, $form_id, $form_build_id, $commands) = ajax_get_form();
+
+ // Process user input. $form and $form_state are modified in the process.
+ drupal_process_form($form['#form_id'], $form, $form_state);
+ $element = drupal_array_get_nested_value($form, $form_parents);
+
+ // Render the output.
+ $output = theme('status_messages') . drupal_render($element);
+
+ // Send AJAX command to update the Hierarchical Select.
+ $commands[] = array(
+ 'command' => 'hierarchicalSelectUpdate',
+ 'output' => $output,
+ );
+
+ $new_settings = _hs_new_setting_ajax(FALSE);
+ foreach ($new_settings as $new_setting) {
+ $commands[] = array(
+ 'command' => 'hierarchicalSelectSettingsUpdate',
+ 'hsid' => $new_setting['hsid'],
+ 'settings' => $new_setting['settings'],
+ );
+ }
+
+ $context = array(
+ 'form' => $form,
+ 'form_state' => $form_state,
+ 'element' => $element,
+ );
+ drupal_alter('hierarchical_select_ajax_commands', $commands, $context);
+ return array('#type' => 'ajax', '#commands' => $commands);
+}
+
+function _hs_process_determine_hsid($element, &$form_state) {
+ // Determine the HSID to use: either the existing one that is received, or
+ // generate a new one based on the last HSID used (which is
+ // stored in form state storage).
+ if (!isset($element['#value']) || !is_array($element['#value']) || !array_key_exists('hsid', $element['#value'])) {
+ $hsid = uniqid();
+ }
+ else {
+ $hsid = check_plain($element['#value']['hsid']);
+ }
+
+ return $hsid;
+}
+
+// Get the config and convert the 'special_items' setting to a more easily
+// accessible format.
+function _hs_process_shortcut_special_items($config) {
+ $special_items = array();
+ if (isset($config['special_items'])) {
+ $special_items['exclusive'] = array_keys(array_filter($config['special_items'], '_hierarchical_select_special_item_exclusive'));
+ $special_items['none'] = array_keys(array_filter($config['special_items'], '_hierarchical_select_special_item_none'));
+ }
+ return $special_items;
+}
+
+function _hs_process_attach_css_js($element, $hsid, &$form_state, $complete_form) {
+ global $language;
+ // Set up Javascript and add settings specifically for the current
+ // hierarchical select.
+ $element['#attached']['library'][] = array('system', 'ui');
+ $element['#attached']['library'][] = array('system', 'drupal.ajax');
+ $element['#attached']['library'][] = array('system', 'jquery.form');
+ $element['#attached']['library'][] = array('system', 'effects');
+ $element['#attached']['library'][] = array('system', 'effects.drop');
+ $element['#attached']['css'][] = drupal_get_path('module', 'hierarchical_select') . '/hierarchical_select.css';
+ $element['#attached']['js'][] = drupal_get_path('module', 'hierarchical_select') . '/hierarchical_select.js';
+ if (variable_get('hierarchical_select_js_cache_system', 0) == 1) {
+ $element['#attached']['js'][] = drupal_get_path('module', 'hierarchical_select') . '/hierarchical_select_cache.js';
+ }
+
+ if (!isset($form_state['storage']['hs']['js_settings_sent'])) {
+ $form_state['storage']['hs']['js_settings_sent'] = array();
+ }
+
+ // Form was submitted; this is a newly loaded page, thus ensure that all JS
+ // settings are resent.
+ if ($form_state['process_input'] === TRUE) {
+ $form_state['storage']['hs']['js_settings_sent'] = array();
+ }
+
+ if (!isset($form_state['storage']['hs']['js_settings_sent'][$hsid]) || (isset($form_state['storage']['hs']['js_settings_sent'][$hsid]) && (isset($form_state['triggering_element']) && $form_state['triggering_element']['#type'] == 'submit'))) {
+ $config = _hierarchical_select_inherit_default_config($element['#config']);
+ $settings = array(
+ 'HierarchicalSelect' => array(
+ // Save language in settings so we can use the same language during the AJAX callback.
+ 'hs_current_language' => $language->language,
+ 'settings' => array(
+ "hs-$hsid" => array(
+ 'animationDelay' => ($config['animation_delay'] == 0) ? (int) variable_get('hierarchical_select_animation_delay', 400) : $config['animation_delay'],
+ 'cacheId' => $config['module'] . '_' . md5(serialize($config['params'])),
+ 'renderFlatSelect' => (isset($config['render_flat_select'])) ? (int) $config['render_flat_select'] : 0,
+ 'createNewItems' => (isset($config['editability']['status'])) ? (int) $config['editability']['status'] : 0,
+ 'createNewLevels' => (isset($config['editability']['allow_new_levels'])) ? (int) $config['editability']['allow_new_levels'] : 0,
+ 'resizable' => (isset($config['resizable'])) ? (int) $config['resizable'] : 0,
+ 'ajax_url' => url('hierarchical_select_ajax/' . implode('/', $element['#array_parents'])),
+ ),
+ ),
+ )
+ );
+
+ if (!isset($_POST['hsid'])) {
+ $element['#attached']['js'][] = array(
+ 'type' => 'setting',
+ 'data' => $settings,
+ );
+ }
+ else {
+ $element['#attached']['_hs_new_setting_ajax'][] = array($hsid, $settings['HierarchicalSelect']['settings']["hs-$hsid"]);
+ }
+
+ $form_state['storage']['hs']['js_settings_sent'][$hsid] = TRUE;
+ }
+
+ return $element;
+}
+
+function _hs_new_setting_ajax($hsid = FALSE, $settings = NULL) {
+ static $hs_settings = array();
+
+ if ($hsid !== FALSE) {
+ $hs_settings[] = array('hsid' => $hsid, 'settings' => $settings);
+ }
+
+ return $hs_settings;
+}
+
+// Basic config validation and diagnostics.
+function _hs_process_developer_mode_log_diagnostics(&$element) {
+ if (HS_DEVELOPER_MODE) {
+ $config = $element['#config'];
+ $diagnostics = array();
+ if (!isset($config['module']) || empty($config['module'])) {
+ $diagnostics[] = t("'module is not set!");
+ }
+ elseif (!module_exists($config['module'])) {
+ $diagnostics[] = t('the module that should be used (module) is not installed!', array('%module' => $config['module']));
+ }
+ else {
+ $required_params = module_invoke($config['module'], 'hierarchical_select_params');
+ $missing_params = array_diff($required_params, array_keys($config['params']));
+ if (!empty($missing_params)) {
+ $diagnostics[] = t("'params' is missing values for: ") . implode(', ', $missing_params) . '.';
+ }
+ }
+ $config_id = (isset($config['config_id']) && is_string($config['config_id'])) ? $config['config_id'] : 'none';
+ if (empty($diagnostics)) {
+ _hierarchical_select_log("Config diagnostics (config id: $config_id): no problems found!");
+ }
+ else {
+ $diagnostics_string = print_r($diagnostics, TRUE);
+ $message = "Config diagnostics (config id: $config_id): $diagnostics_string";
+ _hierarchical_select_log($message);
+ $title = $element['#title'];
+ $element = array();
+ $element['#type'] = 'item';
+ $element['#title'] = $title;
+ $element['#markup'] = 'Fix the indicated errors in the #config property first!
';
+ return FALSE;
+ }
+ }
+ return TRUE;
+}
+
+function _hs_process_developer_mode_log_selections($config, $hs_selection, $db_selection) {
+ if (HS_DEVELOPER_MODE) {
+ _hierarchical_select_log("Calculated hierarchical select selection:");
+ _hierarchical_select_log($hs_selection);
+
+ if ($config['dropbox']['status']) {
+ _hierarchical_select_log("Calculated dropbox selection:");
+ _hierarchical_select_log($db_selection);
+ }
+ }
+}
+
+function _hs_process_developer_mode_log_hierarchy_and_dropbox($config, $hierarchy, $dropbox) {
+ if (HS_DEVELOPER_MODE) {
+ _hierarchical_select_log('Generated hierarchy in ' . $hierarchy->build_time['total'] . ' ms:');
+ _hierarchical_select_log($hierarchy);
+
+ if ($config['dropbox']['status']) {
+ _hierarchical_select_log('Generated dropbox in ' . $dropbox->build_time . ' ms: ');
+ _hierarchical_select_log($dropbox);
+ }
+ }
+}
+
+function _hs_process_developer_mode_send_log_js($element, $hsid) {
+ if (HS_DEVELOPER_MODE) {
+ $log = _hierarchical_select_log(NULL, TRUE);
+ $settings = array(
+ 'HierarchicalSelect' => array(
+ 'initialLog' => array(
+ "hs-$hsid" => $log,
+ ),
+ ),
+ );
+ $element['#attached']['js'][] = array(
+ 'type' => 'setting',
+ 'data' => $settings,
+ );
+ }
+
+ return $element;
+}
+
+function _hs_process_exclusive_lineages($element, $hs_selection, $db_selection) {
+ $config = $element['#config'];
+ $special_items = _hs_process_shortcut_special_items($config);
+
+ // If:
+ // - the special_items setting has been configured
+ // - at least one special item has the 'exclusive' property
+ // - the dropbox is enabled
+ // then do the necessary processing to make exclusive lineages possible.
+ if (!empty($special_items) && count($special_items['exclusive']) && $config['dropbox']['status']) {
+ // When the form is first loaded, $db_selection will contain the selection
+ // that we should check, but in updates, $hs_selection will.
+ $selection = (!empty($hs_selection)) ? $hs_selection : $db_selection;
+
+ // If the current selection of the hierarchical select matches one of the
+ // configured exclusive items, then disable the dropbox (to ensure an
+ // exclusive selection).
+ $exclusive_item = array_intersect($selection, $special_items['exclusive']);
+ if (count($exclusive_item)) {
+ // By also updating the configuration stored in $element, we ensure that
+ // the validation step, which extracts the configuration again, also gets
+ // the updated config.
+ $element['#config']['dropbox']['status'] = 0;
+
+ // Set the hierarchical select to the exclusive item and make the
+ // dropbox empty.
+ $hs_selection = array(0 => reset($exclusive_item));
+ $db_selection = array();
+ }
+ }
+
+ return array($element, $hs_selection, $db_selection);
+}
+
+function _hs_process_render_create_new_item($element, $hierarchy) {
+ $creating_new_item = FALSE;
+
+ // This container and the "Create" / "Cancel" buttons must always be part of
+ // the form, even when HS is not in create mode, in order for AJAX submit
+ // callbacks on the "Create" and "Cancel" buttons to be processed correctly.
+ //
+ // Basically, FAPI looks through each of the buttons in the form to determine
+ // which one was clicked. If it can't find the responsible button, it
+ // assumes it was the first button in the form. This is problematic when the
+ // user clicks on the "Create" or "Cancel" buttons because we only want them
+ // to show up when HS is in create mode. To fix this, we always render the
+ // buttons as part of the form, then disable access to them in an
+ // "#after_build" callback.
+ //
+ // This might not be necessary if we used D7's native AJAX callback function,
+ // ajax_form_callback().
+ $element['hierarchical_select']['create_new_item'] = array(
+ '#prefix' => '',
+ '#suffix' => '
',
+ '#after_build' => array('hierarchical_select_create_new_item_after_build'),
+ );
+
+ // @todo Port to use built-in D7 AJAX callback?
+ $element['hierarchical_select']['create_new_item']['create'] = array(
+ '#type' => 'submit',
+ '#value' => t('Create'),
+ '#attributes' => array('class' => array('create-new-item-create')),
+ '#limit_validation_errors' => array($element['#parents']),
+ '#validate' => array(),
+ '#submit' => array('hierarchical_select_ajax_update_submit'),
+ );
+
+ $element['hierarchical_select']['create_new_item']['cancel'] = array(
+ '#type' => 'submit',
+ '#value' => t('Cancel'),
+ '#attributes' => array('class' => array('create-new-item-cancel')),
+ '#limit_validation_errors' => array($element['#parents']),
+ '#validate' => array(),
+ '#submit' => array('hierarchical_select_ajax_update_submit'),
+ );
+
+ if (isset($element['#value']['hierarchical_select']['selects'])) {
+ foreach ($element['#value']['hierarchical_select']['selects'] as $depth => $value) {
+ if ($value == 'create_new_item' && _hierarchical_select_create_new_item_is_allowed($element['#config'], $depth)) {
+ $creating_new_item = TRUE;
+
+ // We want to override the select in which the "create_new_item"
+ // option was selected and hide all selects after that, if they exist.
+ // If depth == 0, then that means all selects should be hidden.
+ if ($depth == 0) {
+ unset($element['hierarchical_select']['selects']);
+ }
+ else {
+ for ($i = $depth; $i < count($hierarchy->lineage); $i++) {
+ unset($element['hierarchical_select']['selects'][$i]);
+ }
+ }
+
+ $item_type_depth = ($value == 'create_new_item') ? $depth : $depth + 1;
+ $item_type = (count($element['#config']['editability']['item_types']) == $item_type_depth)
+ ? t($element['#config']['editability']['item_types'][$item_type_depth])
+ : t('item');
+
+ $element['hierarchical_select']['create_new_item']['input'] = array(
+ '#type' => 'textfield',
+ '#size' => 20,
+ '#maxlength' => 255,
+ '#default_value' => t('new @item', array('@item' => $item_type)),
+ '#attributes' => array(
+ 'title' => t('new @item', array('@item' => $item_type)),
+ 'class' => array('create-new-item-input'),
+ ),
+ // Prevent the textfield from being wrapped in a div. This
+ // simplifies the CSS and JS code.
+ '#theme_wrappers' => array(),
+ // Place the textfield above the "Create" / "Cancel" buttons.
+ '#weight' => -1,
+ );
+ }
+ }
+ }
+ $element['hierarchical_select']['create_new_item']['#creating_new_item'] = $creating_new_item;
+
+ return array($element, $creating_new_item);
+}
+
+/**
+ * Render API callback: Controls access to the create_new_item form.
+ *
+ * Only allows access to the create_new_item form if creating a new item.
+ *
+ * This function is assigned as an #after_build callback in
+ * _hs_process_render_create_new_item().
+ */
+function hierarchical_select_create_new_item_after_build(array $element) {
+ $element['#access'] = $element['#creating_new_item'];
+
+ return $element;
+}
+
+function _hs_process_render_dropbox($element, $hsid, $creating_new_item, $dropbox, $form_state) {
+ $config = $element['#config'];
+
+ if ($config['dropbox']['status']) {
+ if (!$creating_new_item) {
+ // Append an "Add" button to the selects.
+ $element['hierarchical_select']['dropbox_add'] = array(
+ '#type' => 'submit',
+ '#value' => t('Add'),
+ '#attributes' => array('class' => array('add-to-dropbox')),
+ '#limit_validation_errors' => array($element['#parents']),
+ '#validate' => array(),
+ '#submit' => array('hierarchical_select_ajax_update_submit'),
+ );
+ }
+
+ if ($config['dropbox']['limit'] > 0) { // Zero as dropbox limit means no limit.
+ if (count($dropbox->lineages) >= $config['dropbox']['limit']) {
+ $element['dropbox_limit_warning'] = array(
+ '#markup' => t("You've reached the maximum number of items you can select."),
+ '#prefix' => '',
+ '#suffix' => '
',
+ );
+
+ // Disable all child form elements of $element['hierarchical_select].
+ // _hierarchical_select_mark_as_disabled($element['hierarchical_select']);
+
+ // TODO: make the above work again. Currently, we're just disabling
+ // the "Add" button. #disabled can't be used for the same reasons as
+ // described in _hierarchical_select_mark_as_disabled().
+ $element['hierarchical_select']['dropbox_add']['#attributes']['disabled'] = TRUE;
+ }
+ }
+
+ // Store the currently selected lineages of the dropbox in the form state's
+ // storage section.
+ if (isset($dropbox->lineages_selections)) {
+ $form_state['storage']['hs'][$hsid]['dropbox_lineages_selections'] = $dropbox->lineages_selections;
+ }
+
+ // Add the dropbox-as-a-table that will be visible to the user.
+ $element['dropbox']['visible'] = _hs_process_render_db_table($hsid, $dropbox);
+ }
+
+ return array($element, $form_state);
+}
+
+function _hs_process_render_nojs($element, $config) {
+ // This button and accompanying help text will be hidden when Javascript is
+ // enabled.
+ $element['nojs'] = array(
+ '#prefix' => '',
+ '#suffix' => '
',
+ );
+ $element['nojs']['update_button'] = array(
+ '#type' => 'submit',
+ '#value' => t('Update'),
+ '#attributes' => array('class' => array('update-button')),
+ '#limit_validation_errors' => array($element['#parents']),
+ '#validate' => array(),
+ '#submit' => array('hierarchical_select_ajax_update_submit'),
+ '#ajax' => array(
+ 'callback' => 'menu_link_weight_parent_ajax_callback',
+ 'wrapper' => 'menu-link-weight-wrapper',
+ ),
+ );
+ $element['nojs']['update_button_help_text'] = array(
+ '#markup' => _hierarchical_select_nojs_helptext($config['dropbox']['status']),
+ '#prefix' => '',
+ '#suffix' => '
',
+ );
+
+ return $element;
+}
+
+/**
+ * Hierarchical select form element type #process callback.
+ */
+function form_hierarchical_select_process($element, &$form_state, $complete_form) {
+ if (arg(0) != 'hierarchical_select_ajax') {
+ // Get unique identifier using parents of the field.
+ $cid = isset($element['#parents']) ? implode("-", $element['#parents']) : implode("-", $element['#field_parents']);
+
+ // Verify if hsid is present.
+ $elhsid = drupal_array_get_nested_value($element, array('#value', 'hsid'));
+
+ if (!isset($elhsid)) {
+ // Retrieve previous element from form_state.
+ $cached = drupal_array_get_nested_value($form_state, array('storage', 'hs', 'hs_fields', $cid));
+ }
+ if (empty($cached)) {
+ $docache = TRUE;
+ }
+ else {
+ // Switch current element with the "cached".
+ return $cached;
+ }
+ }
+
+ // Determine the HSID.
+ $hsid = _hs_process_determine_hsid($element, $form_state);
+
+ // Config.
+ $config = $element['#config'];
+
+ // Attach CSS/JS files and JS settings.
+ $element = _hs_process_attach_css_js($element, $hsid, $form_state, $complete_form);
+
+ // Developer mode diagnostics, return immediately in case of a config error.
+ if (!_hs_process_developer_mode_log_diagnostics($element)) {
+ return $element;
+ }
+
+ // Calculate the selections in both the hierarchical select and the dropbox,
+ // we need these before we can render anything.
+ $hs_selection = $db_selection = array();
+ list($hs_selection, $db_selection) = _hierarchical_select_process_calculate_selections($element, $hsid, $form_state);
+
+ // Developer mode logging: log selections.
+ _hs_process_developer_mode_log_selections($config, $hs_selection, $db_selection);
+
+ // Dynamically disable the dropbox when an exclusive item has been selected.
+ // When this happens, the configuration is dynamically altered. Hence, we
+ // need to update $config.
+ list($element, $hs_selection, $db_selection) = _hs_process_exclusive_lineages($element, $hs_selection, $db_selection);
+ $config = $element['#config'];
+
+ // Generate the $hierarchy and $dropbox objects using the selections that
+ // were just calculated.
+ $dropbox = (!$config['dropbox']['status']) ? FALSE : _hierarchical_select_dropbox_generate($config, $db_selection);
+ $hierarchy = _hierarchical_select_hierarchy_generate($config, $hs_selection, $element['#required'], $dropbox);
+
+ // Developer mode logging: log $hierarchy and $dropbox objects.
+ _hs_process_developer_mode_log_hierarchy_and_dropbox($config, $hierarchy, $dropbox);
+
+ // Finally, calculate the return value of this hierarchical_select form
+ // element. This will be set in _hierarchical_select_validate(). (If we'd
+ // set it now, it would be overridden again.)
+ $element['#return_value'] = _hierarchical_select_process_calculate_return_value($hierarchy, ($config['dropbox']['status']) ? $dropbox : FALSE, $config['module'], $config['params'], $config['save_lineage']);
+ if (!is_array($element['#return_value'])) {
+ $element['#return_value'] = array($element['#return_value']);
+ }
+
+ // Add a validate callback, which will:
+ // - validate that the dropbox limit was not exceeded.
+ // - set the return value of this form element.
+ // Also make sure it is the *first* validate callback.
+ $element['#element_validate'] = (isset($element['#element_validate'])) ? $element['#element_validate'] : array();
+ $element['#element_validate'] = array_merge(array('_hierarchical_select_validate'), $element['#element_validate']);
+
+ // Ensure the form is cached, for AJAX to work.
+ $form_state['cache'] = TRUE;
+
+ //
+ // Rendering.
+ //
+
+ // Ensure that #tree is enabled!
+ $element['#tree'] = TRUE;
+
+ // Store the HSID in a hidden form element; when an AJAX callback comes in,
+ // we'll know which HS was updated.
+ $element['hsid'] = array('#type' => 'hidden', '#value' => $hsid);
+
+
+ // If render_flat_select is enabled, render a flat select.
+ if ($config['render_flat_select']) {
+ $element['flat_select'] = _hs_process_render_flat_select($hierarchy, $dropbox, $config);
+ // See https://www.drupal.org/node/994820
+ if (empty($element['flat_select']['#options'])) {
+ unset($element['flat_select']);
+ }
+ }
+
+ // Render the hierarchical select.
+ $element['hierarchical_select'] = array(
+ '#theme' => 'hierarchical_select_selects_container',
+ );
+ $size = isset($element['#size']) ? $element['#size'] : 0;
+ $element['hierarchical_select']['selects'] = _hs_process_render_hs_selects($hsid, $hierarchy, $size);
+
+ // When the special "create_new_item" value is passed in a level, replace
+ // that level with an inline modal form to create a new item, and hide all
+ // subsequent selects.
+ list($element, $creating_new_item) = _hs_process_render_create_new_item($element, $hierarchy);
+
+ // Render the dropbox, if enabled.
+ // Automatically hides the "Add" button when creating a new item.
+ // Automatically disables HS' selects when reaching the dropbox limit.
+ // Stores the currently selected lineages of the dropbox in storage.
+ list($element, $form_state) = _hs_process_render_dropbox($element, $hsid, $creating_new_item, $dropbox, $form_state);
+
+ // Render the HTML that allows for graceful degradation.
+ $element = _hs_process_render_nojs($element, $config);
+
+ // Ensure the render order is correct.
+ $element['hierarchical_select']['#weight'] = 0;
+ $element['dropbox_limit_warning']['#weight'] = 1;
+ $element['dropbox']['#weight'] = 2;
+ $element['nojs']['#weight'] = 3;
+
+ // If the form item is marked as disabled, disable all child form items as
+ // well.
+ if (isset($element['#disabled']) && $element['#disabled']) {
+ _hierarchical_select_mark_as_disabled($element);
+ }
+
+ // This prevents values from in $form_state['input'] to be used instead of
+ // the generated default values (#default_value).
+ // For example: $element['hierarchical_select']['selects']['0']['#default_value']
+ // is set to 'label_0' after an "Add" operation. When $form_state['input']
+ // is NOT erased, the corresponding value in $form_state['input'] will be
+ // used instead of the default value that was set. This would result in
+ // undesired behavior.
+ // This, however, must not be called on node preview, becuase in that case
+ // the node will be rebuilt and we need the values inside $form_state['input']
+ // to recreate the edited form properly.
+ // @TODO: If the form is rebuilt by some other action than a node preview, we
+ // might lose data again, we should see if there's any way to prevent this from
+ // happening by setting this value after the form has been flagged to be rebuilt,
+ // but as far as I checked, there's not.
+ // Another option might be to rework the need of this function to prevent
+ // the undesired behaviors of not having it with some other logic that would
+ // work as well if the form is rebuilt.
+ if (empty($docache)) {
+ if (!isset($form_state['triggering_element']) || ($form_state['triggering_element']['#value'] != t('Preview') && $form_state['triggering_element']['#value'] != t('View changes'))) {
+ if (isset($form_state['input']) && is_array($form_state['input'])) {
+ drupal_array_set_nested_value($form_state['input'], $element['#array_parents'], array());
+ }
+ }
+ }
+ else {
+ // Store new element in cache.
+ $form_state['storage']['hs']['hs_fields'][$cid] = $element;
+ }
+
+ // Send the collected developer mode logs (by using #attached JS).
+ $element = _hs_process_developer_mode_send_log_js($element, $hsid);
+
+ return $element;
+}
+
+/**
+ * Submit callback; only sets no_redirect to TRUE (which already)
+ */
+function hierarchical_select_ajax_update_submit($form, &$form_state) {
+ $form_state['no_redirect'] = TRUE;
+}
+
+
+/**
+ * Hierarchical select form element #element_validate callback.
+ */
+function _hierarchical_select_validate(&$element, &$form_state) {
+ // If the dropbox is enabled and a dropbox limit is configured, check if
+ // this limit is not exceeded.
+ $hsid = $element['hsid']['#value'];
+ $config = _hierarchical_select_inherit_default_config($element['#config']);
+ if ($config['dropbox']['status']) {
+ if ($config['dropbox']['limit'] > 0) { // Zero as dropbox limit means no limit.
+ // TRICKY: #element_validate is not called upon the initial rendering
+ // (i.e. it is assumed that the default value is valid). However,
+ // Hierarchical Select's config can influence the validity (i.e. how
+ // many selections may be added to the dropbox). This means it's
+ // possible the user has actually selected too many items without being
+ // notified of this.
+ $lineage_count = count($form_state['storage']['hs'][$hsid]['dropbox_lineages_selections']);
+ if ($lineage_count > $config['dropbox']['limit']) {
+ // TRICKY: this should propagate the error down to the children, but
+ // this doesn't seem to happen, since for example the selects of the
+ // hierarchical select don't get the error class set. Further
+ // investigation needed.
+ form_error(
+ $element,
+ t("You've selected %lineage-count items, but you're only allowed to select %dropbox-limit items.",
+ array(
+ '%lineage-count' => $lineage_count,
+ '%dropbox-limit' => $config['dropbox']['limit'],
+ )
+ )
+ );
+ _hierarchical_select_form_set_error_class($element);
+ }
+ }
+ }
+
+ // Set the proper return value. I.e. instead of returning all the values
+ // that are used for making the hierarchical_select form element type work,
+ // we pass a flat array of item ids. e.g. for the taxonomy module, this will
+ // be an array of term ids. If a single item is selected, this will not be
+ // an array.
+ // If the form item is disabled, set the default value as the return value,
+ // because otherwise nothing would be returned (disabled form items are not
+ // submitted, as described in the HTML standard).
+ if (isset($element['#disabled']) && $element['#disabled']) {
+ $element['#return_value'] = $element['#default_value'];
+ }
+
+ $element['#value'] = $element['#return_value'];
+ form_set_value($element, $element['#value'], $form_state);
+
+ // We have to check again for errors. This line is taken litterally from
+ // form.inc, so it works in an identical way.
+ if ($element['#required'] &&
+ (!isset($form_state['submit_handlers'][0]) || $form_state['submit_handlers'][0] !== 'hierarchical_select_ajax_update_submit') &&
+ (!count($element['#value']) || (is_string($element['#value']) && strlen(trim($element['#value'])) == 0))) {
+ form_error($element, t('!name field is required.', array('!name' => $element['#title'])));
+ _hierarchical_select_form_set_error_class($element);
+ }
+}
+
+
+//----------------------------------------------------------------------------
+// Forms API #process callback:
+// Calculation of hierarchical select and dropbox selection.
+
+/**
+ * Get the current (flat) selection of the hierarchical select.
+ *
+ * This selection is updatable by the user, because the values are retrieved
+ * from the selects in $element['hierarchical_select']['selects'].
+ *
+ * @param array $element
+ * A hierarchical_select form element.
+ * @return array
+ * An array (bag) containing the ids of the selected items in the
+ * hierarchical select.
+ */
+function _hierarchical_select_process_get_hs_selection($element) {
+ $hs_selection = array();
+ $config = _hierarchical_select_inherit_default_config($element['#config']);
+
+ if (!empty($element['#value']['hierarchical_select']['selects'])) {
+ if ($config['save_lineage']) {
+ foreach ($element['#value']['hierarchical_select']['selects'] as $key => $value) {
+ $hs_selection[] = $value;
+ }
+ }
+ else {
+ foreach ($element['#value']['hierarchical_select']['selects'] as $key => $value) {
+ $hs_selection[] = $value;
+ }
+ $hs_selection = _hierarchical_select_hierarchy_validate($hs_selection, $config['module'], $config['params']);
+
+ // Get the last valid value. (Only the deepest item gets saved). Make
+ // sure $hs_selection is an array at all times.
+ $hs_selection = ($hs_selection != -1) ? array(end($hs_selection)) : array();
+ }
+ }
+
+ return $hs_selection;
+}
+
+/**
+ * Get the current (flat) selection of the dropbox.
+ *
+ * This selection is not updatable by the user, because the values are
+ * retrieved from the hidden values in
+ * $element['dropbox']['hidden']['lineages_selections']. This selection can
+ * only be updated by the server, i.e. when the user clicks the "Add" button.
+ * But this selection can still be reduced in size if the user has marked
+ * dropbox entries (lineages) for removal.
+ *
+ * @param $element
+ * A hierarchical_select form element.
+ * @param $form_state
+ * The $form_state array. We need to look at
+ * $form_state['storage']['hs'][$hsid]['dropbox_lineages_selections']
+ * to know what to remove.
+ * @return
+ * An array (bag) containing the ids of the selected items in the
+ * dropbox.
+ */
+function _hierarchical_select_process_get_db_selection($element, $hsid, &$form_state) {
+ $db_selection = array();
+
+ if (!empty($form_state['storage']['hs'][$hsid]['dropbox_lineages_selections'])) {
+ // Check which lineages have been marked for removal by the user.
+ $remove_from_db_selection = array();
+ if (isset($element['#value']['dropbox']['visible']['lineages'])) {
+ foreach ($element['#value']['dropbox']['visible']['lineages'] as $x => $remove_value) {
+ if ($remove_value['remove'] === '1') {
+ // $x is of the form "lineage-". Extract the number.
+ $remove_from_db_selection[] = substr($x, 8);
+ // By removing the input (POST) reference to the remove checkbox,
+ // we make sure that on a form rebuild the same remove checkbox,
+ // which is accessed by index, is not set, preventing a double removal.
+ // @see https://www.drupal.org/node/1566878#comment-9226261
+ $elm = &$form_state['input'];
+ foreach ($element['#parents'] as $parent) {
+ $elm = &$elm[$parent];
+ }
+ unset($elm['dropbox']['visible']['lineages'][$x]['remove']);
+ }
+ }
+ }
+
+ // Add all selections to the dropbox selection, except for the ones that
+ // are scheduled for removal.
+ foreach ($form_state['storage']['hs'][$hsid]['dropbox_lineages_selections'] as $x => $selection) {
+ if (!in_array($x, $remove_from_db_selection)) {
+ $db_selection = array_merge($db_selection, $selection);
+ }
+ }
+
+ // Ensure that the last item of each selection that was scheduled for
+ // removal is completely absent from the dropbox selection.
+ // In case of a tree with multiple parents, the same item can exist in
+ // different entries, and thus it would stay in the selection. When the
+ // server then reconstructs all lineages, the lineage we're removing, will
+ // also be reconstructed: it will seem as if the removing didn't work!
+ // This will not break removing dropbox entries for hierarchies without
+ // multiple parents, since items at the deepest level are always unique to
+ // that specific lineage.
+ // Easier explanation at http://drupal.org/node/221210#comment-733715.
+ foreach ($remove_from_db_selection as $key => $x) {
+ $item = end($form_state['storage']['hs'][$hsid]['dropbox_lineages_selections'][$x]);
+ $position = array_search($item, $db_selection);
+ if ($position) {
+ unset($db_selection[$position]);
+ }
+ }
+ $db_selection = array_unique($db_selection);
+ }
+
+ return $db_selection;
+}
+
+/**
+ * Calculates the flat selections of both the hierarchical select and the
+ * dropbox.
+ *
+ * @param $element
+ * A hierarchical_select form element.
+ * @param $form_state
+ * The $form_state array. We need to look at $form_state['input']['op'], to
+ * know which operation has occurred.
+ * @return
+ * An array of the following structure:
+ * array(
+ * $hierarchical_select_selection = array(), // Flat list of selected ids.
+ * $dropbox_selection = array(),
+ * )
+ * with both of the subarrays flat lists of selected ids. The
+ * _hierarchical_select_hierarchy_generate() and
+ * _hierarchical_select_dropbox_generate() functions should be applied on
+ * these respective subarrays.
+ *
+ * @see _hierarchical_select_hierarchy_generate()
+ * @see _hierarchical_select_dropbox_generate()
+ */
+function _hierarchical_select_process_calculate_selections(&$element, $hsid, &$form_state) {
+ $hs_selection = array(); // hierarchical select selection
+ $db_selection = array(); // dropbox selection
+
+ $config = _hierarchical_select_inherit_default_config($element['#config']);
+ $dropbox = (bool) $config['dropbox']['status'];
+
+ // When:
+ // - no input data was provided (through POST nor GET)
+ // - or #value is set directly and not by a Hierarchical Select POST (and
+ // therefor set either manually or by another module),
+ // then use the value of #default_value, or when available, of #value.
+ if (empty($form_state['input']) || (!isset($element['#value']['hierarchical_select']) && !isset($element['#value']['dropbox']))) {
+ $value = (!empty($element['#value'])) ? $element['#value'] : $element['#default_value'];
+ $value = (is_array($value)) ? $value : array($value);
+ if ($dropbox) {
+ $db_selection = $value;
+ }
+ else {
+ $hs_selection = $value;
+ }
+ }
+ else {
+ $op = (isset($form_state['input']['op']) && isset($form_state['input']['hsid']) && $form_state['input']['hsid'] == $hsid) ? $form_state['input']['op'] : NULL;
+ if ($dropbox && $op == t('Add')) {
+ $hs_selection = _hierarchical_select_process_get_hs_selection($element);
+ $db_selection = _hierarchical_select_process_get_db_selection($element, $hsid, $form_state);
+
+ // Add $hs_selection to $db_selection.
+ $db_selection = array_unique(array_merge($db_selection, $hs_selection));
+
+ // Only reset $hs_selection if the user has configured it that way.
+ if ((bool) $config['dropbox']['reset_hs']) {
+ $hs_selection = array();
+ }
+ }
+ else if ($op == t('Create')) {
+ // This code handles both the creation of a new item in an existing
+ // level and the creation of an item that also creates a new level.
+ $label = trim($element['#value']['hierarchical_select']['create_new_item']['input']);
+ $selects = isset($element['#value']['hierarchical_select']['selects']) ? $element['#value']['hierarchical_select']['selects'] : array();
+ $depth = count($selects);
+ $parent = ($depth > 0) ? end($selects) : 0;
+
+ // Disallow items with empty labels; allow the user again to create a
+ // (proper) new item.
+ if (empty($label)) {
+ $element['#value']['hierarchical_select']['selects'][count($selects)] = 'create_new_item';
+ }
+ // Ensure that this new item will not violate the max_levels and
+ // allowed_levels settings.
+ else if (
+ (count(module_invoke($config['module'], 'hierarchical_select_children', $parent, $config['params']))
+ || $config['editability']['max_levels'] == 0
+ || $depth < $config['editability']['max_levels']
+ )
+ &&
+ (_hierarchical_select_create_new_item_is_allowed($config, $depth))
+ ) {
+ // Create the new item in the hierarchy and retrieve its value.
+ $value = module_invoke($config['module'], 'hierarchical_select_create_item', check_plain($label), $parent, $config['params']);
+
+ // Ensure the newly created item will be selected after rendering.
+ if ($value) {
+ // Pretend there was a select where the "create new item" section
+ // was, and assign it the value of the item that was just created.
+ $element['#value']['hierarchical_select']['selects'][count($selects)] = $value;
+ }
+ }
+
+ $hs_selection = _hierarchical_select_process_get_hs_selection($element);
+ if ($dropbox) {
+ $db_selection = _hierarchical_select_process_get_db_selection($element, $hsid, $form_state);
+ }
+ }
+ else {
+ // This handles the cases of:
+ // - $op == t('Update')
+ // - $op == t('Cancel') (used when creating a new item or a new level)
+ // - any other submit button, e.g. the "Preview" button
+ $hs_selection = _hierarchical_select_process_get_hs_selection($element);
+ if ($dropbox) {
+ $db_selection = _hierarchical_select_process_get_db_selection($element, $hsid, $form_state);
+ }
+ }
+ }
+
+ // Prevent doubles in either array.
+ $hs_selection = array_unique($hs_selection, SORT_REGULAR);
+ $db_selection = array_unique($db_selection, SORT_REGULAR);
+
+ return array($hs_selection, $db_selection);
+}
+
+
+//----------------------------------------------------------------------------
+// Forms API #process callback:
+// Rendering (generation of FAPI code) of hierarchical select and dropbox.
+
+/**
+ * Render the selects in the hierarchical select.
+ *
+ * @param $hsid
+ * A hierarchical select id.
+ * @param $hierarchy
+ * A hierarchy object.
+ * @param $size
+ * The $size to render each select with.
+ * @return
+ * A structured array for use in the Forms API.
+ */
+function _hs_process_render_hs_selects($hsid, $hierarchy, $size) {
+ $form['#tree'] = TRUE;
+ $form['#prefix'] = '';
+ $form['#suffix'] = '
';
+
+ foreach ($hierarchy->lineage as $depth => $selected_item) {
+ $form[$depth] = array(
+ '#type' => 'select',
+ '#options' => $hierarchy->levels[$depth],
+ '#default_value' => $selected_item,
+ '#size' => $size,
+ // Prevent the select from being wrapped in a div. This simplifies the
+ // CSS and JS code.
+ '#theme_wrappers' => array(),
+ // This alternative to theme_select ets a special class on the level
+ // label option, if any, to make level label styles possible.
+ '#theme' => 'hierarchical_select_select',
+ // Add child information. When a child has no children, its
+ // corresponding "option" element will be marked as such.
+ '#childinfo' => (isset($hierarchy->childinfo[$depth])) ? $hierarchy->childinfo[$depth] : NULL,
+ // Drupal 7's Forms API insists on validating "select" form elements,
+ // despite the fact that this form element is merely part of a larger
+ // whole, with its own #element_validate callback. This disables that
+ // validation.
+ '#validated' => TRUE,
+ );
+ }
+ return $form;
+}
+
+/**
+ * Render the visible part of the dropbox.
+ *
+ * @param $hsid
+ * A hierarchical select id.
+ * @param $dropbox
+ * A dropbox object.
+ * @return
+ * A structured array for use in the Forms API.
+ */
+function _hs_process_render_db_table($hsid, $dropbox) {
+ $element['#tree'] = TRUE;
+ $element['#theme'] = 'hierarchical_select_dropbox_table';
+
+
+ // This information is necessary for the #theme callback.
+ $element['title'] = array('#type' => 'value', '#value' => t($dropbox->title));
+ $element['separator'] = array('#type' => 'value', '#value' => '›');
+ $element['is_empty'] = array('#type' => 'value', '#value' => empty($dropbox->lineages));
+
+
+ if (!empty($dropbox->lineages)) {
+ foreach ($dropbox->lineages as $x => $lineage) {
+
+ // Store position information for the lineage. This will be used in the
+ // #theme callback.
+ $element['lineages']["lineage-$x"] = array(
+ '#zebra' => (($x + 1) % 2 == 0) ? 'even' : 'odd',
+ '#first' => ($x == 0) ? 'first' : '',
+ '#last' => ($x == count($dropbox->lineages) - 1) ? 'last' : '',
+ );
+
+ // Create a 'markup' element for each item in the lineage.
+ foreach ($lineage as $depth => $item) {
+ // The item is selected when save_lineage is enabled (i.e. each item
+ // will be selected), or when the item is the last item in the current
+ // lineage.
+ $is_selected = $dropbox->save_lineage || ($depth == count($lineage) - 1);
+
+ $element['lineages']["lineage-$x"][$depth] = array(
+ '#markup' => $item['label'],
+ '#prefix' => '',
+ '#suffix' => ' ',
+ );
+ }
+
+ // Finally, create a "Remove" checkbox for the lineage.
+ $element['lineages']["lineage-$x"]['remove'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Remove'),
+ );
+ }
+ }
+
+ return $element;
+}
+
+/**
+ * Render a flat select version of a hierarchical_select form element. This is
+ * necessary for backwards compatibility (together with some Javascript code)
+ * in case of GET forms.
+ *
+ * @param $hierarchy
+ * A hierarchy object.
+ * @param $dropbox
+ * A dropbox object.
+ * @param $config
+ * A config array with at least the following settings:
+ * - module
+ * - params
+ * - dropbox
+ * - status
+ * @return
+ * A structured array for use in the Forms API.
+ */
+function _hs_process_render_flat_select($hierarchy, $dropbox, $config) {
+ $selection = array();
+ if ($config['dropbox']['status']) {
+ foreach ($dropbox->lineages_selections as $lineage_selection) {
+ $selection = array_merge($selection, $lineage_selection);
+ }
+ }
+ else {
+ $selection = $hierarchy->lineage;
+ }
+
+ $options = array();
+ foreach ($selection as $value) {
+ $is_valid = module_invoke($config['module'], 'hierarchical_select_valid_item', $value, $config['params']);
+ if ($is_valid) {
+ $options[$value] = $value;
+ }
+ }
+
+ $element = array(
+ '#type' => 'select',
+ '#multiple' => ($config['save_lineage'] || $config['dropbox']['status']),
+ '#options' => $options,
+ '#value' => array_keys($options),
+ // Use a #theme callback to prevent the select from being wrapped in a
+ // div. This simplifies the CSS and JS code.
+ '#theme' => 'hierarchical_select_select',
+ '#attributes' => array('class' => array('flat-select')),
+ );
+
+ return $element;
+}
+
+/**
+ * Calculate the return value of a hierarchical_select form element, based on
+ * the $hierarchy and $dropbox objects. We have to set a return value, because
+ * the values set and used by this form element ($element['#value]) are not
+ * easily usable in the Forms API; we want to return a flat list of item ids.
+ *
+ * @param $hierarchy
+ * A hierarchy object.
+ * @param $dropbox
+ * Optional. A dropbox object.
+ * @param $module
+ * The module that should be used for HS hooks.
+ * @param $params
+ * Optional. An array of parameters, which may be necessary for some
+ * implementations.
+ * @param $save_lineage
+ * Whether the save_lineage setting is enabled or not.
+ * @return
+ * A single item id or a flat array of item ids.
+ */
+function _hierarchical_select_process_calculate_return_value($hierarchy, $dropbox = FALSE, $module, $params, $save_lineage) {
+ if (!$dropbox) {
+ $return_value = _hierarchical_select_hierarchy_validate($hierarchy->lineage, $module, $params);
+ // If the save_lineage setting is disabled, keep only the deepest item.
+ if (!$save_lineage) {
+ $return_value = (is_array($return_value)) ? end($return_value) : NULL;
+ }
+
+ // Prevent a return value of -1. -1 is used for HS' internal system and
+ // means "nothing selected", but to Drupal it *will* seam like a valid
+ // value. Therefore, we set it to NULL.
+ $return_value = ($return_value != -1) ? $return_value : NULL;
+ }
+ else {
+ $return_value = array();
+ foreach ($dropbox->lineages_selections as $x => $selection) {
+ if (!$save_lineage) {
+ // An entry in the dropbox when the save_lineage setting is disabled
+ // is only the deepest item of the generated lineage.
+ $return_value[] = end($selection);
+ }
+ else {
+ // An entry in the dropbox when the save_lineage setting is enabled is
+ // the entire generated lineage, if it's valid (i.e. if the user has
+ // not tampered with it).
+ $lineage = _hierarchical_select_hierarchy_validate($selection, $module, $params);
+ $return_value = array_merge($return_value, $lineage);
+ }
+ }
+ $return_value = array_unique($return_value);
+ }
+
+ return $return_value;
+}
+
+
+//----------------------------------------------------------------------------
+// Private functions.
+
+/**
+ * Inherit the default config from Hierarchical Selects' hook_elements().
+ *
+ * @param $config
+ * A config array with at least the following settings:
+ * - module
+ * - params
+ * @return
+ * An updated config array.
+ */
+function _hierarchical_select_inherit_default_config($config, $defaults_override = array()) {
+ // Set defaults for unconfigured settings. Get the defaults from our
+ // hook_elements() implementation. Default properties from this hook are
+ // applied automatically, but properties inside properties, such as is the
+ // case for Hierarchical Select's #config property, aren't applied.
+ $type = hierarchical_select_element_info();
+ $defaults = $type['hierarchical_select']['#config'];
+ // Don't inherit the module and params settings.
+ unset($defaults['module']);
+ unset($defaults['params']);
+
+ // Allow the defaults to be overridden.
+ $defaults = array_smart_merge($defaults, $defaults_override);
+
+ // Apply the defaults to the config.
+ $config = array_smart_merge($defaults, $config);
+
+ return $config;
+}
+
+/**
+ * Convert a hierarchy object into an array of arrays that can be used for
+ * caching an entire hierarchy in a client-side database.
+ *
+ * @param $hierarchy
+ * A hierarchy object.
+ * @return
+ * An array of arrays.
+ */
+function _hierarchical_select_json_convert_hierarchy_to_cache($hierarchy) {
+ // Convert the hierarchy object to an array of values like these:
+ // array('value' => $term_id, 'label => $term_name, 'parent' => $term_id)
+ $cache = array();
+ foreach ($hierarchy->levels as $depth => $items) {
+ $weight = 0;
+ foreach ($items as $value => $label) {
+ $weight++;
+ $cache[] = array(
+ 'value' => $value,
+ 'label' => $label,
+ 'parent' => ($depth == 0) ? 0 : $hierarchy->lineage[$depth - 1],
+ 'weight' => $weight,
+ );
+ }
+ }
+
+ // The last item in the lineage never has any children.
+ $value = end($hierarchy->lineage);
+ $cache[] = array(
+ 'value' => $value . '-has-no-children', // Construct a pseudo-value (will never be actually used).
+ 'label' => '',
+ 'parent' => $value,
+ 'weight' => 0,
+ );
+
+ return $cache;
+}
+
+/**
+ * Helper function that marks every element in the given element as disabled.
+ *
+ * @param &$element
+ * The element of which we want to mark all elements as disabled.
+ * @return
+ * A structured array for use in the Forms API.
+ */
+function _hierarchical_select_mark_as_disabled(&$element) {
+ // Setting $element['#disabled'] = TRUE resulted in undesired side-effects:
+ // when the dropbox limit would be reached after pressing the "Add" button,
+ // then the *entire form* would be submitted. Using #attributes instead does
+ // not trigger this behavior.
+ // Based on documentation of @see _form_builder_handle_input_element():
+ // "If a form wants to start a control off with one of these attributes
+ // for UI purposes only, but still allow input to be processed if it's
+ // sumitted, it can set the desired attribute in #attributes directly
+ // rather than using #disabled."
+ // #disabled prevents #value from containing values for disabled elements,
+ // but using #attributes circumvents this. Most likely, Form API thinks that
+ // because HS' selects are disabled, that the whole of HS is disabled (which
+ // is of course a wrong assumption). Hence it thinks the 'op' that is being
+ // passed ('Add') is wrong and is forcefully being set through JS (which is
+ // also a wrong assumption). Hence it reverts to the main form's default
+ // submit handler.
+ $element['#attributes']['disabled'] = TRUE;
+
+ // Recurse through all children:
+ foreach (element_children($element) as $key) {
+ if (isset($element[$key]) && $element[$key]) {
+ _hierarchical_select_mark_as_disabled($element[$key]);
+ }
+ }
+}
+
+/**
+ * Helper function to determine whether a given depth (i.e. the depth of a
+ * level) is allowed by the allowed_levels setting.
+ *
+ * @param $config
+ * A config array with at least the following settings:
+ * - editability
+ * - allowed_levels
+ * @param $depth
+ * A depth, starting from 0.
+ * @return
+ * 0 or 1 if it allowed_levels is set for the given depth, 1 otherwise.
+ */
+function _hierarchical_select_create_new_item_is_allowed($config, $depth) {
+ return (isset($config['editability']['allowed_levels'][$depth])) ? $config['editability']['allowed_levels'][$depth] : 1;
+}
+
+/**
+ * Helper function that generates the help text is that is displayed to the
+ * user when Javascript is disabled.
+ *
+ * @param $dropbox_is_enabled
+ * Indicates if the dropbox is enabled or not, the help text will be
+ * adjusted depending on this value.
+ * @return
+ * The generated help text (in HTML).
+ */
+function _hierarchical_select_nojs_helptext($dropbox_is_enabled) {
+ $output = '';
+
+ // The options that will be used in the unordered list.
+ $items = array(
+ t('enable Javascript in your browser and then refresh this page, for a much enhanced experience.'),
+ t('click the Update button every time you want to update the selection'),
+ );
+ $items[1] .= (!$dropbox_is_enabled) ? '.' : t(", or when you've checked some checkboxes for entries in the dropbox you'd like to remove.");
+
+ $output .= '';
+ $output .= t("You don't have Javascript enabled.");
+ $output .= ' ';
+ $output .= '';
+ $output .= t('Hover for more information!');
+ $output .= ' ';
+ $output .= t("But don't worry: you can still use this web site! You have two options:");
+ $output .= theme('item_list', array('items' => $items, 'title' => NULL, 'type' => 'ul', 'attributes' => array('class' => array('solutions'))));
+ $output .= ' ';
+
+ return $output;
+}
+
+/**
+ * Set the 'error' class on the appropriate part of Hierarchical Select,
+ * depending on its configuration.
+ *
+ * @param $element
+ * A Hierarchical Select form item.
+ */
+function _hierarchical_select_form_set_error_class(&$element) {
+ $config = _hierarchical_select_inherit_default_config($element['#config']);
+
+ if ($config['dropbox']['status']) {
+ form_error($element['dropbox']['visible']);
+ }
+ else {
+ for ($i = 0; $i < count(element_children($element['hierarchical_select']['selects'])); $i++) {
+ form_error($element['hierarchical_select']['selects'][$i]);
+ }
+ }
+}
+
+/**
+ * Append messages to Hierarchical Select's log. Used when in developer mode.
+ *
+ * @param $item
+ * Either a message (string) or an array.
+ * @param $reset
+ * Reset the stored log.
+ * @return
+ * Only when the log is being reset, the stored log is returned.
+ */
+function _hierarchical_select_log($item, $reset = FALSE) {
+ static $log;
+
+ if ($reset) {
+ $copy_of_log = $log;
+ $log = array();
+ return $copy_of_log;
+ }
+
+ $log[] = $item;
+}
+
+
+//----------------------------------------------------------------------------
+// Hierarchy object generation functions.
+
+/**
+ * Generate the hierarchy object.
+ *
+ * @param $config
+ * A config array with at least the following settings:
+ * - module
+ * - params
+ * - enforce_deepest
+ * - save_lineage
+ * - level_labels
+ * - status
+ * - labels
+ * - editability
+ * - status
+ * - allow_new_levels
+ * - max_levels
+ * @param $selection
+ * The selection based on which a HS should be rendered.
+ * @param $required
+ * Whether the form element is required or not. (#required in Forms API)
+ * @param $dropbox
+ * A dropbox object, or FALSE.
+ * @return
+ * A hierarchy object.
+ */
+function _hierarchical_select_hierarchy_generate($config, $selection, $required, $dropbox = FALSE) {
+ $hierarchy = new stdClass();
+
+ // Convert the 'special_items' setting to a more easily accessible format.
+ if (isset($config['special_items'])) {
+ $special_items['exclusive'] = array_keys(array_filter($config['special_items'], '_hierarchical_select_special_item_exclusive'));
+ $special_items['none'] = array_keys(array_filter($config['special_items'], '_hierarchical_select_special_item_none'));
+ }
+
+
+ //
+ // Build the lineage.
+ //
+
+ $start_lineage = microtime();
+
+ // If save_linage is enabled, reconstruct the lineage. This is necessary
+ // because e.g. the taxonomy module stores the terms by order of weight and
+ // lexicography, rather than by hierarchy.
+ if ($config['save_lineage'] && is_array($selection) && count($selection) >= 2) {
+ // Ensure the item in the root level is the first item in the selection.
+ $root_level = array_keys(module_invoke($config['module'], 'hierarchical_select_root_level', $config['params']));
+
+ for ($i = 0; $i < count($selection); $i++) {
+ if (in_array($selection[$i], $root_level)) {
+ if ($i != 0) { // Don't swap if it's already the first item.
+ list($selection[0], $selection[$i]) = array($selection[$i], $selection[0]);
+ }
+ break;
+ }
+ }
+ // Reconstruct all sublevels.
+ for ($i = 0; $i < count($selection); $i++) {
+ $children = array_keys(module_invoke($config['module'], 'hierarchical_select_children', $selection[$i], $config['params']));
+
+ // Ensure the next item in the selection is a child of the current item.
+ for ($j = $i + 1; $j < count($selection); $j++) {
+ if (in_array($selection[$j], $children)) {
+ list($selection[$j], $selection[$i + 1]) = array($selection[$i + 1], $selection[$j]);
+ }
+ }
+ }
+ }
+
+ // Validate the hierarchy.
+ $selection = _hierarchical_select_hierarchy_validate($selection, $config['module'], $config['params']);
+
+ // When nothing is currently selected, set the root level to:
+ // - "" (or its equivalent special item) when:
+ // - enforce_deepest is enabled *and* level labels are enabled *and*
+ // no root level label is set (1), or
+ // - the dropbox is enabled *and* at least one selection has been added
+ // to the dropbox (2)
+ // - "label_0" (the root level label) in all other cases.
+ if ($selection == -1) {
+ $root_level = module_invoke($config['module'], 'hierarchical_select_root_level', $config['params']);
+ $first_case = $config['enforce_deepest'] && $config['level_labels']['status'] && !isset($config['level_labels']['labels'][0]);
+ $second_case = $dropbox && count($dropbox->lineages) > 0;
+
+ // If
+ // - the special_items setting has been configured, and
+ // - one special item has the 'none' property
+ // then we'll use the special item instead of the normal "" option.
+ $none_option = (isset($special_items) && count($special_items['none'])) ? $special_items['none'][0] : 'none';
+
+ // Set "" option (or its equivalent special item), or "label_0".
+ $hierarchy->lineage[0] = ($first_case || $second_case) ? $none_option : 'label_0';
+ }
+ else {
+ // If save_lineage setting is enabled, then the selection *is* a lineage.
+ // If it's disabled, we have to generate one ourselves based on the
+ // (deepest) selected item.
+ if ($config['save_lineage']) {
+ // When the form element is optional, the "" setting can be
+ // selected, thus only the first level will be displayed. As a result,
+ // we won't receive an array as the selection, but only a single item.
+ // We convert this into an array.
+ $hierarchy->lineage = (is_array($selection)) ? $selection : array(0 => $selection);
+ }
+ else {
+ $selection = (is_array($selection)) ? $selection[0] : $selection;
+ if (module_invoke($config['module'], 'hierarchical_select_valid_item', $selection, $config['params'])) {
+ $hierarchy->lineage = module_invoke($config['module'], 'hierarchical_select_lineage', $selection, $config['params']);
+ }
+ else {
+ // If the selected item is invalid, then start with an empty lineage.
+ $hierarchy->lineage = array();
+ }
+ }
+ }
+
+ // If enforce_deepest is enabled, ensure that the lineage goes as deep as
+ // possible: append values of items that will be selected by default.
+ if ($config['enforce_deepest'] && !in_array($hierarchy->lineage[0], array('none', 'label_0'))) {
+ $hierarchy->lineage = _hierarchical_select_hierarchy_enforce_deepest($hierarchy->lineage, $config['module'], $config['params']);
+ }
+
+ $end_lineage = microtime();
+
+
+ //
+ // Build the levels.
+ //
+
+ $start_levels = microtime();
+
+ // Start building the levels, initialize with the root level.
+ $hierarchy->levels[0] = module_invoke($config['module'], 'hierarchical_select_root_level', $config['params']);
+ $hierarchy->levels[0] = _hierarchical_select_apply_entity_settings($hierarchy->levels[0], $config);
+
+ // Prepend a "" option to the root level when:
+ // - the editability setting is enabled, and
+ // - the hook is implemented (this is an optional hook), and
+ // - the logged in user has permission to edit terms in this vocabulary, and
+ // - the allowed_levels setting allows to create new items at this level.
+ if (!empty($config['editability']['status'])
+ && module_hook($config['module'], 'hierarchical_select_create_item')
+ && ($config['module'] == 'hs_taxonomy' && (user_access('administer taxonomy') || user_access('edit terms in ' . $config['params']['vid'])))
+ && _hierarchical_select_create_new_item_is_allowed($config, 0)
+ ) {
+ $item_type = (count($config['editability']['item_types']) > 0)
+ ? t($config['editability']['item_types'][0])
+ : t('item');
+ $option = theme('hierarchical_select_special_option', array('option' => t('create new !item_type', array('!item_type' => $item_type))));
+ $hierarchy->levels[0] = array('create_new_item' => $option) + $hierarchy->levels[0];
+ }
+
+ // Prepend a "" option to the root level when:
+ // - the form element is optional (1), or
+ // - enforce_deepest is enabled (2), or
+ // - the dropbox is enabled *and* at least one selection has been added to
+ // the dropbox (3)
+ // except when:
+ // - level labels are enabled
+ // - the special_items setting has been configured, and
+ // - one special item has the 'none' property
+ $first_case = !$required;
+ $second_case = $config['enforce_deepest'];
+ $third_case = $dropbox && count($dropbox->lineages) > 0;
+ if (($first_case || $second_case || $third_case) && (!$config['level_labels']['status'] && isset($special_items) && !count($special_items['none']))) {
+ $option = theme('hierarchical_select_special_option', array('option' => t('none')));
+ $hierarchy->levels[0] = array('none' => $option) + $hierarchy->levels[0];
+ }
+
+ // Calculate the lineage's depth (starting from 0).
+ $max_depth = count($hierarchy->lineage) - 1;
+
+ // Build all sublevels, based on the lineage.
+ for ($depth = 1; $depth <= $max_depth; $depth++) {
+ $hierarchy->levels[$depth] = module_invoke($config['module'], 'hierarchical_select_children', $hierarchy->lineage[$depth - 1], $config['params']);
+ $hierarchy->levels[$depth] = _hierarchical_select_apply_entity_settings($hierarchy->levels[$depth], $config);
+ }
+
+ if ($config['enforce_deepest']) {
+ // Prepend a "" option to each level below the root level
+ // when:
+ // - the editability setting is enabled, and
+ // - the hook is implemented (this is an optional hook), and
+ // - the allowed_levels setting allows to create new items at this level.
+ if (!empty($config['editability']['status'])
+ && ($config['module'] == 'hs_taxonomy' && (user_access('administer taxonomy') || user_access('edit terms in ' . $config['params']['vid'])))
+ && module_hook($config['module'], 'hierarchical_select_create_item')) {
+ for ($depth = 1; $depth <= $max_depth; $depth++) {
+ $item_type = (count($config['editability']['item_types']) >= $depth)
+ ? t($config['editability']['item_types'][$depth])
+ : t('item');
+ $option = theme('hierarchical_select_special_option', array('option' => t('create new !item_type', array('!item_type' => $item_type))));
+ if (_hierarchical_select_create_new_item_is_allowed($config, $depth)) {
+ $hierarchy->levels[$depth] = array('create_new_item' => $option) + $hierarchy->levels[$depth];
+ }
+ }
+ }
+
+ // If level labels are enabled and the root label is set, prepend it.
+ if ($config['level_labels']['status'] && isset($config['level_labels']['labels'][0])) {
+ $hierarchy->levels[0] = array('label_0' => t($config['level_labels']['labels'][0])) + $hierarchy->levels[0];
+ }
+ }
+ else if (!$config['enforce_deepest']) {
+ // Prepend special options to every level.
+ for ($depth = 0; $depth <= $max_depth; $depth++) {
+ // Prepend a "" option to the current level when:
+ // - this is not the root level (the root level already has this), and
+ // - the editability setting is enabled, and
+ // - the hook is implemented (this is an optional hook), and
+ // - the logged in user has permission to edit terms in this vocabulary, and
+ // - the allowed_levels setting allows to create new items at this level.
+ if ($depth > 0
+ && !empty($config['editability']['status'])
+ && module_hook($config['module'], 'hierarchical_select_create_item')
+ && ($config['module'] == 'hs_taxonomy' && (user_access('administer taxonomy') || user_access('edit terms in ' . $config['params']['vid'])))
+ && _hierarchical_select_create_new_item_is_allowed($config, $depth)
+ ) {
+ $item_type = (count($config['editability']['item_types']) == $depth)
+ ? t($config['editability']['item_types'][$depth])
+ : t('item');
+ $option = theme('hierarchical_select_special_option', array('option' => t('create new !item_type', array('!item_type' => $item_type))));
+ $hierarchy->levels[$depth] = array('create_new_item' => $option) + $hierarchy->levels[$depth];
+ }
+ // Level label: set an empty level label if they've been disabled.
+ $label = ($config['level_labels']['status'] && isset($config['level_labels']['labels'][$depth])) ? t($config['level_labels']['labels'][$depth]) : '';
+ $hierarchy->levels[$depth] = array('label_' . $depth => $label) + $hierarchy->levels[$depth];
+ }
+
+ // If the root level label is empty and the none option is present, remove
+ // the root level label because it's conceptually identical.
+ if ($hierarchy->levels[0]['label_0'] == '' && isset($hierarchy->levels[0]['none'])) {
+ unset($hierarchy->levels[0]['label_0']);
+ // Update the selected lineage when necessary to prevent an item that
+ // doesn't exist from being "selected" internally.
+ if ($hierarchy->lineage[0] == 'label_0') {
+ $hierarchy->lineage[0] = 'none';
+ }
+ }
+
+ // Add one more level if appropriate.
+ $parent = $hierarchy->lineage[$max_depth];
+ if (module_invoke($config['module'], 'hierarchical_select_valid_item', $parent, $config['params'])) {
+ $children = module_invoke($config['module'], 'hierarchical_select_children', $parent, $config['params']);
+ if (count($children)) {
+ // We're good, let's add one level!
+ $depth = $max_depth + 1;
+
+ $hierarchy->levels[$depth] = array();
+
+ // Prepend a "" option to the current level when:
+ // - the editability setting is enabled, and
+ // - the hook is implemented (this is an optional hook), and
+ // - the logged in user has permission to edit terms in this vocabulary, and
+ // - the allowed_levels setting allows to create new items at this level.
+ if (!empty($config['editability']['status'])
+ && module_hook($config['module'], 'hierarchical_select_create_item')
+ && ($config['module'] == 'hs_taxonomy' && (user_access('administer taxonomy') || user_access('edit terms in ' . $config['params']['vid'])))
+ && _hierarchical_select_create_new_item_is_allowed($config, $depth)
+ ) {
+ $item_type = (count($config['editability']['item_types']) >= $depth)
+ ? t($config['editability']['item_types'][$depth])
+ : t('item');
+ $option = theme('hierarchical_select_special_option', array('option' => t('create new !item_type', array('!item_type' => $item_type))));
+ $hierarchy->levels[$depth] = array('create_new_item' => $option);
+ }
+
+ // Level label: set an empty level label if they've been disabled.
+ $hierarchy->lineage[$depth] = 'label_' . $depth;
+ $label = ($config['level_labels']['status']) ? t($config['level_labels']['labels'][$depth]) : '';
+ $hierarchy->levels[$depth] = array('label_' . $depth => $label) + $hierarchy->levels[$depth] + $children;
+
+ $hierarchy->levels[$depth] = _hierarchical_select_apply_entity_settings($hierarchy->levels[$depth], $config);
+ }
+ }
+ }
+
+ // Add an extra level with only a level label and a ""
+ // option, if:
+ // - the editability setting is enabled
+ // - the allow_new_levels setting is enabled
+ // - an additional level is permitted by the max_levels setting
+ // - the logged in user has permission to edit terms in this vocabulary
+ // - the deepest item of the lineage is a valid item
+ // NOTE: this uses an optional hook, so we also check if it's implemented.
+ if (!empty($config['editability']['status'])
+ && !empty($config['editability']['allow_new_levels'])
+ && ($config['editability']['max_levels'] == 0 || count($hierarchy->lineage) < $config['editability']['max_levels'])
+ && module_invoke($config['module'], 'hierarchical_select_valid_item', end($hierarchy->lineage), $config['params'])
+ && ($config['module'] == 'hs_taxonomy' && (user_access('administer taxonomy') || user_access('edit terms in ' . $config['params']['vid'])))
+ && module_hook($config['module'], 'hierarchical_select_create_item')
+ ) {
+ $depth = $max_depth + 1;
+
+ // Level label: set an empty level label if they've been disabled.
+ $hierarchy->lineage[$depth] = 'label_' . $depth;
+ $label = ($config['level_labels']['status']) ? t($config['level_labels']['labels'][$depth]) : '';
+
+ // Item type.
+ $item_type = (count($config['editability']['item_types']) >= $depth)
+ ? t($config['editability']['item_types'][$depth])
+ : t('item');
+
+ // The new level with only a level label and a "" option.
+ $option = theme('hierarchical_select_special_option', array('option' => t('create new !item_type', array('!item_type' => $item_type))));
+ $hierarchy->levels[$depth] = array(
+ 'label_' . $depth => $label,
+ 'create_new_item' => $option,
+ );
+ }
+
+ // Calculate the time it took to generate the levels.
+ $end_levels = microtime();
+
+ // Add child information.
+ $start_childinfo = microtime();
+ $hierarchy = _hierarchical_select_hierarchy_add_childinfo($hierarchy, $config);
+ $end_childinfo = microtime();
+
+ // Calculate the time it took to build the hierarchy object.
+ $hierarchy->build_time['total'] = ($end_childinfo - $start_lineage) * 1000;
+ $hierarchy->build_time['lineage'] = ($end_lineage - $start_lineage) * 1000;
+ $hierarchy->build_time['levels'] = ($end_levels - $start_levels) * 1000;
+ $hierarchy->build_time['childinfo'] = ($end_childinfo - $start_childinfo) * 1000;
+
+ return $hierarchy;
+}
+
+/**
+ * Given a level, apply the entity_count and require_entity settings.
+ *
+ * @param $level
+ * A level in the hierarchy.
+ * @param $config
+ * A config array with at least the following settings:
+ * - module
+ * - params
+ * - entity_count
+ * - require_entity
+ * @return
+ * The updated level
+ */
+function _hierarchical_select_apply_entity_settings($level, $config) {
+ if (isset($config['special_items'])) {
+ $special_items['exclusive'] = array_keys(array_filter($config['special_items'], '_hierarchical_select_special_item_exclusive'));
+ $special_items['none'] = array_keys(array_filter($config['special_items'], '_hierarchical_select_special_item_none'));
+ }
+
+ // Only do something when the entity_count or the require_entity (or both)
+ // settings are enabled.
+ // NOTE: this uses the optional "hierarchical_select_entity_count" hook, so
+ // we also check if it's implemented.
+ if (isset($config['entity_count']['enabled']) && ($config['entity_count']['enabled'] || $config['entity_count']['require_entity']) && module_hook($config['module'], 'hierarchical_select_entity_count')) {
+ foreach ($level as $item => $label) {
+ // We don't want to alter internal or special items.
+ if (!preg_match('/(none|label_\d+|create_new_item)/', $item)
+ && !in_array($item, $special_items['exclusive'])
+ && !in_array($item, $special_items['none'])
+ ) {
+ // Add our entity count settings to the parameters.
+ $config['params'] += array(
+ 'entity_count' => array(
+ 'settings' => array(
+ 'count_children' => $config['entity_count']['settings']['count_children'],
+ 'entity_types' => $config['entity_count']['settings']['entity_types'],
+ ),
+ ),
+ );
+ $entity_count = module_invoke($config['module'], 'hierarchical_select_entity_count', $item, $config['params']);
+
+ // When the require_entity setting is enabled and the entity count is
+ // zero, then remove the item from the level.
+ // When the item is not removed from the level due to the above and
+ // the entity_count setting is enabled, update the label of the item
+ // to include the entity count.
+ if ($config['entity_count']['require_entity'] && $entity_count == 0) {
+ unset($level[$item]);
+ }
+ elseif ($config['entity_count']['enabled']) {
+ $level[$item] = "$label ($entity_count)";
+ }
+ }
+ }
+ }
+
+ return $level;
+}
+
+/**
+ * Extends a hierarchy object with child information: for each item in the
+ * hierarchy, the child count will be retrieved and stored in the hierarchy
+ * object, in the "childinfo" property. Items are grouped per level.
+ *
+ * @param $hierarchy
+ * A hierarchy object with the "levels" property set.
+ * @param $config
+ * A config array with at least the following settings:
+ * - module
+ * - params
+ * @return
+ * An updated hierarchy object with the "childinfo" property set.
+ */
+function _hierarchical_select_hierarchy_add_childinfo($hierarchy, $config) {
+ foreach ($hierarchy->levels as $depth => $level) {
+ foreach (array_keys($level) as $item) {
+ if (!preg_match('/(none|label_\d+|create_new_item)/', $item)) {
+ $hierarchy->childinfo[$depth][$item] = count(module_invoke($config['module'], 'hierarchical_select_children', $item, $config['params']));
+ }
+ }
+ }
+
+ return $hierarchy;
+}
+
+/**
+ * Reset the selection if no valid item was selected. The first item in the
+ * array corresponds to the first selected term. As soon as an invalid item
+ * is encountered, the lineage from that level to the deeper levels should be
+ * unset. This is so to ignore selection of a level label.
+ *
+ * @param $selection
+ * Either a single item id or an array of item ids.
+ * @param $module
+ * The module that should be used for HS hooks.
+ * @param $params
+ * The module that should be passed to HS hooks.
+ * @return
+ * The updated selection.
+ */
+function _hierarchical_select_hierarchy_validate($selection, $module, $params) {
+ $valid = TRUE;
+ $selection_levels = count($selection);
+ for ($i = 0; $i < $selection_levels; $i++) {
+ // As soon as one invalid item has been found, we'll stop validating; all
+ // subsequently selected items will be removed from the selection.
+ if ($valid) {
+ $valid = module_invoke($module, 'hierarchical_select_valid_item', $selection[$i], $params);
+ if ($i > 0) {
+ $parent = $selection[$i - 1];
+ $child = $selection[$i];
+ $children = array_keys(module_invoke($module, 'hierarchical_select_children', $parent, $params));
+ $valid = $valid && in_array($child, $children);
+ }
+ }
+ if (!$valid) {
+ unset($selection[$i]);
+ }
+ }
+
+ if (empty($selection)) {
+ $selection = -1;
+ }
+ if (is_array($selection)) {
+ // This is needed because we may have unset some values and we don't want
+ // any gaps in the indexes (ie. the indexes would be 0,1,3 if we did
+ // "$selection[] = X" after unsetting #2).
+ $selection = array_values($selection);
+ }
+
+ return $selection;
+}
+
+/**
+ * Helper function to update the lineage of the hierarchy to ensure that the
+ * user selects an item in the deepest level of the hierarchy.
+ *
+ * @param $lineage
+ * The lineage up to the deepest selection the user has made so far.
+ * @param $module
+ * The module that should be used for HS hooks.
+ * @param $params
+ * The params that should be passed to HS hooks.
+ * @return
+ * The updated lineage.
+ */
+function _hierarchical_select_hierarchy_enforce_deepest($lineage, $module, $params) {
+ // Use the deepest item as the first parent. Then apply this algorithm:
+ // 1) get the parent's children, stop if no children
+ // 2) choose the first child as the option that is selected by default, by
+ // adding it to the lineage of the hierarchy
+ // 3) make this child the parent, go to step 1.
+ $parent = end($lineage); // The last item in the lineage is the deepest one.
+ $children = module_invoke($module, 'hierarchical_select_children', $parent, $params);
+ while (count($children)) {
+ $keys = array_keys($children);
+ $first_child = $keys[0];
+ $lineage[] = $first_child;
+ $parent = $first_child;
+ $children = module_invoke($module, 'hierarchical_select_children', $parent, $params);
+ }
+
+ return $lineage;
+}
+
+
+//----------------------------------------------------------------------------
+// Dropbox object generation functions.
+
+/**
+ * Generate the dropbox object.
+ *
+ * @param $config
+ * A config array with at least the following settings:
+ * - module
+ * - save_lineage
+ * - params
+ * - dropbox
+ * - title
+ * @param $selection
+ * The selection based on which a dropbox should be generated.
+ * @return
+ * A dropbox object.
+ */
+function _hierarchical_select_dropbox_generate($config, $selection) {
+ $dropbox = new stdClass();
+ $start = microtime();
+
+ $dropbox->title = (!empty($config['dropbox']['title'])) ? filter_xss_admin($config['dropbox']['title']) : t('All selections');
+ $dropbox->lineages = array();
+ $dropbox->lineages_selections = array();
+
+ // Clean selection.
+ foreach ($selection as $key => $item) {
+ if (!module_invoke($config['module'], 'hierarchical_select_valid_item', $item, $config['params'])) {
+ unset($selection[$key]);
+ }
+ }
+
+ if (!empty($selection)) {
+ // Store the "save lineage" setting, needed in the rendering layer.
+ $dropbox->save_lineage = $config['save_lineage'];
+ if ($config['save_lineage']) {
+ $dropbox->lineages = _hierarchical_select_dropbox_reconstruct_lineages_save_lineage_enabled($config['module'], $selection, $config['params']);
+ }
+ else {
+ // Retrieve the lineage of each item.
+ foreach ($selection as $item) {
+ $dropbox->lineages[] = module_invoke($config['module'], 'hierarchical_select_lineage', $item, $config['params']);
+ }
+
+ // We will also need the labels of each item in the rendering layer.
+ foreach ($dropbox->lineages as $id => $lineage) {
+ foreach ($lineage as $level => $item) {
+ $dropbox->lineages[$id][$level] = array('value' => $item, 'label' => module_invoke($config['module'], 'hierarchical_select_item_get_label', $item, $config['params']));
+ }
+ }
+ }
+
+ // Sanitize the labels.
+ foreach ($dropbox->lineages as $id => $lineage) {
+ foreach ($lineage as $level => $item) {
+ $dropbox->lineages[$id][$level]['label'] = check_plain($dropbox->lineages[$id][$level]['label']);
+ }
+ }
+
+ if (!isset($config['dropbox']['sort']) || $config['dropbox']['sort']){
+ usort($dropbox->lineages, '_hierarchical_select_dropbox_sort');
+ }
+
+ // Now store each lineage's selection too. This is needed on the client side
+ // to enable the remove button to let the server know which selected items
+ // should be removed.
+ foreach ($dropbox->lineages as $id => $lineage) {
+ if ($config['save_lineage']) {
+ // Store the entire lineage.
+ $dropbox->lineages_selections[$id] = array_map('_hierarchical_select_dropbox_lineage_item_get_value', $lineage);
+ }
+ else {
+ // Store only the last (aka the deepest) value of the lineage.
+ $dropbox->lineages_selections[$id][0] = $lineage[count($lineage) - 1]['value'];
+ }
+ }
+ }
+
+ // Calculate the time it took to build the dropbox object.
+ $dropbox->build_time = (microtime() - $start) * 1000;
+
+ return $dropbox;
+}
+
+/**
+ * Helper function to reconstruct the lineages given a set of selected items
+ * and the fact that the "save lineage" setting is enabled.
+ *
+ * Note that it's impossible to predict how many lineages if we know the
+ * number of selected items, exactly because the "save lineage" setting is
+ * enabled.
+ *
+ * Worst case time complexity is O(n^3), optimizations are still possible.
+ *
+ * @param $module
+ * The module that should be used for HS hooks.
+ * @param $selection
+ * The selection based on which a dropbox should be generated.
+ * @param $params
+ * Optional. An array of parameters, which may be necessary for some
+ * implementations.
+ * @return
+ * An array of dropbox lineages.
+ */
+function _hierarchical_select_dropbox_reconstruct_lineages_save_lineage_enabled($module, $selection, $params) {
+ // We have to reconstruct all lineages from the given set of selected items.
+ // That means: we have to reconstruct every possible combination!
+ $lineages = array();
+ $root_level = module_invoke($module, 'hierarchical_select_root_level', $params);
+
+ foreach ($selection as $key => $item) {
+ // Create new lineage if the item can be found in the root level.
+ if (array_key_exists($item, $root_level)) {
+ $lineages[][0] = array('value' => $item, 'label' => $root_level[$item]);
+ unset($selection[$key]);
+ }
+ }
+
+ // Keep on trying as long as at least one lineage has been extended.
+ $at_least_one = TRUE;
+ for ($level = 0; $at_least_one; $level++) {
+ $at_least_one = FALSE;
+ $num = count($lineages);
+
+ // Try to extend every lineage. Make sure we don't iterate over
+ // possibly new lineages.
+ for ($id = 0; $id < $num; $id++) {
+ // Only try to extend a lineage if it has an item at the current level.
+ if (!isset($lineages[$id][$level])) {
+ continue;
+ }
+ $children = module_invoke($module, 'hierarchical_select_children', $lineages[$id][$level]['value'], $params);
+
+ $child_added_to_lineage = FALSE;
+ foreach (array_keys($children) as $child) {
+ if (in_array($child, $selection)) {
+ if (!$child_added_to_lineage) {
+ // Add the child to the lineage.
+ $lineages[$id][$level + 1] = array('value' => $child, 'label' => $children[$child]);
+ $child_added_to_lineage = TRUE;
+ $at_least_one = TRUE;
+ }
+ else {
+ // Create new lineage based on current one and add the child.
+ $lineage = $lineages[$id];
+ $lineage[$level + 1] = array('value' => $child, 'label' => $children[$child]);
+
+ // Add the new lineage to the set of lineages
+ $lineages[] = $lineage;
+ }
+ }
+ }
+ }
+ }
+
+ return $lineages;
+}
+
+/**
+ * Dropbox lineages sorting callback.
+ *
+ * @param $lineage_a
+ * The first lineage.
+ * @param $lineage_b
+ * The second lineage.
+ * @return
+ * An integer that determines which of the two lineages comes first.
+ */
+function _hierarchical_select_dropbox_sort($lineage_a, $lineage_b) {
+ $string_a = implode('', array_map('_hierarchical_select_dropbox_lineage_item_get_label', $lineage_a));
+ $string_b = implode('', array_map('_hierarchical_select_dropbox_lineage_item_get_label', $lineage_b));
+ return strcmp($string_a, $string_b);
+}
+
+/**
+ * Helper function needed for the array_map() call in the dropbox sorting
+ * callback.
+ *
+ * @param $item
+ * An item in a dropbox lineage.
+ * @return
+ * The value associated with the "label" key of the item.
+ */
+function _hierarchical_select_dropbox_lineage_item_get_label($item) {
+ return t($item['label']);
+}
+
+/**
+ * Helper function needed for the array_map() call in the dropbox lineages
+ * selections creation.
+ *
+ * @param $item
+ * An item in a dropbox lineage.
+ * @return
+ * The value associated with the "value" key of the item.
+ */
+function _hierarchical_select_dropbox_lineage_item_get_value($item) {
+ return $item['value'];
+}
+
+/**
+ * Smarter version of array_merge_recursive: overwrites scalar values.
+ *
+ * From: http://www.php.net/manual/en/function.array-merge-recursive.php#82976.
+ */
+if (!function_exists('array_smart_merge')) {
+ function array_smart_merge($array, $override) {
+ if (is_array($array) && is_array($override)) {
+ foreach ($override as $k => $v) {
+ if (isset($array[$k]) && is_array($v) && is_array($array[$k])) {
+ $array[$k] = array_smart_merge($array[$k], $v);
+ }
+ else {
+ $array[$k] = $v;
+ }
+ }
+ }
+ return $array;
+ }
+}
+
+/**
+ * Helper function needed for the array_filter() call to filter the items
+ * marked with the 'exclusive' property
+ *
+ * @param $item
+ * An item in the 'special_items' setting.
+ * @return
+ * TRUE if it's marked with the 'exclusive' property, FALSE otherwise.
+ */
+function _hierarchical_select_special_item_exclusive($item) {
+ return in_array('exclusive', $item);
+}
+
+/**
+ * Helper function needed for the array_filter() call to filter the items
+ * marked with the 'none' property
+ *
+ * @param $item
+ * An item in the 'special_items' setting.
+ * @return
+ * TRUE if it's marked with the 'none' property, FALSE otherwise.
+ */
+function _hierarchical_select_special_item_none($item) {
+ return in_array('none', $item);
+}
diff --git a/sites/all/modules/hierarchical_select/hierarchical_select_cache.js b/sites/all/modules/hierarchical_select/hierarchical_select_cache.js
new file mode 100644
index 0000000..dbac146
--- /dev/null
+++ b/sites/all/modules/hierarchical_select/hierarchical_select_cache.js
@@ -0,0 +1,229 @@
+
+/**
+ * @file
+ * Cache system for Hierarchical Select.
+ * This cache system takes advantage of the HTML 5 client-side database
+ * storage specification to reduce the number of queries to the server. A lazy
+ * loading strategy is used.
+ */
+
+
+/**
+ * Note: this cache system can be replaced by another one, as long as you
+ * provide the following methods:
+ * - initialize()
+ * - status()
+ * - load()
+ * - sync()
+ * - updateHierarchicalSelect()
+ *
+ * TODO: better documentation
+ */
+
+(function ($) {
+
+Drupal.HierarchicalSelect.cache = {};
+
+Drupal.HierarchicalSelect.cache.initialize = function() {
+ try {
+ if (window.openDatabase) {
+ this.db = openDatabase("Hierarchical Select", "3.x", "Hierarchical Select cache", 200000);
+
+ this.db
+ // Create the housekeeping table if it doesn't exist yet.
+ .transaction(function(tx) {
+ tx.executeSql("SELECT COUNT(*) FROM hierarchical_select", [], null, function(tx, error) {
+ tx.executeSql("CREATE TABLE hierarchical_select (table_name TEXT UNIQUE, expires REAL)", []);
+ console.log("Created housekeeping table.");
+ });
+ })
+ // Empty tables that have expired, based on the information in the
+ // housekeeping table.
+ .transaction(function(tx) {
+ tx.executeSql("SELECT table_name FROM hierarchical_select WHERE expires < ?", [ new Date().getTime() ], function(tx, resultSet) {
+ for (var i = 0; i < resultSet.rows.length; i++) {
+ var row = resultSet.rows.item(i);
+ var newExpiresTimestamp = new Date().getTime() + 86400;
+
+ tx.executeSql("DELETE * FROM " + row.table_name);
+ tx.executeSql("UPDATE hierarchical_select SET expires = ? WHERE table_name = ?", [ newExpiresTimestamp, row.table_name ]);
+
+ console.log("Table "+ row.table_name +" was expired: emptied it. Will expire again in "+ (newExpiresTimestamp - new Date().getTime()) / 3600 +" hours.");
+ }
+ });
+ });
+ }
+ else {
+ this.db = false;
+ }
+ }
+ catch(err) { }
+};
+
+Drupal.HierarchicalSelect.cache.status = function() {
+ return Drupal.HierarchicalSelect.cache.db !== false;
+};
+
+Drupal.HierarchicalSelect.cache.table = function(hsid) {
+ return Drupal.settings.HierarchicalSelect.settings[hsid].cacheId;
+};
+
+Drupal.HierarchicalSelect.cache.load = function(hsid) {
+ // If necessary, create the cache table for the given Hierarchical Select.
+ Drupal.HierarchicalSelect.cache.db.transaction(function(tx) {
+ var table = Drupal.HierarchicalSelect.cache.table(hsid);
+
+ tx.executeSql("SELECT value FROM "+ table, [], function(tx, resultSet) {
+ console.log("" + resultSet.rows.length + " cached items in the " + table + " table.");
+ }, function(tx, error) {
+ var expiresTimestamp = new Date().getTime() + 86400;
+
+ tx.executeSql("CREATE TABLE "+ table +" (parent REAL, value REAL UNIQUE, label REAL, weight REAL)");
+ tx.executeSql("INSERT INTO hierarchical_select (table_name, expires) VALUES (?, ?)", [ table, expiresTimestamp ]);
+
+ console.log("Created table "+ table +", will expire in "+ (expiresTimestamp - new Date().getTime()) / 3600 +" hours.");
+ });
+ });
+};
+
+Drupal.HierarchicalSelect.cache.insertOnDuplicateKeyUpdate = function(table, row) {
+// console.log("storing: value: "+ row.value +", label: "+ row.label +", parent: "+ row.parent +", weight: "+ row.weight);
+ Drupal.HierarchicalSelect.cache.db.transaction(function(tx) {
+ tx.executeSql("INSERT INTO "+ table +" (parent, value, label, weight) VALUES (?, ?, ?, ?)", [ row.parent, row.value, row.label, row.weight ], null, function(tx, error) {
+// console.log("UPDATING value: "+ row.value +", label: "+ row.label +", parent: "+ row.parent +", weight: "+ row.weight);
+ tx.executeSql("UPDATE "+ table +" SET parent = ?, label = ?, weight = ? WHERE value = ?", [ row.parent, row.label, row.weight, row.value ], null, function(tx, error) {
+// console.log("sql error: " + error.message);
+ });
+ });
+ });
+};
+
+Drupal.HierarchicalSelect.cache.sync = function(hsid, info) {
+ var table = Drupal.HierarchicalSelect.cache.table(hsid);
+ for (var id in info) {
+ var closure = function(_info, id) {
+ Drupal.HierarchicalSelect.cache.insertOnDuplicateKeyUpdate(table, _info[id]);
+ } (info, id);
+ }
+};
+
+Drupal.HierarchicalSelect.cache.hasChildren = function(hsid, value, successCallback, failCallback) {
+ var table = Drupal.HierarchicalSelect.cache.table(hsid);
+ Drupal.HierarchicalSelect.cache.db.transaction(function(tx) {
+ tx.executeSql("SELECT * FROM "+ table +" WHERE parent = ?", [ value ], function(tx, resultSet) {
+ if (resultSet.rows.length > 0) {
+ successCallback();
+ }
+ else {
+ failCallback();
+ }
+ });
+ });
+};
+
+Drupal.HierarchicalSelect.cache.getSubLevels = function(hsid, value, callback, previousSubLevels) {
+ var table = Drupal.HierarchicalSelect.cache.table(hsid);
+
+ var subLevels = new Array();
+ if (previousSubLevels != undefined) {
+ subLevels = previousSubLevels;
+ }
+
+ Drupal.HierarchicalSelect.cache.db.transaction(function(tx) {
+ tx.executeSql("SELECT value, label FROM "+ table +" WHERE parent = ? ORDER BY weight", [ value ], function(tx, resultSet) {
+ var numChildren = resultSet.rows.length;
+
+ // If there's only one child, check if it has the dummy "-has-no-children" value.
+ if (numChildren == 1) {
+ var valueOfFirstRow = String(resultSet.rows.item(0).value);
+ var isDummy = valueOfFirstRow.match(/^.*-has-no-children$/);
+ }
+
+ // Only pass the children if there are any (and not a fake one either).
+ if (numChildren && !isDummy) {
+ var level = new Array();
+ for (var i = 0; i < resultSet.rows.length; i++) {
+ var row = resultSet.rows.item(i);
+ level[i] = { 'value' : row.value, 'label' : row.label };
+ console.log("child of "+ value +": ("+ row.value +", "+ row.label +")");
+ }
+
+ subLevels.push(level);
+
+ Drupal.HierarchicalSelect.cache.getSubLevels(hsid, level[0].value, callback, subLevels);
+ }
+ else {
+ if (subLevels.length > 0) {
+ callback(subLevels);
+ }
+ else {
+ callback(false);
+ }
+ }
+ });
+ });
+};
+
+Drupal.HierarchicalSelect.cache.createAndUpdateSelects = function(hsid, subLevels, lastUnchanged) {
+ // Remove all levels below the level in which a value was selected, if they
+ // exist.
+ // Note: the root level can never change because of this!
+ $('#hierarchical-select-'+ hsid +'-wrapper .hierarchical-select .selects select').slice(lastUnchanged).remove();
+
+ // Create the new sublevels, by cloning the root level and then modifying
+ // that clone.
+ var $rootSelect = $('#hierarchical-select-'+ hsid +'-wrapper .hierarchical-select .selects select:first');
+ for (var depth in subLevels) {
+ var optionElements = $.map(subLevels[depth], function(item) { return ''+ item.label +' '; });
+
+ var level = parseInt(lastUnchanged) + parseInt(depth);
+
+ $('#hierarchical-select-'+ hsid +'-wrapper .hierarchical-select .selects select:last').after(
+ $rootSelect.clone()
+ // Update the name attribute.
+ .attr('name', $rootSelect.attr('name').replace(/(.*)\d+\]$/, "$1"+ level +"]"))
+ // Update the id attribute.
+ .attr('id', $rootSelect.attr('id').replace(/(.*-hierarchical-select-selects-)\d+/, "$1"+ level))
+ // Remove the existing options and set the new ones.
+ .empty().append(optionElements.join(''))
+ );
+ }
+};
+
+Drupal.HierarchicalSelect.cache.updateHierarchicalSelect = function(hsid, value, settings, lastUnchanged, ajaxOptions) {
+ // If the selected value has children
+ Drupal.HierarchicalSelect.cache.hasChildren(hsid, value, function() {
+ console.log("Cache hit.");
+ Drupal.HierarchicalSelect.cache.getSubLevels(hsid, value, function(subLevels) {
+ Drupal.HierarchicalSelect.preUpdateAnimations(hsid, 'update-hierarchical-select', lastUnchanged, function() {
+ if (subLevels !== false) {
+ Drupal.HierarchicalSelect.cache.createAndUpdateSelects(hsid, subLevels, lastUnchanged);
+ }
+ else {
+ // Nothing must happen: the user selected a value that doesn't
+ // have any subLevels.
+ $('#hierarchical-select-' + hsid + '-wrapper .hierarchical-select .selects select').slice(lastUnchanged).remove();
+ }
+
+ Drupal.HierarchicalSelect.postUpdateAnimations(hsid, 'update-hierarchical-select', lastUnchanged, function() {
+ // Reattach the bindings.
+ Drupal.HierarchicalSelect.attachBindings(hsid);
+
+ Drupal.HierarchicalSelect.triggerEvents(hsid, 'update-hierarchical-select', settings);
+
+ // The selection of this hierarchical select has changed!
+ Drupal.HierarchicalSelect.triggerEvents(hsid, 'change-hierarchical-select', settings);
+ });
+ });
+ });
+ }, function() {
+ // This item was not yet requested before, so we still have to perform
+ // the dynamic form submit.
+ console.log("Cache miss. Querying the server.");
+ Drupal.HierarchicalSelect.preUpdateAnimations(hsid, 'update-hierarchical-select', lastUnchanged, function() {
+ $.ajax(ajaxOptions);
+ });
+ });
+};
+
+})(jQuery);
diff --git a/sites/all/modules/hierarchical_select/hierarchical_select_formtoarray.js b/sites/all/modules/hierarchical_select/hierarchical_select_formtoarray.js
new file mode 100644
index 0000000..62af3ec
--- /dev/null
+++ b/sites/all/modules/hierarchical_select/hierarchical_select_formtoarray.js
@@ -0,0 +1,95 @@
+
+/**
+ * @file
+ * Contains the formToArray method and the method it depends on. Taken from
+ * jQuery Form Plugin 2.12. (http://www.malsup.com/jquery/form/)
+ */
+
+(function ($) {
+
+/**
+ * formToArray() gathers form element data into an array of objects that can
+ * be passed to any of the following ajax functions: $.get, $.post, or load.
+ * Each object in the array has both a 'name' and 'value' property. An example of
+ * an array for a simple login form might be:
+ *
+ * [ { name: 'username', value: 'jresig' }, { name: 'password', value: 'secret' } ]
+ *
+ * It is this array that is passed to pre-submit callback functions provided to the
+ * ajaxSubmit() and ajaxForm() methods.
+ */
+$.fn.formToArray = function(semantic) {
+ var a = [];
+ if (this.length == 0) return a;
+
+ var form = this[0];
+ var els = semantic ? form.getElementsByTagName('*') : form.elements;
+ if (!els) return a;
+ for(var i=0, max=els.length; i < max; i++) {
+ var el = els[i];
+ var n = el.name;
+ if (!n) continue;
+
+ if (semantic && form.clk && el.type == "image") {
+ // handle image inputs on the fly when semantic == true
+ if(!el.disabled && form.clk == el)
+ a.push({name: n+'.x', value: form.clk_x}, {name: n+'.y', value: form.clk_y});
+ continue;
+ }
+
+ var v = $.fieldValue(el, true);
+ if (v && v.constructor == Array) {
+ for(var j=0, jmax=v.length; j < jmax; j++)
+ a.push({name: n, value: v[j]});
+ }
+ else if (v !== null && typeof v != 'undefined')
+ a.push({name: n, value: v});
+ }
+
+ if (!semantic && form.clk) {
+ // input type=='image' are not found in elements array! handle them here
+ var inputs = form.getElementsByTagName("input");
+ for(var i=0, max=inputs.length; i < max; i++) {
+ var input = inputs[i];
+ var n = input.name;
+ if(n && !input.disabled && input.type == "image" && form.clk == input)
+ a.push({name: n+'.x', value: form.clk_x}, {name: n+'.y', value: form.clk_y});
+ }
+ }
+ return a;
+};
+
+/**
+ * Returns the value of the field element.
+ */
+$.fieldValue = function(el, successful) {
+ var n = el.name, t = el.type, tag = el.tagName.toLowerCase();
+ if (typeof successful == 'undefined') successful = true;
+
+ if (successful && (!n || el.disabled || t == 'reset' || t == 'button' ||
+ (t == 'checkbox' || t == 'radio') && !el.checked ||
+ (t == 'submit' || t == 'image') && el.form && el.form.clk != el ||
+ tag == 'select' && el.selectedIndex == -1))
+ return null;
+
+ if (tag == 'select') {
+ var index = el.selectedIndex;
+ if (index < 0) return null;
+ var a = [], ops = el.options;
+ var one = (t == 'select-one');
+ var max = (one ? index+1 : ops.length);
+ for(var i=(one ? index : 0); i < max; i++) {
+ var op = ops[i];
+ if (op.selected) {
+ // extra pain for IE...
+ var v = $.browser.msie && !(op.attributes['value'].specified) ? op.text : op.value;
+ if (one) return v;
+ a.push(v);
+ }
+ }
+ return a;
+ }
+ return el.value;
+};
+
+})(jQuery);
diff --git a/sites/all/modules/hierarchical_select/images/arrow-rtl.png b/sites/all/modules/hierarchical_select/images/arrow-rtl.png
new file mode 100644
index 0000000..2908c38
Binary files /dev/null and b/sites/all/modules/hierarchical_select/images/arrow-rtl.png differ
diff --git a/sites/all/modules/hierarchical_select/images/arrow.png b/sites/all/modules/hierarchical_select/images/arrow.png
new file mode 100644
index 0000000..cb901e2
Binary files /dev/null and b/sites/all/modules/hierarchical_select/images/arrow.png differ
diff --git a/sites/all/modules/hierarchical_select/images/grippie.png b/sites/all/modules/hierarchical_select/images/grippie.png
new file mode 100644
index 0000000..6524d41
Binary files /dev/null and b/sites/all/modules/hierarchical_select/images/grippie.png differ
diff --git a/sites/all/modules/hierarchical_select/includes/common.inc b/sites/all/modules/hierarchical_select/includes/common.inc
new file mode 100644
index 0000000..151873f
--- /dev/null
+++ b/sites/all/modules/hierarchical_select/includes/common.inc
@@ -0,0 +1,441 @@
+ $strings['item'],
+ '!items' => $strings['items'],
+ '!entity' => $strings['entity'],
+ '!entities' => $strings['entities'],
+ '!hierarchy' => $strings['hierarchy'],
+ '!hierarchies' => $strings['hierarchies']
+ );
+
+ $form = array(
+ '#tree' => TRUE,
+ '#type' => 'fieldset',
+ '#title' => t('Hierarchical Select configuration'),
+ '#attributes' => array(
+ 'class' => array('hierarchical-select-config-form'),
+ 'id' => 'hierarchical-select-config-form-' . $config_id,
+ ),
+ '#attached' => array(
+ 'css' => array(
+ drupal_get_path('module', 'hierarchical_select') . '/includes/common_config_form.css'
+ ),
+ 'js' => array(
+ array(
+ 'type' => 'file',
+ 'data' => drupal_get_path('module', 'hierarchical_select') . '/includes/common_config_form.js',
+ ),
+ array(
+ 'type' => 'setting',
+ 'data' => array('HierarchicalSelect' => array('configForm' => array($config_id))),
+ ),
+ ),
+ )
+ );
+
+ $form['config_id'] = array('#type' => 'value', '#value' => $config_id);
+
+ // TODO: really make this a *live* preview, i.e. refresh the preview on each
+ // change in the form. This cannot be done easily in Drupal 5 or 6, so let's
+ // do so in Drupal 7. See cfg.livePreview in common_config_form.js.
+ $form['live_preview'] = array(
+ '#type' => 'fieldset',
+ '#title' => t('Preview'),
+ '#description' => t('This is what the Hierarchical Select will look like with your current configuration.'),
+ '#collapsible' => FALSE,
+ '#attributes' => array('class' => array('live-preview')),
+ );
+ $form['live_preview']['example'] = array(
+ '#type' => 'hierarchical_select',
+ '#required' => $preview_is_required,
+ '#title' => t('Preview'),
+ '#description' => t('The description.'),
+ // Skip al validation for this form element: the data collected through it
+ // is always discarded, it's merely here for illustrative purposes.
+ '#validated' => TRUE,
+ );
+ hierarchical_select_common_config_apply($form['live_preview']['example'], $config_id, array_merge($defaults_override, array('module' => $module, 'params' => $params)));
+
+ $form['save_lineage'] = array(
+ '#type' => 'radios',
+ '#title' => t('Save lineage'),
+ '#options' => array(
+ 1 => t('Save !item lineage', $args),
+ 0 => t('Save only the deepest !item', $args),
+ ),
+ '#default_value' => (isset($config['save_lineage'])) ? $config['save_lineage'] : NULL,
+ '#description' => t(
+ 'Saving the !item lineage means saving the the !item itself and all
+ its ancestors .',
+ $args
+ ),
+ );
+
+ $form['enforce_deepest'] = array(
+ '#type' => 'radios',
+ '#title' => t('Level choice'),
+ '#options' => array(
+ 1 => t('Force the user to choose a !item from a deepest level ', $args),
+ 0 => t('Allow the user to choose a !item from any level ', $args),
+ ),
+ '#default_value' => (isset($config['enforce_deepest'])) ? $config['enforce_deepest'] : NULL,
+ '#description' => t(
+ 'This setting determines from which level in the !hierarchy tree a
+ user can select a !item.',
+ $args
+ ),
+ '#attributes' => array('class' => array('enforce-deepest')),
+ );
+
+ $form['resizable'] = array(
+ '#type' => 'radios',
+ '#title' => t('Resizable'),
+ '#description' => t(
+ "When enabled, a handle appears below the Hierarchical Select to allow
+ the user to dynamically resize it. Double clicking will toggle between
+ the smallest and a sane 'big size'."
+ ),
+ '#options' => array(
+ 0 => t('Disabled'),
+ 1 => t('Enabled'),
+ ),
+ '#default_value' => (isset($config['resizable'])) ? $config['resizable'] : NULL,
+ '#attributes' => array('class' => array('resizable')),
+ );
+
+ $form['level_labels'] = array(
+ '#tree' => TRUE,
+ '#type' => 'fieldset',
+ '#title' => t('Level labels'),
+ '#description' => t(
+ 'When the user is allowed to choose a !item from any level in the
+ Level choice setting, you can enter a label for each
+ level.root
+ level.',
+ $args
+ ),
+ '#collapsible' => TRUE,
+ );
+ $form['level_labels']['status'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Enable level labels'),
+ '#default_value' => (isset($config['level_labels']['status'])) ? $config['level_labels']['status'] : NULL,
+ '#attributes' => array('class' => array('level-labels-status')),
+ );
+ for ($depth = 0; $depth <= $max_hierarchy_depth; $depth++) {
+ $form['level_labels']['labels'][$depth] = array(
+ '#type' => 'textfield',
+ '#size' => 20,
+ '#maxlength' => 255,
+ '#default_value' => (isset($config['level_labels']['labels'][$depth])) ? $config['level_labels']['labels'][$depth] : NULL,
+ '#attributes' => array('class' => array('level-label')),
+ );
+ }
+ $form['level_labels']['#theme'] = 'hierarchical_select_common_config_form_level_labels';
+ $form['level_labels']['#strings'] = $strings;
+
+ $form['dropbox'] = array(
+ '#type' => 'fieldset',
+ '#title' => t('Dropbox settings'),
+ '#description' => t('The dropbox allows the user to make multiple selections .'),
+ '#collapsible' => TRUE,
+ );
+ $form['dropbox']['status'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Enable the dropbox'),
+ '#default_value' => (isset($config['dropbox']['status'])) ? $config['dropbox']['status'] : NULL,
+ '#attributes' => array('class' => array('dropbox-status')),
+ );
+ $form['dropbox']['title'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Title'),
+ '#description' => t('The title you enter here appears above the dropbox.'),
+ '#size' => 20,
+ '#maxlength' => 255,
+ '#default_value' => (isset($config['dropbox']['title'])) ? $config['dropbox']['title'] : NULL,
+ '#attributes' => array('class' => array('dropbox-title')),
+ );
+ $form['dropbox']['limit'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Limit the number of selections'),
+ '#description' => t(
+ 'Limits the number of selections that can be added to the dropbox.
+ 0 means no limit.
+ add new !items to this
+ !hierarchy through Hierarchical Select.',
+ $args
+ ),
+ '#collapsible' => TRUE,
+ );
+ $form['editability']['status'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Allow creation of new !items', $args),
+ '#options' => array(
+ 0 => t('Disabled'),
+ 1 => t('Enabled'),
+ ),
+ '#default_value' => (isset($config['editability']['status'])) ? $config['editability']['status'] : NULL,
+ '#attributes' => array('class' => array('editability-status')),
+ );
+ for ($depth = 0; $depth <= $max_hierarchy_depth; $depth++) {
+ $form['editability']['item_types'][$depth] = array(
+ '#type' => 'textfield',
+ '#size' => 20,
+ '#maxlength' => 255,
+ '#default_value' => (isset($config['editability']['item_types'][$depth])) ? $config['editability']['item_types'][$depth] : NULL,
+ '#attributes' => array('class' => array('editability-item-type')),
+ );
+ }
+ for ($depth = 0; $depth <= $max_hierarchy_depth; $depth++) {
+ $form['editability']['allowed_levels'][$depth] = array(
+ '#type' => 'checkbox',
+ '#default_value' => (isset($config['editability']['allowed_levels'][$depth])) ? $config['editability']['allowed_levels'][$depth] : 1,
+ );
+ }
+ $form['editability']['allow_new_levels'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Allow creation of new levels'),
+ '#default_value' => $config['editability']['allow_new_levels'],
+ '#description' => t(
+ 'Allow the user to create child !items for !items that do not yet have
+ children.',
+ $args
+ ),
+ '#attributes' => array('class' => array('editability-allow-new-levels')),
+ );
+ $form['editability']['max_levels'] = array(
+ '#type' => 'select',
+ '#title' => t('Maximum number of levels allowed'),
+ '#options' => array(
+ 0 => t('0 (no limit)'), 1, 2, 3, 4, 5, 6, 7, 8, 9
+ ),
+ '#default_value' => (isset($config['editability']['max_levels'])) ? $config['editability']['max_levels'] : NULL,
+ '#description' => t(
+ 'When the user is allowed to create new levels, this option prevents
+ the user from creating extremely deep !hierarchies.',
+ $args
+ ),
+ '#attributes' => array('class' => array('editability-max-levels')),
+ );
+
+ $form['editability']['#theme'] = 'hierarchical_select_common_config_form_editability';
+ $form['editability']['#strings'] = $strings;
+ }
+
+ if (module_hook($module, 'hierarchical_select_entity_count')) {
+ $form['entity_count'] = array(
+ '#type' => 'fieldset',
+ '#title' => t('Entity Count'),
+ '#collapsible' => TRUE,
+ );
+
+ $form['entity_count']['enabled'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Display number of entities'),
+ '#description' => t('Display the number of entities associated with the !item. Do not forget to check which entities should be counted.', $args),
+ '#default_value' => isset($config['entity_count']['enabled']) ? $config['entity_count']['enabled'] : FALSE,
+ '#weight' => -1,
+ '#attributes' => array('class' => array('entity-count-enabled')),
+ );
+
+ $form['entity_count']['require_entity'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Require associated entity'),
+ '#description' => t('If checked only !items that have at least one entity associated with them will be displayed.', $args),
+ '#default_value' => (isset($config['entity_count']['require_entity'])) ? $config['entity_count']['require_entity'] : FALSE,
+ );
+
+ $form['entity_count']['settings'] = array(
+ '#type' => 'fieldset',
+ '#title' => t('Entity count settings'),
+ '#collapsible' => TRUE,
+ '#collapsed' => FALSE,
+ '#weight' => -1,
+ '#attributes' => array('class' => array('entity-count-settings')),
+ );
+
+ $form['entity_count']['settings']['count_children'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Also count children of !item.', $args),
+ '#description' => t('If checked this will result in a larger number because the children will be counted also.'),
+ '#default_value' => isset($config['entity_count']['settings']['count_children']) ? $config['entity_count']['settings']['count_children'] : FALSE,
+ );
+
+ $form['entity_count']['settings']['entity_types'] = array(
+ '#type' => 'item',
+ '#title' => t('Select entities that should be counted.'),
+ '#description' => t('Select entity type or one of it\'s bundles that should be counted'),
+ );
+
+ $entity_info = entity_get_info();
+ foreach ($entity_info as $entity => $entity_info) {
+ if (!empty($entity_info['bundles']) && $entity_info['fieldable'] === TRUE) {
+ $options = array();
+ $default_values = array();
+
+ $form['entity_count']['settings']['entity_types'][$entity] = array(
+ '#type' => 'fieldset',
+ '#title' => check_plain($entity_info['label']),
+ '#collapsible' => TRUE,
+ '#collapsed' => TRUE,
+ );
+
+ foreach ($entity_info['bundles'] as $bundle => $bundle_info) {
+ $options[$bundle] = check_plain($bundle_info['label']);
+ $default_values[$entity][$bundle] = isset($config['entity_count']['settings']['entity_types'][$entity]['count_' . $entity][$bundle]) ? $config['entity_count']['settings']['entity_types'][$entity]['count_' . $entity][$bundle] : 0;
+ }
+
+ $form['entity_count']['settings']['entity_types'][$entity]['count_' . $entity] = array(
+ '#type' => 'checkboxes',
+ '#options' => $options,
+ '#default_value' => $default_values[$entity],
+ );
+ }
+ }
+ }
+
+ return $form;
+}
+
+/**
+ * Submit callback for the hierarchical_select_common_config_form form.
+ */
+function hierarchical_select_common_config_form_submit($form, &$form_state) {
+ $config = _hierarchical_select_get_form_item_by_parents($form_state['values'], $form['#hs_common_config_form_parents']);
+
+ // Don't include the value of the live preview in the config.
+ unset($config['live_preview']);
+
+ hierarchical_select_common_config_set($config['config_id'], $config);
+}
+
+/**
+ * Get the form element of a form that has a certain lineage of parents.
+ *
+ * @param $form
+ * A structured array for use in the Forms API.
+ * @param $parents
+ * An array of parent form element names.
+ * @return
+ * The form element that has the specified lineage of parents.
+ */
+function _hierarchical_select_get_form_item_by_parents($form, $parents) {
+ if (count($parents)) {
+ $parent = array_shift($parents);
+ return _hierarchical_select_get_form_item_by_parents($form[$parent], $parents);
+ }
+ else {
+ return $form;
+ }
+}
diff --git a/sites/all/modules/hierarchical_select/includes/common_config_form.css b/sites/all/modules/hierarchical_select/includes/common_config_form.css
new file mode 100644
index 0000000..d72c277
--- /dev/null
+++ b/sites/all/modules/hierarchical_select/includes/common_config_form.css
@@ -0,0 +1,11 @@
+
+.hierarchical-select-config-form .live-preview {
+ margin-left: auto;
+ margin-right: auto;
+ width: 25em;
+ float: right;
+}
+
+.hierarchical-select-config-form fieldset {
+ clear: right;
+}
diff --git a/sites/all/modules/hierarchical_select/includes/common_config_form.js b/sites/all/modules/hierarchical_select/includes/common_config_form.js
new file mode 100644
index 0000000..36233a6
--- /dev/null
+++ b/sites/all/modules/hierarchical_select/includes/common_config_form.js
@@ -0,0 +1,148 @@
+
+Drupal.HierarchicalSelectConfigForm = {};
+
+(function ($, cfg) {
+
+cfg.context = function(configId) {
+ if (configId === undefined) {
+ return $('.hierarchical-select-config-form > *').not('.live-preview');
+ }
+ else {
+ return $('#hierarchical-select-config-form-'+ configId + ' > *').not('.live-preview');
+ }
+};
+
+cfg.levelLabels = function(configId) {
+ var $status = $('.level-labels-status', cfg.context(configId));
+ var $enforceDeepest = $('.enforce-deepest input', cfg.context(configId));
+
+ var showHide = function(speed) {
+ $affected = $('.level-labels-settings', cfg.context(configId));
+ if (!$status.is(':checked')) {
+ $affected.hide(speed);
+ }
+ else {
+ // For showing/hiding rows, I'm relying on setting the style
+ // "display: none" and removing it again. jQuery's show()/hide() leave
+ // "display: block" behind and are thereby messing up the table layout.
+ if ($enforceDeepest.slice(1, 2).is(':checked')) {
+ $affected.find('tr').removeAttr('style');
+ }
+ else {
+ // We need to take special measures if sticky headers are enabled, so
+ // handle the show/hide separately when it's enabled.
+ if ($affected.find('table.sticky-header').length == 0) {
+ $affected.find('tr').slice(0, 2).removeAttr('style'); // Show header tr and root level tr.
+ $affected.find('tr').slice(2).attr('style', 'display: none'); // Hide all other tr's.
+ }
+ else {
+ $affected.find('table').show(speed); // Show both tables (the one with the sticky headers and the one with the actual content).
+ $affected.find('table').slice(1).find('tr').slice(2).attr('style', 'display: none'); // Show all tr's after the header tr and root level tr of the 2nd table (the one with the actual content).
+ }
+ }
+
+ // If $status was unchecked previously, the entire div would have been
+ // hidden!
+ if ($affected.css('display') == 'none') {
+ $affected.show(speed);
+ }
+ }
+ };
+
+ $status.click(function() { showHide(200); });
+ $enforceDeepest.click(function() { showHide(200); });
+ showHide(0);
+};
+
+cfg.dropbox = function(configId) {
+ var $status = $('.dropbox-status', cfg.context(configId));
+
+ var showHide = function(speed) {
+ var $affected = $('.dropbox-title, .dropbox-limit, .dropbox-reset-hs', cfg.context(configId)).parent();
+ if ($status.is(':checked')) {
+ $affected.show(speed);
+ }
+ else {
+ $affected.hide(speed);
+ }
+ };
+
+ $status.click(function() { showHide(200); });
+ showHide(0);
+};
+
+cfg.editability = function(configId) {
+ var $status = $('.editability-status', cfg.context(configId));
+ var $allowNewLevels = $('.editability-allow-new-levels', cfg.context(configId));
+
+ var showHide = function(speed) {
+ var $affected = $('.editability-per-level-settings, .form-item:has(.editability-allow-new-levels)', cfg.context(configId));
+ var $maxLevels = $('.form-item:has(.editability-max-levels)', cfg.context(configId));
+ if ($status.is(':checked')) {
+ if ($allowNewLevels.is(':checked')) {
+ $affected.add($maxLevels).show(speed);
+ }
+ else {
+ $affected.show(speed);
+ }
+ }
+ else {
+ $affected.add($maxLevels).hide(speed);
+ }
+ };
+
+ var showHideMaxLevels = function(speed) {
+ $affected = $('.editability-max-levels', cfg.context(configId)).parent();
+ if ($allowNewLevels.is(':checked')) {
+ $affected.show(speed);
+ }
+ else {
+ $affected.hide(speed);
+ }
+ };
+
+ $status.click(function() { showHide(200); });
+ $allowNewLevels.click(function() { showHideMaxLevels(200); });
+ showHideMaxLevels(0);
+ showHide(0);
+};
+
+cfg.entityCount = function(configId) {
+ var $status = $('.entity-count-enabled', cfg.context(configId));
+
+ var showHide = function(speed) {
+ var $affected = $('.entity-count-settings', cfg.context(configId));
+ if ($status.is(':checked')) {
+ $affected.show(speed);
+ }
+ else {
+ $affected.hide(speed);
+ }
+ };
+
+ $status.click(function() { showHide(200); });
+ showHide(0);
+};
+
+cfg.livePreview = function(configId) {
+ // React on changes to any input, except the ones in the live preview.
+ $updateLivePreview = $('input', cfg.context(configId))
+ .filter(':not(.create-new-item-input):not(.create-new-item-create):not(.create-new-item-cancel)')
+ .change(function() {
+ // TODO: Do an AJAX submit of the entire form.
+ });
+};
+
+$(document).ready(function() {
+ for (var id in Drupal.settings.HierarchicalSelect.configForm) {
+ var configId = Drupal.settings.HierarchicalSelect.configForm.id;
+
+ cfg.levelLabels(configId);
+ cfg.dropbox(configId);
+ cfg.editability(configId);
+ cfg.entityCount(configId);
+ //cfg.livePreview(configId);
+ }
+});
+
+})(jQuery, Drupal.HierarchicalSelectConfigForm);
diff --git a/sites/all/modules/hierarchical_select/includes/theme.inc b/sites/all/modules/hierarchical_select/includes/theme.inc
new file mode 100644
index 0000000..7c37667
--- /dev/null
+++ b/sites/all/modules/hierarchical_select/includes/theme.inc
@@ -0,0 +1,413 @@
+\n";
+ $required = !empty($element['#required']) ? '* ' : '';
+
+ if (!empty($element['#title'])) {
+ $title = $element['#title'];
+ if (!empty($element['#id'])) {
+ $output .= ' ' . t('!title: !required', array('!title' => filter_xss_admin($title), '!required' => $required)) . " \n";
+ }
+ else {
+ $output .= ' ' . t('!title: !required', array('!title' => filter_xss_admin($title), '!required' => $required)) . " \n";
+ }
+ }
+
+ $output .= " $value\n";
+
+ if (!empty($element['#description'])) {
+ $output .= ' ' . $element['#description'] . "
\n";
+ }
+
+ $output .= "\n";
+
+ return $output;
+}
+
+/**
+ * Format a hierarchical select.
+ *
+ * @param array $variables
+ * An associative array containing the properties of the element.
+ * @return string
+ * A themed HTML string representing the form element.
+ */
+function theme_hierarchical_select($variables) {
+ $element = $variables['element'];
+ $output = '';
+
+ // Update $element['#attributes']['class'].
+ if (!isset($element['#attributes']['class'])) {
+ $element['#attributes']['class'] = array();
+ }
+ $hsid = $element['hsid']['#value'];
+ $level_labels_style = variable_get('hierarchical_select_level_labels_style', 'none');
+ $classes = array(
+ 'hierarchical-select-wrapper',
+ "hierarchical-select-level-labels-style-$level_labels_style",
+ // Classes that make it possible to override the styling of specific
+ // instances of Hierarchical Select, based on either the ID of the form
+ // element or the config that it uses.
+ 'hierarchical-select-wrapper-for-name-' . $element['#id'],
+ (isset($element['#config']['config_id'])) ? 'hierarchical-select-wrapper-for-config-' . $element['#config']['config_id'] : NULL,
+ );
+ $element['#attributes']['class'] = array_merge($element['#attributes']['class'], $classes);
+ $element['#attributes']['id'] = "hierarchical-select-$hsid-wrapper";
+ $element['#id'] = "hierarchical-select-$hsid-wrapper"; // This ensures the label's for attribute is correct.
+
+ return '' . drupal_render_children($element) . '
';
+}
+
+/**
+ * Format the container for all selects in the hierarchical select.
+ *
+ * @param array $variables
+ * An associative array containing the properties of the element.
+ * @return string
+ * A themed HTML string representing the form element.
+ */
+function theme_hierarchical_select_selects_container($variables) {
+ $element = $variables['element'];
+ $output = '';
+ $output .= '';
+ $output .= drupal_render_children($element);
+ $output .= '
';
+ return $output;
+}
+
+/**
+ * Format a select in the .hierarchial-select div: prevent it from being
+ * wrapped in a div. This simplifies the CSS and JS code.
+ *
+ * @param array $variables
+ * An associative array containing the properties of the element.
+ * @return string
+ * A themed HTML string representing the form element.
+ */
+function theme_hierarchical_select_select($variables) {
+ $element = $variables['element'];
+ element_set_attributes($element, array('id', 'name', 'size'));
+ _form_set_class($element, array('form-select'));
+
+ return '' . _hierarchical_select_options($element) . ' ';
+}
+
+/**
+ * Format an item separator (for use in a lineage).
+ */
+function theme_hierarchical_select_item_separator($variables) {
+ $output = '';
+ $output .= '';
+ if (isset($form['labels']) && count(element_children($form['labels']))) {
+ foreach (element_children($form['labels']) as $depth) {
+ $row = array();
+ $row[]['data'] = ($depth == 0) ? t('Root level') : t('Sublevel !depth', array('!depth' => $depth));
+ $row[]['data'] = drupal_render($form['labels'][$depth]);
+ $rows[] = $row;
+ }
+
+ // Render the table.
+ $output .= theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array('style' => 'width: auto;')));
+ }
+ else {
+ // No levels exist yet in the hierarchy!
+ $output .= '
';
+ $output .= t('There are no levels yet in this !hierarchy!', array('!hierarchy' => $strings['hierarchy']));
+ $output .= '
';
+ }
+ $output .= '
';
+ if (isset($form['item_types']) && count(element_children($form['item_types']))) {
+ foreach (element_children($form['item_types']) as $depth) {
+ $row = array();
+ $row[]['data'] = ($depth == 0) ? t('Root level') : t('Sublevel !depth', array('!depth' => $depth));
+ $row[]['data'] = drupal_render($form['allowed_levels'][$depth]);
+ $row[]['data'] = drupal_render($form['item_types'][$depth]);
+ $rows[] = $row;
+ }
+
+ // Render the table and description.
+ $output .= theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array('style' => 'width: auto;'), 'caption' => '
' . t('Per-level settings for creating new !items.', array('!items' => $strings['items']))));
+ $output .= '';
+ $output .= t(
+ 'The %item_type you enter for each level is what will be used in
+ each level to replace a "<create new item>" option with a
+ "<create new %item_type>" option, which is often more
+ intuitive.',
+ array(
+ '%item_type' => $strings['item_type'],
+ )
+ );
+ $output .= '
';
+ }
+ else {
+ // No levels exist yet in the hierarchy!
+ $output .= '';
+ $output .= t('There are no levels yet in this !hierarchy!', array('!hierarchy' => $strings['hierarchy']));
+ $output .= '
';
+ }
+ $output .= '