You are here

class views_handler_filter_dynamic_fields in Views Dynamic Fields 7

Simple filter to pick and choose the fields to show in the view.

Hierarchy

Expanded class hierarchy of views_handler_filter_dynamic_fields

1 string reference to 'views_handler_filter_dynamic_fields'
views_dynamic_fields_views_data_alter in ./views_dynamic_fields.module
Implements hook_views_data_alter().

File

handlers/views_handler_filter_dynamic_fields.inc, line 10
Views dynamic fields filter handler.

View source
class views_handler_filter_dynamic_fields extends views_handler_filter {

  // Array to store combined fields as an associative array (parent => child)
  // E.g. using table style plugin, one can set the column of one field as that
  // of another so they appear as one column in the output.
  public $combined_fields = array();

  // Array to store the fields to be used in the exposed filter.
  public $view_fields = array();

  /**
   * Enables handler options.
   */
  public function has_extra_options() {
    return TRUE;
  }

  /**
   * Defines handler options.
   */
  public function option_definition() {
    $options = parent::option_definition();

    // Fields to display in exposed filter.
    $options['filterable_fields'] = array(
      'default' => array(),
    );

    // Fields already displayed when user does no filtering.
    // @see http://drupal.org/node/1039760
    $options['defaults_filterable_fields'] = array(
      'default' => array(),
    );

    // Choose between checkboxes or select.
    // @see http://drupal.org/node/1039760
    $options['checkboxes'] = array(
      'default' => TRUE,
    );

    // Boolean to control display of Exclusion mode.
    $options['reverse'] = array(
      'default' => 0,
    );

    // Label for the Exclusion mode.
    $options['reverse_label'] = array(
      'default' => '',
    );

    // Custom description.
    // @see http://drupal.org/node/1958930
    $options['description'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * Pre-set the filter fields and combined fields arrays.
   *
   * @see \views\handler\views_handler_filter::init()
   */
  public function init(&$view, &$options) {
    parent::init($view, $options);
    $this->view_fields = $view
      ->get_items('field');
    $this
      ->remove_combined_fields($view);

    // Select all fields by default when setting up a new filter.
    $this->options['filterable_fields'] = empty($this->options['filterable_fields']) ? array_keys($this->view_fields) : $this->options['filterable_fields'];
  }

  /**
   * Prune fields to be displayed in the filter and capture combined fields sep.
   */
  protected function remove_combined_fields($view) {
    $this->combined_fields = array();
    $style_columns = isset($view->display_handler->default_display->options['style_options']['columns']) ? $view->display_handler->default_display->options['style_options']['columns'] : NULL;
    if (is_array($style_columns)) {
      foreach ($style_columns as $key => $name) {
        if (isset($this->view_fields[$key]) && $key != $name) {
          unset($this->view_fields[$key]);

          // The $key field will be acted upon if the $name (parent) field
          // is acted upon by the user.
          $this->combined_fields[$name] = $key;
        }
      }
    }
  }

  /**
   * Provide an 'exclusion mode' option.
   *
   * @see \views\handler\views_handler::extra_options_form()
   */
  public function extra_options_form(&$form, &$form_state) {

    // Get all non-excluded fields.
    $view_fields = $this->view_fields;
    foreach ($view_fields as $field_name => $field) {
      if (empty($field['label'])) {
        $field_label = ucfirst($field['id']);
      }
      else {
        $field_label = $field['label'];
      }

      // Do not allow pre-configured excluded fields in the filter.
      if (isset($field['exclude']) && $field['exclude']) {
        $fields_excluded[$field_name] = $field_label;
      }
      else {
        $fields[$field_name] = $field_label;
      }
    }
    $form['description'] = array(
      '#type' => 'textfield',
      '#default_value' => $this->options['description'],
      '#title' => t('Exposed filter description'),
      '#description' => t('Change the default description for the exposed dynamic fields filter.'),
      '#size' => 40,
    );

    // Switch multi select mode vs single select.
    // @see http://drupal.org/node/1299806
    $form['checkboxes'] = array(
      '#type' => 'checkbox',
      '#default_value' => $this->options['checkboxes'],
      '#title' => t('List filters in checkboxes'),
      '#description' => t('If selected the fields will be listed as checkboxes (multi select mode), otherwise they will be listed in a select box (single select).'),
    );
    $form['filterable_fields'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Selectable Fields'),
      '#description' => t('Select the fields that you want to make available for filtering. Unchecked fields will not be filterable and will always show up in the view.'),
      '#options' => $fields,
      '#default_value' => $this->options['filterable_fields'],
    );
    $form['defaults_filterable_fields'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Default displayed fields'),
      '#description' => t('Select the fields that you want displayed by default in the view when no filtering is applied. Any explicitly unchecked fields in the list above will also be included as permanent fields. Leave empty to choose all fields.'),
      '#options' => $fields,
      '#default_value' => $this->options['defaults_filterable_fields'],
    );

    // Fields may been excluded from the view in field settings.
    if ($fields_excluded) {
      $form['filterable_fields_excluded'] = array(
        '#type' => 'checkboxes',
        '#title' => t('Excluded fields'),
        '#options' => $fields_excluded,
        '#description' => t('You have configured these fields to be excluded from the view, hence they will not appear as filters.'),
        '#disabled' => TRUE,
      );
    }
    $form['reverse'] = array(
      '#type' => 'checkbox',
      '#default_value' => $this->options['reverse'],
      '#title' => t('Provide exclusion mode'),
      '#description' => t('Provide a checkbox to reverse the selection from inclusion to exclusion.'),
    );
    $form['reverse_label'] = array(
      '#type' => 'textfield',
      '#default_value' => $this->options['reverse_label'],
      '#title' => t('Label for exclusion fields options'),
      '#description' => t('Change the default label for the exclusion mode.'),
      '#size' => 40,
    );
  }

  /**
   * Provide a list of all fields that are for display.
   */
  public function value_form(&$form, &$form_state) {

    // All the non-permanently excluded fields of the view that we will display
    // in the exposed filter.
    $all_fields = array();

    // Just the names of all the non-permanently excluded fields.
    $field_names = array();
    $view_fields = $this->view_fields;
    $combined_fields = $this->combined_fields;

    // The final fields that are part of the filter after going through a
    // pruning process.
    $displayed_field_names = array();
    $filterable_fields = array_filter($this->options['filterable_fields']);
    $defaults_filterable_fields = array_filter($this->options['defaults_filterable_fields']);

    // Create fields to be displayed as part of the filter.
    foreach ($view_fields as $field_name => $field) {

      // Apply filterable fields options removing any field not in the set of
      // filterable fields.
      if (!empty($filterable_fields) && !isset($filterable_fields[$field_name])) {
        continue;
      }
      if (!isset($_SESSION[$this->view->name]['perm_exc']) && isset($field['exclude']) && $field['exclude']) {

        // Fields already marked as 'exclude from display' in the original
        // view should be omitted.
        $_SESSION[$this->view->name]['perm_exc'][$field_name] = $field_name;
        continue;
      }
      if (!isset($_SESSION[$this->view->name]['perm_exc'][$field_name])) {

        // Use the field id as label if label is empty
        // @see http://drupal.org/node/1951742
        if (empty($field['label'])) {
          $all_fields[$field_name] = ucfirst($field['id']);
        }
        else {
          $all_fields[$field_name] = $field['label'];
        }
        $field_names[] = $field_name;

        // Get fields to display in the plain (unfiltered) view.
        if (isset($defaults_filterable_fields[$field_name]) && $defaults_filterable_fields[$field_name] == $field_name) {
          $field_names_defaults[$field_name] = $field_name;
        }
      }
    }

    // Also add any combined fields to the default fields to display
    // as configured.
    foreach ($combined_fields as $c_parent => $c_child) {
      if ($defaults_filterable_fields[$c_parent] == $c_parent) {
        $field_names_defaults[$c_parent] = $c_parent;
      }
    }

    // Initialize the permanent exclusion array if not set.
    if (!isset($_SESSION[$this->view->name]['perm_exc'])) {
      $_SESSION[$this->view->name]['perm_exc'] = array();
    }

    // Display all the filter fields in the plain view if no explicit.
    // defaults are set in the view.
    $field_names_defaults = empty($field_names_defaults) ? $all_fields : $field_names_defaults;
    if ($form_state['exposed']) {

      // Get submitted filter data if any.
      $exposed_input = $this->view
        ->get_exposed_input();
      if (isset($exposed_input[$this->options['expose']['identifier']])) {
        $exposed_input_fields = $exposed_input[$this->options['expose']['identifier']];
        $exposed_field_names = isset($exposed_input['field_names']) ? unserialize($exposed_input['field_names']) : $field_names;
      }
      $this->options['expose']['multiple'] = $this->options['checkboxes'];

      // If checkboxes has not been enabled, display the fields in as
      // select list / drop down.
      if (!$this->options['checkboxes']) {
        $form['value'] = array(
          '#type' => 'select',
          '#no_convert' => $this->options['checkboxes'],
          '#title' => $this->options['expose']['label'] ? $this->options['expose']['label'] : t('Fields'),
          '#options' => $all_fields,
          '#description' => $this->options['description'] ? check_plain($this->options['description']) : t('Select the field to display in the view'),
        );
        $displayed_field_names = $field_names;
      }
      else {

        // For a view that has already been filtered by the user.
        if (!empty($exposed_input_fields)) {
          $delta = count($exposed_input_fields);
          $key = 0;

          // Regenerate the sortable table.
          foreach ($exposed_input_fields as $oldid => $oldvalue) {
            $def_check = isset($oldvalue['check']) && $oldvalue['check'] || empty($all_fields[$exposed_field_names[$oldid]]);
            $def_sort = $oldvalue['sort'] ? $oldvalue['sort'] : $key;
            $def_disabled = empty($all_fields[$exposed_field_names[$oldid]]);
            $def_title = '';
            if (isset($all_fields[$exposed_field_names[$oldid]]) && !empty($all_fields[$exposed_field_names[$oldid]])) {
              $def_title = $all_fields[$exposed_field_names[$oldid]];
            }
            else {
              if (empty($view_fields[$exposed_field_names[$oldid]]['label'])) {
                $def_title = ucfirst($view_fields[$exposed_field_names[$oldid]]['id']);
              }
              else {
                $def_title = $view_fields[$exposed_field_names[$oldid]]['label'];
              }
            }
            $def_desc = empty($all_fields[$exposed_field_names[$oldid]]) ? t('Visible') : '';
            $form['value'][$key]['check'] = array(
              '#type' => 'checkbox',
              '#value' => $def_check,
              // Set field to hidden style rather than disabling them.
              // @see http://drupal.org/node/2291727
              // notes: disabled attribute prevents the item to be submitted
              //        readonly attribute only protects the checkbox value and
              //        not its status (checked/unchecked) so we don't use it
              // @see https://www.drupal.org/node/2368771
              '#attributes' => $def_disabled ? array(
                'style' => 'visibility: hidden',
              ) : '',
              '#description' => check_plain($def_desc),
            );
            $form['value'][$key]['title'] = array(
              '#markup' => $def_title,
            );
            $form['value'][$key]['sort'] = array(
              '#type' => 'weight',
              '#delta' => $delta,
              '#value' => $def_sort,
              '#default_value' => $def_sort,
            );
            $displayed_field_names[] = $exposed_field_names[$oldid];
            ++$key;
          }
        }
        else {
          $delta = count($view_fields) - count($combined_fields);
          $key = 0;

          // Create the sortable table.
          foreach ($view_fields as $field_title => $field_info) {

            // Skip over permanently excluded fields.
            if (isset($field_info['exclude']) && $field_info['exclude']) {
              continue;
            }

            // Display only default filterable fields
            // if there is no exposed input.
            $def_check = in_array($field_title, array_keys($field_names_defaults)) || empty($all_fields[$field_title]);
            $def_sort = $key;
            $def_desc = empty($all_fields[$field_title]) ? t('Visible') : '';
            $def_disabled = empty($all_fields[$field_title]);
            $def_title = '';
            if (isset($all_fields[$field_title]) && !empty($all_fields[$field_title])) {
              $def_title = $all_fields[$field_title];
            }
            else {
              if (empty($view_fields[$field_title]['label'])) {
                $def_title = ucfirst($view_fields[$field_title]['id']);
              }
              else {
                $def_title = $view_fields[$field_title]['label'];
              }
            }
            $form['value'][$key]['check'] = array(
              '#type' => 'checkbox',
              '#value' => $def_check,
              // Set field to hidden style rather than disabling them.
              // @see http://drupal.org/node/2291727
              // notes: disabled attribute prevents the item to be submitted
              //        readonly attribute only protects the checkbox value and
              //        not its status (checked/unchecked) so we don't use it
              // @see https://www.drupal.org/node/2368771
              '#attributes' => $def_disabled ? array(
                'style' => 'visibility: hidden',
              ) : '',
              '#description' => check_plain($def_desc),
            );
            $form['value'][$key]['title'] = array(
              '#markup' => $def_title,
            );
            $form['value'][$key]['sort'] = array(
              '#type' => 'weight',
              '#delta' => $delta,
              '#default_value' => $def_sort,
            );
            $displayed_field_names[] = $field_title;
            ++$key;
          }
        }

        // Theme the draggable sort table.
        $form['value']['#theme'] = 'views_dynamic_fields_sort_filter_fields';
      }
      $form['value']['#tree'] = TRUE;
      $form['value']['#title'] = $this->options['expose']['label'] ? $this->options['expose']['label'] : t('Fields');

      // Store the fields being displayed in the filter for use
      // as form data when processing filter submissions.
      $form['field_names'] = array(
        '#type' => 'hidden',
        '#value' => serialize($displayed_field_names),
      );
      $form['combined'] = array(
        '#type' => 'hidden',
        '#value' => serialize($combined_fields),
        '#weight' => 9,
      );
      if ($this->options['reverse']) {
        $form['reverse'] = array(
          '#type' => 'checkbox',
          '#default_value' => $this->options['reverse'],
          '#title' => $this->options['reverse_label'] ? $this->options['reverse_label'] : t('Selected fields will be excluded'),
          '#description' => t('Check this to exclude the selected fields from the view.'),
        );
      }
    }
    else {

      // Ensure there is something in the 'value'.
      $form['value'] = array(
        '#type' => 'value',
        '#value' => NULL,
      );
    }
  }

  /**
   * Exclude fields from the view before the query is run.
   *
   * @see \views\handler\views_handler::pre_query()
   */
  public function pre_query() {

    // Fields submitted by user in the exposed filter.
    $exposed_input = $this->view
      ->get_exposed_input();
    if (isset($exposed_input[$this->options['expose']['identifier']])) {
      $exposed_input_fields = $exposed_input[$this->options['expose']['identifier']];
    }
    $defaults_filterable_fields = array_filter($this->options['defaults_filterable_fields']);
    $filterable_fields = array_filter($this->options['filterable_fields']);

    // Get all fields.
    foreach ($this->view->field as $field_name => $field) {
      $field_names[] = $field_name;

      // Default view when no filtering is applied.
      if (empty($exposed_input_fields)) {
        if (!in_array($field_name, array_keys($defaults_filterable_fields)) && isset($filterable_fields[$field_name])) {
          $this->view->field[$field_name]->options['exclude'] = 1;
        }
      }
    }
    if (!empty($exposed_input_fields)) {

      // Exclude these fields.
      $combined_fields = isset($exposed_input['combined']) ? unserialize($exposed_input['combined']) : array();
      if (!$this->options['checkboxes']) {
        $this
          ->pre_query_single($exposed_input, $field_names, $combined_fields);
      }
      else {
        $this
          ->pre_query_multiple($exposed_input, $field_names, $combined_fields);
      }
    }
  }

  /**
   * Handle pre_query processing when checkboxes are not enabled.
   */
  private function pre_query_single($exposed_input, $field_names, $combined_fields) {

    // If exclusion mode is selected.
    if (isset($exposed_input['reverse']) && $exposed_input['reverse']) {
      $fields_to_exclude = $exposed_input[$this->options['expose']['identifier']];
    }
    else {
      $selected_fields = $exposed_input[$this->options['expose']['identifier']];
      if (!is_array($selected_fields)) {
        $selected_fields = array(
          $selected_fields,
        );
      }
      if ($selected_fields[0] == 'All') {
        $fields_to_exclude = array();
      }
      else {
        $fields_to_exclude = array_diff($field_names, $selected_fields);
      }
    }
    $filterable_fields = array_filter($this->options['filterable_fields']);

    // If only one field is selected, this ensures no issues with array.
    // @see http://drupal.org/node/1831858
    if (!is_array($fields_to_exclude)) {
      $fields_to_exclude = array(
        $fields_to_exclude,
      );
    }

    // Also include/exclude the fields combined into any
    // of the $exposed_input fields.
    foreach ($fields_to_exclude as $key => $efield) {

      // Add the combined field to the exclusion array
      // if parent is filterable and excluded.
      if (isset($combined_fields[$efield]) && $this->options['filterable_fields'][$efield] !== 0) {
        $fields_to_exclude[$combined_fields[$efield]] = $combined_fields[$efield];
      }

      // On the other hand, the combined field should be include.
      // in the view if the parent is.
      if (in_array($efield, $combined_fields)) {
        unset($fields_to_exclude[$key]);
      }
    }

    // Mark the fields to be excluded to the view object.
    foreach ($fields_to_exclude as $field_to_exclude) {

      // Exclude only the fields chosen as excludable in filter options.
      if (empty($filterable_fields) || isset($this->options['filterable_fields'][$field_to_exclude]) && $this->options['filterable_fields'][$field_to_exclude] !== 0) {
        $this->view->field[$field_to_exclude]->options['exclude'] = 1;
      }
    }
  }

  /**
   * Handle pre_query processing when checkboxes are enabled.
   */
  private function pre_query_multiple($exposed_input, $field_names, $combined_fields) {
    $exposed_input_fields = $exposed_input[$this->options['expose']['identifier']];

    // Fields displayed in the filter.
    $form_field_names = isset($exposed_input['field_names']) ? unserialize($exposed_input['field_names']) : $field_names;
    $orig_field_exposed = $order_includes = $order_excludes = array();
    foreach ($exposed_input_fields as $id => $info) {
      $orig_field_exposed[$info['sort']] = $form_field_names[$id];

      // Unset fields that haven't been selected.
      if (!isset($info['check']) || $info['check'] != 1) {
        unset($exposed_input_fields[$id]);
        $order_includes[$info['sort']] = $form_field_names[$id];
      }
      else {
        $order_excludes[$info['sort']] = $form_field_names[$id];
      }
    }

    // Sorted order of fields for display.
    ksort($orig_field_exposed);
    ksort($order_includes);
    ksort($order_excludes);

    // If exclusion mode is selected.
    if (isset($exposed_input['reverse']) && $exposed_input['reverse']) {
      $fields_to_exclude = $order_excludes;
    }
    else {
      $fields_to_exclude = $order_includes;
    }

    // If only one field is selected, this ensures no issues with array.
    // @see http://drupal.org/node/1831858
    if (!is_array($fields_to_exclude)) {
      $fields_to_exclude = array(
        $fields_to_exclude,
      );
    }

    // Also include/exclude the fields combined into any
    // of the $exposed_input fields.
    foreach ($fields_to_exclude as $key => $efield) {

      // Add the combined field to the exclusion array if parent
      // is filterable and excluded.
      if (isset($combined_fields[$efield]) && $this->options['filterable_fields'][$efield] !== 0) {
        $fields_to_exclude[$combined_fields[$efield]] = $combined_fields[$efield];
      }

      // On the other hand, the combined field should be included
      // in the view if the parent is.
      if (in_array($efield, $combined_fields)) {
        unset($fields_to_exclude[$key]);
      }
    }

    // Mark the fields to be excluded to the view object.
    foreach ($fields_to_exclude as $field_to_exclude) {

      // Exclude only the fields chosen as excludable in filter options.
      if ($this->options['filterable_fields'][$field_to_exclude] !== 0) {
        $this->view->field[$field_to_exclude]->options['exclude'] = 1;
      }
    }

    // Reorder the view's fields.
    $view_fields = $this->view->field;
    $view_fields_ordered = array();
    foreach ($orig_field_exposed as $field_title) {
      $view_fields_ordered[$field_title] = $view_fields[$field_title];
      unset($view_fields[$field_title]);
    }

    // Check if any still remaning (hidden fields, already excluded fields).
    if (!empty($view_fields)) {
      foreach ($view_fields as $field_title => $field_info) {
        $view_fields_ordered[$field_title] = $field_info;
      }
    }
    $this->view->field = $view_fields_ordered;
  }

  /**
   * Do nothing in the query.
   *
   * This function needs to be defined and left to do nothing.
   *
   * @see \views\handler\views_handler_filter::query()
   */
  public function query() {
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::ensure_my_table public function Ensure the main table for this handler is in the query. This is used a lot. 8
views_handler::exposed_submit public function Submit the exposed handler form.
views_handler::exposed_validate public function Validate the exposed handler form. 4
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::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::validate public function Validates the handler against the complete View. 1
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::accept_exposed_input public function Check to see if input from the exposed filters should change the behavior. Overrides views_handler::accept_exposed_input 2
views_handler_filter::admin_summary public function Display the filter on the administrative summary. Overrides views_handler::admin_summary 10
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_form public function Options form subform for exposed filter options. Overrides views_handler::expose_form 2
views_handler_filter::expose_options public function Provide default options for exposed filters. Overrides views_handler::expose_options 2
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_options public function Provide a list of options for the default operator form. 4
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::value_submit public function Perform any necessary changes to the form values prior to storage. 1
views_handler_filter::value_validate public function Validate the options form. 3
views_handler_filter_dynamic_fields::$combined_fields public property
views_handler_filter_dynamic_fields::$view_fields public property
views_handler_filter_dynamic_fields::extra_options_form public function Provide an 'exclusion mode' option. Overrides views_handler::extra_options_form
views_handler_filter_dynamic_fields::has_extra_options public function Enables handler options. Overrides views_handler::has_extra_options
views_handler_filter_dynamic_fields::init public function Pre-set the filter fields and combined fields arrays. Overrides views_handler_filter::init
views_handler_filter_dynamic_fields::option_definition public function Defines handler options. Overrides views_handler_filter::option_definition
views_handler_filter_dynamic_fields::pre_query public function Exclude fields from the view before the query is run. Overrides views_handler::pre_query
views_handler_filter_dynamic_fields::pre_query_multiple private function Handle pre_query processing when checkboxes are enabled.
views_handler_filter_dynamic_fields::pre_query_single private function Handle pre_query processing when checkboxes are not enabled.
views_handler_filter_dynamic_fields::query public function Do nothing in the query. Overrides views_handler_filter::query
views_handler_filter_dynamic_fields::remove_combined_fields protected function Prune fields to be displayed in the filter and capture combined fields sep.
views_handler_filter_dynamic_fields::value_form public function Provide a list of all fields that are for display. Overrides views_handler_filter::value_form
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::construct public function Views handlers use a special construct function. 4
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