class views_handler_relationship_node_term_data

Same name in other branches

6.x-3.x modules/taxonomy/views_handler_relationship_node_term_data.inc \views_handler_relationship_node_term_data

Relationship handler to return the taxonomy terms of nodes.

Hierarchy

class \views_object
- class \views_handler extends \views_object
  - class \views_handler_relationship extends \views_handler
    - class \views_handler_relationship_node_term_data extends \views_handler_relationship

Expanded class hierarchy of views_handler_relationship_node_term_data

File

modules/taxonomy/views_handler_relationship_node_term_data.inc, line 13

View source

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);
    }

}

Members

Title Sort descending	Deprecated	Modifiers	Object type	Summary	Overriden Title	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::accept_exposed_input		public	function	Take input from exposed handlers and assign to this handler, if necessary.		1
views_handler::access		public	function	Check whether current user has access to this handler.		10
views_handler::admin_summary		public	function	Provide text for the administrative summary.		4
views_handler::broken		public	function	Determine if the handler is considered 'broken'.		6
views_handler::can_expose		public	function	Determine if a handler can be exposed.		2
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_form		public	function	Render our chunk of the exposed handler form when selecting.		1
views_handler::exposed_info		public	function	Get information about the exposed form for the form renderer.		1
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_form		public	function	Form for exposed handler options.		2
views_handler::expose_options		public	function	Set new exposed option defaults when exposed setting is flipped on.		2
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::expose_validate		public	function	Validate the options form.		1
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_a_group		public	function	Returns TRUE if the exposed filter works like a grouped filter.		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::multiple_exposed_input		public	function	Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets.		1
views_handler::needs_style_plugin		public	function	Determine if the argument needs a style plugin.		1
views_handler::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.		5
views_handler::options_validate		public	function	Validate the options form.		4
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_button		public	function	Shortcut to display the expose/hide button.		2
views_handler::show_expose_form		public	function	Shortcut to display the exposed options form.
views_handler::store_exposed_input		public	function	If set to remember exposed input in the session, store it there.		1
views_handler::ui_name		public	function	Return a string representing this handler's name in the UI.		9
views_handler::validate		public	function	Validates the handler against the complete View.		1
views_handler_relationship::label		public	function	Get this field's label.
views_handler_relationship::use_group_by		public	function	You can't groupby a relationship.	Overrides views_handler::use_group_by
views_handler_relationship_node_term_data::init		public	function	Let relationships live on tables other than the table they operate on.	Overrides views_handler_relationship::init
views_handler_relationship_node_term_data::options_form		public	function	Provide the label widget that all fields should have.	Overrides views_handler_relationship::options_form
views_handler_relationship_node_term_data::option_definition		public	function	Information about options for all kinds of purposes will be held here.	Overrides views_handler_relationship::option_definition
views_handler_relationship_node_term_data::query		public	function	Called to implement a relationship in a query.	Overrides views_handler_relationship::query
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		public	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

class views_handler_relationship_node_term_data

Hierarchy

Related topics

File

Members

Search views 7.x-3.x

API Navigation

Breadcrumb

class views_handler_relationship_node_term_data

Hierarchy

Related topics

File

Members

Search views 7.x-3.x

API Navigation