|
1
|
<?php
|
|
2
|
/**
|
|
3
|
* @file
|
|
4
|
* Provides tokens for taxa, names, references, etc.
|
|
5
|
*
|
|
6
|
* @copyright
|
|
7
|
* (C) 2021 EDIT
|
|
8
|
* European Distributed Institute of Taxonomy
|
|
9
|
* http://www.cybertaxonopmy.org
|
|
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
|
* Implements hook_token_info().
|
|
21
|
*/
|
|
22
|
function cdm_tokens_token_info() {
|
|
23
|
$info = array();
|
|
24
|
|
|
25
|
$info['tokens']['cdm']['taxon_name'] = t('The taxon name consisting of all name parts and sub species rank. (Only present on a cdm_dataportal/taxon/ or cdm_dataportal/name/* page)');
|
|
26
|
$info['tokens']['cdm']['taxon_name:genus_or_uninomial'] = t('The taxon names uninomial or genus name. (Only present on a cdm_dataportal/taxon/ or cdm_dataportal/name/* page)');
|
|
27
|
$info['tokens']['cdm']['taxon_name:family'] = t('The family name. (Only present on a cdm_dataportal/taxon/ or cdm_dataportal/name/* page)');
|
|
28
|
$info['tokens']['cdm']['taxon_name:genus'] = t('The genus name. (Only present on a cdm_dataportal/taxon/ or cdm_dataportal/name/* page)');
|
|
29
|
$info['tokens']['cdm']['taxon_name:infrageneric_epithet'] = t('The genus name. (Only present on a cdm_dataportal/taxon/ or cdm_dataportal/name/* page)');
|
|
30
|
$info['tokens']['cdm']['taxon_name:epithet'] = t('The taxon names specific epithet. (Only present on a cdm_dataportal/taxon/ or cdm_dataportal/name/* page');
|
|
31
|
$info['tokens']['cdm']['taxon_name:infraspecific_epithet'] = t('The taxon names specific epithet. (Only present on a cdm_dataportal/taxon/ or cdm_dataportal/name/* page');
|
|
32
|
$info['tokens']['cdm']['taxon_name:reference'] = t('The taxon name nomenclatural reference. (Only present on a cdm_dataportal/taxon/ or cdm_dataportal/name/* page');
|
|
33
|
// $info['tokens']['cdm']['taxon_name:reference:doi'] = t('The taxon name nomenclatural reference. (Only present on a cdm_dataportal/taxon/ or cdm_dataportal/name/* page');
|
|
34
|
$info['tokens']['cdm']['taxon_name:authorship'] = t('The author(s) of taxon name. (Only present on a cdm_dataportal/taxon/ or cdm_dataportal/name/* page');
|
|
35
|
$info['tokens']['cdm']['taxon_name:rank'] = t('The names rank. (Only present on a cdm_dataportal/taxon/ or cdm_dataportal/name/* page');
|
|
36
|
|
|
37
|
return $info;
|
|
38
|
}
|
|
39
|
|
|
40
|
/**
|
|
41
|
* Implements hook_tokens().
|
|
42
|
*/
|
|
43
|
function cdm_tokens_tokens($type, $tokens, array $data = array(), array $options = array()) {
|
|
44
|
$replacements = array();
|
|
45
|
if ($type == 'cdm') {
|
|
46
|
$token_values = _cdm_tokens_taxon_or_name();
|
|
47
|
foreach ($tokens as $name => $original) {
|
|
48
|
// Find the desired token by name
|
|
49
|
switch ($name) {
|
|
50
|
case 'taxon_name':
|
|
51
|
if($token_values['taxon_name']){
|
|
52
|
$replacements[$original] = $token_values['taxon_name'];
|
|
53
|
}
|
|
54
|
break;
|
|
55
|
case 'taxon_name:genus_or_uninomial':
|
|
56
|
case 'taxon_name:family':
|
|
57
|
case 'taxon_name:genus':
|
|
58
|
case 'taxon_name:infrageneric_epithet':
|
|
59
|
case 'taxon_name:epithet':
|
|
60
|
case 'taxon_name:infraspecific_epithet':
|
|
61
|
case 'taxon_name:reference':
|
|
62
|
case 'taxon_name:authorship':
|
|
63
|
case 'taxon_name:rank':
|
|
64
|
if($token_values[$name]){
|
|
65
|
$replacements[$original] = $token_values[$name];
|
|
66
|
}
|
|
67
|
break;
|
|
68
|
}
|
|
69
|
}
|
|
70
|
}
|
|
71
|
|
|
72
|
// Return the replacements.
|
|
73
|
return $replacements;
|
|
74
|
}
|
|
75
|
|
|
76
|
|
|
77
|
function _cdm_tokens_taxon_or_name(){
|
|
78
|
static $current_token_values;
|
|
79
|
if(!isset($current_token_values)){
|
|
80
|
$current_token_values = [
|
|
81
|
'taxon_name' => null,
|
|
82
|
|
|
83
|
'taxon_name:genus_or_uninomial' => null,
|
|
84
|
'taxon_name:family' => null,
|
|
85
|
'taxon_name:genus' => null,
|
|
86
|
'taxon_name:infrageneric_epithet' => null,
|
|
87
|
'taxon_name:epithet' => null,
|
|
88
|
'taxon_name:infraspecific_epithet' => null,
|
|
89
|
'taxon_name:rank' => null,
|
|
90
|
'taxon_name:reference' => null,
|
|
91
|
// 'taxon_name:reference:doi' => null,
|
|
92
|
'taxon_name:authorship' => null
|
|
93
|
];
|
|
94
|
$taxon_name = null;
|
|
95
|
|
|
96
|
$taxon_uuid = get_current_taxon_uuid();
|
|
97
|
if($taxon_uuid){
|
|
98
|
// this is request is made anyway. Practically we only query the L1 cache here.
|
|
99
|
$taxon = cdm_ws_get(CDM_WS_PORTAL_TAXON, [$taxon_uuid]);
|
|
100
|
if(isset_not_empty($taxon)){
|
|
101
|
$taxon_name = $taxon->name;
|
|
102
|
}
|
|
103
|
} else {
|
|
104
|
$name_uuid = get_current_name_uuid();
|
|
105
|
$taxon_name = cdm_ws_get(CDM_WS_PORTAL_NAME, [$name_uuid]);
|
|
106
|
}
|
|
107
|
|
|
108
|
if(isset_not_empty($taxon_name)){
|
|
109
|
$current_token_values['taxon_name:taxon_name'] = $taxon_name->nameCache;
|
|
110
|
$current_token_values['taxon_name:family'] = $taxon_name->rank->isFamily ? $taxon_name->genusOrUninomial : null;
|
|
111
|
$current_token_values['taxon_name:genus_or_uninomial'] = $taxon_name->genusOrUninomial;
|
|
112
|
$current_token_values['taxon_name:genus'] = !$taxon_name->rank->isSupraGeneric ? $taxon_name->genusOrUninomial : null;
|
|
113
|
$current_token_values['taxon_name:infrageneric_epithet'] = $taxon_name->rank->isInfraGeneric ? $taxon_name->infraGenericEpithet : null;
|
|
114
|
$current_token_values['taxon_name:epithet'] = $taxon_name->rank->isSpecies || $taxon_name->rank->isInfraSpecific ? $taxon_name->specificEpithet : null;
|
|
115
|
$current_token_values['taxon_name:infraspecific_epithet'] = $taxon_name->rank->isInfraSpecific ? $taxon_name->infraSpecificEpithet : null;
|
|
116
|
if(@isset_not_empty($taxon_name->rank->representation_L10n)) {
|
|
117
|
$current_token_values['taxon_name:rank'] = $taxon_name->rank->representation_L10n;
|
|
118
|
}
|
|
119
|
if(@isset_not_empty($taxon_name->nomenclaturalSource->citation->titleCache)) {
|
|
120
|
$current_token_values['taxon_name:reference'] = $taxon_name->nomenclaturalSource->citation->titleCache;
|
|
121
|
}
|
|
122
|
if(@isset_not_empty($taxon_name->nomenclaturalSource->citation->authorship->titleCache)) {
|
|
123
|
$current_token_values['taxon_name:authorship'] = $taxon_name->nomenclaturalSource->citation->authorship->titleCache;
|
|
124
|
}
|
|
125
|
}
|
|
126
|
}
|
|
127
|
|
|
128
|
return $current_token_values;
|
|
129
|
}
|
|
130
|
|