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