Project

General

Profile

Download (5.68 KB) Statistics
| Branch: | Tag: | Revision:
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 2ffe4d59 Andreas Kohlbecker
 *   - doTextLink:
30
 *      Show the citation string as link to the reference page. This option does not affect links to the reference URI or DOI.
31
 *      These links are always created when this data is available
32
 *   - doIconLink:
33
 *      Append an icon to the citation string which links to the reference page, links to the reference URI or DOI are always
34 0639ca2a Andreas Kohlbecker
 *      created when this data is available
35 43998144 Andreas Kohlbecker
 *   - referenceStyle: the value "zoology" will cause a specific rendeting of the
36
 *      reference suitable for zoological publications.
37
 *
38
 * @return string
39
 *    the markup for the reference
40 6657531f Andreas Kohlbecker
 *
41
 * @ingroup themeable
42
 */
43
function theme_cdm_reference($variables) {
44
  $reference = $variables['reference'];
45
  $microReference = $variables['microReference'];
46 2ffe4d59 Andreas Kohlbecker
  $doTextLink = $variables['doTextLink'];
47
  $doIconLink = $variables['doIconLink'];
48 6657531f Andreas Kohlbecker
  $referenceStyle = $variables['referenceStyle'];
49 1b57b3c1 Andreas Kohlbecker
50 0639ca2a Andreas Kohlbecker
  if (!isset($reference->authorship)) {
51 f0bf24e7 Andreas Kohlbecker
    $author_team = cdm_ws_get(CDM_WS_REFERENCE_AUTHORTEAM, $reference->uuid);
52 0639ca2a Andreas Kohlbecker
  }
53
  else {
54 1ce9afb7 Patric Plitzner
    $author_team = $reference->authorship;
55 f0bf24e7 Andreas Kohlbecker
  }
56 6657531f Andreas Kohlbecker
  if ($referenceStyle == "zoology") {
57
    $year = '';
58 c7f92453 Andreas Kohlbecker
    if (isset($reference->datePublished)) {
59
      $year = timePeriodToString($reference->datePublished, true, 'YYYY');
60 6657531f Andreas Kohlbecker
    }
61
    $citation = $author_team->titleCache . (!empty($year) ? '. ' . $year : '');
62
  }
63
  else {
64
    $citation = $reference->titleCache;
65
  }
66
67 b9a4f351 Andreas Kohlbecker
  $citation = trim($citation);
68 b0cdc514 Andreas Kohlbecker
  $iconlink = "";
69 40360e37 Andreas Kohlbecker
  if((isset($doIconLink) && $doIconLink === TRUE)) {
70
    $iconlink = l(custom_icon_font_markup('icon-interal-link-alt-solid', array('class' => array('superscript'))), path_to_reference($reference->uuid), array('html' => true));
71
  }
72 2ffe4d59 Andreas Kohlbecker
  if (isset($doTextLink) && $doTextLink === TRUE) {
73 6657531f Andreas Kohlbecker
    $out = '<span class="reference">';
74
    $out .= l($citation, path_to_reference($reference->uuid), array(
75
      'attributes' => array(
76
        "class" => "reference",
77
      ),
78
      'absolute' => TRUE,
79
      'html' => TRUE,
80
    ));
81 40360e37 Andreas Kohlbecker
    $out .= $iconlink . '</span>';
82 6657531f Andreas Kohlbecker
  }
83
  else {
84 40360e37 Andreas Kohlbecker
    $out = '<span class="reference">' . $citation . $iconlink . '</span>';
85 2ffe4d59 Andreas Kohlbecker
  }
86 6657531f Andreas Kohlbecker
87
  if (!empty($microReference)) {
88
    $out .= ": " . $microReference;
89
  }
90
91 0a288588 Andreas Kohlbecker
  if(isset($reference->doi)){
92
    $out .= cdm_doi($reference->doi);
93
  }
94
95
  if (isset($reference->uri)){
96 27bceb70 Andreas Kohlbecker
    if($reference->type == 'WebPage'){
97
      // the cdm cache strategy adds the uri to the titleCache which is unwanted in this case,
98
      // so is is removed from there
99
      $out = str_replace('- ' . $reference->uri, '',  $out);
100
    }
101 0a288588 Andreas Kohlbecker
    $out .= cdm_external_uri($reference->uri);
102
  }
103
104
  return $out;
105
}
106 9091d35a Andreas Kohlbecker
107 0a288588 Andreas Kohlbecker
/**
108 723aa98c Andreas Kohlbecker
 * Creates a anchor tag as clickable link to an external resource, either as text link or as icon.
109
 * The resulting link will have no 'target' attribute, so the link will open in the same tab by default.
110
 * So the users can decide.
111
 *
112
 * @param $uri
113
 *    The uri to link to
114
 * @param $iconified
115
 *    The link will be rendered as icon of this is true.
116 0a288588 Andreas Kohlbecker
 * @return string
117 723aa98c Andreas Kohlbecker
 *
118 0a288588 Andreas Kohlbecker
 */
119
function cdm_external_uri($uri, $iconified = true)
120
{
121 723aa98c Andreas Kohlbecker
  $options = array(
122
    'external' => true,
123
    'html' => false,
124
    );
125 0a288588 Andreas Kohlbecker
  if (!empty($uri)) {
126
    if($iconified){
127 723aa98c Andreas Kohlbecker
      $options['html'] = true;
128
      return l(font_awesome_icon_markup('fa-external-link', array('class' => array('superscript'))), $uri, $options);
129 0a288588 Andreas Kohlbecker
    } else {
130 723aa98c Andreas Kohlbecker
      return l($uri, $uri, $options);
131 9091d35a Andreas Kohlbecker
    }
132 0639ca2a Andreas Kohlbecker
  }
133 0a288588 Andreas Kohlbecker
}
134
135
/**
136
 * Creates markup for a CDM Doi entity.
137
 *
138
 * @param $doi
139
 *  The CDM DOI
140
 *
141
 * @return string
142
 *  Markup
143
 */
144
function cdm_doi($doi, $iconified = true) {
145
146
  if (!empty($doi)) {
147
148
    $doi_resolve_uri = 'http://doi.org/' . $doi->prefix;
149
    if (isset($doi->suffix)) {
150
      $doi_resolve_uri .= '/' . $doi->suffix;
151
    }
152
    if($iconified){
153
      return l(font_awesome_icon_markup('fa-external-link-square', array('class' => array('superscript'))), $doi_resolve_uri, array('html' => TRUE));
154
    } else {
155
      return l($doi_resolve_uri, $doi_resolve_uri);
156
    }
157 0639ca2a Andreas Kohlbecker
  }
158
159 6657531f Andreas Kohlbecker
}
160
161 f3a04cfa Andreas Kohlbecker
/**
162 bb93d5d1 Andreas Kohlbecker
 * Renders a representation for an CDM OriginalSourceBase entity
163
 *
164
 * @param $source
165
 *  The cdm OriginalSourceBase entity
166
 * @param $do_link_to_reference
167
 * @param $do_link_to_name_used_in_source
168
 * @return string
169 f3a04cfa Andreas Kohlbecker
 */
170 44707ee3 Andreas Kohlbecker
function render_original_source($source, $do_link_to_reference = true, $do_link_to_name_used_in_source = false) {
171 f3a04cfa Andreas Kohlbecker
  $out = '';
172
173 1b04a204 Andreas Kohlbecker
  if (isset($source->citation)) {
174 f3a04cfa Andreas Kohlbecker
    $out = theme('cdm_reference', array(
175
        'reference' => $source->citation,
176
        'microReference' => $source->citationMicroReference,
177 2ffe4d59 Andreas Kohlbecker
        'doIconLink' => $do_link_to_reference,
178 f3a04cfa Andreas Kohlbecker
    ));
179 dcf17487 Andreas Kohlbecker
180 bb3188cb Andreas Kohlbecker
    $name_in_source_render_array = compose_name_in_source($source, $do_link_to_name_used_in_source);
181
    if(!empty($name_in_source_render_array)) {
182
      $out .=  ' <span class="nameUsedInSource">(' . t('as') . ' ' . $name_in_source_render_array['#markup'] . ')</span>';
183 046b235b Andreas Kohlbecker
    }
184 8ca88c4e Andreas Kohlbecker
185
    $id_with_namespace = '';
186
    if( isset($source->idNamespace) && $source->idNamespace ) {
187 05c57463 Andreas Kohlbecker
      $id_with_namespace = $source->idNamespace . ' ';
188 8ca88c4e Andreas Kohlbecker
    }
189 8af64a68 Andreas Kohlbecker
    if( isset($source->idInSource) && $source->idInSource ) {
190 8ca88c4e Andreas Kohlbecker
      $id_with_namespace .= $source->idInSource;
191
    } else {
192
      $id_with_namespace = NULL;
193
    }
194 44d445c0 Andreas Kohlbecker
195 8ca88c4e Andreas Kohlbecker
    if($id_with_namespace){
196
      $out .=  ' <span class="idInSource">[' . $id_with_namespace . ']</span>';
197 f3a04cfa Andreas Kohlbecker
    }
198
  }
199
  return $out;
200 1b04a204 Andreas Kohlbecker
}