class TaxonomyIndexTid

Same name in this branch

Field handler to display all taxonomy terms of a node.

Plugin annotation

@PluginID("taxonomy_index_tid");

Hierarchy

Expanded class hierarchy of TaxonomyIndexTid

Related topics

File

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

Namespace

Drupal\taxonomy\Plugin\views\field
View source
class TaxonomyIndexTid extends PrerenderList {

  /**
   * Overrides \Drupal\views\Plugin\views\field\PrerenderList::init().
   */
  public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
    parent::init($view, $display, $options);

    // @todo: Wouldn't it be possible to use $this->base_table and no if here?
    if ($view->storage
      ->get('base_table') == 'node_field_revision') {
      $this->additional_fields['nid'] = array(
        'table' => 'node_field_revision',
        'field' => 'nid',
      );
    }
    else {
      $this->additional_fields['nid'] = array(
        'table' => 'node',
        'field' => 'nid',
      );
    }
  }
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['link_to_taxonomy'] = array(
      'default' => TRUE,
      'bool' => TRUE,
    );
    $options['limit'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
    $options['vids'] = array(
      'default' => array(),
    );
    return $options;
  }

  /**
   * Provide "link to term" option.
   */
  public function buildOptionsForm(&$form, &$form_state) {
    $form['link_to_taxonomy'] = array(
      '#title' => t('Link this field to its term page'),
      '#type' => 'checkbox',
      '#default_value' => !empty($this->options['link_to_taxonomy']),
    );
    $form['limit'] = array(
      '#type' => 'checkbox',
      '#title' => t('Limit terms by vocabulary'),
      '#default_value' => $this->options['limit'],
    );
    $options = array();
    $vocabularies = entity_load_multiple('taxonomy_vocabulary');
    foreach ($vocabularies as $voc) {
      $options[$voc
        ->id()] = $voc
        ->label();
    }
    $form['vids'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Vocabularies'),
      '#options' => $options,
      '#default_value' => $this->options['vids'],
      '#states' => array(
        'visible' => array(
          ':input[name="options[limit]"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    );
    parent::buildOptionsForm($form, $form_state);
  }

  /**
   * Add this term to the query
   */
  public function query() {
    $this
      ->addAdditionalFields();
  }
  function pre_render(&$values) {
    $vocabularies = entity_load_multiple('taxonomy_vocabulary');
    $this->field_alias = $this->aliases['nid'];
    $nids = array();
    foreach ($values as $result) {
      if (!empty($result->{$this->aliases['nid']})) {
        $nids[] = $result->{$this->aliases['nid']};
      }
    }
    if ($nids) {
      $query = db_select('taxonomy_term_data', 'td');
      $query
        ->innerJoin('taxonomy_index', 'tn', 'td.tid = tn.tid');
      $query
        ->fields('td');
      $query
        ->addField('tn', 'nid', 'node_nid');
      $query
        ->orderby('td.weight');
      $query
        ->orderby('td.name');
      $query
        ->condition('tn.nid', $nids);
      $query
        ->addTag('term_access');
      $vocabs = array_filter($this->options['vids']);
      if (!empty($this->options['limit']) && !empty($vocabs)) {
        $query
          ->condition('td.vid', $vocabs);
      }
      $result = $query
        ->execute();
      foreach ($result as $term) {
        $this->items[$term->node_nid][$term->tid]['name'] = check_plain($term->name);
        $this->items[$term->node_nid][$term->tid]['tid'] = $term->tid;
        $this->items[$term->node_nid][$term->tid]['vocabulary_vid'] = $term->vid;
        $this->items[$term->node_nid][$term->tid]['vocabulary'] = check_plain($vocabularies[$term->vid]
          ->label());
        if (!empty($this->options['link_to_taxonomy'])) {
          $this->items[$term->node_nid][$term->tid]['make_link'] = TRUE;
          $this->items[$term->node_nid][$term->tid]['path'] = 'taxonomy/term/' . $term->tid;
        }
      }
    }
  }
  function render_item($count, $item) {
    return $item['name'];
  }
  protected function documentSelfTokens(&$tokens) {
    $tokens['[' . $this->options['id'] . '-tid' . ']'] = t('The taxonomy term ID for the term.');
    $tokens['[' . $this->options['id'] . '-name' . ']'] = t('The taxonomy term name for the term.');
    $tokens['[' . $this->options['id'] . '-vocabulary-vid' . ']'] = t('The machine name for the vocabulary the term belongs to.');
    $tokens['[' . $this->options['id'] . '-vocabulary' . ']'] = t('The name for the vocabulary the term belongs to.');
  }
  protected function addSelfTokens(&$tokens, $item) {
    foreach (array(
      'tid',
      'name',
      'vocabulary_vid',
      'vocabulary',
    ) as $token) {

      // Replace _ with - for the vocabulary vid.
      $tokens['[' . $this->options['id'] . '-' . str_replace('_', '-', $token) . ']'] = isset($item[$token]) ? $item[$token] : '';
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContainerFactoryPluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
FieldPluginBase::$additional_fields property Stores additional fields which get's added to the query. The generated aliases are stored in $aliases.
FieldPluginBase::$aliases property
FieldPluginBase::$field_alias property
FieldPluginBase::$original_value public property The field value prior to any rewriting.
FieldPluginBase::addAdditionalFields protected function Add 'additional' fields to the query.
FieldPluginBase::adminLabel public function Return a string representing this handler's name in the UI. Overrides HandlerBase::adminLabel 1
FieldPluginBase::adminSummary public function Provide extra data to the administration form Overrides HandlerBase::adminSummary
FieldPluginBase::advancedRender public function Render a field using advanced settings.
FieldPluginBase::clickSort public function Called to determine what to tell the clicksorter. 1
FieldPluginBase::clickSortable public function Determine if this field is click sortable. 3
FieldPluginBase::elementClasses public function Return the class of the field.
FieldPluginBase::elementLabelClasses public function Return the class of the field's label.
FieldPluginBase::elementLabelType public function Return an HTML element for the label based upon the field's element type.
FieldPluginBase::elementType public function Return an HTML element based upon the field's element type. 1
FieldPluginBase::elementWrapperClasses public function Return the class of the field's wrapper.
FieldPluginBase::elementWrapperType public function Return an HTML element for the wrapper based upon the field's element type.
FieldPluginBase::getElements public function Provide a list of elements valid for field HTML.
FieldPluginBase::getEntity public function Gets the entity matching the current row and relationship.
FieldPluginBase::getPreviousFieldLabels protected function Returns all field lables of fields before this field.
FieldPluginBase::getRenderTokens public function Get the 'render' tokens to use for advanced rendering.
FieldPluginBase::getTokenValuesRecursive protected function Recursive function to add replacements for nested query string parameters.
FieldPluginBase::getValue public function Get the value that's supposed to be rendered. 1
FieldPluginBase::isValueEmpty public function Checks if a field value is empty.
FieldPluginBase::label public function Get this field's label.
FieldPluginBase::render function Render the field. 35
FieldPluginBase::renderAltered protected function Render this field as altered text, from a fieldset set by the user.
FieldPluginBase::renderAsLink protected function Render this field as a link, with the info from a fieldset set by the user.
FieldPluginBase::renderText public function Perform an advanced text render for the item.
FieldPluginBase::renderTrimText public function Trim the field down to the specified length.
FieldPluginBase::submitOptionsForm public function Performs some cleanup tasks on the options array before saving it. Overrides HandlerBase::submitOptionsForm
FieldPluginBase::theme function Call out to the theme() function, which probably just calls render() but allows sites to override output fairly easily.
FieldPluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides PluginBase::themeFunctions
FieldPluginBase::tokenizeValue public function Replace a value with tokens from the last field.
FieldPluginBase::trimText public static function Trims the field down to the specified length.
FieldPluginBase::useStringGroupBy public function Determines if this field will be available as an option to group the result by in the style settings.
HandlerBase::$actualField public property When a field has been moved this property is set.
HandlerBase::$actualTable public property When a table has been moved this property is set.
HandlerBase::$field public property With field you can override the realField if the real field is not set.
HandlerBase::$query public property Where the $query object will reside: 1
HandlerBase::$realField public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
HandlerBase::$relationship public property The relationship used for this field.
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::acceptExposedInput public function Take input from exposed handlers and assign to this handler, if necessary. 1
HandlerBase::access public function Check whether current user has access to this handler. 6
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.
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::buildExposedForm public function Render our chunk of the exposed handler form when selecting 1
HandlerBase::buildExposeForm public function Form for exposed handler options. 2
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 1
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::canExpose public function Determine if a handler can be exposed. 2
HandlerBase::caseTransform protected function Transform a string by a certain method.
HandlerBase::defaultExposeOptions public function Set new exposed option defaults when exposed setting is flipped on. 2
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
HandlerBase::displayExposedForm public function Displays the Expose form.
HandlerBase::ensureMyTable public function Ensure the main table for this handler is in the query. This is used a lot. 8
HandlerBase::exposedInfo public function Get information about the exposed form for the form renderer. 1
HandlerBase::getDateField public function Creates cross-database SQL dates.
HandlerBase::getDateFormat public function Creates cross-database SQL date formatting.
HandlerBase::getEntityType public function Determines the entity type used by this handler.
HandlerBase::getField public function Shortcut to get a handler's raw field value.
HandlerBase::getJoin public function Get the join object that should be used for this handler.
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache.
HandlerBase::hasExtraOptions public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
HandlerBase::isAGroup public function Returns TRUE if the exposed filter works like a grouped filter. 1
HandlerBase::isExposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
HandlerBase::multipleExposedInput 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
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
HandlerBase::postExecute public function Run after the view is executed, before the result is cached.
HandlerBase::preQuery public function Run before the view is built. 1
HandlerBase::sanitizeValue public function Sanitize the value for output.
HandlerBase::setRelationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
HandlerBase::showExposeButton public function Shortcut to display the expose/hide button. 2
HandlerBase::showExposeForm public function Shortcut to display the exposed options form.
HandlerBase::storeExposedInput public function If set to remember exposed input in the session, store it there. 1
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::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::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::submitTemporaryForm public function A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests.
HandlerBase::usesGroupBy public function Provides the handler some groupby. 2
HandlerBase::validate public function Validates the handler against the complete View. Overrides PluginBase::validate 1
HandlerBase::validateExposed public function Validate the exposed handler form 4
HandlerBase::validateExposeForm public function Validate the options form. 1
HandlerBase::validateExtraOptionsForm public function Validate the options form.
HandlerBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm 5
HandlerBase::__construct public function Constructs a Handler object. Overrides PluginBase::__construct 3
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::getPluginDefinition public function Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PrerenderList::$items property Stores all items which are used to render the items. It should be keyed first by the id of the base table, for example nid. The second key is the id of the thing which is displayed multiple times per row, for example the tid.
PrerenderList::allowAdvancedRender protected function Determine if advanced rendering is allowed. Overrides FieldPluginBase::allowAdvancedRender
PrerenderList::getItems public function Return an array of items for the field.
PrerenderList::renderItems protected function Render all items in this field together.
TaxonomyIndexTid::addSelfTokens protected function Add any special tokens this field might use for itself. Overrides FieldPluginBase::addSelfTokens
TaxonomyIndexTid::buildOptionsForm public function Provide "link to term" option. Overrides PrerenderList::buildOptionsForm
TaxonomyIndexTid::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides PrerenderList::defineOptions
TaxonomyIndexTid::documentSelfTokens protected function Document any special tokens this field might use for itself. Overrides FieldPluginBase::documentSelfTokens
TaxonomyIndexTid::init public function Overrides \Drupal\views\Plugin\views\field\PrerenderList::init(). Overrides FieldPluginBase::init
TaxonomyIndexTid::pre_render function Run before any fields are rendered. Overrides FieldPluginBase::pre_render
TaxonomyIndexTid::query public function Add this term to the query Overrides FieldPluginBase::query
TaxonomyIndexTid::render_item function