openlayers_ui.admin.inc in Openlayers 7.2

This file holds the functions for the main openlayers Admin settings.

File

modules/openlayers_ui/includes/openlayers_ui.admin.inc

<?php

/**
 * @file
 * This file holds the functions for the main openlayers Admin settings.
 *
 * @ingroup openlayers
 */

/**
 * Menu callback; displays the openlayers module settings page.
 *
 * @see system_settings_form()
 */
function openlayers_ui_admin_settings() {
  $client_check = variable_get('openlayers_ui_version_check', 'no-check');
  $source_description = t('<p>By default your site will point to a CDN-backed version of the
      OpenLayers library at %ol_api_url.</p>
      <p>If desired, you can use an internal version of the library.
      <a href="!ol_url">Download the OpenLayers library</a>, and add it to your Drupal installation.
      Use the new drush command \'<em>dl-openlayers</em>\' to download it and place it at the right place automatically.
      If you download the library manually, then place it in the <em>libraries/openlayers</em> folder and new options will appear under <em>OpenLayers source type</em> on this page.
      You can also use a double backslash before the domain name
      (eg. //www.example.com/OpenLayers.js) which then respects the use of both HTTPS and HTTP protocols.</p>
      <ul>
        <li>The default suggested, compatible version: <strong>%suggested_api</strong></li>
        <li>The default suggested, compatible CDN-hosted URL: <strong>%ol_api_url</strong></li>
        <li>Your version found from client-side, Javascript check: <strong>%client</strong></li>
      </ul>', array(
    '%ol_api_url' => OPENLAYERS_DEFAULT_LIBRARY,
    '%suggested_api' => OPENLAYERS_SUGGESTED_LIBRARY,
    '!ol_url' => 'http://openlayers.org/',
    '%client' => $client_check == 'no-check' ? t('(not checked)') : $client_check,
  ));
  $options = array(
    'external' => 'External',
  );
  if (module_exists('libraries') && ($library = libraries_detect('openlayers')) && !empty($library['installed'])) {
    $options += array(
      'internal' => 'Internal',
    );
  }
  $form['openlayers_source_type'] = array(
    '#type' => 'radios',
    '#options' => $options,
    '#title' => t('OpenLayers source type'),
    '#description' => t('
      <ul>
        <li>Select internal to load the OpenLayers library from your drupal installation.
          <br/>You can use the drush command <em>dl-openlayers</em> to download the library and place it at the right place automatically.</li>
        <li>Select external to load it from <a href="http://cdnjs.cloudflare.com">cdnjs.cloudflare.com</a>, a free public CDN.</li>
      </ul>
      <p>You should use the <a href="!libraries">libraries module</a> to enable the internal loading of the library.</p>
      ', array(
      '!libraries' => 'http://drupal.org/project/libraries',
    )),
    '#default_value' => variable_get('openlayers_source_type', 'external'),
  );
  $form['openlayers_source_external'] = array(
    '#type' => 'textfield',
    '#title' => t('OpenLayers external source'),
    '#description' => $source_description,
    '#default_value' => variable_get('openlayers_source_external', OPENLAYERS_DEFAULT_LIBRARY),
    '#states' => array(
      'visible' => array(
        ':input[name="openlayers_source_type"]' => array(
          'value' => 'external',
        ),
      ),
    ),
  );
  $library = libraries_info('openlayers');
  $variants = array(
    'original' => 'original',
  ) + $library['variants'];
  $form['openlayers_source_internal_variant'] = array(
    '#type' => 'radios',
    '#options' => array_combine(array_keys($variants), array_map('ucfirst', array_keys($variants))),
    '#title' => t('OpenLayers internal source variant'),
    '#description' => t('The OpenLayers library (<em>version >= 2.12</em>) has different variants. Select the one you prefer for your installation. <b>Warning: OpenLayers is design to only work for original variants.</b> Hopefully more variants will be supported soon.'),
    '#default_value' => variable_get('openlayers_source_internal_variant', 'original'),
    '#states' => array(
      'visible' => array(
        ':input[name="openlayers_source_type"]' => array(
          'value' => 'internal',
        ),
      ),
    ),
  );
  $form['openlayers_default_map'] = array(
    '#type' => 'select',
    '#title' => t('OpenLayers Default Map'),
    '#description' => t('This is the default map that will be used
      in cases where one is not defined.  It will also be used as
      the default when creating new maps.'),
    '#options' => openlayers_map_options(),
    '#default_value' => variable_get('openlayers_default_map', 'default'),
  );
  $form['openlayers_ui_preview_map'] = array(
    '#type' => 'checkbox',
    '#title' => t('Preview Map'),
    '#description' => t('Turning this on will show you a map preview when editing it through the !link.', array(
      '!link' => l(t('Map Interface'), 'admin/structure/openlayers/maps'),
    )),
    '#default_value' => variable_get('openlayers_ui_preview_map', FALSE),
  );

  // A hidden value to reset client check
  $form['openlayers_ui_version_check'] = array(
    '#type' => 'hidden',
    '#value' => '',
  );

  // Make a system setting form and return
  return system_settings_form($form);
}

/**
 * Settings form validation
 *
 * @param $form
 * @param $form_state
 */
function openlayers_ui_admin_settings_validate($form, &$form_state) {
  if ($form_state['values']['openlayers_source_type'] == 'external') {
    $url = $form_state['values']['openlayers_source_external'];

    // If protocol neutral, fake a URL that will pass valid_url() and
    // url_is_external().
    if (strpos($url, '//') === 0) {
      $url = 'http:' . $url;
    }
    if (!valid_url($url, TRUE) && !url_is_external($url)) {
      form_set_error('openlayers_source_external', 'The source must be a valid external URL, beginning with http(s).');
    }
  }
}

/**
 * Callback endpoint for sending in OL version from client JS.
 */
function openlayers_ui_version_check($version = 0) {
  $version = check_plain($version);

  // Set variable with version for hook_requirements
  // and so we dont do this on every page load.
  variable_set('openlayers_ui_version_check', $version);

  // Do a basic check
  if (strpos($version, (string) OPENLAYERS_SUGGESTED_LIBRARY) !== FALSE) {
    $status = 'valid';
    $message = t('Valid library found with a Javascript client check; version: %version', array(
      '%version' => $version,
    ));
  }
  else {
    $status = 'invalid';
    $message = t('Could not find a valid library with a Javascript client-side check;  Value found: %version.  Please visit the !settings for more details.', array(
      '%version' => $version,
      '!settings' => l(t('OpenLayers settings page'), 'admin/structure/openlayers'),
    ));
  }

  // Kind of a hack, but since we are using messages for this, let's clear the
  // messages queue out.
  $messages = drupal_get_messages();

  // We just want to send some markup back.
  drupal_json_output(array(
    'status' => $status,
    'response' => $message,
  ));
}

Related topics

OpenLayers provides an API and

Modules to interface with OpenLayers

Functions

Name	Description
openlayers_ui_admin_settings	Menu callback; displays the openlayers module settings page.
openlayers_ui_admin_settings_validate	Settings form validation
openlayers_ui_version_check	Callback endpoint for sending in OL version from client JS.