EDIT

<?php

const BIBLIOGRAPHY_FOOTNOTE_KEY = PSEUDO_FEATURE_BIBLIOGRAPHY;

 * Returns the localized representations of the modifiers hold by the

 * supplied cdm instance concatenated into one string.

 *

 *   DescriptionElementBase, StateDate, State

 *

 * @return String

 *   localized representations of the modifiers hold by the

 *   supplied cdm instance concatenated into one string

 */

    foreach ($is_modifieable->modifiers as $modifier) {

}

 * Filters the given set of description elements and prefers computed elements over others.

 *

 * Computed description elements

 * are identified by the MarkerType.COMPUTED()

 *

 * If the given set contains at least one computed element only

 * the computed elements are returned.

 *

 * @param array $description_elements

 *   An array of CDM DescriptionElementBase instances

 *

 * @return array

 *   only the computed description elements otherwise all others.

 *

 * @deprecated this is replaced by the cdmlib DistributionUtil class!!!

 */

function cdm_description_elements_prefer_computed($description_elements){

  $other_elements = array();

    foreach ($description_elements as $element) {

      if (cdm_entity_has_marker($element, UUID_MARKERTYPE_COMPUTED)) {

        $computed_elements[] = $element;

      }

      else {

        $other_elements[] = $element;

    }

    return $computed_elements;

  }

  else {

    return $other_elements;

 * Creates a query parameter array based on the setting stored in the drupal variable CDM_DISTRIBUTION_FILTER.

 *

 * @return array

 *   An array with distribution filter query parameters

 */

function cdm_distribution_filter_query() {

  $cdm_distribution_filter = get_array_variable_merged(CDM_DISTRIBUTION_FILTER, CDM_DISTRIBUTION_FILTER_DEFAULT);

  $query = array();

  if($feature_block_settings['sort_elements'] == SORT_HIERARCHICAL){

    $query['distributionOrder'] = 'AREA_ORDER';

  }

    $query['statusOrderPreference'] = 1;

  }

  if ($cdm_distribution_filter['filter_rules']['subAreaPreference']) {

    $query['subAreaPreference'] = 1;

  }

    $query['hiddenAreaMarkerType'] = '';

    foreach ($cdm_distribution_filter['hiddenAreaMarkerType'] as $marker_type => $enabled) {

}

 * Merge the fields 'annotations', 'markers', 'sources', 'media' from the source CDM DescriptionElement into  the target.

 *

 * @param object $target

 *   The source CDM DescriptionElement

 * @param object $source

 *   The target CDM DescriptionElement

 */

  foreach ($fields_to_merge as $field) {

    if (is_array($source->$field)) {

      if (!is_array($target->$field)) {

        $target->$field = $source->$field;

      }

      else {

        $target->$field = array_merge($target->$field, $source->$field);

    }

  }

 * Adds an entry to the end of the table of content items list

 *

 * The  table of content items are crated internally by calling

 * toc_list_item() the resulting item is added to the statically cached

 * list of toc elements

 *

 * @param string $label

 *   The label of toc entry

 * @param $class_attribute_suffix

 *   "feature-toc-item-"

 *   Optional parameter to define a url fragment different from the $label,

 *   if the $fragment is not defined the $label will be used

 *   being set

 *   Defines the weight for the ordering the item in the toc list.

 *   The item will be placed at the end if weigth is NULL.

 * @throws \Exception re-throws exception from theme()

    $fragment = $label;

  }

  $fragment = generalizeString($fragment);

    theme(

      'cdm_feature_name',

      array('feature_name' => $label)),

      $fragment

    );

    reset($toc_list_items);

    $weight = key($toc_list_items); // returns null for empty arrays

    $weight = $weight !== null ? $weight - FEATURE_BLOCK_WEIGHT_INCREMENT : 0;

      end($toc_list_items);

      $weight = key($toc_list_items); // returns null for empty arrays

      $weight = $weight !== null ? $weight + FEATURE_BLOCK_WEIGHT_INCREMENT : 0;

  ksort($toc_list_items); // sort so that the last element has always the highest weight

 * Returns the statically cached table of content items as render array.

 *

 * @see cdm_toc_list_add_item()

 *

 * @return array

 *   a render array of table of content items suitable for theme_item_list()

 */

function &cdm_toc_list(){

  return $toc_list_items;

}

 * specific CDM Feature.

 * features are derived from other data on the fly and so not exist as such in

 * the cdm data. For pseudo features the $feature can be created using

 * make_pseudo_feature().

 * @param $feature_name

 *   representation.

 * @throws \Exception re-throws exception from theme()

  $block = new stdclass();

    . '</span>';

  $block->module = "cdm_dataportal-feature";

  $block->content = '';

  return $block;

}

 * Returns a list of a specific type of IdentificationKeys.

 *

 * The list can be restricted by a taxon.

 *

 * @param string $type

 *   The simple name of the cdm class implementing the interface

 *   IdentificationKey, valid values are:

 *   PolytomousKey, MediaKey, MultiAccessKey.

 * @param string $taxonUuid

 *   If given this parameter restrict the listed keys to those which have

 *   the taxon identified be this uuid in scope.

 *

 * @return array

 *   List with identification keys.

 */

function _list_IdentificationKeys($type, $taxonUuid = NULL, $pageSize = NULL, $pageNumber = NULL) {

  if (!$type) {

    drupal_set_message(t('Type parameter is missing'), 'error');

    return;

  }

    case "PolytomousKey":

    case "MediaKey":

  }

  }

  $queryParameters = '';

  if (is_numeric($pageSize)) {

    $queryParameters = "pageSize=" . $pageSize;

  }

  else {

    $queryParameters = "pageSize=0";

  }

  if (is_numeric($pageNumber)) {

    $queryParameters = "pageNumber=" . $pageNumber;

  }

  else {

    $queryParameters = "pageNumber=0";

  }

  $queryParameters = NULL;

  if ($taxonUuid) {

    $queryParameters = "findByTaxonomicScope=$taxonUuid";

  }

  if (!$pager || $pager->count == 0) {

    return array();

  }

  return $pager->records;

}

/**

 * Creates a list item for a table of content, suitable as data element for a themed list

 *

 * @see theme_list()

 *

 * @param $label

 * @param $http_request_params

 * @param $attributes

 * @return array

 */

function toc_list_item($label, $attributes = array(), $fragment = null) {

  // we better cache here since drupal_get_query_parameters has no internal static cache variable

  $http_request_params = drupal_static('http_request_params', drupal_get_query_parameters());

  $item =  array(

    'data' => l(

      $label,

      $_GET['q'],

      array(

        'attributes' => array('class' => array('toc')),

        'fragment' => generalizeString($label),

        'query' => $http_request_params,

  );

  $item['attributes'] = $attributes;

  return $item;

}

 * compose_description_element().

 * @param $a

 * @param $b

 * @return int Returns < 0 if $a['#value'].$a['#value-suffix'] from is less than

 * $b['#value'].$b['#value-suffix'], > 0 if it is greater than $b['#value'].$b['#value-suffix'],

 * and 0 if they are equal.

function compare_description_element_render_arrays($a, $b){

  if ($a['#value'].$a['#value-suffix'] == $b['#value'].$b['#value-suffix']) {

    return 0;

  }

  return ($a['#value'].$a['#value-suffix'] < $b['#value'].$b['#value-suffix']) ? -1 : 1;

}

/**

 * @param $element

 * @param $feature_block_settings

 * @param $element_markup

 * @param $footnote_list_key_suggestion

 *

 * @return array|null

  $render_array = array(

    '#type' => 'html_tag',

    '#tag' => cdm_feature_block_element_tag_name($feature_block_settings),

    '#attributes' => array(

        'DescriptionElement',

        'DescriptionElement-' . $element->class,

        html_class_attribute_ref($element)

      )

    '#value' => '',

    '#value_suffix' => NULL

  );

    $element,

    handle_annotations_and_sources_config($feature_block_settings),

    $element_markup,

    $footnote_list_key_suggestion

  );

  if(isset($element->timeperiod)){

  // used in source information without any text stored in it.

  if (!empty($annotations_and_sources['names_used_in_source']) && empty($element_markup)) {

    $names_used_in_source_markup = join(', ', $annotations_and_sources['names_used_in_source']) . ': ';

    // these are expected to be at the end of the strings

    $pattern = '/ <span class="nameUsedInSource">.*$/';

    foreach( $annotations_and_sources['source_references'] as &$source_reference){

      $source_reference = preg_replace($pattern , '', $source_reference);

    }

  $source_references_markup = '';

  if (!empty($annotations_and_sources['source_references'])) {

    $source_references_markup = '<span class="sources">' . join(' ', $annotations_and_sources['source_references']) . '<span>';

  }

  if ($prepend_feature_label) {

    $feature_label = '<span class="nested-feature-tree-feature-label">' . $element->feature->representation_L10n . ':</span> ';

  }

    // no textual content? So skip this element completely, even if there could be an footnote key

    return null;

  }

    $render_array['#value'] = $feature_label . $content_markup;

    $render_array['#value_suffix'] = $annotations_and_sources['foot_note_keys'];

 * Creates a handle_annotations_and_sources configuration array from feature_block_settings.

 *

 * The handle_annotations_and_sources configuration array is meant to be used for the

 * method handle_annotations_and_sources().

 *

 * @param $feature_block_settings array

 *

 * @return array

 *   The configuration array for handle_annotations_and_sources()

 */

function handle_annotations_and_sources_config($feature_block_settings){

  $config = $feature_block_settings;

  unset($config['sources_as_content_to_bibliography']);

    $config['add_footnote_keys'] = 1;

  }

  $config['bibliography_aware'] = 1;

  return $config;

}

 * Provides the according tag name for the description element markup which

 * fits the  $feature_block_settings['as_list'] value

 *

 * @param $feature_block_settings

 *   A feature_block_settings array, for details, please see

 *   get_feature_block_settings($feature_uuid = 'DEFAULT')

 *

 * @return mixed|string

 */

    switch ($feature_block_settings['as_list']){

      case 'ul':

      case 'ol':

        return 'li';

      case 'div':

          return $feature_block_settings['element_tag'];

        }

      case 'dl':

        return 'dd';

      default:

        return 'div'; // should never happen, throw error instead?

    }

  }

/* ==================== COMPOSE FUNCTIONS =============== */

  /**

   * Returns a set of feature blocks for a taxon profile from the $mergedFeatureNodes of a given $taxon.

   *

   * The taxon profile consists of drupal block elements, one for the description elements

   * of a specific feature. The structure is defined by specific FeatureTree.

   * The chosen FeatureTree is merged with the list of description elements prior to using this method.

   *

   * The merged nodes can be obtained by making use of the

   * function cdm_ws_descriptions_by_featuretree().

   *

   * @see cdm_ws_descriptions_by_featuretree()

   *

   * @param $mergedFeatureNodes

   *

   * @param $taxon

   *

   * @return array

   *  A Drupal render array containing feature blocks and the table of content

   *

   * @ingroup compose

   */

    $block_list = array();

    $gallery_settings = getGallerySettings(CDM_DATAPORTAL_DESCRIPTION_GALLERY_NAME);

    RenderHints::pushToRenderStack('feature_block');

          has_feature_node_description_elements($feature_node)) && $feature_node->term->uuid != UUID_IMAGE) { // skip empty or suppressed features

        $feature_block_settings = get_feature_block_settings($feature_node->term->uuid);

        $block_content_is_empty = TRUE;

        }

         * Content/DISTRIBUTION.

         */

          $block = compose_feature_block_distribution($taxon, $feature_node->descriptionElements, $feature_node->term);

        }

         * Content/COMMON_NAME.

         */

          $common_names_render_array = compose_feature_block_items_feature_common_name($feature_node->descriptionElements, $feature_node->term);

          $block_content_is_empty = FALSE;

        }

          $block->content[] = cdm_block_use_description_content($taxon->uuid, $feature_node->term);

        }

        /*

         * Content/ALL OTHER FEATURES.

         */

        else {

          $media_list = array();

          $child_elements_render_array = null;

            $elements_render_array = compose_feature_block_items_generic($feature_node->descriptionElements, $feature_node->term);

          // Content/ALL OTHER FEATURES/Subordinate Features

          // subordinate features are printed inline in one floating text,

          // it is expected hat subordinate features can "contain" TextData,

            $child_elements_render_array = compose_feature_block_items_nested($feature_node, $media_list, $feature_block_settings);

          }

          $block_content_is_empty = $block_content_is_empty && empty($media_list) && empty($elements_render_array);

          if(!$block_content_is_empty){

            $block->content[] = compose_feature_media_gallery($feature_node, $media_list, $gallery_settings);

             * Footnotes for the feature block

             */

            $block->content[] = markup_to_render_array(render_footnotes($feature_node->term->uuid));

        } // END all other features

          cdm_toc_list_add_item(cdm_term_representation($feature_node->term), $feature_node->term->uuid, null, FALSE, $block_weight);

 * Creates a render array of description elements  held by child nodes of the given feature node.

 *

 * This function is called recursively!

 *

 * @param array $media_list

 *   List of CDM Media entities. All media of subordinate elements should be passed to the main feature.ä

 * @param $feature_block_settings

 *   The feature block settings.

 * @param $main_feature

 *  Only used internally in recursive calls.

 *

 * @return array

 *  A Drupal render array

 *

 * @ingroup compose

 */

  if(!$main_feature){

  /*

   * TODO should be configurable, options; YES, NO, AUTOMATIC

   * (automatic will only place the label if the first word of the description element text is not the same)

   */

  $prepend_feature_label = false;

  $render_arrays = array();

      foreach ($child_node->descriptionElements as $element) {

        if (isset($element->media[0])) {

          // Append media of subordinate elements to list of main

          // feature.

          $media_list = array_merge($media_list, $element->media);

        }

        $child_node_element = null;

        switch ($element->class) {

          case 'TextData':

            $child_node_element = compose_description_element_text_data($element, $element->feature->uuid, $feature_block_settings, $prepend_feature_label);

            break;

          case 'CategoricalData':

            $child_node_element = compose_description_element_categorical_data($element, $feature_block_settings, $prepend_feature_label);

            break;

          case 'QuantitativeData':

            $child_node_element = compose_description_element_quantitative_data($element, $feature_block_settings, $prepend_feature_label);

        }

        if (is_array($child_node_element)) {

          $render_arrays[] = $child_node_element;

        }

      }

    }

    if(isset($child_node->childNodes[0])){

      $render_arrays = array_merge($render_arrays, compose_feature_block_items_nested($child_node, $media_list, $feature_block_settings, $main_feature ));

    }

  }

  return $render_arrays;

}

   * @return array

   * @ingroup compose

      $media_list = array_merge($media_list, cdm_dataportal_media_from_descriptionElements($feature_node->descriptionElements));

    $captionElements = array('title', 'rights');

    if (isset($media_list[0]) && isset($gallery_settings['cdm_dataportal_media_maxextend']) && isset($gallery_settings['cdm_dataportal_media_cols'])) {

        'cols' => $gallery_settings['cdm_dataportal_media_cols'],

        'captionElements' => $captionElements,

      ));

      return markup_to_render_array($gallery);

    }

    return markup_to_render_array('');

  }

  /**

   *

   * @param $descriptionElements

   *   an associative array with two elements:

   *   - '#type': must be 'DTO'

   *   - 'DistributionInfoDTO': a CDM DistributionInfoDTO object as returned by the DistributionInfo web service