You are here

Home » API reference » Simple hierarchical select 7 » shs_handler_filter_term_node_tid.inc

class shs_handler_filter_term_node_tid in Simple hierarchical select 7

Filter by term id (including selection by simple hierarchical select).

Hierarchy

Expanded class hierarchy of shs_handler_filter_term_node_tid

1 string reference to 'shs_handler_filter_term_node_tid'
shs_field_views_data_alter in ./shs.module
Implements hook_field_views_data_alter().

File

includes/handlers/shs_handler_filter_term_node_tid.inc, line 13
Definition of shs_handler_filter_term_node_tid.

View source 
class shs_handler_filter_term_node_tid extends views_handler_filter_term_node_tid {

  /**
   * {@inheritdoc}
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['type'] = array(
      'default' => 'shs',
    );
    $options['use_chosen'] = array(
      'default' => 'never',
    );
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function extra_options_form(&$form, &$form_state) {
    parent::extra_options_form($form, $form_state);
    $form['type']['#options'] += array(
      'shs' => t('Simple hierarchical select'),
    );
    if (module_exists('chosen')) {
      $form['use_chosen'] = array(
        '#type' => 'select',
        '#title' => t('Output this field with !chosen', array(
          '!chosen' => l(t('Chosen'), 'http://drupal.org/project/chosen'),
        )),
        '#description' => t('Select in which cases the element will use the !chosen module for the term selection of each level.', array(
          '!chosen' => l(t('Chosen'), 'http://drupal.org/project/chosen'),
        )),
        '#default_value' => empty($this->options['use_chosen']) ? 'never' : $this->options['use_chosen'],
        '#dependency' => array(
          'radio:options[type]' => array(
            'shs',
          ),
        ),
        '#options' => array(
          'chosen' => t('let chosen decide'),
          'always' => t('always'),
          'never' => t('never'),
        ),
      );
    }
  }

  /**
   * {@inheritdoc}
   */
  public function value_form(&$form, &$form_state) {
    global $language;
    parent::value_form($form, $form_state);
    $multiple = $this->options['expose']['multiple'];
    $vocabulary = taxonomy_vocabulary_machine_name_load($this->options['vocabulary']);
    if (empty($vocabulary) && $this->options['limit']) {
      $form['markup'] = array(
        '#markup' => '<div class="form-item">' . t('An invalid vocabulary is selected. Please change it in the options.') . '</div>',
      );
      return;
    }
    if ($this->options['type'] == 'shs' && $this->options['exposed']) {
      $identifier = $this->options['expose']['identifier'];

      // Get parents of selected term.
      $default_value = empty($this->value) ? 0 : $this->value;
      if (!empty($form_state['input'][$identifier])) {
        $input_value = $form_state['input'][$identifier];
        $default_value = is_array($form_state['input'][$identifier]) ? check_plain(reset($form_state['input'][$identifier])) : check_plain($form_state['input'][$identifier]);
        if ($multiple && !is_array($default_value)) {
          $default_value = array(
            $default_value,
          );
        }
      }
      $parents = array();
      if (!empty($default_value) && $default_value != 'All') {
        if (is_array($default_value) && $default_value[0] != 'All') {
          if (strpos($default_value[0], ',') !== FALSE || strpos($default_value[0], '+') !== FALSE) {
            $values = array();
            foreach ($default_value as $default) {
              $values += preg_split('/[,\\+]+/', $default, -1, PREG_SPLIT_NO_EMPTY);
            }
            $form_state['input'][$identifier] = empty($values) ? 'All' : $values;
            $default_value = $values;
          }
          $parents_multiple = array();
          foreach ($default_value as $tid) {
            $parents_multiple[] = $tid;
          }
          $parents[] = array(
            'tid' => $parents_multiple,
          );
        }
        elseif (is_string($default_value)) {
          $term_parents = taxonomy_get_parents_all($default_value);

          // Remove selected term from list.
          array_shift($term_parents);
          foreach (array_reverse($term_parents) as $term) {
            $parents[] = array(
              'tid' => $term->tid,
            );
          }

          // Add current term (name not needed).
          $parents[] = array(
            'tid' => $default_value,
          );
        }
      }

      // Add fake item for next level.
      $parents[] = array(
        'tid' => 0,
      );
      $element_settings = array(
        'create_new_terms' => FALSE,
        'create_new_levels' => FALSE,
        'required' => FALSE,
        'language' => $language,
      );
      if (module_exists('chosen') && !empty($this->options['use_chosen'])) {
        $element_settings['use_chosen'] = $this->options['use_chosen'];
      }
      if (!empty($this->options['exposed']) && !empty($this->options['expose']['required'])) {
        $element_settings['required'] = TRUE;
      }

      // Allowing other modules to add settings for shs.
      if (!empty($this->options['expose']['shs'])) {
        $element_settings = array_merge($element_settings, $this->options['expose']['shs']);
      }

      // Generate a random hash to avoid merging of settings by drupal_add_js.
      // This is necessary until http://drupal.org/node/208611 lands for D7.
      $js_hash = _shs_create_hash();

      // Create settings needed for our js magic.
      $settings_js = array(
        'shs' => array(
          $identifier . ($multiple ? '[]' : '') => array(
            $js_hash => array(
              'vid' => $vocabulary->vid,
              'settings' => $element_settings,
              'default_value' => $default_value,
              'parents' => $parents,
              'multiple' => $multiple,
              'any_label' => variable_get('views_exposed_filter_any_label', 'new_any') == 'old_any' ? t('<Any>') : t('- Any -'),
              'any_value' => 'All',
            ),
          ),
        ),
      );
      drupal_alter(array(
        'shs_js_settings',
        "shs_{$identifier}_js_settings",
      ), $settings_js, $identifier, $vocabulary->vid);

      // Add settings.
      drupal_add_js($settings_js, 'setting');

      // Add behavior.
      drupal_add_js(drupal_get_path('module', 'shs') . '/js/shs.js');

      // Rewrite default select element.
      $form['value'] += array(
        '#attributes' => array(
          'class' => array(
            'element-invisible',
            'shs-enabled',
          ),
        ),
      );
    }
    if (empty($form_state['exposed'])) {

      // Retain the helper option.
      $this->helper
        ->options_form($form, $form_state);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function admin_summary() {

    // Set up $this->value_options for the parent summary.
    $this->value_options = array();
    if ($this->value == 'All') {
      $this->value = NULL;
    }
    return parent::admin_summary();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
shs_handler_filter_term_node_tid::admin_summary public function Display the filter on the administrative summary. Overrides views_handler_filter_term_node_tid::admin_summary
shs_handler_filter_term_node_tid::extra_options_form public function Provide a form for setting options. Overrides views_handler_filter_term_node_tid::extra_options_form 1
shs_handler_filter_term_node_tid::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_handler_filter_term_node_tid::option_definition 1
shs_handler_filter_term_node_tid::value_form public function Options form subform for setting options. Overrides views_handler_filter_term_node_tid::value_form
views_handler::$handler_type public property The type of the handler, for example filter/footer/field.
views_handler::$query public property Where the $query object will reside:. 1
views_handler::$real_field public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
views_handler::$relationship public property The relationship used for this field.
views_handler::$table_alias public property The alias of the table of this handler which is used in the query.
views_handler::$view public property The top object of a view. Overrides views_object::$view
views_handler::access public function Check whether current user has access to this handler. 10
views_handler::broken public function Determine if the handler is considered 'broken'. 6
views_handler::case_transform public function Transform a string by a certain method.
views_handler::exposed_submit public function Submit the exposed handler form.
views_handler::expose_submit public function Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
views_handler::extra_options public function Provide defaults for the handler.
views_handler::extra_options_submit public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
views_handler::extra_options_validate public function Validate the options form.
views_handler::get_field public function Shortcut to get a handler's raw field value.
views_handler::get_join public function Get the join object that should be used for this handler.
views_handler::groupby_form public function Provide a form for aggregation settings. 1
views_handler::groupby_form_submit public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. 1
views_handler::is_exposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::needs_style_plugin public function Determine if the argument needs a style plugin. 1
views_handler::placeholder public function Provides a unique placeholders for handlers.
views_handler::post_execute public function Run after the view is executed, before the result is cached. 1
views_handler::pre_query public function Run before the view is built. 1
views_handler::sanitize_value public function Sanitize the value for output.
views_handler::set_relationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_form public function Shortcut to display the exposed options form.
views_handler::ui_name public function Return a string representing this handler's name in the UI. 9
views_handler::use_group_by public function Provides the handler some groupby. 2
views_handler_filter::$always_multiple public property Disable the possibility to force a single value. 6
views_handler_filter::$always_required public property Disable the possibility to allow a exposed input to be optional.
views_handler_filter::$group_info public property Contains the information of the selected item in a gruped filter.
views_handler_filter::$no_operator public property Disable the possibility to use operators. 2
views_handler_filter::$operator public property Contains the operator which is used on the query.
views_handler_filter::$value public property Contains the actual value of the field.
views_handler_filter::build_group_form public function Build the form to let users create the group of exposed filters.
views_handler_filter::build_group_options public function Provide default options for exposed filters.
views_handler_filter::build_group_submit public function Save new group items, re-enumerates and remove groups marked to delete.
views_handler_filter::build_group_validate public function Validate the build group options form. 1
views_handler_filter::can_build_group public function Determine if a filter can be converted into a group.
views_handler_filter::can_expose public function Determine if a filter can be exposed. Overrides views_handler::can_expose 5
views_handler_filter::can_group public function Can this filter be used in OR groups? 1
views_handler_filter::convert_exposed_input public function Transform the input from a grouped filter into a standard filter.
views_handler_filter::exposed_form public function Render our chunk of the exposed filter form when selecting. Overrides views_handler::exposed_form
views_handler_filter::exposed_info public function Tell the renderer about our exposed form. Overrides views_handler::exposed_info
views_handler_filter::exposed_translate public function Make some translations to a form item to make it more suitable to exposing.
views_handler_filter::expose_validate public function Validate the options form. Overrides views_handler::expose_validate
views_handler_filter::group_form public function Build a form with a group of operator | values to apply as a single filter.
views_handler_filter::group_multiple_exposed_input public function Options available for a grouped filter which uses checkboxes.
views_handler_filter::is_a_group public function Returns TRUE if the exposed filter works like a grouped filter. Overrides views_handler::is_a_group
views_handler_filter::multiple_exposed_input public function Indicate whether users can select multiple group items. Overrides views_handler::multiple_exposed_input
views_handler_filter::operator_form public function Options form subform for setting the operator. 6
views_handler_filter::operator_submit public function Perform any necessary changes to the form values prior to storage.
views_handler_filter::operator_validate public function Validate the operator form.
views_handler_filter::options_form public function Provide the basic form which calls through to subforms. Overrides views_handler::options_form 4
views_handler_filter::options_submit public function Simple submit handler. Overrides views_handler::options_submit
views_handler_filter::options_validate public function Simple validate handler. Overrides views_handler::options_validate 1
views_handler_filter::prepare_filter_select_options public function Sanitizes the HTML select element's options.
views_handler_filter::show_build_group_button public function Shortcut to display the build_group/hide button.
views_handler_filter::show_build_group_form public function Shortcut to display the exposed options form.
views_handler_filter::show_expose_button public function Shortcut to display the expose/hide button. Overrides views_handler::show_expose_button
views_handler_filter::show_operator_form public function Shortcut to display the operator form.
views_handler_filter::show_value_form public function Shortcut to display the value form.
views_handler_filter::store_exposed_input public function Store the exposed input for processing later. Overrides views_handler::store_exposed_input
views_handler_filter::store_group_input public function If set to remember exposed input in the session, store it there.
views_handler_filter_in_operator::$value_options public property Stores all operations which are available on the form.
views_handler_filter_in_operator::construct public function Views handlers use a special construct function. Overrides views_object::construct
views_handler_filter_in_operator::expose_options public function Provide default options for exposed filters. Overrides views_handler_filter::expose_options
views_handler_filter_in_operator::operator_options public function Build strings from the operators() for 'select' options. Overrides views_handler_filter::operator_options 2
views_handler_filter_in_operator::operator_values public function
views_handler_filter_in_operator::op_empty public function
views_handler_filter_in_operator::op_simple public function
views_handler_filter_in_operator::query public function Add this filter to the query. Overrides views_handler_filter::query 5
views_handler_filter_in_operator::reduce_value_options public function When using exposed filters, we may be required to reduce the set.
views_handler_filter_in_operator::validate public function Validates the handler against the complete View. Overrides views_handler::validate
views_handler_filter_many_to_one::$helper public property Stores the Helper object which handles the many_to_one complexity.
views_handler_filter_many_to_one::$value_form_type public property Overrides views_handler_filter_in_operator::$value_form_type
views_handler_filter_many_to_one::ensure_my_table public function Override ensure_my_table so we can control how this joins in. The operator actually has influence over joining. Overrides views_handler::ensure_my_table
views_handler_filter_many_to_one::operators public function This kind of construct makes it relatively easy for a child class to add or remove functionality by overriding this function and adding/removing items from this array. Overrides views_handler_filter_in_operator::operators 1
views_handler_filter_many_to_one::op_helper public function
views_handler_filter_term_node_tid::$validated_exposed_input public property Stores the exposed input for this filter.
views_handler_filter_term_node_tid::accept_exposed_input public function Check to see if input from the exposed filters should change the behavior. Overrides views_handler_filter_in_operator::accept_exposed_input
views_handler_filter_term_node_tid::exposed_validate public function Validate the exposed handler form. Overrides views_handler::exposed_validate
views_handler_filter_term_node_tid::expose_form public function Options form subform for exposed filter options. Overrides views_handler_filter_in_operator::expose_form
views_handler_filter_term_node_tid::get_value_options public function Child classes should be used to override this function and set the 'value options', unless 'options callback' is defined as a valid function or static public method to generate these values. Overrides views_handler_filter_in_operator::get_value_options
views_handler_filter_term_node_tid::has_extra_options public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. Overrides views_handler::has_extra_options
views_handler_filter_term_node_tid::init public function Provide some extra help to get the operator/value easier to use. Overrides views_handler_filter_many_to_one::init
views_handler_filter_term_node_tid::validate_term_strings public function Validate the user string. Since this can come from either the form or the exposed filter, this is abstracted out a bit so it can handle the multiple input sources.
views_handler_filter_term_node_tid::value_submit public function Perform any necessary changes to the form values prior to storage. Overrides views_handler_filter_in_operator::value_submit
views_handler_filter_term_node_tid::value_validate public function Validate the options form. Overrides views_handler_filter::value_validate
views_object::$definition public property Handler's definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition function Collect this handler's option definition and alter them, ready for use.
views_object::destroy public function Destructor. 2
views_object::export_option public function 1
views_object::export_options public function
views_object::export_option_always public function Always exports the option, regardless of the default value.
views_object::options Deprecated public function Set default options on this object. 1
views_object::set_default_options public function Set default options.
views_object::set_definition public function Let the handler know what its full definition is.
views_object::unpack_options public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable public function Unpack a single option definition.
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults public function