EDIT

<?php

 * @file

 * Functions for dealing with CDM entities from the package model.common

 *

 * @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

 *

 * @author

 *   - Andreas Kohlbecker <a.kohlbecker@BGBM.org>

 * @defgroup compose Compose functions

 * @{

 * Functions which are composing Drupal render arays

 *

 * responsible for creating the render arrays.

 * which is used in the proxy_content() function.

 */

/**

 * Composes an HTML element class attribute value composed of

 * the short-name of the cdm class and the uuid of the entity.

 * This class attribute should be used wherever an cdm-entity is rendered.

 *

 * In case of Taxon entities or TaxonNodeDTOs the secReference is also added

 * to the class attributes as 'sec_uuid:<uuid>'. In case of TaxonNodeDTOs the

 * Taxon uuid is added also as taxon_uuid:<uuid>

 *

 * These according class selectors in css must be escaped, eg:

 *    .cdm\:TextData

 *

 * @param $cdm_entity

 *    A CDM entity, TaxonNodeDTO or TypedEntityReference

 */

function html_class_attribute_ref($cdm_entity) {

  $attributes = '';

  if (is_cdm_entity($cdm_entity)) {

    $attributes =  "cdm:" . $cdm_entity->class . " uuid:" . $cdm_entity->uuid;

  } elseif (isset($cdm_entity->class)) {

    switch ($cdm_entity->class){

      case 'TypedEntityReference':

        $attributes =  "cdm:" . $cdm_entity->type . " uuid:" . $cdm_entity->uuid;

      break;

      case 'TaxonNodeDto':

        $attributes .= " taxon_uuid:"  . $cdm_entity->taxonUuid . " sec_uuid:"  . $cdm_entity->secUuid;;

      break;

      case 'Taxon':

        if(isset($cdm_entity->sec->uuid)){

        $attributes .= " sec_uuid:"  . $cdm_entity->sec->uuid;

      }

      break;

    }

  }

  return $attributes;

}

 * Compose an render array from a CDM Marker object.

 *

 * compose_hook() implementation

 *

 * @param object $marker

 *   CDM instance of type Marker

 * @return array

 *   A drupal render array

 * @ingroup compose

function compose_cdm_marker($marker) {

  $render_array = array(

      // ---- generic

      //  these entries should be common to all cdm enitiy render arrays

      '#theme' => 'cdm_marker', // TODO   add alternative theme funcitons: 'cdm_marker_' . marker.type.label

      // ---- individual

      '#label' => $marker->markerType->representation_L10n . ': ' . (($marker->flag !== TRUE ? t('yes') : t('no'))),

  );

  return $render_array;

}

/**

 * Checks if the given $cdm_entitiy has a marker the type references by the

 * $marker_type_uuid and returns TRUE if a matching marker has been found.

 *

 */

function cdm_entity_has_marker($cdm_entitiy, $marker_type_uuid) {

  if(isset($cdm_entitiy->markers[0]) && !is_uuid($marker_type_uuid)){

    foreach ($cdm_entitiy->markers as $marker) {

      if(isset($marker->markerType) && $marker->markerType->uuid == $marker_type_uuid){

        return TRUE;

      }

    }

  }

  return FALSE;

/**

 *  An array of drupal render arrays

    foreach ($sources as $source) {

      $order_key = '';

      // find the familynames

        $persons = array();

        if($authorteam->class == 'Team'){

          if(isset($authorteam->teamMembers)){

            $persons = $authorteam->teamMembers;

          }

        } else {

          $persons[] = $authorteam;

        }

        foreach($persons as $person){

          if(!empty($person->lastname)){

            $order_key .= $person->lastname;

          } else {

            $order_key .= $person->titleCache;

          }

        }

        if(empty($order_key)){

          $order_key = $authorteam->titleCache;

        }

      // add publication date to the key

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

        $order_key .= '_' . timePeriodAsOrderKey($source->citation->datePublished);

      } else {

        $order_key .= '_' . "0000";

      // padd key until unique

        $order_key .= "_";

      }

    ksort($sort_array);

    return array_values ($sort_array);

 * Compare callback to be used in usort to sort image sources of CDM OriginalSource instances.

 *

 *

 * @param $a

 * @param $b

 */

function compare_original_sources($a, $b){

  if(isset($a->citation->titleCache)) {

    $a_string = $a->citation->titleCache;

  }

    $a_string .= $a->nameUsedInSource->titleCache;

  } elseif (isset($a->originalNameString)){

    $a_string .= $a->originalNameString;

  }

  if(isset($b->citation->titleCache)) {

    $b_string = $b->citation->titleCache;

  };

    $b_string .= $b->nameUsedInSource->titleCache;

  } elseif (isset($b->originalNameString)){

    $b_string .= $b->originalNameString;

  }

  if ($a_string == $b_string) {

    return 0;

  }

  return ($a_string < $b_string) ? -1 : 1;

}

/**

 * Compare callback to be used in usort to sort image sources of CDM Media instances.

 *

 * @param $a

 * @param $b

 */

  if ($a->multilanguageText_L10n->text == $b->multilanguageText_L10n->text) {

    return 0;

  }

  return ($a->multilanguageText_L10n->text < $b->multilanguageText_L10n->text) ? -1 : 1;

}

   * Compare two different footnotes objects.

   *

   * The comparison is based on the footnote key. The one which is

   * displayed as footnote number.

   *

   * @param mixed $a

   *   Footnote object $a.

   * @param mixed $b

   *   Footnote object $b.

   */

  function footnotes_key_compare($a, $b) {

    $res = 0;

    if (empty($a) || empty($b)) {

      return $res;

    }

    if ($a->keyStr < $b->keyStr) {

      $res = -1;

    }

    elseif ($a->keyStr > $b->keyStr) {

      $res = 1;

    }

    return $res;

  }

 * @return string

 *     the text

 */

  function statistical_values_explanation(){

    return t("A single or the first number in square brackets denotes sample size");

  }

/**

 *

 * The order of the items is important for the display and must not be changed.

 * @return array

 */

  $min_max = [

    'Min' => NULL,

    'TypicalLowerBoundary' => NULL,

    'TypicalUpperBoundary' => NULL,

    'Max' => NULL,

    'Average' => NULL,

    'StandardDeviation' => NULL,

  ];

}

/**

 *

 * The same also accounts for Max and TypicalUpperBoundary.

 *

 * For further details see #3742, #8766

 *

 *  the statistical values array as produced by statistical_values_array()

 *  Defaults to no unit

 */

  // --- sanitize values

    $stat_vals_arr['TypicalLowerBoundary'] = $stat_vals_arr['Min'];

    $stat_vals_arr['Min'] = NULL;

    $stat_vals_arr['TypicalUpperBoundary'] = $stat_vals_arr['Max'];

    $stat_vals_arr['Max'] = NULL;

    $stat_vals_arr['TypicalLowerBoundary'] = NULL;

    $stat_vals_arr['TypicalUpperBoundary'] = NULL;

  }

      if ($statistical_val == '?') {

        $val_markup = $statistical_val;

      else {

        if (is_numeric($statistical_val->_value)) {

          $val_markup = '<span class="'

        }

        else {

          $val_markup = NULL;

        }

        switch ($key) {

          // ---- min_max_element

          case 'Min':

            $min_max_markup .= "($val_markup–)";

            break;

          case 'Max':

            $min_max_markup .= "(–$val_markup)";

            break;

          case 'TypicalLowerBoundary':

            $min_max_markup .= "$val_markup";

            break;

          case 'TypicalUpperBoundary':

            $min_max_markup .= "–$val_markup";

            break;

            $other_vals_array[$key] = $val_markup;

            break;

          case 'Average':

            $other_vals_array[$key] = $xbar_equals . $val_markup;

            break;

          case 'Variance':

            $other_vals_array[$key] = 'σ²=' . $val_markup;

            break;

          case 'StandardDeviation':

            $other_vals_array[$key] = 'σ=' . $val_markup;

            break;

        }

    }

  }

    // this trivial case needs to be displayed a simpler way

    unset($other_vals_array['Average']);

    $min_max_markup .= '[' . join(';', $other_vals_array) . ']';

    if(count($other_vals_array)){

      $min_max_markup .= '[' . join(';', $other_vals_array) . ']';

    }

  }

 * Calculates the required precision for the taget value to be significantly different from min and may and rounds it.

 *

 * @param $target

 *    The statistical value to be rounded to the least significant precision

 * @param $min

 *    The lower bound to calculate the least significant precision

 * @param $max

 *    The upper bound to calculate the least significant precision

 * @param int $threshold

 *    Per default 1, but can be set to any other value > 0 and < 1 to define

 *    another threshold for the transition to the next precision level.

 *    E.g. A value of 0.5 will cause values > 50 and <= 500 to be shown with

 *    a precision of 2, whereas with a threshold of 1 the values > 10 and <= 100

 *    will be shown with a precision of 2 figures

 */

function statistical_values_adjust_significant_figures(&$target, $min,  $max, $threshold = 1){

  $precision = 1;

  if($min->_value !== $max->_value){

    $precision = floor(log10(abs($max->_value - $min->_value) * (1 / $threshold)));

    // increase precision by one

    $precision += $precision < 0 ? - 1 : 1;

  }

  $target->_value = sigFig($target->_value, $precision);

}

/**

 * based on an idea taken from https://stackoverflow.com/questions/37618679/format-number-to-n-significant-digits-in-php#answer-48283297

 *

 * @param $value

 * @param $digits

 *

 * @return float|string

 */

function sigFig($value, $digits, $round_only = true)

{

  if ($value == 0) {

    $decimalPlaces = $digits - 1;

  } elseif ($value < 0) {

    $decimalPlaces = $digits - floor(log10($value * -1)) - 1;

  } else {

    $decimalPlaces = $digits - floor(log10($value)) - 1;

  }

  $answer = ($decimalPlaces > 0) && !$round_only ?

    number_format($value, $decimalPlaces) : round($value, abs($decimalPlaces));

  return $answer;

}

 * @param $key2

 *

 * @return bool

 */

 * Creates min max markup to represent a min-average-max measure optionally with an error value.

 *

 * The fields that are taken into account are:

 * - field_base_name = min

 * - field_base_nameMax = max

 * - field_base_nameText = free text

 * - field_base_nameError = error value

 *

 * @param $object

 *    The base name for all measurement fields. This name is at the same time the full name of the

 *    min value.

 *   The markup for the min max

 * @see statistical_values()

  static $default_unit = 'm';

  $field_name = $field_base_name . 'Text';

    $min_max_markup = ' ' . $object->$field_name;

  } else {

    // create markup for the atomized min max data

      $min_max_array['Min'] = new stdClass();

      $min_max_array['Min']->_value = $object->$field_base_name;

    }

    $field_name = $field_base_name . 'Max';

    if (@is_numeric($object->$field_name)) {

      $min_max_array['Max'] = new stdClass();

      $min_max_array['Max']->_value = $object->$field_name;

    }

}

// TODO  move below code into new file: agent.inc

/*

 * Compose an render array from a CDM TaxonNodeAgentRelation object as Taxon Expert.

 *

 * compose_hook() implementation

 *

 * @param object $taxon_node_agent_relation

 *   CDM instance of type TaxonNodeAgentRelation

 * @return array

 *   A drupal render array

 *

 * @ingroup compose

 */

function compose_cdm_taxon_expert($taxon_node_agent_relation) {

  if($taxon_node_agent_relation->class == 'DefaultPagerImpl'){

    // oops this is a pager

    // this situation will occur when this compose is executed

    // through the proxy_content() method

    $taxon_node_agent_relation = $taxon_node_agent_relation->records[0];

  }

  if(is_object($taxon_node_agent_relation->agent)) {

    $agent_details = compose_cdm_team_or_person_base($taxon_node_agent_relation->agent);

    // all data will be added to the groups of the agent_details render array

    $groups = &$agent_details[0]['#groups'];

    $family_tnars = cdm_ws_fetch_all(CDM_WS_PORTAL_AGENT . '/' . $taxon_node_agent_relation->agent->uuid . '/taxonNodeAgentRelations', array("rank"=>"Familia"));

    $taxa_markup = array(

      '#theme_wrappers' => array('container'),

      '#attributes' => array('class' => array('managed_taxa')),

      '#wrapper_attributes' => array('class' => 'sublist-container')

      );

    foreach($family_tnars as $tnar){

      if(is_object($tnar->taxonNode->taxon)){

    }

    ksort($taxa_markup);

    @_description_list_group_add($groups, t('Families'). $label_suffix, array($taxa_markup));

  }

  return $agent_details;

}

/*

 * Compose an render array from a CDM TeamOrPersonBase object.

 *

 * compose_hook() implementation

 *

 * TODO: currently mainly implemented for Agent, add Team details

 *

 * @param object $team_or_person

 *   CDM instance of type TeamOrPersonBase

 * @return array

 *   A drupal render array

 *

 * @ingroup compose

 */

function compose_cdm_team_or_person_base($team_or_person, $data = array()) {

  $groups = array();

  $label_suffix = ':';

  // $weight = 0;

  if($team_or_person){

    if(is_object($team_or_person->lifespan)){

      // ToDo render as date* - date† ?

      @_description_list_group_add($groups, t('Lifespan'). $label_suffix, timePeriodToString($team_or_person->lifespan) /*, '' , $weight++ */);

    }

    // nomenclaturalTitle

    @_description_list_group_add($groups, "Nomenclatural Title". $label_suffix, $team_or_person->nomenclaturalTitle);

    // collectorTitle

    @_description_list_group_add($groups, "Collector Title". $label_suffix, $team_or_person->collectorTitle);

    // institutionalMemberships

    if(is_array($team_or_person->institutionalMemberships)){

      $institutes_ra =  array();

      foreach($team_or_person->institutionalMemberships as $membership) {

        $membership_groups = array();

        @_description_list_group_add($membership_groups, t('Department'). $label_suffix, $membership->department);

        @_description_list_group_add($membership_groups, t('Role'). $label_suffix, $membership->role);

        if(is_object($membership->period)){

          @_description_list_group_add($membership_groups, t('Period'). $label_suffix, timePeriodToString($membership->period));

        }

        if(is_object($membership->institute->contact)){

          $institute_contact_details = compose_cdm_contact($membership->institute->contact, $membership->institute->titleCache);

          if(is_array($institute_contact_details[0]['#groups'])){

            $membership_groups = array_merge($membership_groups, $institute_contact_details[0]['#groups']);

          }

        }

        if(count($membership_groups) > 0){

          $institutes_ra[]  = array(

            '#title' => $membership->institute->titleCache,

            '#theme' => 'description_list',

            '#groups' => $membership_groups,

            '#attributes' => array('class' => html_class_attribute_ref($membership)),

            '#wrapper_attributes' => array('class' => 'sublist-container')

          );

        } else {

          // no further details for the membership, display the title

          $institutes_ra[] = markup_to_render_array('<h3>' . $membership->institute->titleCache . '</h3>');

        }

      }

      $label = count($institutes_ra) > 1 ? t('Institutes'):  t('Institute');

      @_description_list_group_add($groups, $label. $label_suffix, $institutes_ra /*, '' , $weight++ */);

    }

    // Contact

    $agent_contact_details = compose_cdm_contact($team_or_person->contact, $team_or_person->titleCache);

    if(is_array($agent_contact_details[0]['#groups'])){

      $groups = array_merge($groups, $agent_contact_details[0]['#groups']);

    }

    // additional data

    foreach($data as $key=>$value){

  }

  $team_or_person_details = array(

    '#title' => $team_or_person->titleCache,

    '#theme' => 'description_list',

    '#groups' => $groups,

    '#attributes' => array('class' => html_class_attribute_ref($team_or_person)),

  );

  return array($team_or_person_details);

}

/*

 * Compose an render array from a CDM Contact object.

 *

 * compose_hook() implementation

 *

 * TODO: currently mainly implemented for Agent, add Team details

 *

 * @param object $contact

 *   CDM instance of type Contact

 * @param $title

 *   The title for the description list header

 * @param $weight

 *   Optional weight for the description list entries

 * @return array

 *   A drupal render array

 *

 * @ingroup compose

 */

function compose_cdm_contact($contact, $title, $weight = 0)

{

  $groups = array();

  $contact_field_names_map = array(

    'emailAddresses' => t('Email'),

    'urls' => t('Urls'),

    'phoneNumbers' => t('Phone'),

    'faxNumbers' => t('Fax'),