views_handler_relationship_node_term_data.inc

<?php


/**
 * @file
 * Definition of views_handler_relationship_node_term_data.
 */

/**
 * Relationship handler to return the taxonomy terms of nodes.
 *
 * @ingroup views_relationship_handlers
 */
class views_handler_relationship_node_term_data extends views_handler_relationship {
    
    /**
     * {@inheritdoc}
     */
    public function init(&$view, &$options) {
        parent::init($view, $options);
        // Convert legacy vids option to machine name vocabularies.
        if (!empty($this->options['vids'])) {
            $vocabularies = taxonomy_get_vocabularies();
            foreach ($this->options['vids'] as $vid) {
                if (isset($vocabularies[$vid], $vocabularies[$vid]->machine_name)) {
                    $this->options['vocabularies'][$vocabularies[$vid]->machine_name] = $vocabularies[$vid]->machine_name;
                }
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        $options['vocabularies'] = array(
            'default' => array(),
        );
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function options_form(&$form, &$form_state) {
        $vocabularies = taxonomy_get_vocabularies();
        $options = array();
        foreach ($vocabularies as $voc) {
            $options[$voc->machine_name] = check_plain($voc->name);
        }
        $form['vocabularies'] = array(
            '#type' => 'checkboxes',
            '#title' => t('Vocabularies'),
            '#options' => $options,
            '#default_value' => $this->options['vocabularies'],
            '#description' => t('Choose which vocabularies you wish to relate. Remember that every term found will create a new record, so this relationship is best used on just one vocabulary that has only one term per node.'),
        );
        parent::options_form($form, $form_state);
    }
    
    /**
     * Called to implement a relationship in a query.
     */
    public function query() {
        $this->ensure_my_table();
        $def = $this->definition;
        $def['table'] = 'taxonomy_term_data';
        if (!array_filter($this->options['vocabularies'])) {
            $taxonomy_index = $this->query
                ->add_table('taxonomy_index', $this->relationship);
            $def['left_table'] = $taxonomy_index;
            $def['left_field'] = 'tid';
            $def['field'] = 'tid';
            $def['type'] = empty($this->options['required']) ? 'LEFT' : 'INNER';
        }
        else {
            // If vocabularies are supplied join a subselect instead.
            $def['left_table'] = $this->table_alias;
            $def['left_field'] = 'nid';
            $def['field'] = 'nid';
            $def['type'] = empty($this->options['required']) ? 'LEFT' : 'INNER';
            $query = db_select('taxonomy_term_data', 'td');
            $query->addJoin($def['type'], 'taxonomy_vocabulary', 'tv', 'td.vid = tv.vid');
            $query->addJoin($def['type'], 'taxonomy_index', 'tn', 'tn.tid = td.tid');
            $query->condition('tv.machine_name', array_filter($this->options['vocabularies']));
            if (empty($this->query->options['disable_sql_rewrite'])) {
                $query->addTag('taxonomy_term_access');
            }
            $query->fields('td');
            $query->fields('tn', array(
                'nid',
            ));
            $def['table formula'] = $query;
        }
        $join = new views_join();
        $join->definition = $def;
        $join->construct();
        $join->adjusted = TRUE;
        // Use a short alias for this.
        $alias = $def['table'] . '_' . $this->table;
        $this->alias = $this->query
            ->add_relationship($alias, $join, 'taxonomy_term_data', $this->relationship);
    }

}