Project

General

Profile

Statistics
| Branch: | Tag: | Revision:

cdm-dataportal / modules / cdm_dataportal / theme / cdm_dataportal.references.theme @ 5446f047

History | View | Annotate | Download (4.84 KB)

1 6657531f Andreas Kohlbecker
<?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 43998144 Andreas Kohlbecker
 * Creates a HTML representations for a CDM Reference instance..
19 6657531f Andreas Kohlbecker
 *
20
 * Used by:
21
 * - theme_cdm_typedesignations
22 b2ebf0d3 Andreas Kohlbecker
 * - cdm_reference_pager
23 b7a20282 Andreas Kohlbecker
 * - cdm_taxonRelationships
24 6657531f Andreas Kohlbecker
 *
25
 * @param array $variables
26
 *   An associative array containing:
27
 *   - reference
28
 *   - microReference
29 0639ca2a Andreas Kohlbecker
 *   - 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 43998144 Andreas Kohlbecker
 *   - 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 6657531f Andreas Kohlbecker
 *
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 1b57b3c1 Andreas Kohlbecker
46 0639ca2a Andreas Kohlbecker
  if (!isset($reference->authorship)) {
47 f0bf24e7 Andreas Kohlbecker
    $author_team = cdm_ws_get(CDM_WS_REFERENCE_AUTHORTEAM, $reference->uuid);
48 0639ca2a Andreas Kohlbecker
  }
49
  else {
50 1ce9afb7 Patric Plitzner
    $author_team = $reference->authorship;
51 f0bf24e7 Andreas Kohlbecker
  }
52 6657531f Andreas Kohlbecker
  if ($referenceStyle == "zoology") {
53
    $year = '';
54 c7f92453 Andreas Kohlbecker
    if (isset($reference->datePublished)) {
55
      $year = timePeriodToString($reference->datePublished, true, 'YYYY');
56 6657531f Andreas Kohlbecker
    }
57
    $citation = $author_team->titleCache . (!empty($year) ? '. ' . $year : '');
58
  }
59
  else {
60
    $citation = $reference->titleCache;
61
  }
62
63 b9a4f351 Andreas Kohlbecker
  $citation = trim($citation);
64 6657531f Andreas Kohlbecker
  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 0a288588 Andreas Kohlbecker
  if(isset($reference->doi)){
84
    $out .= cdm_doi($reference->doi);
85
  }
86
87
  if (isset($reference->uri)){
88
    $out .= cdm_external_uri($reference->uri);
89
  }
90
91
  return $out;
92
}
93 9091d35a Andreas Kohlbecker
94 0a288588 Andreas Kohlbecker
/**
95 723aa98c Andreas Kohlbecker
 * Creates a anchor tag as clickable link to an external resource, either as text link or as icon.
96
 * The resulting link will have no 'target' attribute, so the link will open in the same tab by default.
97
 * So the users can decide.
98
 *
99
 * @param $uri
100
 *    The uri to link to
101
 * @param $iconified
102
 *    The link will be rendered as icon of this is true.
103 0a288588 Andreas Kohlbecker
 * @return string
104 723aa98c Andreas Kohlbecker
 *
105 0a288588 Andreas Kohlbecker
 */
106
function cdm_external_uri($uri, $iconified = true)
107
{
108 723aa98c Andreas Kohlbecker
  $options = array(
109
    'external' => true,
110
    'html' => false,
111
    );
112 0a288588 Andreas Kohlbecker
  if (!empty($uri)) {
113
    if($iconified){
114 723aa98c Andreas Kohlbecker
      $options['html'] = true;
115
      return l(font_awesome_icon_markup('fa-external-link', array('class' => array('superscript'))), $uri, $options);
116 0a288588 Andreas Kohlbecker
    } else {
117 723aa98c Andreas Kohlbecker
      return l($uri, $uri, $options);
118 9091d35a Andreas Kohlbecker
    }
119 0639ca2a Andreas Kohlbecker
  }
120 0a288588 Andreas Kohlbecker
}
121
122
/**
123
 * Creates markup for a CDM Doi entity.
124
 *
125
 * @param $doi
126
 *  The CDM DOI
127
 *
128
 * @return string
129
 *  Markup
130
 */
131
function cdm_doi($doi, $iconified = true) {
132
133
  if (!empty($doi)) {
134
135
    $doi_resolve_uri = 'http://doi.org/' . $doi->prefix;
136
    if (isset($doi->suffix)) {
137
      $doi_resolve_uri .= '/' . $doi->suffix;
138
    }
139
    if($iconified){
140
      return l(font_awesome_icon_markup('fa-external-link-square', array('class' => array('superscript'))), $doi_resolve_uri, array('html' => TRUE));
141
    } else {
142
      return l($doi_resolve_uri, $doi_resolve_uri);
143
    }
144 0639ca2a Andreas Kohlbecker
  }
145
146 6657531f Andreas Kohlbecker
}
147
148
/**
149 f3a04cfa Andreas Kohlbecker
 * @todo Please document this function.
150
 * @see http://drupal.org/node/1354
151
 */
152
function theme_cdm_OriginalSource($variables) {
153
  $out = '';
154
  $source = $variables['source'];
155 bb3188cb Andreas Kohlbecker
  $do_link_to_reference = $variables['doLink'];
156
  $do_link_to_name_used_in_source = $variables['do_link_to_name_used_in_source'];
157 f3a04cfa Andreas Kohlbecker
158 1b04a204 Andreas Kohlbecker
  if (isset($source->citation)) {
159 f3a04cfa Andreas Kohlbecker
    $out = theme('cdm_reference', array(
160
        'reference' => $source->citation,
161
        'microReference' => $source->citationMicroReference,
162 bb3188cb Andreas Kohlbecker
        'doLink' => $do_link_to_reference,
163 f3a04cfa Andreas Kohlbecker
    ));
164 dcf17487 Andreas Kohlbecker
165 bb3188cb Andreas Kohlbecker
    $name_in_source_render_array = compose_name_in_source($source, $do_link_to_name_used_in_source);
166
    if(!empty($name_in_source_render_array)) {
167
      $out .=  ' <span class="nameUsedInSource">(' . t('as') . ' ' . $name_in_source_render_array['#markup'] . ')</span>';
168 046b235b Andreas Kohlbecker
    }
169 8ca88c4e Andreas Kohlbecker
170
    $id_with_namespace = '';
171
    if( isset($source->idNamespace) && $source->idNamespace ) {
172 05c57463 Andreas Kohlbecker
      $id_with_namespace = $source->idNamespace . ' ';
173 8ca88c4e Andreas Kohlbecker
    }
174 8af64a68 Andreas Kohlbecker
    if( isset($source->idInSource) && $source->idInSource ) {
175 8ca88c4e Andreas Kohlbecker
      $id_with_namespace .= $source->idInSource;
176
    } else {
177
      $id_with_namespace = NULL;
178
    }
179 44d445c0 Andreas Kohlbecker
180 8ca88c4e Andreas Kohlbecker
    if($id_with_namespace){
181
      $out .=  ' <span class="idInSource">[' . $id_with_namespace . ']</span>';
182 f3a04cfa Andreas Kohlbecker
    }
183
  }
184
  return $out;
185 1b04a204 Andreas Kohlbecker
}
Add picture from clipboard (Maximum size: 40 MB)