class NodeTermData
Same name and namespace in other branches
- 11.x core/modules/taxonomy/src/Plugin/views/relationship/NodeTermData.php \Drupal\taxonomy\Plugin\views\relationship\NodeTermData
- 9 core/modules/taxonomy/src/Plugin/views/relationship/NodeTermData.php \Drupal\taxonomy\Plugin\views\relationship\NodeTermData
- 8.9.x core/modules/taxonomy/src/Plugin/views/relationship/NodeTermData.php \Drupal\taxonomy\Plugin\views\relationship\NodeTermData
- main core/modules/taxonomy/src/Plugin/views/relationship/NodeTermData.php \Drupal\taxonomy\Plugin\views\relationship\NodeTermData
Relationship handler to return the taxonomy terms of nodes.
Attributes
#[ViewsRelationship("node_term_data")]
Hierarchy
- class \Drupal\taxonomy\Plugin\views\relationship\NodeTermData extends \Drupal\views\Plugin\views\relationship\RelationshipPluginBase
Expanded class hierarchy of NodeTermData
Related topics
File
-
core/
modules/ taxonomy/ src/ Plugin/ views/ relationship/ NodeTermData.php, line 17
Namespace
Drupal\taxonomy\Plugin\views\relationshipView source
class NodeTermData extends RelationshipPluginBase {
/**
* The vocabulary storage.
*
* @var \Drupal\taxonomy\VocabularyStorageInterface
*/
protected $vocabularyStorage;
/**
* Constructs a NodeTermData object.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin ID for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\taxonomy\VocabularyStorageInterface $vocabulary_storage
* The vocabulary storage.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, VocabularyStorageInterface $vocabulary_storage) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->vocabularyStorage = $vocabulary_storage;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity_type.manager')
->getStorage('taxonomy_vocabulary'));
}
protected function defineOptions() {
$options = parent::defineOptions();
$options['vids'] = [
'default' => [],
];
return $options;
}
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
$vocabularies = $this->vocabularyStorage
->loadMultiple();
$options = [];
foreach ($vocabularies as $voc) {
$options[$voc->id()] = $voc->label();
}
$form['vids'] = [
'#type' => 'checkboxes',
'#title' => $this->t('Vocabularies'),
'#options' => $options,
'#default_value' => $this->options['vids'],
'#description' => $this->t('Choose which vocabularies you wish to relate. Remember that every term found will create a new record, so this relationship is best used on just one vocabulary that has only one term per node.'),
];
parent::buildOptionsForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function submitOptionsForm(&$form, FormStateInterface $form_state) {
// Transform the #type = checkboxes value to a numerically indexed array,
// because the config schema expects a sequence, not a mapping.
$vids = $form_state->getValue([
'options',
'vids',
]);
$form_state->setValue([
'options',
'vids',
], array_values(array_filter($vids)));
}
/**
* Called to implement a relationship in a query.
*/
public function query() {
$this->ensureMyTable();
$def = $this->definition;
$def['table'] = 'taxonomy_term_field_data';
if (!array_filter($this->options['vids'])) {
$taxonomy_index = $this->query
->addTable('taxonomy_index', $this->relationship);
$def['left_table'] = $taxonomy_index;
$def['left_field'] = 'tid';
$def['field'] = 'tid';
$def['type'] = empty($this->options['required']) ? 'LEFT' : 'INNER';
}
else {
// If vocabularies are supplied join a subselect instead
$def['left_table'] = $this->tableAlias;
$def['left_field'] = 'nid';
$def['field'] = 'nid';
$def['type'] = empty($this->options['required']) ? 'LEFT' : 'INNER';
$def['adjusted'] = TRUE;
$query = Database::getConnection()->select('taxonomy_term_field_data', 'td');
$query->addJoin($def['type'], 'taxonomy_index', 'tn', '[tn].[tid] = [td].[tid]');
$query->condition('td.vid', array_filter($this->options['vids']), 'IN');
if (empty($this->query->options['disable_sql_rewrite'])) {
$query->addTag('taxonomy_term_access');
}
$query->fields('td');
$query->fields('tn', [
'nid',
]);
$def['table formula'] = $query;
}
$join = \Drupal::service('plugin.manager.views.join')->createInstance('standard', $def);
// Use a short alias for this:
$alias = $def['table'] . '_' . $this->table;
$this->alias = $this->query
->addRelationship($alias, $join, 'taxonomy_term_field_data', $this->relationship);
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
$dependencies = parent::calculateDependencies();
foreach ($this->options['vids'] as $vocabulary_id) {
if ($vocabulary = $this->vocabularyStorage
->load($vocabulary_id)) {
$dependencies[$vocabulary->getConfigDependencyKey()][] = $vocabulary->getConfigDependencyName();
}
}
return $dependencies;
}
}
Members
| Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
|---|---|---|---|---|---|---|
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
| DependencySerializationTrait::__sleep | public | function | 2 | |||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | ||
| HandlerBase::$field | public | property | With field you can override the realField if the real field is not set. | |||
| HandlerBase::$is_handler | public | property | Tracks whether the plugin is a handler. | |||
| HandlerBase::$moduleHandler | protected | property | The module handler. | 2 | ||
| HandlerBase::$query | public | property | Where the $query object will reside. | 7 | ||
| HandlerBase::$realField | public | property | The real field. | |||
| 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::$viewsData | protected | property | The views data service. | |||
| HandlerBase::acceptExposedInput | public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 | ||
| HandlerBase::access | public | function | Overrides ViewsHandlerInterface::access | 5 | ||
| HandlerBase::adminLabel | public | function | Overrides ViewsHandlerInterface::adminLabel | 4 | ||
| HandlerBase::adminSummary | public | function | Overrides ViewsHandlerInterface::adminSummary | 5 | ||
| HandlerBase::breakString | public static | function | Overrides ViewsHandlerInterface::breakString | |||
| HandlerBase::broken | public | function | Overrides ViewsHandlerInterface::broken | |||
| 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 | Overrides ViewsHandlerInterface::ensureMyTable | 2 | ||
| HandlerBase::exposedInfo | public | function | Get information about the exposed form for the form renderer. | 1 | ||
| HandlerBase::getDateField | public | function | Creates cross-database SQL dates. | 2 | ||
| HandlerBase::getDateFormat | public | function | Creates cross-database SQL date formatting. | 2 | ||
| HandlerBase::getEntityType | public | function | Overrides ViewsHandlerInterface::getEntityType | |||
| HandlerBase::getField | public | function | Overrides ViewsHandlerInterface::getField | |||
| HandlerBase::getJoin | public | function | Overrides ViewsHandlerInterface::getJoin | |||
| HandlerBase::getModuleHandler | protected | function | Gets the module handler. | |||
| HandlerBase::getTableJoin | public static | function | Overrides ViewsHandlerInterface::getTableJoin | |||
| HandlerBase::getViewsData | protected | function | Gets views data service. | |||
| HandlerBase::hasExtraOptions | public | function | Determines if the handler has 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'. | |||
| HandlerBase::multipleExposedInput | public | function | Define if the exposed input has to be submitted multiple times. | 1 | ||
| HandlerBase::placeholder | protected | function | Provides a unique placeholders for handlers. | |||
| HandlerBase::postExecute | public | function | Overrides ViewsHandlerInterface::postExecute | |||
| HandlerBase::preQuery | public | function | Overrides ViewsHandlerInterface::preQuery | 2 | ||
| HandlerBase::sanitizeValue | public | function | Overrides ViewsHandlerInterface::sanitizeValue | |||
| HandlerBase::setModuleHandler | public | function | Sets the module handler. | |||
| HandlerBase::setRelationship | public | function | Overrides ViewsHandlerInterface::setRelationship | |||
| HandlerBase::setViewsData | public | function | ||||
| HandlerBase::showExposeButton | public | function | Shortcut to display the expose/hide button. | 2 | ||
| HandlerBase::showExposeForm | public | function | Shortcut to display the exposed options form. | Overrides ViewsHandlerInterface::showExposeForm | ||
| 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. | |||
| HandlerBase::submitExtraOptionsForm | public | function | Perform any necessary changes to the form values prior to storage. | |||
| HandlerBase::submitFormCalculateOptions | public | function | Calculates options stored on the handler. | 1 | ||
| HandlerBase::submitGroupByForm | public | function | Perform any necessary changes to the form values prior to storage. | 1 | ||
| HandlerBase::submitTemporaryForm | public | function | Submits a temporary form. | |||
| HandlerBase::validate | public | function | Overrides PluginBase::validate | 2 | ||
| HandlerBase::validateExposed | public | function | Validate the exposed handler form. | 4 | ||
| HandlerBase::validateExposeForm | public | function | Validate the options form. | 2 | ||
| HandlerBase::validateExtraOptionsForm | public | function | Validate the options form. | |||
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
| MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
| NodeTermData::$vocabularyStorage | protected | property | The vocabulary storage. | |||
| NodeTermData::buildOptionsForm | public | function | Overrides RelationshipPluginBase::buildOptionsForm | |||
| NodeTermData::calculateDependencies | public | function | Overrides RelationshipPluginBase::calculateDependencies | |||
| NodeTermData::create | public static | function | Overrides PluginBase::create | |||
| NodeTermData::defineOptions | protected | function | Overrides RelationshipPluginBase::defineOptions | |||
| NodeTermData::query | public | function | Called to implement a relationship in a query. | Overrides RelationshipPluginBase::query | ||
| NodeTermData::submitOptionsForm | public | function | Overrides PluginBase::submitOptionsForm | |||
| NodeTermData::__construct | public | function | Constructs a NodeTermData object. | Overrides HandlerBase::__construct | ||
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | ||
| PluginBase::$definition | public | property | Plugins' 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. | 1 | ||
| PluginBase::$pluginId | protected | property | The plugin ID. | |||
| PluginBase::$position | public | property | The handler position. | |||
| PluginBase::$renderer | protected | property | Stores the render API renderer. | 3 | ||
| 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::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | ||||
| PluginBase::destroy | public | function | Overrides ViewsPluginInterface::destroy | 2 | ||
| PluginBase::doFilterByDefinedOptions | protected | function | Do the work to filter out stored options depending on the defined options. | |||
| PluginBase::filterByDefinedOptions | public | function | Overrides ViewsPluginInterface::filterByDefinedOptions | |||
| PluginBase::getAvailableGlobalTokens | public | function | Overrides ViewsPluginInterface::getAvailableGlobalTokens | |||
| PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | ||
| PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | ||
| PluginBase::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | 2 | |
| PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | ||
| PluginBase::getProvider | public | function | Overrides ViewsPluginInterface::getProvider | |||
| PluginBase::getRenderer | protected | function | Returns the render API renderer. | 1 | ||
| PluginBase::globalTokenForm | public | function | Overrides ViewsPluginInterface::globalTokenForm | |||
| PluginBase::globalTokenReplace | public | function | Overrides ViewsPluginInterface::globalTokenReplace | |||
| PluginBase::INCLUDE_ENTITY | constant | Include entity row languages when listing languages. | ||||
| PluginBase::INCLUDE_NEGOTIATED | constant | Include negotiated languages when listing languages. | ||||
| PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | |||
| PluginBase::listLanguages | protected | function | Makes an array of languages, optionally including special languages. | |||
| PluginBase::pluginTitle | public | function | Overrides ViewsPluginInterface::pluginTitle | |||
| PluginBase::preRenderAddFieldsetMarkup | public static | function | Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup | |||
| PluginBase::preRenderFlattenData | public static | function | Overrides ViewsPluginInterface::preRenderFlattenData | |||
| PluginBase::queryLanguageSubstitutions | public static | function | Returns substitutions for Views queries for languages. | |||
| PluginBase::setOptionDefaults | protected | function | Fills up the options of the plugin with defaults. | |||
| PluginBase::summaryTitle | public | function | Overrides ViewsPluginInterface::summaryTitle | 6 | ||
| PluginBase::themeFunctions | public | function | Overrides ViewsPluginInterface::themeFunctions | 1 | ||
| PluginBase::trustedCallbacks | public static | function | Overrides TrustedCallbackInterface::trustedCallbacks | 6 | ||
| PluginBase::unpackOptions | public | function | Overrides ViewsPluginInterface::unpackOptions | |||
| PluginBase::usesOptions | public | function | Overrides ViewsPluginInterface::usesOptions | 8 | ||
| PluginBase::validateOptionsForm | public | function | Overrides ViewsPluginInterface::validateOptionsForm | 15 | ||
| PluginBase::viewsTokenReplace | protected | function | Replaces Views' tokens in a given string. | 1 | ||
| PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT | constant | Query string to indicate the site default language. | ||||
| RelationshipPluginBase::$alias | public | property | The relationship alias. | |||
| RelationshipPluginBase::init | public | function | Overrides \Drupal\views\Plugin\views\HandlerBase::init(). | Overrides HandlerBase::init | ||
| RelationshipPluginBase::usesGroupBy | public | function | Overrides HandlerBase::usesGroupBy | |||
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | ||
| StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | |||
| StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | |||
| StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | |||
| StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | ||
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | |||
| TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | ||||
| TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||||
| TrustedCallbackInterface::TRIGGER_WARNING | Deprecated | constant | Untrusted callbacks trigger E_USER_WARNING errors. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.