class TaxonomyIndexTid

Same name in this branch

Filter by term id.

Plugin annotation

@PluginID("taxonomy_index_tid");

Hierarchy

Expanded class hierarchy of TaxonomyIndexTid

Related topics

File

drupal/core/modules/taxonomy/lib/Drupal/taxonomy/Plugin/views/filter/TaxonomyIndexTid.php, line 22
Definition of views_handler_filter_term_node_tid.

Namespace

Drupal\taxonomy\Plugin\views\filter
View source
class TaxonomyIndexTid extends ManyToOne {

  // Stores the exposed input for this filter.
  var $validated_exposed_input = NULL;

  /**
   * Overrides \Drupal\views\Plugin\views\filter\ManyToOne::init().
   */
  public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
    parent::init($view, $display, $options);
    if (!empty($this->definition['vocabulary'])) {
      $this->options['vid'] = $this->definition['vocabulary'];
    }
  }
  public function hasExtraOptions() {
    return TRUE;
  }
  public function getValueOptions() {

    /* don't overwrite the value options */
  }
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['type'] = array(
      'default' => 'textfield',
    );
    $options['limit'] = array(
      'default' => TRUE,
      'bool' => TRUE,
    );
    $options['vid'] = array(
      'default' => '',
    );
    $options['hierarchy'] = array(
      'default' => 0,
    );
    $options['error_message'] = array(
      'default' => TRUE,
      'bool' => TRUE,
    );
    return $options;
  }
  public function buildExtraOptionsForm(&$form, &$form_state) {
    $vocabularies = entity_load_multiple('taxonomy_vocabulary');
    $options = array();
    foreach ($vocabularies as $voc) {
      $options[$voc
        ->id()] = $voc
        ->label();
    }
    if ($this->options['limit']) {

      // We only do this when the form is displayed.
      if (empty($this->options['vid'])) {
        $first_vocabulary = reset($vocabularies);
        $this->options['vid'] = $first_vocabulary
          ->id();
      }
      if (empty($this->definition['vocabulary'])) {
        $form['vid'] = array(
          '#type' => 'radios',
          '#title' => t('Vocabulary'),
          '#options' => $options,
          '#description' => t('Select which vocabulary to show terms for in the regular options.'),
          '#default_value' => $this->options['vid'],
        );
      }
    }
    $form['type'] = array(
      '#type' => 'radios',
      '#title' => t('Selection type'),
      '#options' => array(
        'select' => t('Dropdown'),
        'textfield' => t('Autocomplete'),
      ),
      '#default_value' => $this->options['type'],
    );
    $form['hierarchy'] = array(
      '#type' => 'checkbox',
      '#title' => t('Show hierarchy in dropdown'),
      '#default_value' => !empty($this->options['hierarchy']),
      '#states' => array(
        'visible' => array(
          ':input[name="options[type]"]' => array(
            'value' => 'select',
          ),
        ),
      ),
    );
  }
  protected function valueForm(&$form, &$form_state) {
    $vocabulary = entity_load('taxonomy_vocabulary', $this->options['vid']);
    if (empty($vocabulary) && $this->options['limit']) {
      $form['markup'] = array(
        '#markup' => '<div class="form-item">' . t('An invalid vocabulary is selected. Please change it in the options.') . '</div>',
      );
      return;
    }
    if ($this->options['type'] == 'textfield') {
      $default = '';
      if ($this->value) {
        $result = db_select('taxonomy_term_data', 'td')
          ->fields('td')
          ->condition('td.tid', $this->value)
          ->execute();
        foreach ($result as $term) {
          if ($default) {
            $default .= ', ';
          }
          $default .= $term->name;
        }
      }
      $form['value'] = array(
        '#title' => $this->options['limit'] ? t('Select terms from vocabulary @voc', array(
          '@voc' => $vocabulary
            ->label(),
        )) : t('Select terms'),
        '#type' => 'textfield',
        '#default_value' => $default,
      );
      if ($this->options['limit']) {
        $form['value']['#autocomplete_path'] = 'admin/views/ajax/autocomplete/taxonomy/' . $vocabulary
          ->id();
      }
    }
    else {
      if (!empty($this->options['hierarchy']) && $this->options['limit']) {
        $tree = taxonomy_get_tree($vocabulary
          ->id());
        $options = array();
        if ($tree) {
          foreach ($tree as $term) {
            $choice = new stdClass();
            $choice->option = array(
              $term->tid => str_repeat('-', $term->depth) . $term->name,
            );
            $options[] = $choice;
          }
        }
      }
      else {
        $options = array();
        $query = db_select('taxonomy_term_data', 'td');
        $query
          ->fields('td');

        // @todo Sorting on vocabulary properties http://drupal.org/node/1821274
        $query
          ->orderby('td.weight');
        $query
          ->orderby('td.name');
        $query
          ->addTag('term_access');
        if ($this->options['limit']) {
          $query
            ->condition('td.vid', $vocabulary
            ->id());
        }
        $result = $query
          ->execute();
        foreach ($result as $term) {
          $options[$term->tid] = $term->name;
        }
      }
      $default_value = (array) $this->value;
      if (!empty($form_state['exposed'])) {
        $identifier = $this->options['expose']['identifier'];
        if (!empty($this->options['expose']['reduce'])) {
          $options = $this
            ->reduceValueOptions($options);
          if (!empty($this->options['expose']['multiple']) && empty($this->options['expose']['required'])) {
            $default_value = array();
          }
        }
        if (empty($this->options['expose']['multiple'])) {
          if (empty($this->options['expose']['required']) && (empty($default_value) || !empty($this->options['expose']['reduce']))) {
            $default_value = 'All';
          }
          elseif (empty($default_value)) {
            $keys = array_keys($options);
            $default_value = array_shift($keys);
          }
          elseif ($default_value == array(
            '',
          )) {
            $default_value = 'All';
          }
          else {
            $copy = $default_value;
            $default_value = array_shift($copy);
          }
        }
      }
      $form['value'] = array(
        '#type' => 'select',
        '#title' => $this->options['limit'] ? t('Select terms from vocabulary @voc', array(
          '@voc' => $vocabulary
            ->label(),
        )) : t('Select terms'),
        '#multiple' => TRUE,
        '#options' => $options,
        '#size' => min(9, count($options)),
        '#default_value' => $default_value,
      );
      if (!empty($form_state['exposed']) && isset($identifier) && !isset($form_state['input'][$identifier])) {
        $form_state['input'][$identifier] = $default_value;
      }
    }
    if (empty($form_state['exposed'])) {

      // Retain the helper option
      $this->helper
        ->buildOptionsForm($form, $form_state);
    }
  }
  protected function valueValidate($form, &$form_state) {

    // We only validate if they've chosen the text field style.
    if ($this->options['type'] != 'textfield') {
      return;
    }
    $values = drupal_explode_tags($form_state['values']['options']['value']);
    $tids = $this
      ->validate_term_strings($form['value'], $values);
    if ($tids) {
      $form_state['values']['options']['value'] = $tids;
    }
  }
  public function acceptExposedInput($input) {
    if (empty($this->options['exposed'])) {
      return TRUE;
    }

    // If view is an attachment and is inheriting exposed filters, then assume
    // exposed input has already been validated
    if (!empty($this->view->is_attachment) && $this->view->display_handler
      ->usesExposed()) {
      $this->validated_exposed_input = (array) $this->view->exposed_raw_input[$this->options['expose']['identifier']];
    }

    // If it's non-required and there's no value don't bother filtering.
    if (!$this->options['expose']['required'] && empty($this->validated_exposed_input)) {
      return FALSE;
    }
    $rc = parent::acceptExposedInput($input);
    if ($rc) {

      // If we have previously validated input, override.
      if (isset($this->validated_exposed_input)) {
        $this->value = $this->validated_exposed_input;
      }
    }
    return $rc;
  }
  public function validateExposed(&$form, &$form_state) {
    if (empty($this->options['exposed'])) {
      return;
    }
    $identifier = $this->options['expose']['identifier'];

    // We only validate if they've chosen the text field style.
    if ($this->options['type'] != 'textfield') {
      if ($form_state['values'][$identifier] != 'All') {
        $this->validated_exposed_input = (array) $form_state['values'][$identifier];
      }
      return;
    }
    if (empty($this->options['expose']['identifier'])) {
      return;
    }
    $values = drupal_explode_tags($form_state['values'][$identifier]);
    $tids = $this
      ->validate_term_strings($form[$identifier], $values);
    if ($tids) {
      $this->validated_exposed_input = $tids;
    }
  }

  /**
   * Validate the user string. Since this can come from either the form
   * or the exposed filter, this is abstracted out a bit so it can
   * handle the multiple input sources.
   *
   * @param $form
   *   The form which is used, either the views ui or the exposed filters.
   * @param $values
   *   The taxonomy names which will be converted to tids.
   *
   * @return array
   *   The taxonomy ids fo all validated terms.
   */
  function validate_term_strings(&$form, $values) {
    if (empty($values)) {
      return array();
    }
    $tids = array();
    $names = array();
    $missing = array();
    foreach ($values as $value) {
      $missing[strtolower($value)] = TRUE;
      $names[] = $value;
    }
    if (!$names) {
      return FALSE;
    }
    $query = db_select('taxonomy_term_data', 'td');
    $query
      ->fields('td');
    $query
      ->condition('td.name', $names);
    $query
      ->condition('td.vid', $this->options['vid']);
    $query
      ->addTag('term_access');
    $result = $query
      ->execute();
    foreach ($result as $term) {
      unset($missing[strtolower($term->name)]);
      $tids[] = $term->tid;
    }
    if ($missing && !empty($this->options['error_message'])) {
      form_error($form, format_plural(count($missing), 'Unable to find term: @terms', 'Unable to find terms: @terms', array(
        '@terms' => implode(', ', array_keys($missing)),
      )));
    }
    elseif ($missing && empty($this->options['error_message'])) {
      $tids = array(
        0,
      );
    }
    return $tids;
  }
  protected function valueSubmit($form, &$form_state) {

    // prevent array_filter from messing up our arrays in parent submit.
  }
  public function buildExposeForm(&$form, &$form_state) {
    parent::buildExposeForm($form, $form_state);
    if ($this->options['type'] != 'select') {
      unset($form['expose']['reduce']);
    }
    $form['error_message'] = array(
      '#type' => 'checkbox',
      '#title' => t('Display error message'),
      '#default_value' => !empty($this->options['error_message']),
    );
  }
  public function adminSummary() {

    // set up $this->value_options for the parent summary
    $this->value_options = array();
    if ($this->value) {
      $this->value = array_filter($this->value);
      $result = db_select('taxonomy_term_data', 'td')
        ->fields('td')
        ->condition('td.tid', $this->value)
        ->execute();
      foreach ($result as $term) {
        $this->value_options[$term->tid] = $term->name;
      }
    }
    return parent::adminSummary();
  }

}

Members

Name Modifierssort descending Type Description Overrides
TaxonomyIndexTid::validate_term_strings function Validate the user string. Since this can come from either the form or the exposed filter, this is abstracted out a bit so it can handle the multiple input sources.
ManyToOne::operators function This kind of construct makes it relatively easy for a child class to add or remove functionality by overriding this function and adding/removing items from this array. Overrides InOperator::operators 1
TaxonomyIndexTid::$validated_exposed_input property
ManyToOne::$helper property Stores the Helper object which handles the many_to_one complexity.
ManyToOne::$value_form_type property Overrides InOperator::$value_form_type
InOperator::$value_options property Stores all operations which are available on the form.
FilterPluginBase::$value property Contains the actual value of the field,either configured in the views ui or entered in the exposed filters.
FilterPluginBase::$operator property Contains the operator which is used on the query.
FilterPluginBase::$group_info property Contains the information of the selected item in a gruped filter.
FilterPluginBase::$always_multiple property Disable the possibility to force a single value. 6
FilterPluginBase::$no_operator property Disable the possibility to use operators. 2
FilterPluginBase::$always_required property Disable the possibility to allow a exposed input to be optional.
TaxonomyIndexTid::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides ManyToOne::defineOptions 1
TaxonomyIndexTid::valueForm protected function Options form subform for setting options. Overrides ManyToOne::valueForm
TaxonomyIndexTid::valueValidate protected function Validate the options form. Overrides FilterPluginBase::valueValidate
TaxonomyIndexTid::valueSubmit protected function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides InOperator::valueSubmit
ManyToOne::opHelper protected function
InOperator::operatorValues protected function
InOperator::opSimple protected function
InOperator::opEmpty protected function
FilterPluginBase::canBuildGroup protected function Determine if a filter can be converted into a group. Only exposed filters with operators available can be converted into groups.
FilterPluginBase::operatorForm protected function Options form subform for setting the operator. 4
FilterPluginBase::operatorValidate protected function Validate the operator form.
FilterPluginBase::showValueForm protected function Shortcut to display the value form.
FilterPluginBase::showBuildGroupButton protected function Shortcut to display the build_group/hide button.
FilterPluginBase::buildGroupValidate protected function Validate the build group options form. 1
FilterPluginBase::buildGroupSubmit protected function Save new group items, re-enumerates and remove groups marked to delete.
FilterPluginBase::buildGroupOptions protected function Provide default options for exposed filters.
FilterPluginBase::buildExposedFiltersGroupForm protected function Build the form to let users create the group of exposed filters. This form is displayed when users click on button 'Build group'
FilterPluginBase::exposedTranslate protected function Make some translations to a form item to make it more suitable to exposing.
FilterPluginBase::prepareFilterSelectOptions protected function Sanitizes the HTML select element's options.
HandlerBase::caseTransform protected function Transform a string by a certain method.
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
FilterPluginBase::arrayFilterZero protected static function Filter by no empty values, though allow to use "0".
TaxonomyIndexTid::init public function Overrides \Drupal\views\Plugin\views\filter\ManyToOne::init(). Overrides ManyToOne::init
TaxonomyIndexTid::hasExtraOptions public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. Overrides HandlerBase::hasExtraOptions
TaxonomyIndexTid::getValueOptions public function Child classes should be used to override this function and set the 'value options', unless 'options callback' is defined as a valid function or static public method to generate these values. Overrides InOperator::getValueOptions
TaxonomyIndexTid::buildExtraOptionsForm public function Provide a form for setting options. Overrides HandlerBase::buildExtraOptionsForm 1
TaxonomyIndexTid::acceptExposedInput public function Check to see if input from the exposed filters should change the behavior of this filter. Overrides InOperator::acceptExposedInput
TaxonomyIndexTid::validateExposed public function Validate the exposed handler form Overrides HandlerBase::validateExposed
TaxonomyIndexTid::buildExposeForm public function Options form subform for exposed filter options. Overrides InOperator::buildExposeForm
TaxonomyIndexTid::adminSummary public function Display the filter on the administrative summary Overrides InOperator::adminSummary
ManyToOne::ensureMyTable public function Override ensureMyTable so we can control how this joins in. The operator actually has influence over joining. Overrides HandlerBase::ensureMyTable
InOperator::defaultExposeOptions public function Provide default options for exposed filters. Overrides FilterPluginBase::defaultExposeOptions
InOperator::operatorOptions public function Build strings from the operators() for 'select' options Overrides FilterPluginBase::operatorOptions 1
InOperator::reduceValueOptions public function When using exposed filters, we may be required to reduce the set.
InOperator::query public function Add this filter to the query. Overrides FilterPluginBase::query 4
InOperator::validate public function Validates the handler against the complete View. Overrides HandlerBase::validate
FilterPluginBase::canExpose public function Determine if a filter can be exposed. Overrides HandlerBase::canExpose 2
FilterPluginBase::isAGroup public function Returns TRUE if the exposed filter works like a grouped filter. Overrides HandlerBase::isAGroup
FilterPluginBase::buildOptionsForm public function Provide the basic form which calls through to subforms. If overridden, it is best to call through to the parent, or to at least make sure all of the functions in this form are called. Overrides HandlerBase::buildOptionsForm 3
FilterPluginBase::validateOptionsForm public function Simple validate handler Overrides HandlerBase::validateOptionsForm 1
FilterPluginBase::submitOptionsForm public function Simple submit handler Overrides HandlerBase::submitOptionsForm
FilterPluginBase::showOperatorForm public function Shortcut to display the operator form.
FilterPluginBase::operatorSubmit 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.
FilterPluginBase::showBuildGroupForm public function Shortcut to display the exposed options form.
FilterPluginBase::buildGroupForm public function Displays the Build Group form.
FilterPluginBase::showExposeButton public function Shortcut to display the expose/hide button. Overrides HandlerBase::showExposeButton
FilterPluginBase::validateExposeForm public function Validate the options form. Overrides HandlerBase::validateExposeForm
FilterPluginBase::groupForm public function Build a form containing a group of operator | values to apply as a single filter.
FilterPluginBase::buildExposedForm public function Render our chunk of the exposed filter form when selecting Overrides HandlerBase::buildExposedForm
FilterPluginBase::addGroupForm public function Add a new group to the exposed filter groups.
FilterPluginBase::exposedInfo public function Tell the renderer about our exposed form. This only needs to be overridden for particularly complex forms. And maybe not even then. Overrides HandlerBase::exposedInfo
FilterPluginBase::convertExposedInput public function
FilterPluginBase::groupMultipleExposedInput public function Returns the options available for a grouped filter that users checkboxes as widget, and therefore has to be applied several times, one per item selected.
FilterPluginBase::multipleExposedInput public function Returns TRUE if users can select multiple groups items of a grouped exposed filter. Overrides HandlerBase::multipleExposedInput
FilterPluginBase::storeGroupInput public function If set to remember exposed input in the session, store it there. This function is similar to storeExposedInput but modified to work properly when the filter is a group.
FilterPluginBase::storeExposedInput public function If set to remember exposed input in the session, store it there. Overrides HandlerBase::storeExposedInput
FilterPluginBase::canGroup public function Can this filter be used in OR groups? 1
HandlerBase::__construct public function Constructs a Handler object. Overrides PluginBase::__construct 3
HandlerBase::adminLabel public function Return a string representing this handler's name in the UI. 9
HandlerBase::getField public function Shortcut to get a handler's raw field value.
HandlerBase::sanitizeValue public function Sanitize the value for output.
HandlerBase::usesGroupBy public function Provides the handler some groupby. 2
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::submitGroupByForm 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
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
HandlerBase::validateExtraOptionsForm public function Validate the options form.
HandlerBase::submitExtraOptionsForm 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.
HandlerBase::submitExposed public function Submit the exposed handler form
HandlerBase::submitExposeForm 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.
HandlerBase::showExposeForm public function Shortcut to display the exposed options form.
HandlerBase::access public function Check whether current user has access to this handler. 6
HandlerBase::preQuery public function Run before the view is built. 1
HandlerBase::postExecute public function Run after the view is executed, before the result is cached.
HandlerBase::setRelationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
HandlerBase::isExposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
HandlerBase::getJoin public function Get the join object that should be used for this handler.
HandlerBase::broken public function Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. 6
HandlerBase::getDateFormat public function Creates cross-database SQL date formatting.
HandlerBase::getDateField public function Creates cross-database SQL dates.
HandlerBase::getEntityType public function Determines the entity type used by this handler.
HandlerBase::displayExposedForm public function Displays the Expose form.
HandlerBase::submitTemporaryForm public function A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests.
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::destroy public function Clears a plugin. 2
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
PluginBase::getPluginId public function Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getPluginDefinition public function Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
HandlerBase::$query public property Where the $query object will reside: 1
HandlerBase::$table public property The table this handler is attached to.
HandlerBase::$tableAlias public property The alias of the table of this handler which is used in the query.
HandlerBase::$actualTable public property When a table has been moved this property is set.
HandlerBase::$realField public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
HandlerBase::$field public property With field you can override the realField if the real field is not set.
HandlerBase::$actualField public property When a field has been moved this property is set.
HandlerBase::$relationship public property The relationship used for this field.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$view public property The top object of a view. 1
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$definition public property Plugins's definition
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache.
HandlerBase::breakPhrase public static function Breaks x,y,z and x+y+z into an array. Numeric only.
HandlerBase::breakPhraseString public static function Breaks x,y,z and x+y+z into an array. Works for strings.
ContainerFactoryPluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11