EDIT

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

function cdm_distribution_filter_query(){

  $cdm_distribution_filter = get_array_variable_merged(CDM_DISTRIBUTION_FILTER, CDM_DISTRIBUTION_FILTER_DEFAULT);

  $query = array();

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

    $query['statusOrderPreference'] = 1;

  }

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

    $query['subAreaPreference'] = 1;

  }

  if(is_array($cdm_distribution_filter['hideMarkedAreas']) && count($cdm_distribution_filter['hideMarkedAreas']) > 0){

    $query['hideMarkedAreas'] = '';

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

      if($enabled){

        $query['hideMarkedAreas'] .= ($query['hideMarkedAreas'] ? ',' : '') . $marker_type;

      }

  }

  return $query;

}

}

/**

 * Composes the render array for a distribution map of the given taxon.

 *

 * The distribution map can either be a plain image or a dynamic open layers map

 * depending on the settings.

 *

 * compose_hook() implementation

 *

 * @param $taxon

 *   The CDM Taxon instance to create the distribution map for.

 * @return array

 *    A drupal render array

 *

 * Similar compose function compose_map()

 *

 * @ingroup compose

 */

function compose_distribution_map($taxon) {

  $out = '';

  $settings = get_edit_map_service_settings();

  $fontStyles = array(

      0 => "plane",

      1 => "italic",

  );

  // Query cdm server for map service uri parameters.

  $query_string = cdm_ws_get(CDM_WS_GEOSERVICE_DISTRIBUTIONMAP, $taxon->uuid, queryString(cdm_distribution_filter_query()));

  $query_string = $query_string->String;

  $out .= "<!-- map_data_parameters:" . print_r($query_string, TRUE) . " -->";

  if (!$query_string) {

    // The $query_string is empty if there are no distribution areas defined.

    return;

  }

  /* ------ choose the display mode, either openlayers or static image ------ */

  $map_settings = get_array_variable_merged(CDM_MAP_DISTRIBUTION, CDM_MAP_DISTRIBUTION_DEFAULT);

  if ($map_settings['map_type'] == 1) {

    /* =========== display distributions using the openlayers map viewer =========== */

    $legendFormatQueryStr = "format=image" . urlencode('/') . "png"

        . "&TRANSPARENT=TRUE"

            . "&WIDTH=" . $map_settings['legend']['icon_width']

            . "&HEIGHT=" . $map_settings['legend']['icon_height']

            // TODO why is the layer=topp:tdwg_level_4 parameter needed at all here??

    // AK: i think the tdwg_level_4 is used as place holder and will be replaced later on

    // => search for "tdwg_level_4" in the code

    . "&layer=topp" . urlencode(':') . "tdwg_level_4"

        . "&LEGEND_OPTIONS=forceLabels" . urlencode(':') . "on"

            . ";fontStyle" . urlencode(':') . $fontStyles[$map_settings['legend']['font_style']]

            . ";fontSize" . urlencode(':') .  $map_settings['legend']['font_size']

            . "&SLD=";

    $out .= get_openlayers_map(

        $map_settings['width'],

        $map_settings['height'],

        $map_settings['bbox'],

        NULL,

        $query_string,

        $legendFormatQueryStr,

        $map_settings['caption']

    );

  }

  else {

    $legendFormatQueryStr = '';

    $out = get_image_map(

        $map_settings['width'],

        $map_settings['height'],

        $map_settings['bbox'],

        NULL,

        $query_string,

        $legendFormatQueryStr,

        $map_settings['caption']

    );

  }

  return markup_to_render_array($out);

}

define('CDM_DISTRIBUTION_FILTER', 'cdm_distribution_filter');

define('CDM_DISTRIBUTION_FILTER_DEFAULT', serialize(

      array(

      'filter_rules' => array(

        'statusOrderPreference' => 0,

        'subAreaPreference' => 0,

      ),

      'hideMarkedAreas' => array()

     )

));

  $form['distribution'] = array(

      '#type' => 'fieldset',

      '#title' => t('Distributions'),

      '#collapsible' => FALSE,

      '#description' => 'This section covers general settings regarding distributions, map related settings are found in the '

          . l('geo & map tab', 'admin/config/cdm_dataportal/settings/geo') .

          '<p>

          </p>',

  );

  $form['distribution'][CDM_DISTRIBUTION_FILTER] = array(

      '#type' => 'fieldset',

      '#title' => 'Distribution filter',

      '#collapsible' => FALSE,

      '#collapsed' => FALSE,

      '#tree' => TRUE,

      '#description' => 'The Distribution filter offers the following options

      <ul>

      <li><strong>Status order preference rule:</strong> In case of multiple distribution status (PresenceAbsenceTermBase) for the same area the status with the highest order is preferred, see OrderedTermBase.compareTo(OrderedTermBase).</li>

      <li><strong>Sub area preference rule:</strong>If there is an area with a direct sub area and both areas have the same computed status only the information on the sub area should be reported, whereas the super area should be ignored.</li>

      <li><strong>Marked area filter:</strong>Skip distributions where the area has a Marker with one of the specified MarkerTypes</li>

      </ul>'

  );

  $cdm_distribution_filter = get_array_variable_merged(CDM_DISTRIBUTION_FILTER, CDM_DISTRIBUTION_FILTER_DEFAULT);

  $form['distribution'][CDM_DISTRIBUTION_FILTER]['filter_rules'] = array(

      '#type' => 'checkboxes',

      '#title' => 'Filter rules',

      '#default_value' => $cdm_distribution_filter['filter_rules'],

      '#options' => array(

          'statusOrderPreference' => 'Status order preference rule',

          'subAreaPreference' => 'Sub area preference rule'

      ),

  );

  $marker_type_options = cdm_terms_as_options( cdm_ws_fetch_all('term', array('class' => 'MarkerType' )) );

  $form['distribution'][CDM_DISTRIBUTION_FILTER]['hideMarkedAreas'] = array(

      '#type' => 'checkboxes',

      '#title' => 'Hide marked area filter',

      '#default_value' => $cdm_distribution_filter['hideMarkedAreas'],

      '#options' => $marker_type_options,

      '#description' => 'Check one or more MarkerTypes to define the "hide marked area" filter .',

  );

      '#description' => 'This section covers the different aspects of aggregating information.

          </p>',

          // FIXME cdm_description_elements_prefer_computed() is deprecated and must be replaced by a REST service call wich will retrieve all distribution elements

  $request_params = cdm_distribution_filter_query();