class views_plugin_argument_default_taxonomy_tid

Taxonomy tid default argument.

Hierarchy

Expanded class hierarchy of views_plugin_argument_default_taxonomy_tid

2 string references to 'views_plugin_argument_default_taxonomy_tid'
hook_views_plugins in ./views.api.php
Describes plugins defined by the module.
taxonomy_views_plugins in modules/taxonomy.views.inc
Implements hook_views_plugins().

File

modules/taxonomy/views_plugin_argument_default_taxonomy_tid.inc, line 11

View source
class views_plugin_argument_default_taxonomy_tid extends views_plugin_argument_default {
    
    /**
     * {@inheritdoc}
     */
    public function init(&$view, &$argument, $options) {
        parent::init($view, $argument, $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['term_page'] = array(
            'default' => TRUE,
            'bool' => TRUE,
        );
        $options['node'] = array(
            'default' => FALSE,
            'bool' => TRUE,
        );
        $options['anyall'] = array(
            'default' => ',',
        );
        $options['limit'] = array(
            'default' => FALSE,
            'bool' => TRUE,
        );
        $options['vocabularies'] = array(
            'default' => array(),
        );
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function options_form(&$form, &$form_state) {
        $form['term_page'] = array(
            '#type' => 'checkbox',
            '#title' => t('Load default filter from term page'),
            '#default_value' => $this->options['term_page'],
        );
        $form['node'] = array(
            '#type' => 'checkbox',
            '#title' => t('Load default filter from node page, that\'s good for related taxonomy blocks'),
            '#default_value' => $this->options['node'],
        );
        $form['limit'] = array(
            '#type' => 'checkbox',
            '#title' => t('Limit terms by vocabulary'),
            '#default_value' => $this->options['limit'],
            '#process' => array(
                'form_process_checkbox',
                'ctools_dependent_process',
            ),
            '#dependency' => array(
                'edit-options-argument-default-taxonomy-tid-node' => array(
                    1,
                ),
            ),
        );
        $options = array();
        $vocabularies = taxonomy_get_vocabularies();
        foreach ($vocabularies as $voc) {
            $options[$voc->machine_name] = check_plain($voc->name);
        }
        $form['vocabularies'] = array(
            '#prefix' => '<div><div id="edit-options-vids">',
            '#suffix' => '</div></div>',
            '#type' => 'checkboxes',
            '#title' => t('Vocabularies'),
            '#options' => $options,
            '#default_value' => $this->options['vocabularies'],
            '#process' => array(
                'form_process_checkboxes',
                'ctools_dependent_process',
            ),
            '#dependency' => array(
                'edit-options-argument-default-taxonomy-tid-limit' => array(
                    1,
                ),
                'edit-options-argument-default-taxonomy-tid-node' => array(
                    1,
                ),
            ),
        );
        $form['anyall'] = array(
            '#type' => 'radios',
            '#title' => t('Multiple-value handling'),
            '#default_value' => $this->options['anyall'],
            '#process' => array(
                'form_process_radios',
                'ctools_dependent_process',
            ),
            '#options' => array(
                ',' => t('Filter to items that share all terms'),
                '+' => t('Filter to items that share any term'),
            ),
            '#dependency' => array(
                'edit-options-argument-default-taxonomy-tid-node' => array(
                    1,
                ),
            ),
        );
    }
    
    /**
     * {@inheritdoc}
     */
    public function options_submit(&$form, &$form_state, &$options = array()) {
        // Filter unselected items so we don't unnecessarily store giant arrays.
        $options['vocabularies'] = array_filter($options['vocabularies']);
    }
    
    /**
     * {@inheritdoc}
     */
    public function get_argument() {
        // Load default argument from taxonomy page.
        if (!empty($this->options['term_page'])) {
            if (arg(0) == 'taxonomy' && arg(1) == 'term' && is_numeric(arg(2))) {
                return arg(2);
            }
        }
        // Load default argument from node.
        if (!empty($this->options['node'])) {
            foreach (range(1, 3) as $i) {
                $node = menu_get_object('node', $i);
                if (!empty($node)) {
                    break;
                }
            }
            // Just check, if a node could be detected.
            if ($node) {
                $taxonomy = array();
                $fields = field_info_instances('node', $node->type);
                foreach ($fields as $name => $info) {
                    $field_info = field_info_field($name);
                    if ($field_info['type'] == 'taxonomy_term_reference') {
                        $items = field_get_items('node', $node, $name);
                        if (is_array($items)) {
                            foreach ($items as $item) {
                                $taxonomy[$item['tid']] = $field_info['settings']['allowed_values'][0]['vocabulary'];
                            }
                        }
                    }
                }
                if (!empty($this->options['limit'])) {
                    $tids = array();
                    // Filter by vocabulary.
                    foreach ($taxonomy as $tid => $vocab) {
                        if (!empty($this->options['vocabularies'][$vocab])) {
                            $tids[] = $tid;
                        }
                    }
                    return implode($this->options['anyall'], $tids);
                }
                else {
                    return implode($this->options['anyall'], array_keys($taxonomy));
                }
            }
        }
        // If the current page is a view that takes tid as an argument,
        // find the tid argument and return it.
        $views_page = views_get_page_view();
        if ($views_page && isset($views_page->argument['tid'])) {
            return $views_page->argument['tid']->argument;
        }
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
views_object::$definition public property Handler&#039;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&#039;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&#039;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
views_plugin::$display public property The current used views display.
views_plugin::$plugin_name public property The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type public property The plugin type of this plugin, for example style or query.
views_plugin::$view public property The top object of a view. Overrides views_object::$view 1
views_plugin::additional_theme_functions public function Provide a list of additional theme functions for the theme info page.
views_plugin::plugin_title public function Return the human readable name of the display.
views_plugin::query public function Add anything to the query that we might need to. 7
views_plugin::summary_title public function Returns the summary of the settings in the display. 8
views_plugin::theme_functions public function Provide a full list of possible theme templates used by this style.
views_plugin::validate public function Validate that the plugin is correct and can be saved. 3
views_plugin_argument_default::access public function Determine if the administrator has the privileges to use this plugin. 1
views_plugin_argument_default::check_access public function If we don&#039;t have access to the form but are showing it anyway, ensure that
the form is safe and cannot be changed from user input.
views_plugin_argument_default::convert_options public function Convert options from the older style. 3
views_plugin_argument_default::options_validate public function Provide the default form form for validating options. Overrides views_plugin::options_validate
views_plugin_argument_default_taxonomy_tid::get_argument public function Return the default argument. Overrides views_plugin_argument_default::get_argument
views_plugin_argument_default_taxonomy_tid::init public function Initialize this plugin with the view and the argument it is linked to. Overrides views_plugin_argument_default::init
views_plugin_argument_default_taxonomy_tid::options_form public function Provide the default form for setting options. Overrides views_plugin_argument_default::options_form
views_plugin_argument_default_taxonomy_tid::options_submit public function Provide the default form form for submitting options. Overrides views_plugin_argument_default::options_submit
views_plugin_argument_default_taxonomy_tid::option_definition public function Retrieve the options when this is a new access control plugin. Overrides views_plugin_argument_default::option_definition