You are here

Home » API reference » Composite Views Filter 7 » composite_views_filter_handler.inc

class composite_views_filter_handler in Composite Views Filter 7

Hierarchy

Expanded class hierarchy of composite_views_filter_handler

3 string references to 'composite_views_filter_handler'
composite_views_filter_form_views_ui_config_item_form_alter in ./composite_views_filter.module
Implements hook_form_FORM_ID_alter() for views_ui_config_item_form().
composite_views_filter_views_data in ./composite_views_filter.module
Implements hook_views_data().
_composite_views_filter_view_has_composite_filters in ./composite_views_filter.module
Helper to determine the composite filters of a View.

File

views/composite_views_filter_handler.inc, line 3

View source 
class composite_views_filter_handler extends views_handler_filter {

  /**
   * Override query() to do nothing.
   */
  function query() {
  }

  /**
   * Options definition.
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['composite_views_filter']['contains']['groups'] = array(
      'default' => '',
    );
    $options['composite_views_filter']['contains']['default_group'] = array(
      'default' => '',
    );
    $options['composite_views_filter']['contains']['all_label'] = array(
      'default' => '',
    );
    $options['composite_views_filter']['contains']['classification'] = array(
      'default' => array(),
    );
    $options['exposed']['default'] = TRUE;
    return $options;
  }

  /**
   * Define options form.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);

    // No multiple!
    if (isset($form['expose']['multiple'])) {
      $form['expose']['multiple']['#access'] = FALSE;
      $form['expose']['multiple']['#default_value'] = 0;
    }

    // @see _composite_views_filter_groups()
    $form['expose']['label']['#required'] = TRUE;
    $form['composite_views_filter'] = array(
      '#type' => 'fieldset',
      '#title' => t('Groups'),
      '#tree' => TRUE,
      '#collapsed' => FALSE,
      '#collapsible' => FALSE,
    );
    $form['composite_views_filter']['groups'] = array(
      '#type' => 'textarea',
      '#title' => t('Groups'),
      '#default_value' => $this->options['composite_views_filter']['groups'],
      '#required' => TRUE,
      '#description' => t('Define groups like you would options in a List Field: <code>key|Readable label</code>. Labels will be translated.'),
    );
    $form['composite_views_filter']['default_group'] = array(
      '#type' => 'textfield',
      '#title' => t('Default selected composite filter'),
      '#default_value' => $this->options['composite_views_filter']['default_group'],
      '#description' => t('Machine name of one of the above groups. Leave this empty to disable all composite filters initially.'),
    );
    $form['composite_views_filter']['all_label'] = array(
      '#type' => 'textfield',
      '#title' => t('Label for &quot;- All -&quot;'),
      '#default_value' => $this->options['composite_views_filter']['all_label'],
      '#description' => t('The dropdown label that represents all filter groups. If empty, &quot;- All -&quot; will be used. This string will be translated.'),
    );
  }

  /**
   * Here we define the custom label for the - All - option.
   */
  function exposed_translate(&$form, $type) {
    parent::exposed_translate($form, $type);
    $label = $this->options['composite_views_filter']['all_label'] ?: '- All -';
    $form['#options']['All'] = t($label);
    $form['#default_value'] = $this->options['composite_views_filter']['default_group'];
  }

  /**
   * Exposed form.
   */
  function value_form(&$form, &$form_state) {
    $form_id = @$form_state['build_info']['form_id'] ?: @$form_state['form_id'] ?: '';
    if ($form_id == 'views_exposed_form') {
      $label = @$this->options['expose']['label'] ?: t('Composite Views Filter Group');
      $form['value'] = array(
        '#type' => 'select',
        '#title' => $label,
        '#options' => $this
          ->get_groups(TRUE),
      );
    }
  }

  /**
   * Admin summary (in View edit overview).
   *
   * This is truly nasty, but I need finer control than Views provides.
   * @see composite_views_filter_views_ui_display_tab_alter()
   */
  function admin_summary() {
    $filter_handlers = _composite_views_filter_view_has_composite_filters($this->view);
    $groups = $this
      ->get_groups();
    return $this->options['expose']['label'] . ' (' . t('@num groups', array(
      '@num' => count($groups),
    ));
  }

  /**
   * Helper to parse and return groups.
   */
  function get_groups($translate = FALSE) {
    $options = list_extract_allowed_values($this->options['composite_views_filter']['groups'], 'list_text', FALSE);
    if ($translate) {
      $options = array_map('t', $options);
    }
    return $options;
  }

  /**
   * Helper to return saved classification.
   */
  function get_classification() {
    return $this->options['composite_views_filter']['classification'];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
composite_views_filter_handler::admin_summary function Admin summary (in View edit overview). Overrides views_handler_filter::admin_summary
composite_views_filter_handler::exposed_translate function Here we define the custom label for the - All - option. Overrides views_handler_filter::exposed_translate
composite_views_filter_handler::get_classification function Helper to return saved classification.
composite_views_filter_handler::get_groups function Helper to parse and return groups.
composite_views_filter_handler::options_form function Define options form. Overrides views_handler_filter::options_form
composite_views_filter_handler::option_definition function Options definition. Overrides views_handler_filter::option_definition
composite_views_filter_handler::query function Override query() to do nothing. Overrides views_handler_filter::query
composite_views_filter_handler::value_form function Exposed form. Overrides views_handler_filter::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::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_form public function Provide a form for setting options. 1
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::has_extra_options public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 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::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::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::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::init public function Provide some extra help to get the operator/value easier to use. Overrides views_handler::init 2
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_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_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