views_handler_filter_term_node_tid.inc

Same filename in other branches
  1. 7.x-3.x modules/taxonomy/views_handler_filter_term_node_tid.inc

File

modules/taxonomy/views_handler_filter_term_node_tid.inc

View source
<?php


/**
 * Filter by term id.
 *
 * @ingroup views_filter_handlers
 */
class views_handler_filter_term_node_tid extends views_handler_filter_many_to_one {
    function can_group() {
        return FALSE;
    }
    function has_extra_options() {
        return TRUE;
    }
    function get_value_options() {
        
        /* don't overwrite the value options */
    }
    function option_definition() {
        $options = parent::option_definition();
        $options['type'] = array(
            'default' => 'textfield',
        );
        $options['limit'] = array(
            'default' => TRUE,
        );
        $options['vid'] = array(
            'default' => 0,
        );
        $options['hierarchy'] = array(
            'default' => 0,
        );
        $options['error_message'] = array(
            'default' => TRUE,
        );
        return $options;
    }
    function extra_options_form(&$form, &$form_state) {
        $vocabularies = taxonomy_get_vocabularies();
        foreach ($vocabularies as $voc) {
            $options[$voc->vid] = check_plain($voc->name);
        }
        if ($this->options['limit']) {
            // We only do this when the form is displayed.
            if ($this->options['vid'] == 0) {
                $first_vocabulary = reset($vocabularies);
                $this->options['vid'] = $first_vocabulary->vid;
            }
            $form['vid'] = array(
                '#prefix' => '<div class="views-left-40">',
                '#suffix' => '</div>',
                '#type' => 'radios',
                '#title' => t('Vocabulary'),
                '#options' => $options,
                '#description' => t('Select which vocabulary to show terms for in the regular options.'),
                '#default_value' => $this->options['vid'],
            );
        }
        $form['markup_start'] = array(
            '#value' => '<div class="views-left-40">',
        );
        $form['type'] = array(
            '#type' => 'radios',
            '#title' => t('Selection type'),
            '#options' => array(
                'select' => t('Dropdown'),
                'textfield' => t('Autocomplete'),
            ),
            '#default_value' => $this->options['type'],
        );
        $form['hierarchy'] = array(
            '#type' => 'checkbox',
            '#title' => t('Show hierarchy in dropdown'),
            '#default_value' => !empty($this->options['hierarchy']),
            '#process' => array(
                'views_process_dependency',
            ),
            '#dependency' => array(
                'radio:options[type]' => array(
                    'select',
                ),
            ),
        );
        $form['markup_end'] = array(
            '#value' => '</div>',
        );
    }
    function value_form(&$form, &$form_state) {
        $vocabulary = taxonomy_vocabulary_load($this->options['vid']);
        if (empty($vocabulary) && $this->options['limit']) {
            $form['markup'] = array(
                '#prefix' => '<div class="form-item">',
                '#suffix' => '</div>',
                '#value' => t('An invalid vocabulary is selected. Please change it in the options.'),
            );
            return;
        }
        if ($this->options['type'] == 'textfield') {
            $default = '';
            if ($this->value) {
                $result = db_query("SELECT * FROM {term_data} td WHERE td.tid IN (" . implode(', ', $this->value) . ')');
                while ($term = db_fetch_object($result)) {
                    if ($default) {
                        $default .= ', ';
                    }
                    $default .= $term->name;
                }
            }
            $form['value'] = array(
                '#title' => $this->options['limit'] ? t('Select terms from vocabulary @voc', array(
                    '@voc' => $vocabulary->name,
                )) : t('Select terms'),
                '#type' => 'textfield',
                '#default_value' => $default,
            );
            if ($this->options['limit']) {
                $form['value']['#autocomplete_path'] = 'taxonomy/autocomplete/' . $vocabulary->vid;
            }
        }
        else {
            if (!empty($this->options['hierarchy']) && $this->options['limit']) {
                $tree = taxonomy_get_tree($vocabulary->vid);
                $options = array();
                if ($tree) {
                    foreach ($tree as $term) {
                        $choice = new stdClass();
                        $choice->option = array(
                            $term->tid => str_repeat('-', $term->depth) . $term->name,
                        );
                        $options[] = $choice;
                    }
                }
            }
            else {
                $options = array();
                if ($this->options['limit']) {
                    $result = db_query(db_rewrite_sql("SELECT t.* FROM {term_data} t WHERE t.vid = %d ORDER BY t.weight, t.name", 't', 'tid'), $vocabulary->vid);
                }
                else {
                    $result = db_query(db_rewrite_sql("SELECT td.* FROM {term_data} td INNER JOIN {vocabulary} v ON td.vid = v.vid ORDER BY v.weight, v.name, td.weight, td.name", 'td', 'tid'));
                }
                while ($term = db_fetch_object($result)) {
                    $options[$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']['single']) && !empty($this->options['expose']['optional'])) {
                        $default_value = array();
                    }
                }
                if (!empty($this->options['expose']['single'])) {
                    if (!empty($this->options['expose']['optional']) && (empty($default_value) || !empty($this->options['expose']['reduce']))) {
                        $default_value = 'All';
                    }
                    else {
                        if (empty($default_value)) {
                            $keys = array_keys($options);
                            $default_value = array_shift($keys);
                        }
                        else {
                            $copy = $default_value;
                            $default_value = array_shift($copy);
                        }
                    }
                }
            }
            $form['value'] = array(
                '#type' => 'select',
                '#title' => $this->options['limit'] ? t('Select terms from vocabulary @voc', array(
                    '@voc' => $vocabulary->name,
                )) : t('Select terms'),
                '#multiple' => TRUE,
                '#options' => $options,
                '#size' => min(9, count($options)),
                '#default_value' => $default_value,
            );
            if (!empty($form_state['exposed']) && isset($identifier) && !isset($form_state['input'][$identifier])) {
                $form_state['input'][$identifier] = $default_value;
            }
        }
        if (empty($form_state['exposed'])) {
            // Retain the helper option
            $this->helper
                ->options_form($form, $form_state);
        }
    }
    function value_validate($form, &$form_state) {
        // We only validate if they've chosen the text field style.
        if ($this->options['type'] != 'textfield') {
            return;
        }
        $values = drupal_explode_tags($form_state['values']['options']['value']);
        $tids = $this->validate_term_strings($form['value'], $values);
        if ($tids) {
            $form_state['values']['options']['value'] = $tids;
        }
    }
    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 (isset($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 optional and there's no value don't bother filtering.
        if ($this->options['expose']['optional'] && 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'];
        // We only validate if they've chosen the text field style.
        if ($this->options['type'] != 'textfield') {
            if ($form_state['values'][$identifier] != 'All') {
                $this->validated_exposed_input = (array) $form_state['values'][$identifier];
            }
            return;
        }
        if (empty($this->options['expose']['identifier'])) {
            return;
        }
        $values = drupal_explode_tags($form_state['values'][$identifier]);
        $tids = $this->validate_term_strings($form[$identifier], $values);
        if ($tids) {
            $this->validated_exposed_input = $tids;
        }
    }
    
    /**
     * 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.
     */
    function validate_term_strings(&$form, $values) {
        if (empty($values)) {
            return array();
        }
        $tids = array();
        $placeholders = array();
        $args = array();
        $results = array();
        foreach ($values as $value) {
            $missing[strtolower($value)] = TRUE;
            $args[] = $value;
            $placeholders[] = "'%s'";
        }
        if (!$args) {
            return;
        }
        // add the taxonomy vid to the argument list.
        $args[] = $this->options['vid'];
        $result = db_query("SELECT * FROM {term_data} td WHERE td.name IN (" . implode(', ', $placeholders) . ") AND td.vid = %d", $args);
        while ($term = db_fetch_object($result)) {
            unset($missing[strtolower($term->name)]);
            $tids[] = $term->tid;
        }
        if ($missing && !empty($this->options['error_message'])) {
            form_error($form, format_plural(count($missing), 'Unable to find term: @terms', 'Unable to find terms: @terms', array(
                '@terms' => implode(', ', array_keys($missing)),
            )));
        }
        elseif ($missing && empty($this->options['error_message'])) {
            $tids = array(
                0,
            );
        }
        return $tids;
    }
    function value_submit($form, &$form_state) {
        // prevent array_filter from messing up our arrays in parent submit.
    }
    function expose_form_right(&$form, &$form_state) {
        parent::expose_form_right($form, $form_state);
        if ($this->options['type'] != 'select') {
            unset($form['expose']['reduce']);
        }
        $form['error_message'] = array(
            '#type' => 'checkbox',
            '#title' => t('Display error message'),
            '#default_value' => !empty($this->options['error_message']),
        );
    }
    function admin_summary() {
        // set up $this->value_options for the parent summary
        $this->value_options = array();
        if ($this->value) {
            $result = db_query("SELECT * FROM {term_data} td WHERE td.tid IN (" . implode(', ', $this->value) . ")");
            while ($term = db_fetch_object($result)) {
                $this->value_options[$term->tid] = $term->name;
            }
        }
        return parent::admin_summary();
    }

}

Classes

Title Deprecated Summary
views_handler_filter_term_node_tid Filter by term id.