EDIT

<?php

/**

 * @file

 * Reference theming functions.

 *

 * @copyright

 *   (C) 2007-2012 EDIT

 *   European Distributed Institute of Taxonomy

 *   http://www.e-taxonomy.eu

 *

 *   The contents of this module are subject to the Mozilla

 *   Public License Version 1.1.

 * @see http://www.mozilla.org/MPL/MPL-1.1.html

 */

/**

 * Creates a HTML representations for a CDM Reference instance..

 *

 * Used by:

 * - render_type_designations

 * - cdm_reference_pager

 * - cdm_taxonRelationships

 *

 * @param array $variables

 *   An associative array containing:

 *   - reference

 *   - microReference

 *   - doTextLink:

 *      Show the citation string as link to the reference page. This option does not affect links to the reference URI or DOI.

 *      These links are always created when this data is available

 *   - doIconLink:

 *      Append an icon to the citation string which links to the reference page, links to the reference URI or DOI are always

 *      created when this data is available

 *   - referenceStyle: the value "zoology" will cause a specific rendeting of the

 *      reference suitable for zoological publications.

 *

 * @return string

 *    the markup for the reference

 *

 * @ingroup themeable

 */

function theme_cdm_reference($variables) {

  $reference = $variables['reference'];

  $microReference = $variables['microReference'];

  $doTextLink = $variables['doTextLink'];

  $doIconLink = $variables['doIconLink'];

  $referenceStyle = $variables['referenceStyle'];

  if (!isset($reference->authorship)) {

    $author_team = cdm_ws_get(CDM_WS_REFERENCE_AUTHORTEAM, $reference->uuid);

  }

  else {

    $author_team = $reference->authorship;

  }

  if ($referenceStyle == "zoology") {

    $year = '';

    if (isset($reference->datePublished)) {

      $year = timePeriodToString($reference->datePublished, true, 'YYYY');

    }

    $citation = $author_team->titleCache . (!empty($year) ? '. ' . $year : '');

  }

  else {

    $citation = $reference->titleCache;

  }

  $citation = trim($citation);

  $iconlink = "";

  if((isset($doIconLink) && $doIconLink === TRUE)) {

    $iconlink = l(custom_icon_font_markup('icon-interal-link-alt-solid', array('class' => array('superscript'))), path_to_reference($reference->uuid), array('html' => true));

  }

  if (isset($doTextLink) && $doTextLink === TRUE) {

    $out = '<span class="reference">';

    $out .= l($citation, path_to_reference($reference->uuid), array(

      'attributes' => array(

        "class" => "reference",

      ),

      'absolute' => TRUE,

      'html' => TRUE,

    ));

    $out .= $iconlink . '</span>';

  }

  else {

    $out = '<span class="reference">' . $citation . $iconlink . '</span>';

  }

  if (!empty($microReference)) {

    $out .= ": " . $microReference;

  }

  if(isset($reference->doi)){

    $out .= cdm_doi($reference->doi);

  }

  if (isset($reference->uri)){

    if($reference->type == 'WebPage'){

      // the cdm cache strategy adds the uri to the titleCache which is unwanted in this case,

      // so is is removed from there

      $out = str_replace('- ' . $reference->uri, '',  $out);

    }

    $out .= cdm_external_uri($reference->uri);

  }

  return $out;

}

/**

 * Creates a anchor tag as clickable link to an external resource, either as text link or as icon.

 * The resulting link will have no 'target' attribute, so the link will open in the same tab by default.

 * So the users can decide.

 *

 * @param $uri

 *    The uri to link to

 * @param $iconified

 *    The link will be rendered as icon of this is true.

 * @return string

 *

 */

function cdm_external_uri($uri, $iconified = true)

{

  $options = array(

    'external' => true,

    'html' => false,

    );

  if (!empty($uri)) {

    if($iconified){

      $options['html'] = true;

      return l(font_awesome_icon_markup('fa-external-link-alt', array('class' => array('superscript'))), $uri, $options);

    } else {

      return l($uri, $uri, $options);

    }

  }

}

/**

 * Creates markup for a CDM Doi entity.

 *

 * @param $doi

 *  The CDM DOI

 *

 * @return string

 *  Markup

 */

function cdm_doi($doi, $iconified = true) {

  if (!empty($doi)) {

    $doi_resolve_uri = 'http://doi.org/' . $doi->prefix;

    if (isset($doi->suffix)) {

      $doi_resolve_uri .= '/' . $doi->suffix;

    }

    if($iconified){

      return l(font_awesome_icon_markup('fa-external-link-square-alt', array('class' => array('superscript'))), $doi_resolve_uri, array('html' => TRUE));

    } else {

      return l($doi_resolve_uri, $doi_resolve_uri);

    }

  }

}

/**

 * Renders a representation for an CDM OriginalSourceBase entity

 *

 * @param $source

 *  The cdm OriginalSourceBase entity

 * @param bool $do_link_to_reference

 *

 * @param bool $do_link_to_name_used_in_source

 *

 * @return string

 * @throws \Exception

 */

function render_original_source($source, $do_link_to_reference = TRUE, $do_link_to_name_used_in_source = FALSE) {

  $out = '';

  if (isset($source->citation)) {

    $out .= theme('cdm_reference', [

      'reference' => $source->citation,

      'microReference' => $source->citationMicroReference,

      'doIconLink' => $do_link_to_reference,

    ]);

  }

  if(isset($source->cdmSource)){

    $out .= render_cdm_entity_link($source->cdmSource);

  }

  if($out){

    $name_in_source_render_array = compose_name_in_source($source, $do_link_to_name_used_in_source);

    if(!empty($name_in_source_render_array)) {

      $out .=  ' <span class="nameUsedInSource">(' . t('as') . ' ' . $name_in_source_render_array['#markup'] . ')</span>';

    }

    $id_with_namespace = '';

    if( isset($source->idNamespace) && $source->idNamespace ) {

      $id_with_namespace = $source->idNamespace . ' ';

    }

    if( isset($source->idInSource) && $source->idInSource ) {

      $id_with_namespace .= $source->idInSource;

    } else {

      $id_with_namespace = NULL;

    }

    if($id_with_namespace){

      $out .=  ' <span class="idInSource">[' . $id_with_namespace . ']</span>';

    }

  }

  return $out;

}