|
1
|
<?php
|
|
2
|
/**
|
|
3
|
* @file
|
|
4
|
* Functions for dealing with CDM entities from the package model.name
|
|
5
|
*
|
|
6
|
* @copyright
|
|
7
|
* (C) 2007-2015 EDIT
|
|
8
|
* European Distributed Institute of Taxonomy
|
|
9
|
* http://www.e-taxonomy.eu
|
|
10
|
*
|
|
11
|
* The contents of this module are subject to the Mozilla
|
|
12
|
* Public License Version 1.1.
|
|
13
|
* @see http://www.mozilla.org/MPL/MPL-1.1.html
|
|
14
|
*
|
|
15
|
* @author
|
|
16
|
* - Andreas Kohlbecker <a.kohlbecker@BGBM.org>
|
|
17
|
*/
|
|
18
|
|
|
19
|
/**
|
|
20
|
* @defgroup compose Compose functions
|
|
21
|
* @{
|
|
22
|
* Functions which are composing Drupal render arays
|
|
23
|
*
|
|
24
|
* The cdm_dataportal module needs to compose rather complex render arrays from
|
|
25
|
* the data returned by the CDM REST service. The compose functions are
|
|
26
|
* responsible for creating the render arrays.
|
|
27
|
*
|
|
28
|
* All these functions are also implementations of the compose_hook()
|
|
29
|
* which is used in the proxy_content() function.
|
|
30
|
* @}
|
|
31
|
*/
|
|
32
|
|
|
33
|
|
|
34
|
/**
|
|
35
|
* Provides the name render template to be used within the page elements identified the the $renderPath.
|
|
36
|
*
|
|
37
|
* The render templates arrays contains one or more name render templates to be used within the page elements identified the the
|
|
38
|
* renderPath. The renderPath is the key of the subelements whereas the value is the name render template.
|
|
39
|
*
|
|
40
|
* The render paths used for a cdm_dataportal page can be visualized by supplying the HTTP query parameter RENDER_PATH=1.
|
|
41
|
*
|
|
42
|
* It will be tried to find the best matching default RenderTemplate by stripping the dot separated render path
|
|
43
|
* element by element. If no matching template is found the DEFAULT will be used:
|
|
44
|
*
|
|
45
|
* - related_taxon.heterotypicSynonymyGroup.taxon_page_synonymy
|
|
46
|
* - related_taxon.heterotypicSynonymyGroup.taxon_page_synonymy
|
|
47
|
* - related_taxon.heterotypicSynonymyGroup.taxon_page_synonymy
|
|
48
|
*
|
|
49
|
* A single render template can be used for multiple render paths. In this case the according key of the render templates
|
|
50
|
* array element should be the list of these render paths concatenated by ONLY a comma character without any whitespace.
|
|
51
|
*
|
|
52
|
* A render template is an associative array. The keys of this array are referring to the keys as defined in the part
|
|
53
|
* definitions array.
|
|
54
|
* @see get_partDefinition($taxonNameType) for more information
|
|
55
|
*
|
|
56
|
* The value of the render template element must be set to TRUE in order to let this part being rendered.
|
|
57
|
* The namePart, nameAuthorPart and referencePart can also hold an associative array with a single
|
|
58
|
* element: array('#uri' => TRUE). The value of the #uri element will be replaced by the according
|
|
59
|
* links if the parameters $nameLink or $refenceLink are set.
|
|
60
|
*
|
|
61
|
* @param string $render_path
|
|
62
|
* The render path can consist of multiple dot separated elements
|
|
63
|
* @see RenderHints::getRenderPath()
|
|
64
|
* @param string $nameLink
|
|
65
|
* The link path ot URL to be used for name parts if a link is forseen in the template
|
|
66
|
* matching the given $renderPath.
|
|
67
|
* @param string $referenceLink
|
|
68
|
* The link path ot URL to be used for nomenclatural reference parts if a link is forseen
|
|
69
|
* in the template matching the given $renderPath.
|
|
70
|
* @return array
|
|
71
|
* An associative array, the render template
|
|
72
|
*/
|
|
73
|
function get_nameRenderTemplate($render_path, $nameLink = NULL, $referenceLink = NULL) {
|
|
74
|
|
|
75
|
static $default_render_templates = NULL;
|
|
76
|
static $split_render_templates = NULL;
|
|
77
|
|
|
78
|
|
|
79
|
if (!isset($default_render_templates)) {
|
|
80
|
$default_render_templates = unserialize(CDM_NAME_RENDER_TEMPLATES_DEFAULT);
|
|
81
|
}
|
|
82
|
if($split_render_templates == NULL) {
|
|
83
|
$render_templates = variable_get(CDM_NAME_RENDER_TEMPLATES, $default_render_templates);
|
|
84
|
// needs to be converted to an array
|
|
85
|
$render_templates = (object_to_array($render_templates));
|
|
86
|
|
|
87
|
// separate render templates which are combined with a comma
|
|
88
|
$split_render_templates = array();
|
|
89
|
foreach($render_templates as $key => $template){
|
|
90
|
if(strpos($key, ',')){
|
|
91
|
foreach(explode(',', $key) as $path){
|
|
92
|
$split_render_templates[$path] = $template;
|
|
93
|
}
|
|
94
|
} else {
|
|
95
|
$split_render_templates[$key] = $template;
|
|
96
|
}
|
|
97
|
}
|
|
98
|
}
|
|
99
|
|
|
100
|
// get the base element of the renderPath
|
|
101
|
if (($separatorPos = strpos($render_path, '.')) > 0) {
|
|
102
|
$renderPath_base = substr($render_path, 0, $separatorPos);
|
|
103
|
} else {
|
|
104
|
$renderPath_base = $render_path;
|
|
105
|
}
|
|
106
|
|
|
107
|
$template = NULL;
|
|
108
|
// 1. try to find a template using the render path base element
|
|
109
|
if(array_key_exists($renderPath_base, $split_render_templates)){
|
|
110
|
$template = (array)$split_render_templates[$renderPath_base];
|
|
111
|
}
|
|
112
|
|
|
113
|
// 2. Find best matching default RenderTemplate
|
|
114
|
// by stripping the dot separated render path element by element
|
|
115
|
// if no matching template is found the DEFAULT will be used.
|
|
116
|
while (!is_array($template) && strlen($render_path) > 0) {
|
|
117
|
foreach ($split_render_templates as $path => $t) {
|
|
118
|
if ($path == $render_path) {
|
|
119
|
$template = $t;
|
|
120
|
break;
|
|
121
|
}
|
|
122
|
}
|
|
123
|
// shorten by one element
|
|
124
|
$render_path = substr($render_path, strrpos($render_path, '.') + 1, strlen($render_path));
|
|
125
|
}
|
|
126
|
|
|
127
|
|
|
128
|
// 3. Otherwise get default RenderTemplate from theme.
|
|
129
|
if (!is_array($template)) {
|
|
130
|
$template = $split_render_templates['#DEFAULT'];
|
|
131
|
}
|
|
132
|
|
|
133
|
// --- set the link uris to the according template fields if they exist
|
|
134
|
if(isset($template['nameAuthorPart']) && isset($template['nameAuthorPart']['#uri'])) {
|
|
135
|
if ($nameLink) {
|
|
136
|
$template['nameAuthorPart']['#uri'] = $nameLink;
|
|
137
|
}
|
|
138
|
else {
|
|
139
|
unset($template['nameAuthorPart']['#uri']);
|
|
140
|
}
|
|
141
|
}
|
|
142
|
|
|
143
|
if ($nameLink && isset($template['namePart']['#uri'])) {
|
|
144
|
$template['namePart']['#uri'] = $nameLink;
|
|
145
|
}
|
|
146
|
else {
|
|
147
|
unset($template['namePart']['#uri']);
|
|
148
|
}
|
|
149
|
|
|
150
|
if ($referenceLink && isset($template['referencePart']['#uri'])) {
|
|
151
|
$template['referencePart']['#uri'] = $referenceLink;
|
|
152
|
}
|
|
153
|
else {
|
|
154
|
unset($template['referencePart']['#uri']);
|
|
155
|
}
|
|
156
|
|
|
157
|
return $template;
|
|
158
|
}
|
|
159
|
|
|
160
|
/**
|
|
161
|
* The part definitions define the specific parts of which a rendered taxon name plus additional information will consist.
|
|
162
|
*
|
|
163
|
* A full taxon name plus additional information can consist of the following elements:
|
|
164
|
*
|
|
165
|
* - name: the taxon name inclugin rank nbut without author
|
|
166
|
* - authorTeam: The authors of a reference, also used in taxon names
|
|
167
|
* - authors: The authors of a reference, also used in taxon names
|
|
168
|
* - reference: the nomenclatural reference,
|
|
169
|
* - microreference: Volume, page number etc.
|
|
170
|
* - status: The nomenclatural status of a name
|
|
171
|
* - description: name descriptions like protologues etc ...
|
|
172
|
*
|
|
173
|
* These elements are combined in the part definitions array to from the specific parts to be rendered.
|
|
174
|
* Usually the following parts are formed:
|
|
175
|
*
|
|
176
|
* The name "Lapsana communis L., Sp. Pl.: 811. 1753" shall be an example here:
|
|
177
|
* - namePart: the name and rank (in example: "Lapsana communis")
|
|
178
|
* - authorshipPart: the author (in example: "L.")
|
|
179
|
* - nameAuthorPart: the combination of name and author part (in example: "Lapsana communis L.").
|
|
180
|
* This is useful for zoological names where the authorshipPart belongs to the name and both should
|
|
181
|
* be combined when a link to the taxon is rendered.
|
|
182
|
* - referencePart: the nomencaltural reference (in example: "Sp. Pl. 1753")
|
|
183
|
* - microreferencePart: usually the page number (in example ": 811.")
|
|
184
|
* - statusPart: the nomenclatorical status
|
|
185
|
* - descriptionPart:
|
|
186
|
*
|
|
187
|
* Each set of parts is dedicated to render a specific TaxonName type, the type names are used as keys for the
|
|
188
|
* specific parts part definitions:
|
|
189
|
*
|
|
190
|
* - BotanicalName
|
|
191
|
* - ZoologicalName
|
|
192
|
* - #DEFAULT: covers ViralNames and general NonViralNames
|
|
193
|
*
|
|
194
|
* An example:
|
|
195
|
* @code
|
|
196
|
* array(
|
|
197
|
* 'ZoologicalName' => array(
|
|
198
|
* 'namePart' => array('name' => TRUE),
|
|
199
|
* 'referencePart' => array('authorTeam' => TRUE),
|
|
200
|
* 'microreferencePart' => array('microreference' => TRUE),
|
|
201
|
* 'statusPart' => array('status' => TRUE),
|
|
202
|
* 'descriptionPart' => array('description' => TRUE),
|
|
203
|
* ),
|
|
204
|
* 'BotanicalName' => array(
|
|
205
|
* 'namePart' => array(
|
|
206
|
* 'name' => TRUE,
|
|
207
|
* 'authors' => TRUE,
|
|
208
|
* ),
|
|
209
|
* 'referencePart' => array(
|
|
210
|
* 'reference' => TRUE,
|
|
211
|
* 'microreference' => TRUE,
|
|
212
|
* ),
|
|
213
|
* 'statusPart' => array('status' => TRUE),
|
|
214
|
* 'descriptionPart' => array('description' => TRUE),
|
|
215
|
* ),
|
|
216
|
* );
|
|
217
|
* @endcode
|
|
218
|
*
|
|
219
|
* @param object $taxonNameType
|
|
220
|
* A cdm TaxonNameType entity
|
|
221
|
*
|
|
222
|
*/
|
|
223
|
function get_partDefinition($taxonNameType) {
|
|
224
|
|
|
225
|
static $default_part_definitions = null;
|
|
226
|
if (!isset($default_part_definitions)) {
|
|
227
|
$default_part_definitions= unserialize(CDM_PART_DEFINITIONS_DEFAULT);
|
|
228
|
}
|
|
229
|
|
|
230
|
static $part_definitions = null;
|
|
231
|
if (!isset($part_definitions)) {
|
|
232
|
$part_definitions = object_to_array(variable_get(CDM_PART_DEFINITIONS, $default_part_definitions));
|
|
233
|
}
|
|
234
|
|
|
235
|
$dtype = nameTypeToDTYPE($taxonNameType);
|
|
236
|
if (array_key_exists($taxonNameType, $part_definitions)) {
|
|
237
|
return $part_definitions[$taxonNameType];
|
|
238
|
} else if (array_key_exists($dtype, $part_definitions)) {
|
|
239
|
return $part_definitions[$dtype];
|
|
240
|
} else {
|
|
241
|
return $part_definitions['#DEFAULT']; // covers ViralNames and general NonViralNames
|
|
242
|
}
|
|
243
|
|
|
244
|
}
|
|
245
|
|
|
246
|
|
|
247
|
/**
|
|
248
|
* Renders the markup for a CDM TaxonName instance.
|
|
249
|
*
|
|
250
|
* The layout of the name representation is configured by the
|
|
251
|
* part_definitions and render_templates (see get_partDefinition() and
|
|
252
|
* get_nameRenderTemplate())
|
|
253
|
*
|
|
254
|
* @param $taxonName
|
|
255
|
* cdm TaxonName instance
|
|
256
|
* @param $nameLink
|
|
257
|
* URI to the taxon, @see path_to_taxon(), must be processed by url() before passing to this method
|
|
258
|
* @param $refenceLink
|
|
259
|
* URI to the reference, @see path_to_reference(), must be processed by url() before passing to this method
|
|
260
|
* @param $show_annotations
|
|
261
|
* turns the display of annotations on
|
|
262
|
* @param $is_type_designation
|
|
263
|
* To indicate that the supplied taxon name is a name type designation.
|
|
264
|
* @param $skiptags
|
|
265
|
* an array of name elements tags like 'name', 'rank' to skip. The name part
|
|
266
|
* 'authors' will not ber affected by this filter. This part is managed though the render template
|
|
267
|
* mechanism.
|
|
268
|
* @param $is_invalid
|
|
269
|
* Indicates that this taxon is invalid. In this case the name part will be shown in double quotes.
|
|
270
|
* This is useful when rendering taxon relation ships.
|
|
271
|
*
|
|
272
|
* @return string
|
|
273
|
* The markup for a taxon name.
|
|
274
|
*
|
|
275
|
*/
|
|
276
|
function render_taxon_or_name($taxon_name_or_taxon_base, $nameLink = NULL, $refenceLink = NULL,
|
|
277
|
$show_annotations = true, $is_type_designation = false, $skiptags = array(), $is_invalid = false) {
|
|
278
|
|
|
279
|
$is_doubtful = false;
|
|
280
|
|
|
281
|
if($taxon_name_or_taxon_base->class == 'Taxon' || $taxon_name_or_taxon_base->class == 'Synonym'){
|
|
282
|
$taxonName = $taxon_name_or_taxon_base->name;
|
|
283
|
$is_doubtful = $taxon_name_or_taxon_base->doubtful;
|
|
284
|
// use the TaxonBase.taggedTitle so we have the secRef
|
|
285
|
$taggedTitle = $taxon_name_or_taxon_base->taggedTitle;
|
|
286
|
} else {
|
|
287
|
// assuming this is a TaxonName
|
|
288
|
$taxonName = $taxon_name_or_taxon_base;
|
|
289
|
$taggedTitle = $taxon_name_or_taxon_base->taggedName;
|
|
290
|
}
|
|
291
|
|
|
292
|
|
|
293
|
$renderTemplate = get_nameRenderTemplate(RenderHints::getRenderPath(), $nameLink, $refenceLink);
|
|
294
|
$partDefinition = get_partDefinition($taxonName->nameType);
|
|
295
|
|
|
296
|
// Apply definitions to template.
|
|
297
|
foreach ($renderTemplate as $part => $uri) {
|
|
298
|
|
|
299
|
if (isset($partDefinition[$part])) {
|
|
300
|
$renderTemplate[$part] = $partDefinition[$part];
|
|
301
|
}
|
|
302
|
if (is_array($uri) && isset($uri['#uri'])) {
|
|
303
|
$renderTemplate[$part]['#uri'] = $uri['#uri'];
|
|
304
|
}
|
|
305
|
}
|
|
306
|
|
|
307
|
$secref_tagged_text = tagged_text_extract_secref($taggedTitle);
|
|
308
|
$nom_status_tagged_text = tagged_text_extract_nomstatus($taggedTitle);
|
|
309
|
$appended_phrase_tagged_text = array(); // this is filled later
|
|
310
|
|
|
311
|
normalize_tagged_text($taggedTitle);
|
|
312
|
|
|
313
|
$firstEntryIsValidNamePart =
|
|
314
|
isset($taggedTitle)
|
|
315
|
&& is_array($taggedTitle)
|
|
316
|
&& isset($taggedTitle[0]->text)
|
|
317
|
&& is_string($taggedTitle[0]->text)
|
|
318
|
&& $taggedTitle[0]->text != ''
|
|
319
|
&& isset($taggedTitle[0]->type)
|
|
320
|
&& $taggedTitle[0]->type == 'name';
|
|
321
|
$lastAuthorElementString = FALSE;
|
|
322
|
|
|
323
|
$name_encasement = $is_invalid ? '"' : '';
|
|
324
|
$doubtful_marker = $is_doubtful ? '? ' : ''; //   = NARROW NO-BREAK SPACE
|
|
325
|
$doubtful_marker_markup = '';
|
|
326
|
|
|
327
|
if($doubtful_marker){
|
|
328
|
$doubtful_marker_markup = '<span class="doubtful">' . $doubtful_marker . '</span>';
|
|
329
|
}
|
|
330
|
|
|
331
|
// split off all appendedPhrase item from the end of the array (usually there only should be one)
|
|
332
|
while($taggedTitle[count($taggedTitle)-1]->type == "appendedPhrase"){
|
|
333
|
$appended_phrase_tagged_text[] = array_pop($taggedTitle);
|
|
334
|
}
|
|
335
|
|
|
336
|
// Got to use second entry as first one, see ToDo comment below ...
|
|
337
|
if ($firstEntryIsValidNamePart) {
|
|
338
|
|
|
339
|
$taggedName = $taggedTitle;
|
|
340
|
$hasNamePart_with_Authors = isset($renderTemplate['namePart']) && isset($renderTemplate['namePart']['authors']);
|
|
341
|
$hasNameAuthorPart_with_Authors = isset($renderTemplate['nameAuthorPart']) && isset($renderTemplate['nameAuthorPart']['authors']);
|
|
342
|
|
|
343
|
|
|
344
|
if (!(($hasNamePart_with_Authors) || ($hasNameAuthorPart_with_Authors))) {
|
|
345
|
// Find author and split off from name.
|
|
346
|
// TODO expecting to find the author as the last element.
|
|
347
|
/*
|
|
348
|
if($taggedName[count($taggedName)- 1]->type == 'authors'){
|
|
349
|
$authorTeam = $taggedName[count($taggedName)- 1]->text;
|
|
350
|
unset($taggedName[count($taggedName)- 1]);
|
|
351
|
}
|
|
352
|
*/
|
|
353
|
|
|
354
|
// Remove all authors.
|
|
355
|
$taggedNameNew = array();
|
|
356
|
foreach ($taggedName as $element) {
|
|
357
|
if ($element->type != 'authors') {
|
|
358
|
$taggedNameNew[] = $element;
|
|
359
|
}
|
|
360
|
else {
|
|
361
|
$lastAuthorElementString = $element->text;
|
|
362
|
}
|
|
363
|
}
|
|
364
|
$taggedName = $taggedNameNew;
|
|
365
|
unset($taggedNameNew);
|
|
366
|
}
|
|
367
|
$name = '<span class="' . $taxonName->class . '">' . $doubtful_marker_markup . $name_encasement . cdm_tagged_text_to_markup($taggedName, $skiptags) . $name_encasement . '</span>';
|
|
368
|
}
|
|
369
|
else {
|
|
370
|
$name = '<span class="' . $taxonName->class . '_titleCache">' . $doubtful_marker_markup . $name_encasement . $taxonName->titleCache . $name_encasement . '</span>';
|
|
371
|
}
|
|
372
|
|
|
373
|
|
|
374
|
if(isset($appended_phrase_tagged_text[0])){
|
|
375
|
$name .= ' <span class="appended-phrase">'. cdm_tagged_text_to_markup($appended_phrase_tagged_text) . '</span>';
|
|
376
|
}
|
|
377
|
|
|
378
|
// Fill name into $renderTemplate.
|
|
379
|
array_setr('name', $name , $renderTemplate);
|
|
380
|
|
|
381
|
// Fill with authorTeam.
|
|
382
|
/*
|
|
383
|
if($authorTeam){
|
|
384
|
$authorTeamHtml = ' <span class="authorTeam">'.$authorTeam.'</span>';
|
|
385
|
array_setr('authorTeam', $authorTeamHtml, $renderTemplate);
|
|
386
|
}
|
|
387
|
*/
|
|
388
|
|
|
389
|
// Fill with reference.
|
|
390
|
if (isset($renderTemplate['referencePart']) && !$is_type_designation) {
|
|
391
|
|
|
392
|
$registrations = cdm_ws_get(CDM_WS_NAME, array($taxonName->uuid, "registrations"));
|
|
393
|
$registration_markup = render_registrations($registrations);
|
|
394
|
|
|
395
|
// default separator
|
|
396
|
$separator = '';
|
|
397
|
|
|
398
|
// [Eckhard]:"Komma nach dem Taxonnamen ist grunsätzlich falsch,
|
|
399
|
// Komma nach dem Autornamen ist überall dort falsch, wo ein "in" folgt."
|
|
400
|
if (isset($renderTemplate['referencePart']['reference']) && isset($taxonName->nomenclaturalReference)) {
|
|
401
|
$microreference = NULL;
|
|
402
|
if (isset($renderTemplate['referencePart']['microreference'])&& isset($taxonName->nomenclaturalMicroReference)) {
|
|
403
|
$microreference = $taxonName->nomenclaturalMicroReference;
|
|
404
|
}
|
|
405
|
$citation = cdm_ws_getNomenclaturalReference($taxonName->nomenclaturalReference->uuid, $microreference);
|
|
406
|
|
|
407
|
// Find preceding element of the reference.
|
|
408
|
$precedingKey = get_preceding_contentElementKey('reference', $renderTemplate);
|
|
409
|
if (str_beginsWith($citation, ", in")) {
|
|
410
|
$citation = substr($citation, 2);
|
|
411
|
$separator = ' ';
|
|
412
|
}
|
|
413
|
elseif (!str_beginsWith($citation, "in") && $precedingKey == 'authors') {
|
|
414
|
$separator = ', ';
|
|
415
|
} else {
|
|
416
|
$separator = ' ';
|
|
417
|
}
|
|
418
|
|
|
419
|
|
|
420
|
$referenceArray['#separator'] = $separator;
|
|
421
|
$referenceArray['#html'] = '<span class="reference">' . $citation . '</span>' . $registration_markup;
|
|
422
|
array_setr('reference', $referenceArray, $renderTemplate);
|
|
423
|
}
|
|
424
|
|
|
425
|
// If authors have been removed from the name part the last named authorteam
|
|
426
|
// should be added to the reference citation, otherwise, keep the separator
|
|
427
|
// out of the reference.
|
|
428
|
if (isset($renderTemplate['referencePart']['authors']) && $lastAuthorElementString) {
|
|
429
|
// If the nomenclaturalReference citation is not included in the
|
|
430
|
// reference part but display of the microreference
|
|
431
|
// is wanted, append the microreference to the authorTeam.
|
|
432
|
$citation = '';
|
|
433
|
if (!isset($renderTemplate['referencePart']['reference']) && isset($renderTemplate['referencePart']['microreference'])) {
|
|
434
|
$separator = ": ";
|
|
435
|
$citation = $taxonName->nomenclaturalMicroReference;
|
|
436
|
}
|
|
437
|
$referenceArray['#html'] = ' <span class="reference">' . $lastAuthorElementString . $separator . $citation . '</span>';
|
|
438
|
array_setr('authors', $referenceArray, $renderTemplate);
|
|
439
|
}
|
|
440
|
}
|
|
441
|
|
|
442
|
$is_reference_year = false;
|
|
443
|
if (isset($renderTemplate['referenceYearPart']['reference.year'])) {
|
|
444
|
if(isset($taxonName->nomenclaturalReference->datePublished)){
|
|
445
|
$referenceArray['#html'] = ' <span class="reference">' . timePeriodToString($taxonName->nomenclaturalReference->datePublished) . '</span>';
|
|
446
|
array_setr('reference.year', $referenceArray, $renderTemplate);
|
|
447
|
$is_reference_year = true;
|
|
448
|
}
|
|
449
|
}
|
|
450
|
|
|
451
|
// Fill with status.
|
|
452
|
if(isset($renderTemplate['statusPart']['status'])){
|
|
453
|
if (isset($nom_status_tagged_text[0])) {
|
|
454
|
array_setr('status', '<span class="nomenclatural_status">' . cdm_tagged_text_to_markup($nom_status_tagged_text, array('postSeparator')) . '</span>', $renderTemplate);
|
|
455
|
}
|
|
456
|
}
|
|
457
|
|
|
458
|
if (isset($renderTemplate['secReferencePart'])){
|
|
459
|
if(isset($secref_tagged_text[1])){
|
|
460
|
$post_separator_markup = $is_reference_year ? '.': '';
|
|
461
|
if(isset($nom_status_tagged_text[count($nom_status_tagged_text) - 1]) && ($nom_status_tagged_text[count($nom_status_tagged_text) - 1]->type == 'postSeparator')){
|
|
462
|
$post_separator_markup = cdm_tagged_text_to_markup(array($nom_status_tagged_text[count($nom_status_tagged_text) - 1 ]));
|
|
463
|
};
|
|
464
|
array_setr('secReference',
|
|
465
|
$post_separator_markup
|
|
466
|
. ' <span class="sec_reference">'
|
|
467
|
. join('', cdm_tagged_text_values($secref_tagged_text))
|
|
468
|
. '</span>', $renderTemplate);
|
|
469
|
}
|
|
470
|
}
|
|
471
|
|
|
472
|
// Fill with protologues etc...
|
|
473
|
$descriptionHtml = '';
|
|
474
|
if (array_setr('description', TRUE, $renderTemplate)) {
|
|
475
|
$descriptions = cdm_ws_get(CDM_WS_PORTAL_NAME_DESCRIPTIONS, $taxonName->uuid);
|
|
476
|
foreach ($descriptions as $description) {
|
|
477
|
if (!empty($description)) {
|
|
478
|
foreach ($description->elements as $description_element) {
|
|
479
|
$second_citation = '';
|
|
480
|
if (isset($description_element->multilanguageText_L10n) && $description_element->multilanguageText_L10n->text) {
|
|
481
|
$second_citation = '[& ' . $description_element->multilanguageText_L10n->text . '].';
|
|
482
|
}
|
|
483
|
$descriptionHtml .= $second_citation;
|
|
484
|
$descriptionHtml .= cdm_description_element_media(
|
|
485
|
$description_element,
|
|
486
|
array(
|
|
487
|
'application/pdf',
|
|
488
|
'image/png',
|
|
489
|
'image/jpeg',
|
|
490
|
'image/gif',
|
|
491
|
'text/html',
|
|
492
|
)
|
|
493
|
);
|
|
494
|
|
|
495
|
}
|
|
496
|
}
|
|
497
|
}
|
|
498
|
array_setr('description', $descriptionHtml, $renderTemplate);
|
|
499
|
}
|
|
500
|
|
|
501
|
// Render.
|
|
502
|
$out = '';
|
|
503
|
if(isset($_REQUEST['RENDER_PATH'])){
|
|
504
|
// developer option to show the render path with each taxon name
|
|
505
|
$out .= '<span class="render-path">' . RenderHints::getRenderPath() . '</span>';
|
|
506
|
}
|
|
507
|
$out .= '<span class="' . html_class_attribute_ref($taxon_name_or_taxon_base)
|
|
508
|
. '" data-cdm-ref="/name/' . $taxonName->uuid . '" data-cdm-render-path="' . RenderHints::getRenderPath() .'">';
|
|
509
|
|
|
510
|
foreach ($renderTemplate as $partName => $part) {
|
|
511
|
$separator = '';
|
|
512
|
$partHtml = '';
|
|
513
|
$uri = FALSE;
|
|
514
|
if (!is_array($part)) {
|
|
515
|
continue;
|
|
516
|
}
|
|
517
|
if (isset($part['#uri']) && is_string($part['#uri'])) {
|
|
518
|
$uri = $part['#uri'];
|
|
519
|
unset($part['#uri']);
|
|
520
|
}
|
|
521
|
foreach ($part as $key => $content) {
|
|
522
|
$html = '';
|
|
523
|
if (is_array($content)) {
|
|
524
|
$html = $content['#html'];
|
|
525
|
if(isset($content['#separator'])) {
|
|
526
|
$separator = $content['#separator'];
|
|
527
|
}
|
|
528
|
}
|
|
529
|
elseif (is_string($content)) {
|
|
530
|
$html = $content;
|
|
531
|
}
|
|
532
|
$partHtml .= '<span class="' . $key . '">' . $html . '</span>';
|
|
533
|
}
|
|
534
|
if ($uri) {
|
|
535
|
// cannot use l() here since the #uri aleady should have been processed through uri() at this point
|
|
536
|
$out .= $separator . '<a href="' . $uri . '" class="' . $partName . '">' . $partHtml . '</a>';
|
|
537
|
|
|
538
|
}
|
|
539
|
else {
|
|
540
|
$out .= $separator . $partHtml;
|
|
541
|
}
|
|
542
|
}
|
|
543
|
$out .= '</span>';
|
|
544
|
if ($show_annotations) {
|
|
545
|
// $out .= theme('cdm_annotations_as_footnotekeys', $taxonName);
|
|
546
|
}
|
|
547
|
return $out;
|
|
548
|
}
|
|
549
|
|
|
550
|
/**
|
|
551
|
* @param $registrations
|
|
552
|
* @return string
|
|
553
|
*/
|
|
554
|
function render_registrations($registrations)
|
|
555
|
{
|
|
556
|
$registration_markup = '';
|
|
557
|
$registration_markup_array = array();
|
|
558
|
if ($registrations) {
|
|
559
|
foreach ($registrations as $reg) {
|
|
560
|
$registration_markup_array[] = render_registration($reg);
|
|
561
|
}
|
|
562
|
$registration_markup = " Registration" . (count($registration_markup_array) > 1 ? 's: ' : ': ')
|
|
563
|
. join(', ', $registration_markup_array);
|
|
564
|
}
|
|
565
|
return $registration_markup;
|
|
566
|
}
|
|
567
|
|
|
568
|
|
|
569
|
/**
|
|
570
|
* Composes the TypedEntityReference to name type designations passed as associatve array.
|
|
571
|
*
|
|
572
|
* @param $$type_entity_refs array
|
|
573
|
* an associative array of name type type => TypedEntityReference for name type designations as
|
|
574
|
* produced by the eu.etaxonomy.cdm.api.service.name.TypeDesignationSetManager
|
|
575
|
*
|
|
576
|
* @ingroup compose
|
|
577
|
*/
|
|
578
|
function compose_name_type_designations($type_entity_refs){
|
|
579
|
$render_array = array();
|
|
580
|
foreach($type_entity_refs as $type_status => $name_type){
|
|
581
|
$type_designation = cdm_ws_get(CDM_TYPEDESIGNATION, array($name_type->uuid, 'preferredUri'));
|
|
582
|
if(isset($type_designation->typeSpecimen->preferredStableUri) && $type_designation->typeSpecimen->preferredStableUri){
|
|
583
|
$preferredStableUri = $type_designation->typeSpecimen->preferredStableUri;
|
|
584
|
}
|
|
585
|
$render_array[] = markup_to_render_array('<div class="name_type_designation ' . html_class_attribute_ref($name_type) . '"><span class="type_status">'. ucfirst($type_status) . "</span>: "
|
|
586
|
. $name_type->label
|
|
587
|
. ($preferredStableUri ? " ". l($preferredStableUri, $preferredStableUri) : '')
|
|
588
|
. '</div>');
|
|
589
|
}
|
|
590
|
return $render_array;
|
|
591
|
}
|
|
592
|
|
|
593
|
/**
|
|
594
|
* Composes the TypedEntityReference to specimen type designations passed as associatve array.
|
|
595
|
*
|
|
596
|
* @param $type_entity_refs array
|
|
597
|
* an associative array of specimen type type => TypedEntityReference for specimen type designations as
|
|
598
|
* produced by the eu.etaxonomy.cdm.api.service.name.TypeDesignationSetManager
|
|
599
|
*
|
|
600
|
* @ingroup compose
|
|
601
|
*/
|
|
602
|
function compose_specimen_type_designations($type_entity_refs){
|
|
603
|
$render_array = array();
|
|
604
|
foreach($type_entity_refs as $type_status => $specimen_type){
|
|
605
|
$type_designation = cdm_ws_get(CDM_TYPEDESIGNATION, array($specimen_type->uuid));
|
|
606
|
$preferredStableUri = '';
|
|
607
|
if(isset($type_designation->typeSpecimen->preferredStableUri) && $type_designation->typeSpecimen->preferredStableUri){
|
|
608
|
$preferredStableUri = $type_designation->typeSpecimen->preferredStableUri;
|
|
609
|
}
|
|
610
|
$render_array[] = markup_to_render_array('<div class="specimen_type_designation ' . html_class_attribute_ref($specimen_type) . '"><span class="type_status">'
|
|
611
|
. ucfirst($type_status)
|
|
612
|
. "</span>: "
|
|
613
|
. $specimen_type->label
|
|
614
|
. ($preferredStableUri ? " ". l($preferredStableUri, $preferredStableUri) : '')
|
|
615
|
. '</div>');
|
|
616
|
}
|
|
617
|
return $render_array;
|
|
618
|
}
|
|
619
|
|
|
620
|
/**
|
|
621
|
* Renders the name relationships.
|
|
622
|
*
|
|
623
|
* @param $name_relations
|
|
624
|
* The list of CDM NameRelationsips
|
|
625
|
* @param $current_name_uuid
|
|
626
|
* The Uuid of the name for which the relations are to be rendered, the current name will be hidden when
|
|
627
|
* rendering the relation an only the other name is shown. Parameter is REQUIRED.
|
|
628
|
* @param $suppress_if_current_name_is_source
|
|
629
|
* The display of the relation will be
|
|
630
|
* suppressed is the current name is on the source of the relation edge.
|
|
631
|
* That is if it is on the from side of the relation. Except for 'blocking name for' which is
|
|
632
|
* an inverse relation. For this relation type the toName is taken in to account.
|
|
633
|
* @param $current_taxon_uuid
|
|
634
|
* The taxon to be omitted from related taxa. This is only used to create links, see path_to_name()
|
|
635
|
* @return String
|
|
636
|
* The markup for the name relationships
|
|
637
|
*/
|
|
638
|
function render_name_relationships_of($name_relations, $current_name_uuid, $current_taxon_uuid, $suppress_if_current_name_is_source = true) {
|
|
639
|
|
|
640
|
static $inverse_name_rels_uuids = array(UUID_NAMERELATIONSHIPTYPE_BLOCKING_NAME_FOR);
|
|
641
|
|
|
642
|
RenderHints::pushToRenderStack('homonym');
|
|
643
|
// the render stack element homonyms is being used in the default render templates !!!, see CDM_NAME_RENDER_TEMPLATES_DEFAULT
|
|
644
|
|
|
645
|
$selected_name_rel_uuids = variable_get(CDM_NAME_RELATIONSHIP_TYPES, unserialize(CDM_NAME_RELATIONSHIP_TYPES_DEFAULT));
|
|
646
|
|
|
647
|
$relations_array = array();
|
|
648
|
|
|
649
|
if ($name_relations) {
|
|
650
|
foreach ($name_relations as $name_rel) {
|
|
651
|
if (!(isset($selected_name_rel_uuids[$name_rel->type->uuid]) && $selected_name_rel_uuids[$name_rel->type->uuid])) {
|
|
652
|
// skip if not selected in the settings
|
|
653
|
continue;
|
|
654
|
}
|
|
655
|
$is_inverse_relation = array_search($name_rel->type->uuid, $inverse_name_rels_uuids) !== false;
|
|
656
|
$is_current_name_to_name = $current_name_uuid == $name_rel->toName->uuid;
|
|
657
|
$is_current_name_from_name = $current_name_uuid == $name_rel->fromName->uuid;
|
|
658
|
$relationship_markup = null;
|
|
659
|
|
|
660
|
if($is_current_name_to_name && ($suppress_if_current_name_is_source && $is_inverse_relation || !$suppress_if_current_name_is_source)){
|
|
661
|
$highlited_synonym_uuid = isset ($name_rel->fromName->taxonBases[0]->uuid) ? $name_rel->fromName->taxonBases[0]->uuid : '';
|
|
662
|
$relationship_markup = render_taxon_or_name($name_rel->fromName,
|
|
663
|
url(path_to_name($name_rel->fromName->uuid, $current_taxon_uuid, $highlited_synonym_uuid))
|
|
664
|
);
|
|
665
|
} else if($is_current_name_from_name && ($suppress_if_current_name_is_source && !$is_inverse_relation || !$suppress_if_current_name_is_source)){
|
|
666
|
$highlited_synonym_uuid = isset ($name_rel->toName->taxonBases[0]->uuid) ? $name_rel->toName->taxonBases[0]->uuid : '';
|
|
667
|
$relationship_markup = render_taxon_or_name($name_rel->toName,
|
|
668
|
url(path_to_name($name_rel->toName->uuid, $current_taxon_uuid, $highlited_synonym_uuid))
|
|
669
|
);
|
|
670
|
}
|
|
671
|
|
|
672
|
if($relationship_markup){
|
|
673
|
if (count($relations_array)) {
|
|
674
|
// lat: "non nec" == german: "weder noch"
|
|
675
|
$relations_array [] = 'nec ' . $relationship_markup;
|
|
676
|
} else {
|
|
677
|
$relations_array [] = 'non ' . $relationship_markup;
|
|
678
|
}
|
|
679
|
}
|
|
680
|
|
|
681
|
}
|
|
682
|
}
|
|
683
|
|
|
684
|
RenderHints::popFromRenderStack();
|
|
685
|
return (count($relations_array) ?'<div class="name-relationships">[' . trim(join(" ", $relations_array)) . ']</div>' : '');
|
|
686
|
}
|
|
687
|
|
|
688
|
/**
|
|
689
|
* @param $taxon
|
|
690
|
* @return array
|
|
691
|
*/
|
|
692
|
function cdm_name_relationships_for_taxon($taxon)
|
|
693
|
{
|
|
694
|
$from_name_relations = cdm_ws_get(CDM_WS_PORTAL_TAXON_FROM_NAMERELATIONS, $taxon->uuid);
|
|
695
|
$to_name_relations = cdm_ws_get(CDM_WS_PORTAL_TAXON_TO_NAMERELATIONS, $taxon->uuid);
|
|
696
|
$name_relations = array_merge($from_name_relations, $to_name_relations);
|
|
697
|
return $name_relations;
|
|
698
|
}
|
|
699
|
|
|
700
|
|
|
701
|
/**
|
|
702
|
* Recursively searches the array for the $key and sets the given value.
|
|
703
|
*
|
|
704
|
* @param mixed $key
|
|
705
|
* Key to search for.
|
|
706
|
* @param mixed $value
|
|
707
|
* Value to set.'
|
|
708
|
* @param array $array
|
|
709
|
* Array to search in.
|
|
710
|
*
|
|
711
|
* @return bool
|
|
712
|
* True if the key has been found.
|
|
713
|
*/
|
|
714
|
function &array_setr($key, $value, array &$array) {
|
|
715
|
$res = NULL;
|
|
716
|
foreach ($array as $k => &$v) {
|
|
717
|
if ($key == $k) {
|
|
718
|
$v = $value;
|
|
719
|
return $array;
|
|
720
|
}
|
|
721
|
elseif (is_array($v)) {
|
|
722
|
$innerArray = array_setr($key, $value, $v);
|
|
723
|
if ($innerArray) {
|
|
724
|
return $array;
|
|
725
|
}
|
|
726
|
}
|
|
727
|
}
|
|
728
|
return $res;
|
|
729
|
}
|
|
730
|
|
|
731
|
/**
|
|
732
|
* @todo Please document this function.
|
|
733
|
* @see http://drupal.org/node/1354
|
|
734
|
*/
|
|
735
|
function &get_preceding_contentElement($contentElementKey, array &$renderTemplate) {
|
|
736
|
$res = NULL;
|
|
737
|
$precedingElement = NULL;
|
|
738
|
foreach ($renderTemplate as &$part) {
|
|
739
|
foreach ($part as $key => &$element) {
|
|
740
|
if ($key == $contentElementKey) {
|
|
741
|
return $precedingElement;
|
|
742
|
}
|
|
743
|
$precedingElement = $element;
|
|
744
|
}
|
|
745
|
}
|
|
746
|
return $res;
|
|
747
|
}
|
|
748
|
|
|
749
|
/**
|
|
750
|
* @todo Please document this function.
|
|
751
|
* @see http://drupal.org/node/1354
|
|
752
|
*/
|
|
753
|
function &get_preceding_contentElementKey($contentElementKey, array &$renderTemplate) {
|
|
754
|
$res = NULL;
|
|
755
|
$precedingKey = NULL;
|
|
756
|
foreach ($renderTemplate as &$part) {
|
|
757
|
if (is_array($part)) {
|
|
758
|
foreach ($part as $key => &$element) {
|
|
759
|
if ($key == $contentElementKey) {
|
|
760
|
return $precedingKey;
|
|
761
|
}
|
|
762
|
if (!str_beginsWith($key, '#')) {
|
|
763
|
$precedingKey = $key;
|
|
764
|
}
|
|
765
|
}
|
|
766
|
}
|
|
767
|
}
|
|
768
|
return $res;
|
|
769
|
}
|
|
770
|
|
|
771
|
function nameTypeToDTYPE($dtype){
|
|
772
|
static $nameTypeLabelMap = array(
|
|
773
|
"ICNB" => "BacterialName",
|
|
774
|
"ICNAFP" => "BotanicalName",
|
|
775
|
"ICNCP" => "CultivarPlantName",
|
|
776
|
"ICZN" => "ZoologicalName",
|
|
777
|
"ICVCN" => "ViralName",
|
|
778
|
"Any taxon name" => "TaxonName",
|
|
779
|
"NonViral" => "TaxonName",
|
|
780
|
"Fungus" => "BotanicalName",
|
|
781
|
"Plant" => "BotanicalName",
|
|
782
|
"Algae" => "BotanicalName",
|
|
783
|
);
|
|
784
|
return $nameTypeLabelMap[$dtype];
|
|
785
|
|
|
786
|
}
|