class views_plugin_argument_default_taxonomy_tid in Views (for Drupal 7) 6.2

@file Taxonomy tid default argument.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_argument_default
      • class \views_plugin_argument_default_taxonomy_tid

1 string reference to 'views_plugin_argument_default_taxonomy_tid'

taxonomy_views_plugins in modules/taxonomy.views.inc

Implementation of hook_views_plugins

File

modules/taxonomy/views_plugin_argument_default_taxonomy_tid.inc, line 7

Taxonomy tid default argument.

class views_plugin_argument_default_taxonomy_tid extends views_plugin_argument_default {
  var $option_name = 'default_taxonomy_tid';
  function option_definition() {
    $options = parent::option_definition();
    $options[$this->option_name . '_term_page'] = array(
      'default' => TRUE,
    );
    $options[$this->option_name . '_node'] = array(
      'default' => FALSE,
    );
    $options[$this->option_name . '_limit'] = array(
      'default' => FALSE,
    );
    $options[$this->option_name . '_vids'] = array(
      'default' => array(),
    );
    return $options;
  }
  function argument_form(&$form, &$form_state) {
    $form[$this->option_name . '_term_page'] = array(
      '#type' => 'checkbox',
      '#title' => t('Load default argument from term page'),
      '#default_value' => $this->argument->options[$this->option_name . '_term_page'],
      '#process' => array(
        'views_process_dependency',
      ),
      '#dependency' => array(
        'radio:options[default_action]' => array(
          'default',
        ),
        'radio:options[default_argument_type]' => array(
          $this->id,
        ),
      ),
      '#dependency_count' => 2,
    );
    $form[$this->option_name . '_node'] = array(
      '#type' => 'checkbox',
      '#title' => t('Load default argument from node page, thats good for related taxonomy blocks'),
      '#default_value' => $this->argument->options[$this->option_name . '_node'],
      '#process' => array(
        'views_process_dependency',
      ),
      '#dependency' => array(
        'radio:options[default_action]' => array(
          'default',
        ),
        'radio:options[default_argument_type]' => array(
          $this->id,
        ),
      ),
      '#dependency_count' => 2,
    );
    $form[$this->option_name . '_limit'] = array(
      '#type' => 'checkbox',
      '#title' => t('Limit terms by vocabulary'),
      '#default_value' => $this->argument->options[$this->option_name . '_limit'],
      '#process' => array(
        'views_process_dependency',
      ),
      '#dependency' => array(
        'radio:options[default_action]' => array(
          'default',
        ),
        'radio:options[default_argument_type]' => array(
          $this->id,
        ),
        'edit-options-default-taxonomy-tid-node' => array(
          1,
        ),
      ),
      '#dependency_count' => 3,
    );
    $options = array();
    $vocabularies = taxonomy_get_vocabularies();
    foreach ($vocabularies as $voc) {
      $options[$voc->vid] = check_plain($voc->name);
    }
    $form[$this->option_name . '_vids'] = array(
      '#prefix' => '<div><div id="edit-options-default-taxonomy-tid-vids-wrapper">',
      '#suffix' => '</div></div>',
      '#type' => 'checkboxes',
      '#title' => t('Vocabularies'),
      '#description' => t('If you wish to limit terms for specific vocabularies, check them; if none are checked, all terms will be included.'),
      '#options' => $options,
      '#default_value' => isset($this->argument->options[$this->option_name . '_vids']) ? $this->argument->options[$this->option_name . '_vids'] : array(),
      '#process' => array(
        'expand_checkboxes',
        'views_process_dependency',
      ),
      '#dependency' => array(
        'radio:options[default_action]' => array(
          'default',
        ),
        'radio:options[default_argument_type]' => array(
          $this->id,
        ),
        'edit-options-default-taxonomy-tid-limit' => array(
          1,
        ),
        'edit-options-default-taxonomy-tid-node' => array(
          1,
        ),
      ),
      '#dependency_count' => 4,
    );
  }
  function get_argument() {

    // Load default argument from taxonomy page.
    if (!empty($this->argument->options[$this->option_name . '_term_page'])) {
      if (arg(0) == 'taxonomy' && arg(1) == 'term' && is_numeric(arg(2))) {
        return arg(2);
      }
    }

    // Load default argument from node.
    if (!empty($this->argument->options[$this->option_name . '_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) {
        if (!empty($this->argument->options[$this->option_name . '_limit'])) {
          $tids = array();

          // Filter by vid.
          foreach ($node->taxonomy as $tid => $term) {
            if (!empty($this->argument->options[$this->option_name . '_vids'][$term->vid])) {
              $tids[] = $tid;
            }
          }
          return implode(",", $tids);
        }
        else {
          return implode(",", array_keys($node->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->view->argument['tid'])) {
      return $views_page->view->argument['tid']->argument;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
views_object::$options		property	Except for displays, options for the object will be held here.	1
views_object::construct		function	Views handlers use a special construct function so that we can more easily construct them with variable arguments.	5
views_object::destroy		function		2
views_object::options		function	Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.	1
views_object::set_default_options		function	Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.
views_object::set_definition		function	Let the handler know what its full definition is.
views_object::unpack_options		function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::_set_option_defaults		function		1
views_plugin::additional_theme_functions		function	Provide a list of additional theme functions for the theme information page
views_plugin::options_form		function	Provide a form to edit options for this plugin.	5
views_plugin::options_submit		function	Handle any special handling on the validate form.	3
views_plugin::options_validate		function	Validate the options form.	3
views_plugin::query		function	Add anything to the query that we might need to.	3
views_plugin::theme_functions		function	Provide a full list of possible theme templates used by this style.
views_plugin::validate		function	Validate that the plugin is correct and can be saved.	2
views_plugin_argument_default::access		function	Determine if the administrator has the privileges to use this plugin	1
views_plugin_argument_default::check_access		function	If we don'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::init		function	Initialize this plugin with the view and the argument it is linked to. Overrides views_plugin::init
views_plugin_argument_default_taxonomy_tid::$option_name		property	Overrides views_plugin_argument_default::$option_name
views_plugin_argument_default_taxonomy_tid::argument_form		function	Overrides views_plugin_argument_default::argument_form
views_plugin_argument_default_taxonomy_tid::get_argument		function	Return the default argument. Overrides views_plugin_argument_default::get_argument
views_plugin_argument_default_taxonomy_tid::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_object::option_definition