Project

General

Profile

Statistics
| Branch: | Tag: | Revision:

cdm-dataportal / modules / cdm_dataportal / theme / cdm_dataportal.references.theme @ 44707ee3

History | View | Annotate | Download (5.11 KB)

1
<?php
2
/**
3
 * @file
4
 * Reference theming functions.
5
 *
6
 * @copyright
7
 *   (C) 2007-2012 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

    
16

    
17
/**
18
 * Creates a HTML representations for a CDM Reference instance..
19
 *
20
 * Used by:
21
 * - theme_cdm_typedesignations
22
 * - cdm_reference_pager
23
 * - cdm_taxonRelationships
24
 *
25
 * @param array $variables
26
 *   An associative array containing:
27
 *   - reference
28
 *   - microReference
29
 *   - doLink:
30
 *      Whether to create a link to the reference page, links to the reference URI or DOI are always
31
 *      created when this data is available
32
 *   - referenceStyle: the value "zoology" will cause a specific rendeting of the
33
 *      reference suitable for zoological publications.
34
 *
35
 * @return string
36
 *    the markup for the reference
37
 *
38
 * @ingroup themeable
39
 */
40
function theme_cdm_reference($variables) {
41
  $reference = $variables['reference'];
42
  $microReference = $variables['microReference'];
43
  $doLink = $variables['doLink'];
44
  $referenceStyle = $variables['referenceStyle'];
45

    
46
  if (!isset($reference->authorship)) {
47
    $author_team = cdm_ws_get(CDM_WS_REFERENCE_AUTHORTEAM, $reference->uuid);
48
  }
49
  else {
50
    $author_team = $reference->authorship;
51
  }
52
  if ($referenceStyle == "zoology") {
53
    $year = '';
54
    if (isset($reference->datePublished)) {
55
      $year = timePeriodToString($reference->datePublished, true, 'YYYY');
56
    }
57
    $citation = $author_team->titleCache . (!empty($year) ? '. ' . $year : '');
58
  }
59
  else {
60
    $citation = $reference->titleCache;
61
  }
62

    
63
  $citation = trim($citation);
64
  if (isset($doLink) && $doLink === TRUE) {
65
    $out = '<span class="reference">';
66
    $out .= l($citation, path_to_reference($reference->uuid), array(
67
      'attributes' => array(
68
        "class" => "reference",
69
      ),
70
      'absolute' => TRUE,
71
      'html' => TRUE,
72
    ));
73
    $out .= '</span>';
74
  }
75
  else {
76
    $out = '<span class="reference">' . $citation . '</span>';
77
  }
78

    
79
  if (!empty($microReference)) {
80
    $out .= ": " . $microReference;
81
  }
82

    
83
  if(isset($reference->doi)){
84
    $out .= cdm_doi($reference->doi);
85
  }
86

    
87
  if (isset($reference->uri)){
88
    if($reference->type == 'WebPage'){
89
      // the cdm cache strategy adds the uri to the titleCache which is unwanted in this case,
90
      // so is is removed from there
91
      $out = str_replace('- ' . $reference->uri, '',  $out);
92
    }
93
    $out .= cdm_external_uri($reference->uri);
94
  }
95

    
96
  return $out;
97
}
98

    
99
/**
100
 * Creates a anchor tag as clickable link to an external resource, either as text link or as icon.
101
 * The resulting link will have no 'target' attribute, so the link will open in the same tab by default.
102
 * So the users can decide.
103
 *
104
 * @param $uri
105
 *    The uri to link to
106
 * @param $iconified
107
 *    The link will be rendered as icon of this is true.
108
 * @return string
109
 *
110
 */
111
function cdm_external_uri($uri, $iconified = true)
112
{
113
  $options = array(
114
    'external' => true,
115
    'html' => false,
116
    );
117
  if (!empty($uri)) {
118
    if($iconified){
119
      $options['html'] = true;
120
      return l(font_awesome_icon_markup('fa-external-link', array('class' => array('superscript'))), $uri, $options);
121
    } else {
122
      return l($uri, $uri, $options);
123
    }
124
  }
125
}
126

    
127
/**
128
 * Creates markup for a CDM Doi entity.
129
 *
130
 * @param $doi
131
 *  The CDM DOI
132
 *
133
 * @return string
134
 *  Markup
135
 */
136
function cdm_doi($doi, $iconified = true) {
137

    
138
  if (!empty($doi)) {
139

    
140
    $doi_resolve_uri = 'http://doi.org/' . $doi->prefix;
141
    if (isset($doi->suffix)) {
142
      $doi_resolve_uri .= '/' . $doi->suffix;
143
    }
144
    if($iconified){
145
      return l(font_awesome_icon_markup('fa-external-link-square', array('class' => array('superscript'))), $doi_resolve_uri, array('html' => TRUE));
146
    } else {
147
      return l($doi_resolve_uri, $doi_resolve_uri);
148
    }
149
  }
150

    
151
}
152

    
153
/**
154
 * Renders a representation for an CDM OriginalSourceBase entity
155
 *
156
 * @param $source
157
 *  The cdm OriginalSourceBase entity
158
 * @param $do_link_to_reference
159
 * @param $do_link_to_name_used_in_source
160
 * @return string
161
 */
162
function render_original_source($source, $do_link_to_reference = true, $do_link_to_name_used_in_source = false) {
163
  $out = '';
164

    
165
  if (isset($source->citation)) {
166
    $out = theme('cdm_reference', array(
167
        'reference' => $source->citation,
168
        'microReference' => $source->citationMicroReference,
169
        'doLink' => $do_link_to_reference,
170
    ));
171

    
172
    $name_in_source_render_array = compose_name_in_source($source, $do_link_to_name_used_in_source);
173
    if(!empty($name_in_source_render_array)) {
174
      $out .=  ' <span class="nameUsedInSource">(' . t('as') . ' ' . $name_in_source_render_array['#markup'] . ')</span>';
175
    }
176

    
177
    $id_with_namespace = '';
178
    if( isset($source->idNamespace) && $source->idNamespace ) {
179
      $id_with_namespace = $source->idNamespace . ' ';
180
    }
181
    if( isset($source->idInSource) && $source->idInSource ) {
182
      $id_with_namespace .= $source->idInSource;
183
    } else {
184
      $id_with_namespace = NULL;
185
    }
186

    
187
    if($id_with_namespace){
188
      $out .=  ' <span class="idInSource">[' . $id_with_namespace . ']</span>';
189
    }
190
  }
191
  return $out;
192
}
Add picture from clipboard (Maximum size: 40 MB)