styled_google_map.module in Styled Google Map 8.2

Contains all hooks and functions for the Styled Google Map module.

File

styled_google_map.module

<?php

/**
 * @file
 * Contains all hooks and functions for the Styled Google Map module.
 */
use Drupal\Component\Utility\UrlHelper;
use Drupal\Component\Utility\Xss;
use Drupal\Core\Entity\Entity\EntityViewDisplay;
use Drupal\Core\Entity\EntityInterface;
use Drupal\styled_google_map\StyledGoogleMapInterface;

/**
 * Implements hook_theme().
 */
function styled_google_map_theme() {
  $themes['styled_google_map'] = [
    'variables' => [
      'location' => NULL,
      'settings' => [],
      'entity' => NULL,
      'gid' => NULL,
      'directions_form' => NULL,
      'steps' => FALSE,
    ],
  ];
  $themes['styled_google_map_directions'] = [
    'variables' => [
      'settings' => [
        'enabled' => FALSE,
        'type' => 'DRIVING',
        'steps' => FALSE,
      ],
      'id' => '',
    ],
  ];
  return $themes;
}

/**
 * Implements hook_preprocess_HOOK().
 */
function styled_google_map_preprocess_styled_google_map(&$variables) {
  $language = \Drupal::languageManager()
    ->getCurrentLanguage();
  $location =& $variables['location'];

  /** @var \Drupal\Core\Entity\FieldableEntityInterface|\Drupal\Core\Entity\TranslatableInterface $entity */
  $entity =& $variables['entity'];
  $settings =& $variables['settings'];
  if (empty($location) || !$location['geohash']) {
    $location = NULL;
    return;
  }

  // Get the pin file url.
  if (isset($settings['style']['pin']) && !empty($settings['style']['pin'])) {
    $settings['style']['pin'] = file_create_url($settings['style']['pin']);
  }

  // Sanitize the output of the style settings.
  foreach ($settings['style'] as $id => $setting) {
    if ($id != 'style') {
      $location[$id] = Xss::filter($settings['style'][$id]);
    }
  }

  // Get the label settings.
  if ($entity instanceof EntityInterface) {
    switch ($settings['popup']['choice']) {

      // Create popup from field.
      case 1:
        if ($settings['popup']['text'] == 'label') {
          $popup_field = [
            '#markup' => $entity
              ->label(),
          ];
        }
        else {
          $settings['popup']['label'] = $settings['popup']['label'] ? 'inline' : 'hidden';
          $popup_field = $entity->{$settings['popup']['text']}
            ->view([
            'label' => $settings['popup']['label'],
          ], $language
            ->getId());
        }
        break;

      // Create popup from view mode.
      case 2:
        $display = EntityViewDisplay::collectRenderDisplay($entity, $settings['popup']['view_mode']);
        $popup_field = $display
          ->build($entity);
        break;

      // Default to empty.
      default:
        $popup_field = [];
    }
    $location['popup'] = render($popup_field);
  }
  else {

    // Not an entity object.
    $location['popup'] = [];
  }
  if ($settings['map_center']['center_coordinates'] && $entity
    ->hasField($settings['map_center']['center_coordinates'])) {
    if ($entity
      ->hasTranslation($language
      ->getId())) {
      $map_center = $entity
        ->getTranslation($language
        ->getId())
        ->get($settings['map_center']['center_coordinates'])
        ->getValue();
    }
    else {
      $map_center = $entity
        ->get($settings['map_center']['center_coordinates'])
        ->getValue();
    }
    if ($map_center && isset($map_center[0]['lat'], $map_center[0]['lon'])) {
      $settings['map_center']['center_coordinates'] = $map_center[0];
    }
    else {
      $settings['map_center']['center_coordinates'] = FALSE;
    }
  }
  else {
    $settings['map_center']['center_coordinates'] = FALSE;
  }

  // Add map settings and required libraries.
  $gid = $variables['gid'];

  // Include the Google Maps API and map location settings.
  $map_settings['locations'] = [
    $location,
  ];

  // Include the custom map settings.
  $map_settings['settings'] = $settings;

  // Include the unique div id.
  $map_settings['id'] = 'styled-google-map-' . $gid;
  $variables['#attached']['drupalSettings']['styled_google_map'] = [
    $gid => $gid,
  ];
  $variables['#attached']['drupalSettings']['maps'] = [
    'id' . $gid => $map_settings,
  ];
  if (!empty($settings['directions']['enabled'])) {
    if (!empty($settings['directions']['steps'])) {
      $variables['steps'] = TRUE;
    }
    $variables['directions_form'] = [
      '#theme' => 'styled_google_map_directions',
      '#settings' => $settings['directions'],
      '#id' => $gid,
    ];
    $variables['#attached']['library'][] = 'styled_google_map/geolocation-marker';
    if (\Drupal::service('library.discovery')
      ->getLibraryByName('core', 'drupal.message')) {
      $variables['#attached']['library'][] = 'core/drupal.message';
    }
  }

  // Attach the Styled Google Map javascript file.
  $variables['#attached']['library'][] = 'styled_google_map/styled-google-map';
}

/**
 * Implements hook_library_info_alter().
 */
function styled_google_map_library_info_alter(&$libraries, $extension) {
  if ($extension == 'styled_google_map' && isset($libraries['styled-google-map'])) {
    if (!empty($libraries['styled-google-map']['js']['//maps.google.com/maps/api/js'])) {
      $options = $libraries['styled-google-map']['js']['//maps.google.com/maps/api/js'];
      unset($libraries['styled-google-map']['js']['//maps.google.com/maps/api/js']);
      $api_url = styled_google_map_build_api_url();
      $libraries['styled-google-map']['js']['//maps.google.com/maps/api/js' . $api_url] = $options;
    }
  }
}

/**
 * Create url addition for Google Maps library.
 *
 * @param array $libraries
 *   Any libraries that should be loaded with API.
 *
 * @return string
 *   The url of the API for maps library.
 */
function styled_google_map_build_api_url(array $libraries = []) {
  $api_url = '';
  $config = \Drupal::config('styled_google_map.settings');
  switch ($config
    ->get('styled_google_map_google_auth_method')) {
    case StyledGoogleMapInterface::STYLED_GOOGLE_MAP_GOOGLE_AUTH_KEY:
      $key = $config
        ->get('styled_google_map_google_apikey');
      if ($key) {
        $query['key'] = $key;
      }
      break;
    case StyledGoogleMapInterface::STYLED_GOOGLE_MAP_GOOGLE_AUTH_WORK:
      $client_id = $config
        ->get('styled_google_map_google_client_id');
      if ($client_id) {
        $query['client'] = $client_id;
      }
      break;
  }
  $libraries = [
    'visualization',
  ];
  $additional_libraries = $config
    ->get('styled_google_map_libraries');
  foreach ($additional_libraries as $additional_library => $enabled) {
    if ($enabled) {
      $libraries[] = $additional_library;
    }
  }
  if (!empty($libraries)) {
    $query['libraries'] = implode(",", $libraries);
  }

  // Add query params to API url.
  if (!empty($query)) {
    $api_url .= '?' . UrlHelper::buildQuery($query);
  }
  return $api_url;
}

/**
 * Implements hook_modules_uninstalled().
 */
function styled_google_map_modules_uninstalled($modules) {

  // Uninstall demo module when data module is disabled because demo is hidden.
  if (in_array('styled_google_map_data', $modules)) {
    \Drupal::service('module_installer')
      ->uninstall([
      'styled_google_map_demo',
    ]);
  }
}

Functions

Name	Description
styled_google_map_build_api_url	Create url addition for Google Maps library.
styled_google_map_library_info_alter	Implements hook_library_info_alter().
styled_google_map_modules_uninstalled	Implements hook_modules_uninstalled().
styled_google_map_preprocess_styled_google_map	Implements hook_preprocess_HOOK().
styled_google_map_theme	Implements hook_theme().