Project

General

Profile

Statistics
| Branch: | Tag: | Revision:

cdm-dataportal / modules / cdm_dataportal / theme / cdm_dataportal.common.theme @ bc7f81f1

History | View | Annotate | Download (14 KB)

1
<?php
2
/**
3
 * @file
4
 * Common 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
define('FOOTNOTE_ANNOTATIONS', 'annotations');
17

    
18
/**
19
 * Get the true path to the root of the Drupal site.
20
 *
21
 * Better than using DOCUMENT_ROOT and base_path().
22
 */
23
function absolute_path_to_drupal() {
24
  static $absolute_path_to_drupal = NULL;
25

    
26
  if ($absolute_path_to_drupal === NULL) {
27
    // Get the absolute path to this file:
28
    $dir = rtrim(str_replace('\\', '/', dirname(__FILE__)), '/');
29
    $parts = explode('/', $dir);
30
    // Iterate up the directory hierarchy until we find the website root:
31
    $done = FALSE;
32
    do {
33
      // Check a couple of obvious things:
34
      $done = is_dir("$dir/sites") && is_dir("$dir/includes") && is_file("$dir/index.php");
35
      if (!$done) {
36
        // If there's no more path to examine, we didn't find the site root:
37
        if (empty($parts)) {
38
          $absolute_path_to_drupal = FALSE;
39
          break;
40
        }
41
        // Go up one level and look again:
42
        array_pop($parts);
43
        $dir = implode('/', $parts);
44
      }
45
    } while (!$done);
46

    
47
    $absolute_path_to_drupal = $dir;
48
  }
49
  return $absolute_path_to_drupal;
50
}
51

    
52
/**
53
 * Checks if the taxon specified by the uuid is contained in the currently focused classification.
54
 *
55
 * @param $taxon_uuid
56
 * @return bool
57
 */
58
function taxon_in_current_classification($taxon_uuid) {
59
  $taxon_nodes = cdm_ws_get(CDM_WS_PORTAL_TAXON_TAXONNODES, $taxon_uuid);
60
  $taxon_in_current_tree = FALSE;
61
  if (is_array($taxon_nodes)) {
62
    foreach ($taxon_nodes as $node) {
63
      if (get_current_classification_uuid() == $node->classificationUUID) {
64
        $taxon_in_current_tree = TRUE;
65
        break;
66
      }
67
    }
68
  }
69
  return $taxon_in_current_tree;
70
}
71

    
72
/**
73
 * TODO if getting fragment from request is possible remove
74
 * $_REQUEST['highlite'] HACK
75
 * NOT WORKING since fragments are not available to the server
76
 *
77
 * function fragment(){
78
 *    global $fragment;
79
 *    if(!$fragment){
80
 *       $fragment = substr($_SERVER['REQUEST_URI'], strrpos($_SERVER['REQUEST_URI'], '#'));
81
 *    }
82
 *   return $fragment;
83
 * }
84
 */
85
function uuid_anchor($uuid, $innerHTML) {
86
  $highlite = FALSE;
87
  $params = drupal_get_query_parameters();
88
  if (isset($params['highlite']) && $params['highlite'] == $uuid) {
89
    $highlite = TRUE;
90
  }
91

    
92
  return '<a name="' . $uuid . '" ></a><span class="' . ($highlite ? 'highlite' : '') . '">' . $innerHTML . '</span>';
93
}
94

    
95
/**
96
 * @todo Enter description here...
97
 * @deprecated looks like this is not used anymore
98
 */
99
/*
100
function tagNameParts($name, $numOfNameTokens) {
101
  $out = '<span class="name">';
102

    
103
  $token = strtok($name, " \n\t");
104
  $i = 0;
105
  $noSpace = TRUE;
106
  while ($token != FALSE) {
107
    if ($i == $numOfNameTokens) {
108
      $out .= '</span> <span class="authors">';
109
      $noSpace = TRUE;
110
    }
111
    $out .= ($noSpace ? '' : ' ') . $token;
112
    $noSpace = FALSE;
113
    $token = strtok(" \n\t");
114
    $i++;
115
  }
116
  return $out . '</span>';
117
}
118
*/
119

    
120
/* ============================ annotations ============================= */
121

    
122
/**
123
 * Returns HTML for annotations to cdm objects.
124
 *
125
 * Almost any cdmObject may be annotated. Therefore we provide a generic way to
126
 * display as well as create or update annotations. The following cdm classes
127
 * are annotatable:
128
 *
129
 * - DescriptionElementBase
130
 * - EventBase
131
 * - HomotypicalGroup
132
 * - IdentifiableEntity
133
 * - DescriptionBase
134
 * - IdentifiableMediaEntity
135
 * - Media
136
 * - Sequence
137
 * - TaxonBase
138
 * - TaxonName
139
 * - TaxonomicTree
140
 * - TermBase
141
 * - LanguageStringBase
142
 * - ReferencedEntityBase
143
 * - NomenclaturalStatus
144
 * - OriginalSourceBase
145
 * - RelationshipBase
146
 * - TypeDesignationBase
147
 * - TaxonNode
148
 * - WorkingSet
149
 *
150
 * @param array $variables
151
 *   An associative array containing:
152
 *  - cdmBase_list: An array of CdmBase instances or a single instance.
153
 *  - footnote_list_key
154
 *
155
 * @ingroup themeable
156
 */
157
function theme_cdm_entities_annotations_as_footnotekeys($variables) {
158
  $cdm_entities = $variables['cdmBase_list'];
159
  $footnote_list_key = $variables['footnote_list_key'];
160
  // check if footnotes for annotations are disabled completely
161
  if (variable_get('cdm_dataportal_annotations_footnotes', CDM_DATAPORTAL_ALL_FOOTNOTES)) {
162
    return '';
163
  }
164
  $out = '';
165
  if(is_array($cdm_entities)){
166
    // array of entities
167
    $footNoteKeys = cdm_entities_annotations_as_footnotekeys($cdm_entities, $footnote_list_key);
168
  } else {
169
    // single entity
170
    $footNoteKeys = cdm_entity_annotations_as_footnotekeys($cdm_entities, $footnote_list_key);
171
  }
172
  foreach ($footNoteKeys as $a) {
173
    // $out .= theme('cdm_footnote_key', $a, $a->footnoteListKey, (isset($out)?
174
    // ',' : ''));
175
    $out .= theme('cdm_footnote_key', array('footnoteKey' => $a, 'separator' => ($out ? ',' : '')));
176
  }
177
  return $out;
178
}
179

    
180
/**
181
 * Create markup for the footnotes mapped to the $footnoteListKey.
182
 *
183
 * @param null $footnote_list_key
184
 *  The footnote list key, see RenderHints::getFootnoteListKey()
185
 * @param $element_tag
186
 *  The tag for the footnote element
187
 *
188
 * @return string
189
 * @throws \Exception
190
 */
191
function cdm_annotation_footnotes($footnote_list_key = null, $element_tag = 'span') {
192
  if (variable_get('cdm_dataportal_annotations_footnotes', CDM_DATAPORTAL_ALL_FOOTNOTES)) {
193
    return '';
194
  }
195
  return cdm_footnotes($footnote_list_key . '-annotations', $element_tag);
196
}
197

    
198
/* ============================ footnotes ============================= */
199
/**
200
 * @todo Please document this function.
201
 * @see http://drupal.org/node/1354
202
 */
203
function theme_cdm_footnote_key($variables) {
204

    
205
  $footnoteKey = $variables['footnoteKey'];
206
  $separator = $variables['separator'];
207
  $highlightable = $variables['highlightable'];
208
  $separator_off = $variables['separator_off'];
209
  if (!is_object($footnoteKey) or !isset($footnoteKey->footnoteListKey)) {
210
    return '';
211
  }
212
  if (variable_get('cdm_dataportal_all_footnotes', CDM_DATAPORTAL_ALL_FOOTNOTES)) {
213
    return '';
214
  }
215

    
216
  if ($separator_off) {
217
    $separator = '';
218
  }
219
  $out = '<span class="footnote-key footnote-key-' . $footnoteKey->keyStr . ' member-of-footnotes-' . $footnoteKey->footnoteListKey . '">' . $separator . '<a href="#footnote-' . $footnoteKey->keyStr . '">' . $footnoteKey->keyStr . '</a>' . '</span>';
220
  return $out;
221
}
222

    
223
/**
224
 * @param null $footnoteKey
225
 * @param null $footnoteText
226
 * @param string $enclosing_tag
227
 *   default is 'span'
228
 *
229
 * @return string
230
 */
231
function footnote_markup($footnoteKey = null, $footnoteText = null, $enclosing_tag = 'span') {
232
  _add_js_footnotes();
233
  if($enclosing_tag == null){
234
    $enclosing_tag = 'span';
235
  }
236
  return '<' . $enclosing_tag . ' class="footnote footnote-' . $footnoteKey . '">'
237
    . '<a name="footnote-' . $footnoteKey . '"></a>'
238
    . '<span class="footnote-anchor">' . $footnoteKey . '.</span>&nbsp;' . $footnoteText
239
    . '</' . $enclosing_tag . '>';
240
}
241

    
242
/**
243
 * Create markup for the footnotes mapped to the $footnoteListKey.
244
 *
245
 * @param null $footnote_list_key
246
 *  The footnote list key, see RenderHints::getFootnoteListKey()
247
 * @param $element_tag
248
 *  The tag for the footnote element
249
 *
250
 * @return string
251
 */
252
function cdm_footnotes($footnote_list_key = null, $element_tag = 'span') {
253

    
254
  if (variable_get('cdm_dataportal_all_footnotes', CDM_DATAPORTAL_ALL_FOOTNOTES)) {
255
    return '';
256
  }
257

    
258
  $out = '<' . $element_tag . ' class="footnotes footnotes-' . $footnote_list_key . ' ">'
259
    . FootnoteManager::renderFootnoteList($footnote_list_key)
260
    . '</' . $element_tag . '>';
261

    
262
  FootnoteManager::removeFootnoteList($footnote_list_key);
263
  return $out;
264
}
265

    
266
/**
267
 * Renders the footnotes for annotations and sources, etc.
268
 *
269
 * @param string $footnote_list_key
270
 *    RenderHints::getFootnoteListKey() will be used if this parameter is undefined.
271
 * @param string $enclosingTag
272
 *    Default tag is 'span'
273
 *
274
 * @return string
275
 *    The markup string
276
 *
277
 */
278
function render_cdm_footnotes($footnote_list_key = NULL, $enclosingTag = 'span'){
279

    
280
  if (variable_get('cdm_dataportal_all_footnotes', CDM_DATAPORTAL_ALL_FOOTNOTES)) {
281
    return '';
282
  }
283
  if(!$footnote_list_key){
284
    $footnote_list_key = RenderHints::getFootnoteListKey();
285
  }
286

    
287
  $out = '<' . $enclosingTag . ' class="footnotes footnotes-' . $footnote_list_key . ' ">'
288
    . FootnoteManager::renderFootnoteList($footnote_list_key . '-annotations') . ' ' . FootnoteManager::renderFootnoteList($footnote_list_key)
289
    . '</' . $enclosingTag . '>';
290
  FootnoteManager::removeFootnoteList($footnote_list_key . '-annotations');
291
  FootnoteManager::removeFootnoteList($footnote_list_key);
292
  return $out;
293
}
294

    
295
/**
296
 * Created markup for the annotations
297
 * @param null $annotations
298
 * @param $enclosingTag
299
 *  Tag name of the DOM element to enclose the annotations.
300
 *
301
 * @return string
302
 */
303
function cdm_annotations($annotations = null, $enclosingTag = span) {
304

    
305
  if (!is_array($annotations)) {
306
    return '';
307
  }
308
  $out = '<' . $enclosingTag . ' class="annotations">';
309
  $i = 0;
310
  foreach ($annotations as $annotation) {
311
    $out .= ($i++ > 0 ? ', ' : '') . $annotation->text;
312
  }
313
  $out .= '</' . $enclosingTag . '>';
314
  return $out;
315
}
316

    
317
/**
318
 * @todo Please document this function.
319
 * @see http://drupal.org/node/1354
320
 */
321
function cdm_exist_footnote($footnote_list, $footnote) {
322
  $result = FALSE;
323
  if (is_array($footnote_list)) {
324
    foreach ($footnote_list as $element) {
325
      if ($element == $footnote) {
326
        $result = TRUE;
327
      }
328
    }
329
  }
330
  return $result;
331
}
332

    
333
/**
334
 * @todo Please document this function.
335
 * @see http://drupal.org/node/1354
336
 */
337
function cdm_add_footnote_to_array(&$footnote_list, $footnote) {
338
  if (!cdm_exist_footnote($footnote_list, $footnote)) {
339
    $footnote_list[] = $footnote;
340
  }
341
}
342

    
343
/**
344
 * Theme function for CDM marker instances
345
 *
346
 * @see compose_cdm_marker();
347
 * @param array $variables
348
 *   - markerType_representation_l10n: the localized representation of the marker.markerType field
349
 */
350
function theme_cdm_marker($variables) {
351
  $class_attribute = null;
352
  //TODO class attribute hacked?, use generic drupal way?
353
  if(isset($variables['attributes']['class'])){
354
    $class_attribute = $variables['attributes']['class'];
355
  }
356
  return '<span class="' . $class_attribute . '">' . $variables['label'] . '</span>';
357
}
358

    
359
/* ============================ pager ============================= */
360

    
361
/**
362
 * @todo Please document this function.
363
 * @see http://drupal.org/node/1354
364
 */
365
function theme_cdm_pager($variables) {
366
  $pager = $variables['pager'];
367
  $path = $variables['path'];
368
  $parameters = $variables['parameters'];
369
  $out = '';
370

    
371
  if ($pager->pagesAvailable > 1) {
372

    
373
    $out .= '<div class="pager">';
374
    if ($pager->currentIndex > 0) {
375
      $out .= theme('cdm_pager_link', array(
376
        'text' => '« ' . t('First'),
377
        'linkIndex' => 0,
378
        'pager' => $pager,
379
        'path' => $path,
380
        'parameters' => $parameters,
381
        'attributes' => array('class' => array('pager-first')),
382
        ));
383
      $out .= theme('cdm_pager_link', array(
384
        'text' => '‹ ' . t('Previous'),
385
        'linkIndex' => $pager->currentIndex - 1,
386
        'pager' => $pager,
387
        'path' => $path,
388
        'parameters' => $parameters,
389
        'attributes' => array('class' => array('pager-previous')),
390
        ));
391
    }
392

    
393
    if ($pager->indices[0] > 0) {
394
      $out .= '<div class="pager-list-dots-left">...</div>';
395
    }
396

    
397
    foreach ($pager->indices as $index) {
398
      $label = $index + 1;
399
      $out .= theme('cdm_pager_link', array('text' => $label, 'linkIndex' => $index, 'pager' => $pager, 'path' => $path, 'parameters' => $parameters, 'attributes' => array(
400
  'class' => array('pager-first'),
401
)));
402
    }
403
    if ($pager->indices[count($pager->indices) - 1] < $pager->pagesAvailable - 1) {
404
      $out .= '<div class="pager-list-dots-right">...</div>';
405
    }
406

    
407
    if ($pager->nextIndex) {
408
      $out .= theme(
409
        'cdm_pager_link',
410
        array(
411
          'text' => t('Next') . ' ›',
412
          'linkIndex' => $pager->nextIndex,
413
          'pager' => $pager,
414
          'path' => $path,
415
          'parameters' => $parameters,
416
          'attributes' => array(
417
            'class' => array('pager-next'),
418
          )
419
        )
420
      );
421
      $out .= theme(
422
        'cdm_pager_link',
423
        array(
424
          'text' => t('Last') . ' »',
425
          'linkIndex' => $pager->pagesAvailable - 1,
426
          'pager' => $pager,
427
          'path' => $path,
428
          'parameters' => $parameters,
429
          'attributes' => array(
430
            'class' => array('pager-last'),
431
          )
432
        )
433
      );
434
    }
435
    $out .= '</div>';
436

    
437
    return $out;
438
  }
439
}
440

    
441
/**
442
 * @todo Please document this function.
443
 * @see http://drupal.org/node/1354
444
 */
445
function theme_cdm_pager_link($variables) {
446
  $text = $variables['text'];
447
  $linkIndex = $variables['linkIndex'];
448
  $pager = $variables['pager'];
449
  $path = $variables['path'];
450
  $parameters = $variables['parameters'];
451
  $attributes = $variables['attributes'];
452

    
453
  // the parameters may still contain the q param,
454
  // but this is already in the path variable
455
  unset($parameters['q']);
456

    
457
  $parameters['pager']['pageNumber'] = $linkIndex;
458
  if ($linkIndex == $pager->currentIndex) {
459
    $out = '<strong>' . $text . '</strong>';
460
  }
461
  else {
462
    // $queryString = drupal_query_string_encode($parameters);
463
    $queryString = $parameters;
464
    $out = l($text, $path, array(
465
      'attributes' => $attributes,
466
      'query' => $queryString,
467
    ));
468
  }
469
  return $out;
470
}
471

    
472
/* ============================ special buttons ============================= */
473

    
474
/**
475
 * @todo Please document this function.
476
 * @see http://drupal.org/node/1354
477
 */
478
function theme_cdm_print_button() {
479

    
480
  drupal_add_js('jQuery(document).ready(function() {
481
         jQuery(\'#print_button\').click(function () {
482
         window.print();
483
     });
484
  });', array('type' => 'inline'));
485

    
486
  $output = '<div id="print_button"><img src="' . base_path()  .  drupal_get_path('module', 'cdm_dataportal') . '/images/print_icon.gif"' . ' alt="' . t('Print this page') . '" title="' . t('Print this page') . '" />';
487
  // .t('Print this page');
488
  // $output .= l('Print this page', '');
489
  $output .= '<span>Print this page</span>';
490
  $output .= '</div>';
491

    
492
  return $output;
493
}
494

    
Add picture from clipboard (Maximum size: 40 MB)