You are here

Home » API reference » Select with Style 7 » select_with_style_handler_filter_term_node_tid.inc

class select_with_style_handler_filter_term_node_tid in Select with Style 7

@file select_with_style_handle_filter_term_node_tid.inc

Views filter override to style exposed term filters. Also covers the case where exposed filter forms are in blocks.

Hierarchy

Expanded class hierarchy of select_with_style_handler_filter_term_node_tid

1 string reference to 'select_with_style_handler_filter_term_node_tid'
select_with_style_views_data_alter in select_with_style/views/select_with_style.views.inc
Implements hook_views_data_alter().

File

select_with_style/views/select_with_style_handler_filter_term_node_tid.inc, line 11
select_with_style_handle_filter_term_node_tid.inc

View source 
class select_with_style_handler_filter_term_node_tid extends views_handler_filter_term_node_tid {
  function value_form(&$form, &$form_state) {
    if (empty($this->options['expose']['identifier'])) {
      parent::value_form($form, $form_state);
      return;
    }
    $field_name = $name = $this->options['expose']['identifier'];

    // See if the filter name has '_tid' or '_tid_N' appended. If it does, chop
    // it to find the associated field name.
    if ($_tid = strrpos($name, '_tid')) {
      $field_name = drupal_substr($name, 0, $_tid);
    }
    if ($field = field_info_field($field_name)) {

      // A field may be attached to multiple node types and users. Each will
      // return an instance. Not sure how to reliable identify the right
      // $instance and thus the widget settings.
      // The important thing is to retrieve the right terms (select options).
      // These depend on the $field only, not the $instance.
      foreach (select_with_style_get_field_instances($field_name) as $instance) {
        if ($instance['widget']['module'] == 'select_with_style') {
          break;
        }
        $instance = NULL;
      }
      if (empty($instance['widget']['settings']['select_with_style'])) {

        // This Views field does not have a Select with Style counterpart field
        // widget on the Manage Fields Edit form. Fall back on global defaults.
        $settings = array(
          'hierarchy_depth_prefix' => variable_get('select_with_style_def_hierarchy_depth_prefix'),
          'term_transform_callback' => variable_get('select_with_style_def_term_transform_callback'),
          'multi_select_height' => variable_get('select_with_style_def_multi_select_height'),
          'css file' => variable_get('select_with_style_def_css_files', array()),
        );
      }
      else {
        $settings = $instance['widget']['settings']['select_with_style'];
      }

      // Suppress hierarchy prefix if "Show hierarchy in dropdown" isn't ticked
      // on the filter's Settings panel.
      if (empty($this->options['hierarchy'])) {
        $settings['hierarchy_depth_prefix'] = NULL;
      }
      $widget_type = isset($instance['widget']['type']) ? $instance['widget']['type'] : 'select_tree';

      // Load options (w/wout hierarchy prefixes) and get attributes too.
      list($options, $option_attributes) = _select_with_style_options_and_attributes_lists($field, $widget_type, $settings);
    }
    if (empty($options)) {

      // If any of the above failed, then default to what Views does normally.
      parent::value_form($form, $form_state);
      return;
    }
    if (!empty($this->options['expose']['reduce'])) {
      $options = $this
        ->reduce_value_options($options);

      // For optgroups, remove parents that have no children ...
      foreach ($options as $parent => $children) {
        if (is_array($children) && empty($children)) {
          unset($options[$parent]);
        }
      }
    }
    if (!empty($settings['multi_select_height'])) {
      if ($field['cardinality'] > 1 || $field['cardinality'] == FIELD_CARDINALITY_UNLIMITED) {
        $form[$name]['#size'] = $settings['multi_select_height'];
      }
    }
    $max_size = empty($form[$name]['#size']) ? 9 : $form[$name]['#size'];
    $form[$name]['#size'] = min($max_size, $this
      ->count_entries($options));
    $form[$name]['#type'] = 'select';
    $form[$name]['#multiple'] = TRUE;
    $form[$name]['#options'] = $options;
    $form[$name]['#option_attributes'] = $option_attributes;

    // Add basic and optional CSS
    $form[$name]['#attached']['css'][] = drupal_get_path('module', 'select_with_style') . '/select_with_style.css';
    if (!empty($settings['css file'])) {
      if (!is_array($settings['css file'])) {
        $settings['css file'] = array(
          $settings['css file'],
        );
      }
      $css_files = select_with_style_css_files();
      foreach ($settings['css file'] as $css_file) {
        if (!empty($css_files[$css_file])) {
          $form[$name]['#attached']['css'][] = $css_files[$css_file];
        }
      }
    }

    // The caller, exposed_form(), wants to receive the element in 'value'.
    $form['value'] = $form[$name];
  }

  // Recursively calculates length of select list, including parent headings.
  function count_entries($array) {
    $count = 0;
    foreach ($array as $value) {
      $count += is_array($value) ? 1 + $this
        ->count_entries($value) : 1;
    }
    return $count;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
select_with_style_handler_filter_term_node_tid::count_entries function
select_with_style_handler_filter_term_node_tid::value_form 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::admin_summary public function Display the filter on the administrative summary. Overrides views_handler_filter_in_operator::admin_summary
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::extra_options_form public function Provide a form for setting options. Overrides views_handler::extra_options_form 2
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::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_handler_filter_many_to_one::option_definition 2
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