class commerce_backoffice_handler_filter_term_node_tid in Commerce Backoffice 7

Filter by term id.

Hierarchy

class \views_object
- class \views_handler
  - class \views_handler_filter
    class \commerce_backoffice_handler_filter_term_node_tid

Expanded class hierarchy of commerce_backoffice_handler_filter_term_node_tid

2 string references to 'commerce_backoffice_handler_filter_term_node_tid'

commerce_backoffice_content_views_data_alter in includes/views/commerce_backoffice_content.views.inc: Implements hook_views_data_alter().
commerce_backoffice_product_views_data_alter in includes/views/commerce_backoffice_product.views.inc: Implements hook_views_data_alter().

File

includes/views/handlers/commerce_backoffice_handler_filter_term_node_tid.inc, line 14: Definition of commerce_backoffice_handler_filter_term_node_tid.

View source

class commerce_backoffice_handler_filter_term_node_tid extends views_handler_filter {

  // Stores the exposed input for this filter.
  var $validated_exposed_input = NULL;
  function option_definition() {
    $options = parent::option_definition();
    $options['per_vocabulary'] = array(
      'default' => TRUE,
    );
    $options['hierarchy'] = array(
      'default' => 0,
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['per_vocabulary'] = array(
      '#type' => 'checkbox',
      '#title' => t('Require all terms to be present'),
      '#description' => t('Shows only content that has all of the selected terms.'),
      '#default_value' => !empty($this->options['per_vocabulary']),
      '#dependency' => array(
        'radio:options[type]' => array(
          'select',
        ),
      ),
    );
    $form['hierarchy'] = array(
      '#type' => 'checkbox',
      '#title' => t('Show hierarchy in dropdown'),
      '#default_value' => !empty($this->options['hierarchy']),
      '#dependency' => array(
        'radio:options[type]' => array(
          'select',
        ),
      ),
    );
  }
  function value_form(&$form, &$form_state) {
    $vocabularies = commerce_backoffice_get_vocabularies($this->definition['product display']);
    if (empty($vocabularies)) {
      $form['markup'] = array(
        '#markup' => '<div class="form-item">' . t('No terms found in the provided vocabularies.') . '</div>',
      );
      $form['value'] = array();
      return;
    }
    $options = array();
    foreach ($vocabularies as $vocabulary) {
      $options[$vocabulary->name] = array();
      $vocabularies_names[] = $vocabulary->name;
      if (!empty($this->options['hierarchy'])) {
        $tree = taxonomy_get_tree($vocabulary->vid);
        if ($tree) {
          foreach ($tree as $term) {
            $choice = new stdClass();
            if (!empty($this->options['per_vocabulary'])) {
              $choice->option = array(
                $term->vid . '-' . $term->tid => str_repeat('-', $term->depth) . $term->name,
              );
            }
            else {
              $choice->option = array(
                $term->tid => str_repeat('-', $term->depth) . $term->name,
              );
            }
            $options[$vocabulary->name][] = $choice;
          }
        }
      }
      else {
        $query = db_select('taxonomy_term_data', 'td');
        $query
          ->innerJoin('taxonomy_vocabulary', 'tv', 'td.vid = tv.vid');
        $query
          ->fields('td');
        $query
          ->orderby('tv.weight');
        $query
          ->orderby('tv.name');
        $query
          ->orderby('td.weight');
        $query
          ->orderby('td.name');
        $query
          ->addTag('term_access');
        $query
          ->condition('tv.machine_name', $vocabulary->machine_name);
        $result = $query
          ->execute();
        foreach ($result as $term) {
          if (!empty($this->options['per_vocabulary'])) {
            $options[$vocabulary->name][$term->vid . '-' . $term->tid] = $term->name;
          }
          else {
            $options[$vocabulary->name][$term->tid] = $term->name;
          }
        }
      }
    }
    $default_value = (array) $this->value;
    if (!empty($form_state['exposed'])) {
      $identifier = $this->options['expose']['identifier'];
      if (!empty($this->options['expose']['reduce'])) {
        $options = $this
          ->reduce_value_options($options);
        if (!empty($this->options['expose']['multiple']) && empty($this->options['expose']['required'])) {
          $default_value = array();
        }
      }
      if (empty($this->options['expose']['multiple'])) {
        if (empty($this->options['expose']['required']) && (empty($default_value) || !empty($this->options['expose']['reduce']))) {
          $default_value = 'All';
        }
        elseif (empty($default_value)) {
          $keys = array_keys($options);
          $default_value = array_shift($keys);
        }
        elseif ($default_value == array(
          '',
        )) {
          $default_value = 'All';
        }
        else {
          $copy = $default_value;
          $default_value = array_shift($copy);
        }
      }
    }
    $form['value'] = array(
      '#type' => 'select',
      '#title' => t('Select terms'),
      '#multiple' => TRUE,
      '#options' => $options,
      '#size' => min(9, count($options, COUNT_RECURSIVE)),
      '#default_value' => $default_value,
    );
    if (!empty($form_state['exposed']) && isset($identifier) && !isset($form_state['input'][$identifier])) {
      $form_state['input'][$identifier] = $default_value;
    }
  }
  function accept_exposed_input($input) {
    if (empty($this->options['exposed'])) {
      return TRUE;
    }

    // If view is an attachment and is inheriting exposed filters, then assume
    // exposed input has already been validated
    if (!empty($this->view->is_attachment) && $this->view->display_handler
      ->uses_exposed()) {
      $this->validated_exposed_input = (array) $this->view->exposed_raw_input[$this->options['expose']['identifier']];
    }

    // If it's non-required and there's no value don't bother filtering.
    if (!$this->options['expose']['required'] && empty($this->validated_exposed_input)) {
      return FALSE;
    }
    $rc = parent::accept_exposed_input($input);
    if ($rc) {

      // If we have previously validated input, override.
      if (isset($this->validated_exposed_input)) {
        $this->value = $this->validated_exposed_input;
      }
    }
    return $rc;
  }
  function exposed_validate(&$form, &$form_state) {
    if (empty($this->options['exposed'])) {
      return;
    }
    $identifier = $this->options['expose']['identifier'];
    if (isset($form_state['values'][$identifier]) && $form_state['values'][$identifier] != 'All') {
      $this->validated_exposed_input = (array) $form_state['values'][$identifier];
    }
    return;
  }
  function value_submit($form, &$form_state) {

    // prevent array_filter from messing up our arrays in parent submit.
  }
  function admin_summary() {
    return '';
  }
  function query() {

    // If no filter values are present, then do nothing.
    if (count($this->value) == 0) {
      return;
    }
    elseif (count($this->value) == 1) {

      // Somethis $this->value is an array with a single element so convert it.
      if (is_array($this->value)) {
        $this->value = current($this->value);
      }
      $operator = '=';
    }
    else {
      $operator = 'IN';
    }

    // The normal use of ensure_my_table() here breaks Views.
    // So instead we trick the filter into using the alias of the base table.
    // See http://drupal.org/node/271833
    // If a relationship is set, we must use the alias it provides.
    if (!empty($this->relationship)) {
      $this->table_alias = $this->relationship;
    }
    elseif (isset($this->query->table_queue[$this->query->base_table]['alias'])) {
      $this->table_alias = $this->query->table_queue[$this->query->base_table]['alias'];
    }
    else {
      return;
    }
    if (empty($this->options['per_vocabulary']) || $operator == '=') {
      if (!is_array($this->value) && ($value_parts = explode('-', $this->value))) {
        $tid = $value_parts[1];
      }
      else {
        $tid = $this->value;
      }
      $subquery = db_select('taxonomy_index', 'tn');
      $subquery
        ->addField('tn', 'nid');
      $last = 'tn';
      $subquery
        ->condition('tn.tid', $tid, $operator);
      $this->query
        ->add_where($this->options['group'], "{$this->table_alias}.nid", $subquery, 'IN');
    }
    else {
      $values = array();
      foreach ($this->value as $value) {
        $value_parts = explode('-', $value);
        $values[$value_parts[0]][] = $value_parts[1];
      }
      foreach ($values as $vid => $tids) {

        // Now build the subqueries.
        $subquery = db_select('taxonomy_index', 'tn');
        $subquery
          ->addField('tn', 'nid');
        $last = 'tn';
        $subquery
          ->innerJoin('taxonomy_term_data', 'td', 'td.tid = tn.tid');
        $last = 'td';
        $subquery
          ->condition('tn.tid', array_values($tids), $operator);
        $subquery
          ->condition('td.vid', $vid);
        $this->query
          ->add_where($this->options['group'], "{$this->table_alias}.nid", $subquery, 'IN');
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
commerce_backoffice_handler_filter_term_node_tid::$validated_exposed_input		property
commerce_backoffice_handler_filter_term_node_tid::accept_exposed_input		function	Check to see if input from the exposed filters should change the behavior. Overrides views_handler_filter::accept_exposed_input
commerce_backoffice_handler_filter_term_node_tid::admin_summary		function	Display the filter on the administrative summary. Overrides views_handler_filter::admin_summary
commerce_backoffice_handler_filter_term_node_tid::exposed_validate		function	Validate the exposed handler form. Overrides views_handler::exposed_validate
commerce_backoffice_handler_filter_term_node_tid::options_form		function	Provide the basic form which calls through to subforms. Overrides views_handler_filter::options_form
commerce_backoffice_handler_filter_term_node_tid::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_handler_filter::option_definition
commerce_backoffice_handler_filter_term_node_tid::query		function	Add this filter to the query. Overrides views_handler_filter::query
commerce_backoffice_handler_filter_term_node_tid::value_form		function	Options form subform for setting options. Overrides views_handler_filter::value_form
commerce_backoffice_handler_filter_term_node_tid::value_submit		function	Perform any necessary changes to the form values prior to storage. Overrides views_handler_filter::value_submit
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::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::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::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_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

You are here

class commerce_backoffice_handler_filter_term_node_tid in Commerce Backoffice 7

Hierarchy

File

Members

API Navigation