taxonomy.module 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606
  1. <?php
  2. /**
  3. * @file
  4. * Enables the organization of content into categories.
  5. */
  6. use Drupal\Component\Utility\Tags;
  7. use Drupal\Component\Utility\Unicode;
  8. use Drupal\Core\Entity\EntityInterface;
  9. use Drupal\Core\Entity\Sql\SqlContentEntityStorage;
  10. use Drupal\Core\Render\Element;
  11. use Drupal\Core\Routing\RouteMatchInterface;
  12. use Drupal\Core\Url;
  13. use Drupal\taxonomy\Entity\Term;
  14. use Drupal\taxonomy\Entity\Vocabulary;
  15. use Drupal\taxonomy\TermInterface;
  16. use Drupal\taxonomy\VocabularyInterface;
  17. /**
  18. * Denotes that no term in the vocabulary has a parent.
  19. *
  20. * @deprecated in Drupal 8.2.x and will be removed before 9.0.0. Use
  21. * \Drupal\taxonomy\VocabularyInterface::HIERARCHY_DISABLED instead.
  22. *
  23. * @see https://www.drupal.org/node/2807795
  24. */
  25. const TAXONOMY_HIERARCHY_DISABLED = 0;
  26. /**
  27. * Denotes that one or more terms in the vocabulary has a single parent.
  28. *
  29. * @deprecated in Drupal 8.2.x and will be removed before 9.0.0. Use
  30. * \Drupal\taxonomy\VocabularyInterface::HIERARCHY_SINGLE instead.
  31. *
  32. * @see https://www.drupal.org/node/2807795
  33. */
  34. const TAXONOMY_HIERARCHY_SINGLE = 1;
  35. /**
  36. * Denotes that one or more terms in the vocabulary have multiple parents.
  37. *
  38. * @deprecated in Drupal 8.2.x and will be removed before 9.0.0. Use
  39. * \Drupal\taxonomy\VocabularyInterface::HIERARCHY_MULTIPLE instead.
  40. *
  41. * @see https://www.drupal.org/node/2807795
  42. */
  43. const TAXONOMY_HIERARCHY_MULTIPLE = 2;
  44. /**
  45. * Implements hook_help().
  46. */
  47. function taxonomy_help($route_name, RouteMatchInterface $route_match) {
  48. switch ($route_name) {
  49. case 'help.page.taxonomy':
  50. $field_ui_url = \Drupal::moduleHandler()->moduleExists('field_ui') ? \Drupal::url('help.page', ['name' => 'field_ui']) : '#';
  51. $output = '';
  52. $output .= '<h3>' . t('About') . '</h3>';
  53. $output .= '<p>' . t('The Taxonomy module allows users who have permission to create and edit content to categorize (tag) content of that type. Users who have the <em>Administer vocabularies and terms</em> <a href=":permissions" title="Taxonomy module permissions">permission</a> can add <em>vocabularies</em> that contain a set of related <em>terms</em>. The terms in a vocabulary can either be pre-set by an administrator or built gradually as content is added and edited. Terms may be organized hierarchically if desired.', [':permissions' => \Drupal::url('user.admin_permissions', [], ['fragment' => 'module-taxonomy'])]) . '</p>';
  54. $output .= '<p>' . t('For more information, see the <a href=":taxonomy">online documentation for the Taxonomy module</a>.', [':taxonomy' => 'https://www.drupal.org/documentation/modules/taxonomy/']) . '</p>';
  55. $output .= '<h3>' . t('Uses') . '</h3>';
  56. $output .= '<dl>';
  57. $output .= '<dt>' . t('Managing vocabularies') . '</dt>';
  58. $output .= '<dd>' . t('Users who have the <em>Administer vocabularies and terms</em> permission can add and edit vocabularies from the <a href=":taxonomy_admin">Taxonomy administration page</a>. Vocabularies can be deleted from their <em>Edit vocabulary</em> page. Users with the <em>Taxonomy term: Administer fields</em> permission may add additional fields for terms in that vocabulary using the <a href=":field_ui">Field UI module</a>.', [':taxonomy_admin' => \Drupal::url('entity.taxonomy_vocabulary.collection'), ':field_ui' => $field_ui_url]) . '</dd>';
  59. $output .= '<dt>' . t('Managing terms') . '</dt>';
  60. $output .= '<dd>' . t('Users who have the <em>Administer vocabularies and terms</em> permission or the <em>Edit terms</em> permission for a particular vocabulary can add, edit, and organize the terms in a vocabulary from a vocabulary\'s term listing page, which can be accessed by going to the <a href=":taxonomy_admin">Taxonomy administration page</a> and clicking <em>List terms</em> in the <em>Operations</em> column. Users must have the <em>Administer vocabularies and terms</em> permission or the <em>Delete terms</em> permission for a particular vocabulary to delete terms.', [':taxonomy_admin' => \Drupal::url('entity.taxonomy_vocabulary.collection')]) . ' </dd>';
  61. $output .= '<dt>' . t('Classifying entity content') . '</dt>';
  62. $output .= '<dd>' . t('A user with the <em>Administer fields</em> permission for a certain entity type may add <em>Taxonomy term</em> reference fields to the entity type, which will allow entities to be classified using taxonomy terms. See the <a href=":entity_reference">Entity Reference help</a> for more information about reference fields. See the <a href=":field">Field module help</a> and the <a href=":field_ui">Field UI help</a> pages for general information on fields and how to create and manage them.', [':field_ui' => $field_ui_url, ':field' => \Drupal::url('help.page', ['name' => 'field']), ':entity_reference' => \Drupal::url('help.page', ['name' => 'entity_reference'])]) . '</dd>';
  63. $output .= '<dt>' . t('Adding new terms during content creation') . '</dt>';
  64. $output .= '<dd>' . t("Allowing users to add new terms gradually builds a vocabulary as content is added and edited. Users can add new terms if either of the two <em>Autocomplete</em> widgets is chosen for the Taxonomy term reference field in the <em>Manage form display</em> page for the field. You will also need to enable the <em>Create referenced entities if they don't already exist</em> option, and restrict the field to one vocabulary.") . '</dd>';
  65. $output .= '<dt>' . t('Configuring displays and form displays') . '</dt>';
  66. $output .= '<dd>' . t('See the <a href=":entity_reference">Entity Reference help</a> page for the field widgets and formatters that can be configured for any reference field on the <em>Manage display</em> and <em>Manage form display</em> pages. Taxonomy additionally provides an <em>RSS category</em> formatter that displays nothing when the entity item is displayed as HTML, but displays an RSS category instead of a list when the entity item is displayed in an RSS feed.', [':entity_reference' => \Drupal::url('help.page', ['name' => 'entity_reference'])]) . '</li>';
  67. $output .= '</ul>';
  68. $output .= '</dd>';
  69. $output .= '</dl>';
  70. return $output;
  71. case 'entity.taxonomy_vocabulary.collection':
  72. $output = '<p>' . t('Taxonomy is for categorizing content. Terms are grouped into vocabularies. For example, a vocabulary called "Fruit" would contain the terms "Apple" and "Banana".') . '</p>';
  73. return $output;
  74. case 'entity.taxonomy_vocabulary.overview_form':
  75. $vocabulary = $route_match->getParameter('taxonomy_vocabulary');
  76. if (\Drupal::currentUser()->hasPermission('administer taxonomy') || \Drupal::currentUser()->hasPermission('edit terms in ' . $vocabulary->id())) {
  77. switch ($vocabulary->getHierarchy()) {
  78. case VocabularyInterface::HIERARCHY_DISABLED:
  79. return '<p>' . t('You can reorganize the terms in %capital_name using their drag-and-drop handles, and group terms under a parent term by sliding them under and to the right of the parent.', ['%capital_name' => Unicode::ucfirst($vocabulary->label()), '%name' => $vocabulary->label()]) . '</p>';
  80. case VocabularyInterface::HIERARCHY_SINGLE:
  81. return '<p>' . t('%capital_name contains terms grouped under parent terms. You can reorganize the terms in %capital_name using their drag-and-drop handles.', ['%capital_name' => Unicode::ucfirst($vocabulary->label()), '%name' => $vocabulary->label()]) . '</p>';
  82. case VocabularyInterface::HIERARCHY_MULTIPLE:
  83. return '<p>' . t('%capital_name contains terms with multiple parents. Drag and drop of terms with multiple parents is not supported, but you can re-enable drag-and-drop support by editing each term to include only a single parent.', ['%capital_name' => Unicode::ucfirst($vocabulary->label())]) . '</p>';
  84. }
  85. }
  86. else {
  87. switch ($vocabulary->getHierarchy()) {
  88. case VocabularyInterface::HIERARCHY_DISABLED:
  89. return '<p>' . t('%capital_name contains the following terms.', ['%capital_name' => Unicode::ucfirst($vocabulary->label())]) . '</p>';
  90. case VocabularyInterface::HIERARCHY_SINGLE:
  91. return '<p>' . t('%capital_name contains terms grouped under parent terms', ['%capital_name' => Unicode::ucfirst($vocabulary->label())]) . '</p>';
  92. case VocabularyInterface::HIERARCHY_MULTIPLE:
  93. return '<p>' . t('%capital_name contains terms with multiple parents.', ['%capital_name' => Unicode::ucfirst($vocabulary->label())]) . '</p>';
  94. }
  95. }
  96. }
  97. }
  98. /**
  99. * Entity URI callback.
  100. */
  101. function taxonomy_term_uri($term) {
  102. return new Url('entity.taxonomy_term.canonical', [
  103. 'taxonomy_term' => $term->id(),
  104. ]);
  105. }
  106. /**
  107. * Implements hook_page_attachments_alter().
  108. */
  109. function taxonomy_page_attachments_alter(array &$page) {
  110. $route_match = \Drupal::routeMatch();
  111. if ($route_match->getRouteName() == 'entity.taxonomy_term.canonical' && ($term = $route_match->getParameter('taxonomy_term')) && $term instanceof TermInterface) {
  112. foreach ($term->uriRelationships() as $rel) {
  113. // Set the URI relationships, like canonical.
  114. $page['#attached']['html_head_link'][] = [
  115. [
  116. 'rel' => $rel,
  117. 'href' => $term->url($rel),
  118. ],
  119. TRUE,
  120. ];
  121. // Set the term path as the canonical URL to prevent duplicate content.
  122. if ($rel == 'canonical') {
  123. // Set the non-aliased canonical path as a default shortlink.
  124. $page['#attached']['html_head_link'][] = [
  125. [
  126. 'rel' => 'shortlink',
  127. 'href' => $term->url($rel, ['alias' => TRUE]),
  128. ],
  129. TRUE,
  130. ];
  131. }
  132. }
  133. }
  134. }
  135. /**
  136. * Implements hook_theme().
  137. */
  138. function taxonomy_theme() {
  139. return [
  140. 'taxonomy_term' => [
  141. 'render element' => 'elements',
  142. ],
  143. ];
  144. }
  145. /**
  146. * Checks and updates the hierarchy flag of a vocabulary.
  147. *
  148. * Checks the current parents of all terms in a vocabulary and updates the
  149. * vocabulary's hierarchy setting to the lowest possible level. If no term
  150. * has parent terms then the vocabulary will be given a hierarchy of
  151. * VocabularyInterface::HIERARCHY_DISABLED. If any term has a single parent then
  152. * the vocabulary will be given a hierarchy of
  153. * VocabularyInterface::HIERARCHY_SINGLE. If any term has multiple parents then
  154. * the vocabulary will be given a hierarchy of
  155. * VocabularyInterface::HIERARCHY_MULTIPLE.
  156. *
  157. * @param \Drupal\taxonomy\VocabularyInterface $vocabulary
  158. * A taxonomy vocabulary entity.
  159. * @param $changed_term
  160. * An array of the term structure that was updated.
  161. *
  162. * @return
  163. * An integer that represents the level of the vocabulary's hierarchy.
  164. */
  165. function taxonomy_check_vocabulary_hierarchy(VocabularyInterface $vocabulary, $changed_term) {
  166. $tree = \Drupal::entityManager()->getStorage('taxonomy_term')->loadTree($vocabulary->id());
  167. $hierarchy = VocabularyInterface::HIERARCHY_DISABLED;
  168. foreach ($tree as $term) {
  169. // Update the changed term with the new parent value before comparison.
  170. if ($term->tid == $changed_term['tid']) {
  171. $term = (object) $changed_term;
  172. $term->parents = $term->parent;
  173. }
  174. // Check this term's parent count.
  175. if (count($term->parents) > 1) {
  176. $hierarchy = VocabularyInterface::HIERARCHY_MULTIPLE;
  177. break;
  178. }
  179. elseif (count($term->parents) == 1 && !isset($term->parents[0])) {
  180. $hierarchy = VocabularyInterface::HIERARCHY_SINGLE;
  181. }
  182. }
  183. if ($hierarchy != $vocabulary->getHierarchy()) {
  184. $vocabulary->setHierarchy($hierarchy);
  185. $vocabulary->save();
  186. }
  187. return $hierarchy;
  188. }
  189. /**
  190. * Generates an array which displays a term detail page.
  191. *
  192. * @param \Drupal\taxonomy\Entity\Term $term
  193. * A taxonomy term object.
  194. * @param string $view_mode
  195. * View mode; e.g., 'full', 'teaser', etc.
  196. * @param string $langcode
  197. * (optional) A language code to use for rendering. Defaults to the global
  198. * content language of the current request.
  199. *
  200. * @return array
  201. * A $page element suitable for use by
  202. * \Drupal\Core\Render\RendererInterface::render().
  203. */
  204. function taxonomy_term_view(Term $term, $view_mode = 'full', $langcode = NULL) {
  205. return entity_view($term, $view_mode, $langcode);
  206. }
  207. /**
  208. * Constructs a drupal_render() style array from an array of loaded terms.
  209. *
  210. * @param array $terms
  211. * An array of taxonomy terms as returned by Term::loadMultiple().
  212. * @param string $view_mode
  213. * View mode; e.g., 'full', 'teaser', etc.
  214. * @param string $langcode
  215. * (optional) A language code to use for rendering. Defaults to the global
  216. * content language of the current request.
  217. *
  218. * @return array
  219. * An array in the format expected by
  220. * \Drupal\Core\Render\RendererInterface::render().
  221. */
  222. function taxonomy_term_view_multiple(array $terms, $view_mode = 'full', $langcode = NULL) {
  223. return entity_view_multiple($terms, $view_mode, $langcode);
  224. }
  225. /**
  226. * Implements hook_theme_suggestions_HOOK().
  227. */
  228. function taxonomy_theme_suggestions_taxonomy_term(array $variables) {
  229. $suggestions = [];
  230. /** @var \Drupal\taxonomy\TermInterface $term */
  231. $term = $variables['elements']['#taxonomy_term'];
  232. $suggestions[] = 'taxonomy_term__' . $term->bundle();
  233. $suggestions[] = 'taxonomy_term__' . $term->id();
  234. return $suggestions;
  235. }
  236. /**
  237. * Prepares variables for taxonomy term templates.
  238. *
  239. * Default template: taxonomy-term.html.twig.
  240. *
  241. * @param array $variables
  242. * An associative array containing:
  243. * - elements: An associative array containing the taxonomy term and any
  244. * fields attached to the term. Properties used:
  245. * - #taxonomy_term: A \Drupal\taxonomy\TermInterface object.
  246. * - #view_mode: The current view mode for this taxonomy term, e.g.
  247. * 'full' or 'teaser'.
  248. * - attributes: HTML attributes for the containing element.
  249. */
  250. function template_preprocess_taxonomy_term(&$variables) {
  251. $variables['view_mode'] = $variables['elements']['#view_mode'];
  252. $variables['term'] = $variables['elements']['#taxonomy_term'];
  253. /** @var \Drupal\taxonomy\TermInterface $term */
  254. $term = $variables['term'];
  255. $variables['url'] = $term->url();
  256. // We use name here because that is what appears in the UI.
  257. $variables['name'] = $variables['elements']['name'];
  258. unset($variables['elements']['name']);
  259. $variables['page'] = $variables['view_mode'] == 'full' && taxonomy_term_is_page($term);
  260. // Helpful $content variable for templates.
  261. $variables['content'] = [];
  262. foreach (Element::children($variables['elements']) as $key) {
  263. $variables['content'][$key] = $variables['elements'][$key];
  264. }
  265. }
  266. /**
  267. * Returns whether the current page is the page of the passed-in term.
  268. *
  269. * @param \Drupal\taxonomy\Entity\Term $term
  270. * A taxonomy term entity.
  271. */
  272. function taxonomy_term_is_page(Term $term) {
  273. if (\Drupal::routeMatch()->getRouteName() == 'entity.taxonomy_term.canonical' && $page_term_id = \Drupal::routeMatch()->getRawParameter('taxonomy_term')) {
  274. return $page_term_id == $term->id();
  275. }
  276. return FALSE;
  277. }
  278. /**
  279. * Clear all static cache variables for terms.
  280. */
  281. function taxonomy_terms_static_reset() {
  282. \Drupal::entityManager()->getStorage('taxonomy_term')->resetCache();
  283. }
  284. /**
  285. * Clear all static cache variables for vocabularies.
  286. *
  287. * @param $ids
  288. * An array of ids to reset in the entity cache.
  289. */
  290. function taxonomy_vocabulary_static_reset(array $ids = NULL) {
  291. \Drupal::entityManager()->getStorage('taxonomy_vocabulary')->resetCache($ids);
  292. }
  293. /**
  294. * Get names for all taxonomy vocabularies.
  295. *
  296. * @return array
  297. * A list of existing vocabulary IDs.
  298. */
  299. function taxonomy_vocabulary_get_names() {
  300. $names = &drupal_static(__FUNCTION__);
  301. if (!isset($names)) {
  302. $names = [];
  303. $config_names = \Drupal::configFactory()->listAll('taxonomy.vocabulary.');
  304. foreach ($config_names as $config_name) {
  305. $id = substr($config_name, strlen('taxonomy.vocabulary.'));
  306. $names[$id] = $id;
  307. }
  308. }
  309. return $names;
  310. }
  311. /**
  312. * Try to map a string to an existing term, as for glossary use.
  313. *
  314. * Provides a case-insensitive and trimmed mapping, to maximize the
  315. * likelihood of a successful match.
  316. *
  317. * @param $name
  318. * Name of the term to search for.
  319. * @param $vocabulary
  320. * (optional) Vocabulary machine name to limit the search. Defaults to NULL.
  321. *
  322. * @return
  323. * An array of matching term objects.
  324. */
  325. function taxonomy_term_load_multiple_by_name($name, $vocabulary = NULL) {
  326. $values = ['name' => trim($name)];
  327. if (isset($vocabulary)) {
  328. $vocabularies = taxonomy_vocabulary_get_names();
  329. if (isset($vocabularies[$vocabulary])) {
  330. $values['vid'] = $vocabulary;
  331. }
  332. else {
  333. // Return an empty array when filtering by a non-existing vocabulary.
  334. return [];
  335. }
  336. }
  337. return entity_load_multiple_by_properties('taxonomy_term', $values);
  338. }
  339. /**
  340. * Load multiple taxonomy terms based on certain conditions.
  341. *
  342. * This function should be used whenever you need to load more than one term
  343. * from the database. Terms are loaded into memory and will not require
  344. * database access if loaded again during the same page request.
  345. *
  346. * @see entity_load_multiple()
  347. * @see \Drupal\Core\Entity\Query\EntityQueryInterface
  348. *
  349. * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
  350. * Use \Drupal\taxonomy\Entity\Term::loadMultiple().
  351. *
  352. * @param array $tids
  353. * (optional) An array of entity IDs. If omitted, all entities are loaded.
  354. *
  355. * @return array
  356. * An array of taxonomy term entities, indexed by tid. When no results are
  357. * found, an empty array is returned.
  358. */
  359. function taxonomy_term_load_multiple(array $tids = NULL) {
  360. return Term::loadMultiple($tids);
  361. }
  362. /**
  363. * Loads multiple taxonomy vocabularies based on certain conditions.
  364. *
  365. * This function should be used whenever you need to load more than one
  366. * vocabulary from the database. Terms are loaded into memory and will not
  367. * require database access if loaded again during the same page request.
  368. *
  369. * @see entity_load_multiple()
  370. *
  371. * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
  372. * Use \Drupal\taxonomy\Entity\Vocabulary::loadMultiple().
  373. *
  374. * @param array $vids
  375. * (optional) An array of entity IDs. If omitted, all entities are loaded.
  376. *
  377. * @return array
  378. * An array of vocabulary objects, indexed by vid.
  379. */
  380. function taxonomy_vocabulary_load_multiple(array $vids = NULL) {
  381. return Vocabulary::loadMultiple($vids);
  382. }
  383. /**
  384. * Return the taxonomy vocabulary entity matching a vocabulary ID.
  385. *
  386. * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
  387. * Use \Drupal\taxonomy\Entity\Vocabulary::load().
  388. *
  389. * @param int $vid
  390. * The vocabulary's ID.
  391. *
  392. * @return \Drupal\taxonomy\Entity\Vocabulary|null
  393. * The taxonomy vocabulary entity, if exists, NULL otherwise. Results are
  394. * statically cached.
  395. */
  396. function taxonomy_vocabulary_load($vid) {
  397. return Vocabulary::load($vid);
  398. }
  399. /**
  400. * Return the taxonomy term entity matching a term ID.
  401. *
  402. * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
  403. * Use \Drupal\taxonomy\Entity\Term::load().
  404. *
  405. * @param $tid
  406. * A term's ID
  407. *
  408. * @return \Drupal\taxonomy\Entity\Term|null
  409. * A taxonomy term entity, or NULL if the term was not found. Results are
  410. * statically cached.
  411. */
  412. function taxonomy_term_load($tid) {
  413. if (!is_numeric($tid)) {
  414. return NULL;
  415. }
  416. return Term::load($tid);
  417. }
  418. /**
  419. * Implodes a list of tags of a certain vocabulary into a string.
  420. *
  421. * @see \Drupal\Component\Utility\Tags::explode()
  422. */
  423. function taxonomy_implode_tags($tags, $vid = NULL) {
  424. $typed_tags = [];
  425. foreach ($tags as $tag) {
  426. // Extract terms belonging to the vocabulary in question.
  427. if (!isset($vid) || $tag->bundle() == $vid) {
  428. // Make sure we have a completed loaded taxonomy term.
  429. if ($tag instanceof EntityInterface && $label = $tag->label()) {
  430. // Commas and quotes in tag names are special cases, so encode 'em.
  431. $typed_tags[] = Tags::encode($label);
  432. }
  433. }
  434. }
  435. return implode(', ', $typed_tags);
  436. }
  437. /**
  438. * Title callback for term pages.
  439. *
  440. * @param \Drupal\taxonomy\Entity\Term $term
  441. * A taxonomy term entity.
  442. *
  443. * @return
  444. * The term name to be used as the page title.
  445. */
  446. function taxonomy_term_title(Term $term) {
  447. return $term->getName();
  448. }
  449. /**
  450. * @defgroup taxonomy_index Taxonomy indexing
  451. * @{
  452. * Functions to maintain taxonomy indexing.
  453. *
  454. * Taxonomy uses default field storage to store canonical relationships
  455. * between terms and fieldable entities. However its most common use case
  456. * requires listing all content associated with a term or group of terms
  457. * sorted by creation date. To avoid slow queries due to joining across
  458. * multiple node and field tables with various conditions and order by criteria,
  459. * we maintain a denormalized table with all relationships between terms,
  460. * published nodes and common sort criteria such as status, sticky and created.
  461. * When using other field storage engines or alternative methods of
  462. * denormalizing this data you should set the
  463. * taxonomy.settings:maintain_index_table to '0' to avoid unnecessary writes in
  464. * SQL.
  465. */
  466. /**
  467. * Implements hook_ENTITY_TYPE_insert() for node entities.
  468. */
  469. function taxonomy_node_insert(EntityInterface $node) {
  470. // Add taxonomy index entries for the node.
  471. taxonomy_build_node_index($node);
  472. }
  473. /**
  474. * Builds and inserts taxonomy index entries for a given node.
  475. *
  476. * The index lists all terms that are related to a given node entity, and is
  477. * therefore maintained at the entity level.
  478. *
  479. * @param \Drupal\node\Entity\Node $node
  480. * The node entity.
  481. */
  482. function taxonomy_build_node_index($node) {
  483. // We maintain a denormalized table of term/node relationships, containing
  484. // only data for current, published nodes.
  485. if (!\Drupal::config('taxonomy.settings')->get('maintain_index_table') || !(\Drupal::entityManager()->getStorage('node') instanceof SqlContentEntityStorage)) {
  486. return;
  487. }
  488. $status = $node->isPublished();
  489. $sticky = (int) $node->isSticky();
  490. // We only maintain the taxonomy index for published nodes.
  491. if ($status && $node->isDefaultRevision()) {
  492. // Collect a unique list of all the term IDs from all node fields.
  493. $tid_all = [];
  494. $entity_reference_class = 'Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem';
  495. foreach ($node->getFieldDefinitions() as $field) {
  496. $field_name = $field->getName();
  497. $class = $field->getItemDefinition()->getClass();
  498. $is_entity_reference_class = ($class === $entity_reference_class) || is_subclass_of($class, $entity_reference_class);
  499. if ($is_entity_reference_class && $field->getSetting('target_type') == 'taxonomy_term') {
  500. foreach ($node->getTranslationLanguages() as $language) {
  501. foreach ($node->getTranslation($language->getId())->$field_name as $item) {
  502. if (!$item->isEmpty()) {
  503. $tid_all[$item->target_id] = $item->target_id;
  504. }
  505. }
  506. }
  507. }
  508. }
  509. // Insert index entries for all the node's terms.
  510. if (!empty($tid_all)) {
  511. foreach ($tid_all as $tid) {
  512. db_merge('taxonomy_index')
  513. ->key(['nid' => $node->id(), 'tid' => $tid, 'status' => $node->isPublished()])
  514. ->fields(['sticky' => $sticky, 'created' => $node->getCreatedTime()])
  515. ->execute();
  516. }
  517. }
  518. }
  519. }
  520. /**
  521. * Implements hook_ENTITY_TYPE_update() for node entities.
  522. */
  523. function taxonomy_node_update(EntityInterface $node) {
  524. // If we're not dealing with the default revision of the node, do not make any
  525. // change to the taxonomy index.
  526. if (!$node->isDefaultRevision()) {
  527. return;
  528. }
  529. taxonomy_delete_node_index($node);
  530. taxonomy_build_node_index($node);
  531. }
  532. /**
  533. * Implements hook_ENTITY_TYPE_predelete() for node entities.
  534. */
  535. function taxonomy_node_predelete(EntityInterface $node) {
  536. // Clean up the {taxonomy_index} table when nodes are deleted.
  537. taxonomy_delete_node_index($node);
  538. }
  539. /**
  540. * Deletes taxonomy index entries for a given node.
  541. *
  542. * @param \Drupal\Core\Entity\EntityInterface $node
  543. * The node entity.
  544. */
  545. function taxonomy_delete_node_index(EntityInterface $node) {
  546. if (\Drupal::config('taxonomy.settings')->get('maintain_index_table')) {
  547. db_delete('taxonomy_index')->condition('nid', $node->id())->execute();
  548. }
  549. }
  550. /**
  551. * Implements hook_ENTITY_TYPE_delete() for taxonomy_term entities.
  552. */
  553. function taxonomy_taxonomy_term_delete(Term $term) {
  554. if (\Drupal::config('taxonomy.settings')->get('maintain_index_table')) {
  555. // Clean up the {taxonomy_index} table when terms are deleted.
  556. db_delete('taxonomy_index')->condition('tid', $term->id())->execute();
  557. }
  558. }
  559. /**
  560. * @} End of "defgroup taxonomy_index".
  561. */