EDIT

<?php

/**

 * @file

 * CDM Dataportal settings.

 */

  define('TAXONTREE_RANKLIMIT_DEFAULT', 0);

  define('CDM_TAXONTREE_INCLUDES', 'taxontree_includes');

  define('NO_SORT', -1);

  define('SORT_HIERARCHICAL', 9);

  define('CDM_DATAPORTAL_SEARCH_ITEMS_ON_PAGE', 25);

  define('SEARCH_RESULTS_SHOW_THUMBNAIL_CHECKBOX_DEFAULT', 1);

  define('SEARCH_RESULTS_SHOW_THUMBNAIL_CHECKBOX', 'search_results_show_thumbnail_checkbox');

  define('CDM_DATAPORTAL_COMPRESSED_SPECIMEN_DERIVATE_TABLE', 0);

  define('CDM_DATAPORTAL_ALL_FOOTNOTES', 0);

  define('CDM_DATAPORTAL_ANNOTATIONS_FOOTNOTES', 0);

  define('CDM_DATAPORTAL_LAST_VISITED_TAB_ARRAY_INDEX', 999);

  /* annotationTypeKeys */

    $annotationTypeKeys = array_flip($annotationTypeKeys);

    // Technical annotation are off by default.

    unset($annotationTypeKeys[UUID_ANNOTATION_TYPE_TECHNICAL]);

    $annotationTypeKeys = array_flip($annotationTypeKeys);

    // Additional value for the NULL case.

    $annotationTypeKeys[] = 'NULL_VALUE';

  }

  define('ANNOTATIONS_TYPES_AS_FOOTNOTES_DEFAULT', serialize($annotationTypeKeys));

  define('BIBLIOGRAPHY_FOR_ORIGINAL_SOURCE_DEFAULT', serialize(array(

    'enabled' => 0,

    'key_format' => 'ALPHA'

  )));

    array(

      UUID_PROPARTE_MISAPPLIEDNAME_FOR => UUID_PROPARTE_MISAPPLIEDNAME_FOR,

      UUID_PARTIAL_MISAPPLIEDNAME_FOR => UUID_PARTIAL_MISAPPLIEDNAME_FOR,

      UUID_PROPARTE_SYNONYM_FOR => UUID_PROPARTE_SYNONYM_FOR,

      UUID_PARTIAL_SYNONYM_FOR => UUID_PARTIAL_SYNONYM_FOR,

      UUID_INVALID_DESIGNATION_FOR => UUID_INVALID_DESIGNATION_FOR

  ));

   * @var array of URIs eg. http://edit.africamuseum.be"

   *   An options array

   */

  define('EDIT_MAPSERVER_URI', serialize(

      array(

  define('EDIT_MAPSERVER_PATH', '/edit_wp5');

  /**

   * @var array of versions eg. "v1.2"

   *   An options array

   */

  define('EDIT_MAPSERVER_VERSION', serialize(

      array(

//        'v1.1' => 'v1.1',        // no longer recommended

//        'v1.2_dev' => 'v1.2_dev',// no longer recommended

        'v1.4_dev' => 'v1.4_dev (experimental features)'

  define('EDIT_MAPSERVER_URI_DEFAULT', 'http://edit.africamuseum.be');

  define('EDIT_MAPSERVER_VERSION_DEFAULT', 'v1.2');

  define('DISTRIBUTION_TEXTDATA_DISPLAY_ON_TOP', 'distribution_textdata_on_top');

  define('CDM_TAXON_PROFILE_IMAGE', 'cdm_taxon_profile_image');

  define('CDM_TAXON_PROFILE_IMAGE_DEFAULT', serialize(

      array(

          'show' => 0,

          'maxextend' => 184,

          'media_uri_query' => '',

          'custom_placeholder_image_fid' => ''

      )

define('FEATURE_BLOCK_SETTINGS', 'feature_block_settings');

define('DISTRIBUTION_CONDENSED', 'distribution_condensed');

define('DISTRIBUTION_CONDENSED_INFO_PATH', 'distribution_condensed_info_path');

define('DISTRIBUTION_CONDENSED_INFO_PATH_DEFAULT', 'cdm_dataportal/help/condensed_distribution');

define('DISTRIBUTION_CONDENSED_RECIPE', 'distribution_condensed_recipe');

define('DISTRIBUTION_CONDENSED_RECIPE_DEFAULT', 'EuroPlusMed');

define('DISTRIBUTION_STATUS_COLORS', 'distribution_status_colors');

define('DISTRIBUTION_ORDER_MODE', 'distribution_order_mode');

define('DISTRIBUTION_ORDER_MODE_DEFAULT', 'TREE');

define('DISTRIBUTION_TREE_OMIT_LEVELS', 'distribution_tree_omit_levels');

define('CDM_SYNONYMY_AS_TAB_DEFAULT', 1);

 * The array has fixed integer keys which must not be changed.

function get_taxon_tabs_list() {

    1 => 'Synonymy',

    2 => 'Images',

    3 => 'Specimens',

    4 => 'Keys',

    // skip the Synonymy if it is shown in  the general tab

    unset($opts[1]);

  }

  return $opts;

    'general' => '-3',

    'synonymy' => '-2',

    'images' => '0',

    'specimens' => '1',

    'keys' => '3',

    'experts' => '5',

    )

// CDM_TAXONPAGE_TAB_LABELS_DEFAULT

define('CDM_TAXONPAGE_TAB_LABELS', 'cdm_taxonpage_tab_labels');

define('CDM_TAXONPAGE_TAB_LABELS_DEFAULT', serialize(

  array(

    'general' => null,

    'synonymy' => null,

    'images' => null,

    'specimens' => null,

    'keys' => null,

    'experts' => null,

  )

));

$taxon_tab_options[CDM_DATAPORTAL_LAST_VISITED_TAB_ARRAY_INDEX] = 'Last visited tab';

define('CDM_DATAPORTAL_DEFAULT_TAXON_TAB', serialize($taxon_tab_options));

/**

 * @todo document this function.

 */

function get_taxon_options_list() {

  $taxon_tab_options = array_flip(get_taxon_tabs_list());

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

  return $taxon_tab_options;

}

define('CDM_PART_DEFINITIONS_DEFAULT', serialize(

        'referencePart' => array('authors' => TRUE),

        'microreferencePart' => array('microreference' => TRUE),

        'descriptionPart' => array('description' => TRUE),

      ),

        'namePart' => array('name' => TRUE),

        'nameAuthorPart' => array('name' => TRUE, 'authors' => TRUE),

        'referencePart' => array('reference' => TRUE, 'microreference' => TRUE),

        'descriptionPart' => array('description' => TRUE),

     '#DEFAULT' => array(

        'namePart' => array(

            'name' => TRUE

        'nameAuthorPart' => array(

            'name' => TRUE,

            'authors' => TRUE

         'reference' => TRUE

         'secReference' => TRUE,

       ),

       'microreferencePart' => array(

          'microreference' => TRUE,

          'status' => TRUE,

          'description' => TRUE,

      )

  )

);

      'ZoologicalName' => array(

        'namePart' => array('name' => TRUE),

        'nameAuthorPart' => array('name' => TRUE),

        'referencePart' => array('authors' => TRUE),

        'microreferencePart' => array('microreference' => TRUE),

        'statusPart' => array('status' => TRUE),

        'descriptionPart' => array('description' => TRUE),

      ),

      'BotanicalName'=> array(

        'namePart' => array('name' => TRUE),

        'nameAuthorPart' => array('name' => TRUE, 'authors' => TRUE),

        'referencePart' => array('reference' => TRUE, 'microreference' => TRUE),

        'referenceYearPart' => array('reference.year' => TRUE),

        'statusPart' => array('status' => TRUE),

        'descriptionPart' => array('description' => TRUE),

      ),

      '#DEFAULT' => array(

        'namePart' => array(

          'name' => TRUE

        ),

        'nameAuthorPart' => array(

          'name' => TRUE,

          'authors' => TRUE

        ),

        'referencePart' => array(

          'reference' => TRUE

        ),

        'microreferencePart' => array(

          'microreference' => TRUE,

        ),

        'statusPart' => array(

          'status' => TRUE,

        ),

        'descriptionPart' => array(

          'description' => TRUE,

        ),

      )

    )

  )

  );

    'taxon_page_title,polytomousKey'=> array(

      ),

     'nameAuthorPart' => TRUE,

     'referencePart' => TRUE,

     'statusPart' => TRUE,

     'secReferencePart' => TRUE,

    ),

    'taxon_page_synonymy,accepted_taxon.taxon_page_synonymy'=> array(

      'nameAuthorPart' => array('#uri' => TRUE),

      'referencePart' => TRUE,

      'descriptionPart' => TRUE,

      'referencePart' => TRUE,

      'secReferencePart' => TRUE,

    ),

      'nameAuthorPart' => array('#uri' => TRUE),

      'referencePart' => TRUE,

      /* no sec ref in this case, misapplied names are

       * de-duplicated and the sec ref is shown as footnote */

    ),

        'referenceYearPart' => TRUE,

    'acceptedFor,typedesignations,list_of_taxa' => array(

        'referencePart' => TRUE,

      ),

        'referencePart' => TRUE,

  )

));

define('CDM_NAME_RENDER_TEMPLATES_DEFAULT_PRE_380', serialize(

  array (

    'taxon_page_title,polytomousKey'=> array(

      'namePart' => array('#uri' => TRUE),

    ),

    'taxon_page_synonymy,related_taxon'=> array(

      'nameAuthorPart' => array('#uri' => TRUE),

      'referencePart' => TRUE,

      'statusPart' => TRUE,

      'descriptionPart' => TRUE,

    ),

    'homonym'=> array(

      'nameAuthorPart' => array('#uri' => TRUE),

      'referenceYearPart' => TRUE,

    ),

    'acceptedFor,typedesignations,list_of_taxa' => array(

      'nameAuthorPart' => array('#uri' => TRUE),

      'referencePart' => TRUE,

    ),

    '#DEFAULT' => array(

      'nameAuthorPart' => array('#uri' => TRUE),

      'referencePart' => TRUE,

));

define('CDM_SEARCH_TAXA_MODE_DEFAULT', serialize(

    // to unset a default enntry set the value to 0

    array(

      'doTaxa'=>'doTaxa',

      'doSynonyms' => 'doSynonyms',

      'doTaxaByCommonNames' => 'doTaxaByCommonNames',

      'doMisappliedNames' => 'doMisappliedNames'

    )

  )

);

$gallery_settings = array(

    "cdm_dataportal_show_taxon_thumbnails" => 1,

    "cdm_dataportal_show_synonym_thumbnails" => 0,

    "cdm_dataportal_show_thumbnail_captions" => 1,

    "cdm_dataportal_media_maxextend" => 120,

    "cdm_dataportal_media_cols" => 3,

    "cdm_dataportal_media_maxRows" => 1,

);

define('CDM_DATAPORTAL_GALLERY_SETTINGS', serialize($gallery_settings));

define('CDM_DATAPORTAL_SPECIMEN_GALLERY_NAME', 'specimen_gallery');

define('CDM_DATAPORTAL_DESCRIPTION_GALLERY_NAME', "description_gallery");

define('CDM_DATAPORTAL_TAXON_MEDIA_GALLERY_NAME_TAB', "taxon_tab_media_gallery");

define('CDM_DATAPORTAL_SEARCH_GALLERY_NAME', "search_gallery");

define('CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS', 'cdm_dataportal_display_taxon_relationships');

define('CDM_DATAPORTAL_DISPLAY_NAME_RELATIONSHIPS', 'cdm_dataportal_display_name_relations');

// define('CDM_DATAPORTAL_DISPLAY_NAME_RELATIONSHIPS_2', array("default" => t('Display all')));

define('CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS_DEFAULT', 1);

define('CDM_DATAPORTAL_DISPLAY_NAME_RELATIONSHIPS_DEFAULT', 1);

define('CDM_STANDARD_IMAGE_VIEWER_DEFAULT', serialize(array(

  'media_representation_details_enabled' => 0

)));

 * The drupal variable key for the array containing the uuids of the taxon relationship types to display in

 * the snonymy.

 *

 * @var string

 */

define('CDM_NAME_RELATIONSHIP_TYPES', 'cdm_name_relationship_types');

define('CDM_NAME_RELATIONSHIP_TYPES_DEFAULT', serialize(

    array(

      UUID_NAMERELATIONSHIPTYPE_TREATED_AS_LATER_HOMONYM => UUID_NAMERELATIONSHIPTYPE_TREATED_AS_LATER_HOMONYM,

      UUID_NAMERELATIONSHIPTYPE_BLOCKING_NAME_FOR => UUID_NAMERELATIONSHIPTYPE_BLOCKING_NAME_FOR

  )

);

 * The drupal variable for the configuration of the information aggregation along

 * the taxon relation ships. The mapped arrayis associative and holds two elements:

 *    - direct: the uuids of the taxon relationship types to take into account in invers

 *      direction.

 *    - invers: the uuids of the taxon relationship types to take into account in direct

 *      direction.

 *

 * @var String

 */

define('CDM_AGGREGATE_BY_TAXON_RELATIONSHIPS', 'cdm_aggregate_by_taxon_relationships');

define('CDM_AGGREGATE_BY_TAXON_RELATIONSHIPS_DEFAULT', serialize(

    array(

        'direct'=>array(),

        'invers'=>array()

     )

   ));

define('CDM_DISTRIBUTION_FILTER_DEFAULT', serialize(

      array(

      'filter_rules' => array(

        'statusOrderPreference' => 0,

        'subAreaPreference' => 0,

      ),

));

define('DISTRIBUTION_HIERARCHY_STYLE_DEFAULT', serialize(array(

  "level_0" => array(

    'label_suffix' => ':',

    'item_group_prefix' => '',

    'item_group_postfix' => ''

  ),

  "level_1" => array(

    'status_glue' => '‒ ', // '‒ '

    'item_group_prefix' => ', ',

    'item_group_postfix' => ''

  ),

  "level_2" => array(

    'status_glue' => '‒ ', // '‒ '

    'item_group_prefix' => ' (',

    'item_group_postfix' => ')'

  )

)));

 * Constant for the drupal variable key distribution_map_visibility

 *

 * possible values:

 *  - never

 *  - automatic

 *  - always

 */

define('DISTRIBUTION_MAP_VISIBILITY', 'distribution_map_visibility');

define('DISTRIBUTION_MAP_VISIBILITY_DEFAULT', 'automatic');

/**

 * Constant for the drupal variable key specimen_map_visibility

 *

 * possible values:

 *  - never

 *  - automatic

 *  - always

 */

define('SPECIMEN_MAP_VISIBILITY', 'specimen_map_visibility');

define('SPECIMEN_MAP_VISIBILITY_DEFAULT', 'automatic');

define('CDM_TAXON_MEDIA_FILTER_DEFAULT', serialize(

    array(

        'includeTaxonDescriptions' => 'includeTaxonDescriptions',

        'includeOccurrences' => 0,

        'includeTaxonNameDescriptions' => 0

     )

  ));

define('CDM_MAP_DISTRIBUTION_DEFAULT', serialize(array(

  // needs to be merged with user setting by drupal_array_merge_deep()

  // 'height' => 512 / 2, // optimum size for OSM layers 256

  'aspect_ratio' => 2,

  'caption' => '',

  'distribution_opacity' => '0.5',

  'map_type' => 1, //  1 = 'openlayers', 0 = 'image'

  'image_map' => array(

    'base_layer' => '', // none, formerly this was cyprusdivs

    'bg_color' => '1874CD',

    'layer_style' => 'ffffff,606060,,',

  ),

  'openlayers' => array(

    'base_layers' =>  array(

      // A layer MUST NOT BE SET in the defaults,

      // otherwise it can not be overidden by the user settings:

      // since it will automatically be enabled:

      'name' => NULL,

      'url' => NULL,

      'params' =>  NULL,

      'projection' => NULL,

      'proj4js_def' => NULL,

      'max_extent' => NULL,

      'untiled' => FALSE

    ),

    'wms_overlay_layer' => array(

      'name' => NULL,

      'url' => NULL,

      'params' =>  NULL,

      'untiled' => FALSE

    'google_maps_api_key' => NULL,

  'legend' => array(

    'show' => TRUE,

    'opacity' => '0.5',

    'font_size' => 10,

    'font_style' => FALSE,

    'icon_width' => 35,

    'icon_height' => 15

  )

)));

/**

 * Merges the named array variable with the array of defaults.

 *

 * the merging will not take place for these entities. Number keyed entities

 *

 *     The variable name

 * @param string | array $default

 *     The array containing the default values either as array or serialized as string.

 * TODO force $default being an array

function get_array_variable_merged($variable_name, $default){

    // unserialize if nessecary

    if(!is_array($default)){

      $default = unserialize($default);

    }

    $variable = variable_get($variable_name, array());

    return $result;

 * @todo document this function.

 */

function getGallerySettings($gallery_config_form_name) {

/**

 * Returns the string representation of the default tab.

 *

 * @param bool $returnTabIndex

 *   Defaults to FALSE, if set true this function will return the index number

 *   of the default tab. (used to supply default values to form elements).

 */

function get_default_taxon_tab($returnTabIndex = FALSE) {

  global $user;

  $values = unserialize(CDM_DATAPORTAL_DEFAULT_TAXON_TAB);

  $user_tab_active = 'cdm_dataportal_' . $user->uid . '_default_tab_active';

  $user_tab = 'cdm_dataportal_' . $user->uid . '_default_tab';

  // Get the user value if the used has chosen to overwrite the system settings.

  $user_tab_on = variable_get($user_tab_active, FALSE);

  if ($user_tab_on) {

    $user_value = variable_get($user_tab, 0);

    $index_value = $user_value;

    // Get the system value.

  }

  else {

    $system_value = variable_get('cdm_dataportal_default_tab', 0);

    $index_value = $system_value;

  }

  // Return the index value or the string representation.

  if ($returnTabIndex) {

    return $index_value;

  }

  else {

    return ($values[$index_value]);

 * Provides the feature block settings for a specific feature which matches the $feature_uuid parameter.

 *

 * In case specifically configured settings array, like these which are stored in the drupal variables, is missing

 * one or more fields these fields are taken from the default. That is the specific settings are always merges

 * with the default.

 *

 * Note: These settings only apply to feature blocks which do not have a special rendering

 * the specially handled features (e.g.: Distribution, CommonNames) may make use of the

 * 'special' element of the settings

 *

 * @param $feature_uuid

 *   The uuid string representation of the feature to return the settings for

 *

 * @return array

 *  an associative array of settings, with the following fields:

 *    - as_list: string

 *        this setting will be used in compose_feature_block_wrap_elements() as $enclosing_tag

 *        possible values are:

 *          div: not as list,

 *          ul: as bullet list,

 *          ol: as numbered list,

 *          dl: as definition list

 *        The tag used for the inner element, thus depends on the value of this field. The

 *        inner tag name can be retrieved by the function cdm_feature_block_element_tag_name()

 *    - link_to_reference: boolean,

 *        render the reference as link, ignored if the element is NOT a DescriptionElementSource

 *    - link_to_name_used_in_source": boolean

 *        whether to show name in source information as link which will point to the according name page

 *    - sources_as_content (boolean)

 *        TRUE (int: 1):

 *          1. If element is of the CDM type TextData and the text is not empty the source references will be

 *             appended in brackets like "text (source references)". If the original source has name in source

 *             information it will be appended to the citation string,

 *             like : "(citation, as name in source; citation, as name in source)"

 *          2. if the text of the TextData is empty, the original source citations are the only content

 *             (e.g. use case CITATION) and are not put into brackets. In this case the nameInSource is

 *             prepended to the citation string like: "name in source: citation"

 *        FALSE (int: 0):

 *          Original sources are put into the bibliography(=references) pseudo feature block. If the original source

 *          citations are the only content, the resulting feature block content would only consist of footnotes.

 *          In this case the display of the respective feature block is suppressed.

 *          TODO if the bibliography is not enabled the sources will be treated as footnotes like annotations,

 *               in future however they will in this case be shown in a separate references section for each

 *               feature block.

 *    - sources_as_content_to_bibliography  (boolean)

 *        Only valid if sources_as_content == TRUE, will cause the sources to be also shown

 *        in the bibliography.

 *    - sort_elements

 *        whether and how to sort the elements

 *        possible values are the constants SORT_ASC, SORT_DESC, NULL,

 *        some feature types (Distribution) also support: SORT_HIERARCHICAL (

 *        TODO option to exclude levels, put in special?,

 *        TODO make use of this setting in compose_feature_block_wrap_elements())

 *    - element_tag

 *        specifies the tag to be used for creating the elements, only applies if "as_list" == 'div'

 *        possible values are span | div. the proper inner tag name can be retrieved by the function

 *        cdm_feature_block_element_tag_name()

 *    - special: array()

 *        an array with further settings, this field can be used for special

 *        settings for specialized rendering like for distributions

 *  }

 *

 */

function get_feature_block_settings($feature_uuid = 'DEFAULT') {

  // the default must conform to the default parameter values of

  // compose_feature_block_wrap_elements() : $glue = '', $sort = FALSE, $enclosing_tag = 'ul'

  // compose_description_element_text_data() : asListElement = NULL

  // ---- DEFAULTS settings

  // only needed as final option, when the settings are not having a default

  $default = array(

    'DEFAULT' => array(

      'as_list' => 'div',

      'link_to_reference' => 0,

      'link_to_name_used_in_source' => 1,

      'sources_as_content' => 0,

      'sources_as_content_to_bibliography' => 0,

      'sort_elements' => NO_SORT,

      'glue' => '',

      'element_tag' => NULL

    ),

    // settings for pseudo feature bibliography

    // only hard coded here

    'BIBLIOGRAPHY' => array(

      'as_list' => 'div',

      'link_to_reference' => 0,

      'link_to_name_used_in_source' => 1,

      'sources_as_content' => 0,

      'sources_as_content_to_bibliography' => 0,

      'sort_elements' => NO_SORT,

      'glue' => '',

      'element_tag' => NULL

    )

  );

  $other_themes_default = array(

    'DEFAULT' => array(

      'as_list' => 'div',

      'link_to_reference' => 0,

      'link_to_name_used_in_source' => 1,

      'sources_as_content' => 0,

      'sources_as_content_to_bibliography' => 0,

      'sort_elements' => NO_SORT,

      'glue' => '',

      'element_tag' => NULL

    ),

    UUID_CITATION => array(

      'as_list' => 'div',

      'link_to_reference' => 0,

      'link_to_name_used_in_source' => 0,