You are here

Home » API reference » Views arg parent term 7 » views_plugin_argument_default_parent_taxonomy_tid.inc

class views_arg_parent_term_plugin_argument_default_parent_taxonomy_tid in Views arg parent term 7

Parent Taxonomy tid default argument.

Hierarchy

Expanded class hierarchy of views_arg_parent_term_plugin_argument_default_parent_taxonomy_tid

1 string reference to 'views_arg_parent_term_plugin_argument_default_parent_taxonomy_tid'
views_arg_parent_term_views_plugins in ./views_arg_parent_term.views.inc
Implements hook_views_plugins().

File

includes/views_plugin_argument_default_parent_taxonomy_tid.inc, line 11
Definition of views_arg_parent_term_plugin_argument_default_parent_taxonomy_tid.

View source 
class views_arg_parent_term_plugin_argument_default_parent_taxonomy_tid extends views_plugin_argument_default {

  /**
   * Class init method.
   */
  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;
        }
      }
    }
  }

  /**
   * Option definition method.
   */
  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(),
    );
    $options['root_parent'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
    $options['root_term_page'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
    $options['term_page_anyall'] = array(
      'default' => ',',
    );
    return $options;
  }

  /**
   * Form builder method.
   */
  function options_form(&$form, &$form_state) {
    $form['term_page'] = array(
      '#type' => 'checkbox',
      '#title' => t('Load default filter from term page. It will get parent terms of current term page.'),
      '#default_value' => $this->options['term_page'],
    );
    $form['root_term_page'] = array(
      '#type' => 'checkbox',
      '#title' => t("Get term's parents to root parent term"),
      '#default_value' => $this->options['root_term_page'],
      '#process' => array(
        'ctools_dependent_process',
        'form_process_checkbox',
      ),
      '#dependency' => array(
        'edit-options-argument-default-taxonomy-parent-tid-term-page' => array(
          1,
        ),
      ),
    );
    $form['term_page_anyall'] = array(
      '#type' => 'radios',
      '#title' => t('Multiple-value handling'),
      '#default_value' => $this->options['term_page_anyall'],
      '#process' => array(
        'ctools_dependent_process',
        'form_process_radios',
      ),
      '#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-parent-tid-term-page' => array(
          1,
        ),
      ),
    );
    $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['root_parent'] = array(
      '#type' => 'checkbox',
      '#title' => t("Get term's parents to root parent term"),
      '#default_value' => $this->options['root_parent'],
      '#process' => array(
        'ctools_dependent_process',
        'form_process_checkbox',
      ),
      '#dependency' => array(
        'edit-options-argument-default-taxonomy-parent-tid-node' => array(
          1,
        ),
      ),
    );
    $form['limit'] = array(
      '#type' => 'checkbox',
      '#title' => t('Limit terms by vocabulary'),
      '#default_value' => $this->options['limit'],
      '#process' => array(
        'ctools_dependent_process',
        'form_process_checkbox',
      ),
      '#dependency' => array(
        'edit-options-argument-default-taxonomy-parent-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(
        'ctools_dependent_process',
        'form_process_checkboxes',
      ),
      '#dependency' => array(
        'edit-options-argument-default-taxonomy-parent-tid-limit' => array(
          1,
        ),
        'edit-options-argument-default-taxonomy-parent-tid-node' => array(
          1,
        ),
      ),
    );
    $form['anyall'] = array(
      '#type' => 'radios',
      '#title' => t('Multiple-value handling'),
      '#default_value' => $this->options['anyall'],
      '#process' => array(
        'ctools_dependent_process',
        'form_process_radios',
      ),
      '#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-parent-tid-node' => array(
          1,
        ),
      ),
    );
  }

  /**
   * Options submit method.
   */
  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']);
  }

  /**
   * Method to get/set views' default arguments.
   */
  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))) {
        $parents = !empty($this->options['root_term_page']) ? taxonomy_get_parents_all(arg(2)) : taxonomy_get_parents(arg(2));
        $taxonomy = array();
        foreach ($parents as $parent) {
          $taxonomy[] = $parent->tid;
        }
        return implode($this->options['term_page_anyall'], $taxonomy);
      }
    }

    // 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) {
                $parents = !empty($this->options['root_parent']) ? taxonomy_get_parents_all($item['tid']) : taxonomy_get_parents($item['tid']);
                foreach ($parents as $parent) {
                  $taxonomy[$parent->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

Namesort descending Modifiers Type Description Overrides
views_arg_parent_term_plugin_argument_default_parent_taxonomy_tid::get_argument function Method to get/set views' default arguments. Overrides views_plugin_argument_default::get_argument
views_arg_parent_term_plugin_argument_default_parent_taxonomy_tid::init function Class init method. Overrides views_plugin_argument_default::init
views_arg_parent_term_plugin_argument_default_parent_taxonomy_tid::options_form function Form builder method. Overrides views_plugin_argument_default::options_form
views_arg_parent_term_plugin_argument_default_parent_taxonomy_tid::options_submit function Options submit method. Overrides views_plugin_argument_default::options_submit
views_arg_parent_term_plugin_argument_default_parent_taxonomy_tid::option_definition function Option definition method. Overrides views_plugin_argument_default::option_definition
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 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
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'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