public function StyledGoogleMapDefaultFormatter::settingsForm in Styled Google Map 8.2

Same name and namespace in other branches

1. 8 src/Plugin/Field/FieldFormatter/StyledGoogleMapDefaultFormatter.php \Drupal\styled_google_map\Plugin\Field\FieldFormatter\StyledGoogleMapDefaultFormatter::settingsForm()

Returns a form to configure settings for the formatter.

Invoked from \Drupal\field_ui\Form\EntityDisplayFormBase to allow administrators to configure the formatter. The field_ui module takes care of handling submitted form values.

Parameters

array $form: The form where the settings form is being included in.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form elements for the formatter settings.

Overrides FormatterBase::settingsForm

File

src/Plugin/Field/FieldFormatter/StyledGoogleMapDefaultFormatter.php, line 101

Class

StyledGoogleMapDefaultFormatter

Plugin implementation of the 'styled_google_map_default' formatter.

Namespace

Drupal\styled_google_map\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $elements = parent::settingsForm($form, $form_state);
  $default_settings = StyledGoogleMapDefaultFormatter::defaultSettings();

  // Set all available setting fields for the Styled Google Map.
  $elements['width'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Width size'),
    '#default_value' => $this
      ->getSetting('width'),
    '#description' => $this
      ->t('Map width written in pixels or percentage'),
    '#required' => TRUE,
  ];
  $elements['height'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Height size'),
    '#default_value' => $this
      ->getSetting('height'),
    '#description' => $this
      ->t('Map height written in pixels or percentage'),
    '#required' => TRUE,
  ];
  $elements['gestureHandling'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Gesture handling'),
    '#description' => $this
      ->t('This setting controls how the API handles gestures on the map. See more <a href="@href">here</a>', [
      '@href' => 'https://developers.google.com/maps/documentation/javascript/reference/map#MapOptions.gestureHandling',
    ]),
    '#options' => [
      'cooperative' => $this
        ->t('Scroll events with a ctrl key or ⌘ key pressed zoom the map.'),
      'greedy' => $this
        ->t('All touch gestures and scroll events pan or zoom the map.'),
      'none' => $this
        ->t('The map cannot be panned or zoomed by user gestures.'),
      'auto' => $this
        ->t('(default) Gesture handling is either cooperative or greedy'),
    ],
    '#default_value' => $this
      ->getSetting('gestureHandling'),
  ];
  $elements['style'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Map style'),
  ];
  $style_settings = $this
    ->getSetting('style');
  $elements['style']['maptype'] = [
    '#type' => 'select',
    '#options' => [
      'ROADMAP' => $this
        ->t('ROADMAP'),
      'SATELLITE' => $this
        ->t('SATELLITE'),
      'HYBRID' => $this
        ->t('HYBRID'),
      'TERRAIN' => $this
        ->t('TERRAIN'),
    ],
    '#title' => $this
      ->t('Map type'),
    '#default_value' => empty($style_settings['maptype']) ? $default_settings['style']['maptype'] : $style_settings['maptype'],
    '#required' => TRUE,
  ];
  $elements['style']['style'] = [
    '#type' => 'textarea',
    '#title' => $this
      ->t('JSON Style'),
    '#default_value' => empty($style_settings['style']) ? $default_settings['style']['style'] : $style_settings['style'],
    '#description' => $this
      ->t('Check out @url for custom styles. Also check out this @project to style and edit Google Map JSON styles.', [
      '@url' => Link::fromTextAndUrl($this
        ->t('Snazzy maps'), Url::fromUri('http://snazzymaps.com/'))
        ->toString(),
      '@project' => Link::fromTextAndUrl($this
        ->t('Github page'), Url::fromUri('http://instrument.github.io/styled-maps-wizard/'))
        ->toString(),
    ]),
  ];
  $elements['style']['pin'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('URL to the marker'),
    '#default_value' => empty($style_settings['pin']) ? $default_settings['style']['pin'] : $style_settings['pin'],
    '#description' => $this
      ->t('URL to the marker image. You can use a @wrapper for the url. Ex. @example (not working until @fixed)', [
      '@wrapper' => Link::fromTextAndUrl($this
        ->t('Stream wrapper'), Url::fromUri('https://drupal.org/project/system_stream_wrapper'))
        ->toString(),
      '@example' => StyledGoogleMapInterface::STYLED_GOOGLE_MAP_DEFAULT_PIN,
      '@fixed' => Link::fromTextAndUrl('https://www.drupal.org/node/1308152', Url::fromUri('https://www.drupal.org/node/1308152'))
        ->toString(),
    ]),
  ];
  $elements['style']['pin_width'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Pin width'),
    '#default_value' => empty($style_settings['pin_width']) ? '' : $style_settings['pin_width'],
    '#description' => $this
      ->t('If you want to scale the pin to certain dimensions. If you set width, height is also required'),
  ];
  $elements['style']['pin_height'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Pin height'),
    '#default_value' => empty($style_settings['pin_height']) ? '' : $style_settings['pin_height'],
    '#description' => $this
      ->t('If you want to scale the pin to certain dimensions. If you set height, width is also required'),
  ];
  $map_center_settings = $this
    ->getSetting('map_center');
  $elements['map_center'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Centering map'),
  ];

  // Retrieve all field names from the current entity bundle.
  $field_options = [
    'label' => $this
      ->t('Entity label'),
  ];
  $center_options = [
    '' => $this
      ->t('Center automatically'),
  ];
  $fields = $form['#fields'];
  foreach ($fields as $field) {
    $config = FieldConfig::loadByName($form['#entity_type'], $form['#bundle'], $field);
    if (!$config) {
      continue;
    }
    $type = $config
      ->get('field_type');
    $name = $config
      ->get('field_name');
    $field_options[$field] = $config
      ->getLabel();
    if ($type == 'geofield' && $this->fieldDefinition
      ->getName() != $name) {
      $center_options[$field] = $config
        ->getLabel();
    }
  }
  $elements['map_center']['center_coordinates'] = [
    '#type' => 'select',
    '#options' => $center_options,
    '#default_value' => empty($map_center_settings['center_coordinates']) ? $default_settings['map_center']['center_coordinates'] : $map_center_settings['center_coordinates'],
    '#description' => $this
      ->t('To have map centered on other point than location you need to have another GeoField in your content type structure'),
  ];
  $elements['popup'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Marker popup'),
  ];
  $popup_settings = $this
    ->getSetting('popup');
  $elements['popup']['choice'] = [
    '#title' => $this
      ->t('How to render popup'),
    '#type' => 'select',
    '#options' => [
      0 => $this
        ->t('No need'),
      1 => $this
        ->t('From Field'),
      2 => $this
        ->t('From View mode'),
    ],
    '#default_value' => empty($popup_settings['choice']) ? $default_settings['popup']['choice'] : $popup_settings['choice'],
    '#id' => 'edit-popup-choice-field',
  ];

  // Retrieve view mode settings from the current entity bundle.
  $view_modes = \Drupal::service('entity_display.repository')
    ->getViewModeOptions($form['#entity_type']);
  $elements['popup']['view_mode'] = [
    '#title' => $this
      ->t('Select the view mode'),
    '#type' => 'select',
    '#options' => $view_modes,
    '#default_value' => empty($popup_settings['view_mode']) ? $default_settings['popup']['view_mode'] : $popup_settings['view_mode'],
    '#states' => [
      'visible' => [
        ':input[id="edit-popup-choice-field"]' => [
          'value' => 2,
        ],
      ],
    ],
  ];
  $elements['popup']['text'] = [
    '#title' => $this
      ->t('Select field'),
    '#type' => 'select',
    '#options' => $field_options,
    '#default_value' => empty($popup_settings['text']) ? $default_settings['popup']['text'] : $popup_settings['text'],
    '#states' => [
      'visible' => [
        ':input[id="edit-popup-choice-field"]' => [
          'value' => 1,
        ],
      ],
    ],
  ];
  $elements['popup']['label'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Show field label'),
    '#default_value' => empty($popup_settings['label']) ? $default_settings['popup']['label'] : $popup_settings['label'],
    '#states' => [
      'visible' => [
        ':input[id="edit-popup-choice-field"]' => [
          'value' => 1,
        ],
      ],
    ],
  ];
  $elements['popup']['default_state'] = [
    '#title' => $this
      ->t('Popup default state'),
    '#type' => 'select',
    '#options' => [
      '0' => $this
        ->t('Closed'),
      '1' => $this
        ->t('Opened'),
    ],
    '#default_value' => empty($popup_settings['default_state']) ? $default_settings['popup']['default_state'] : $popup_settings['default_state'],
    '#states' => [
      'visible' => [
        ':input[id="edit-popup-choice-field"]' => [
          '!value' => 0,
        ],
      ],
    ],
  ];
  $elements['popup']['second_click'] = [
    '#title' => $this
      ->t('Close popup on second mouse click'),
    '#type' => 'select',
    '#options' => [
      '0' => $this
        ->t('No'),
      '1' => $this
        ->t('Yes'),
    ],
    '#default_value' => !isset($popup_settings['second_click']) ? $default_settings['popup']['second_click'] : $popup_settings['second_click'],
    '#states' => [
      'visible' => [
        ':input[id="edit-popup-choice-field"]' => [
          '!value' => 0,
        ],
      ],
    ],
  ];
  $elements['popup']['close_button_source'] = [
    '#title' => $this
      ->t('Popup close button image'),
    '#type' => 'textfield',
    '#default_value' => empty($popup_settings['close_button_source']) ? $default_settings['popup']['close_button_source'] : $popup_settings['close_button_source'],
    '#states' => [
      'visible' => [
        ':input[id="edit-popup-choice-field"]' => [
          '!value' => 0,
        ],
      ],
    ],
  ];
  $elements['popup']['open_event'] = [
    '#type' => 'select',
    '#options' => [
      'click' => $this
        ->t('On click'),
      'mouseover' => $this
        ->t('On hover'),
    ],
    '#title' => $this
      ->t('Mouse event for opening popup'),
    '#default_value' => empty($popup_settings['open_event']) ? $default_settings['popup']['open_event'] : $popup_settings['open_event'],
  ];
  $elements['popup']['shadow_style'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Shadow style'),
    '#options' => [
      0,
      1,
      2,
    ],
    '#description' => $this
      ->t('1: shadow behind, 2: shadow below, 0: no shadow'),
    '#default_value' => empty($popup_settings['shadow_style']) ? $default_settings['popup']['shadow_style'] : $popup_settings['shadow_style'],
  ];
  $elements['popup']['padding'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Padding'),
    '#field_suffix' => 'px',
    '#default_value' => empty($popup_settings['padding']) ? $default_settings['popup']['padding'] : $popup_settings['padding'],
  ];
  $elements['popup']['border_radius'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Border radius'),
    '#field_suffix' => 'px',
    '#default_value' => empty($popup_settings['border_radius']) ? $default_settings['popup']['border_radius'] : $popup_settings['border_radius'],
  ];
  $elements['popup']['border_width'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Border width'),
    '#field_suffix' => 'px',
    '#default_value' => empty($popup_settings['border_width']) ? $default_settings['popup']['border_width'] : $popup_settings['border_width'],
  ];
  $elements['popup']['border_color'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Border color'),
    '#field_suffix' => '#hex',
    '#default_value' => empty($popup_settings['border_color']) ? $default_settings['popup']['border_color'] : $popup_settings['border_color'],
  ];
  $elements['popup']['background_color'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Background color'),
    '#field_suffix' => '#hex',
    '#default_value' => empty($popup_settings['background_color']) ? $default_settings['popup']['background_color'] : $popup_settings['background_color'],
  ];
  $elements['popup']['min_width'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Min width'),
    '#field_suffix' => 'px (or auto)',
    '#default_value' => empty($popup_settings['min_width']) ? $default_settings['popup']['min_width'] : $popup_settings['min_width'],
  ];
  $elements['popup']['max_width'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Max width'),
    '#field_suffix' => 'px (or auto)',
    '#default_value' => empty($popup_settings['max_width']) ? $default_settings['popup']['max_width'] : $popup_settings['max_width'],
  ];
  $elements['popup']['min_height'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Min height'),
    '#field_suffix' => 'px (or auto)',
    '#default_value' => empty($popup_settings['min_height']) ? $default_settings['popup']['min_height'] : $popup_settings['min_height'],
  ];
  $elements['popup']['max_height'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Max height'),
    '#field_suffix' => 'px (or auto)',
    '#default_value' => empty($popup_settings['max_height']) ? $default_settings['popup']['max_height'] : $popup_settings['max_height'],
  ];
  $elements['popup']['arrow_style'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Arrow style'),
    '#options' => [
      0,
      1,
      2,
    ],
    '#description' => $this
      ->t('1: left side visible, 2: right side visible, 0: both sides visible'),
    '#default_value' => empty($popup_settings['arrow_style']) ? $default_settings['popup']['arrow_style'] : $popup_settings['arrow_style'],
  ];
  $elements['popup']['arrow_size'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Arrow size'),
    '#field_suffix' => 'px',
    '#default_value' => empty($popup_settings['arrow_size']) ? $default_settings['popup']['arrow_size'] : $popup_settings['arrow_size'],
  ];
  $elements['popup']['arrow_position'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Arrow position'),
    '#field_suffix' => 'px',
    '#default_value' => empty($popup_settings['arrow_position']) ? $default_settings['popup']['arrow_position'] : $popup_settings['arrow_position'],
  ];
  $elements['popup']['disable_autopan'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Auto pan'),
    '#options' => [
      TRUE => $this
        ->t('Yes'),
      FALSE => $this
        ->t('No'),
    ],
    '#description' => $this
      ->t('Automatically center the pin on click'),
    '#default_value' => empty($popup_settings['disable_autopan']) ? $default_settings['popup']['disable_autopan'] : $popup_settings['disable_autopan'],
  ];
  $elements['popup']['hide_close_button'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Hide close button'),
    '#options' => [
      TRUE => $this
        ->t('Yes'),
      FALSE => $this
        ->t('No'),
    ],
    '#description' => $this
      ->t('Hide the popup close button'),
    '#default_value' => empty($popup_settings['hide_close_button']) ? $default_settings['popup']['hide_close_button'] : $popup_settings['hide_close_button'],
  ];
  $elements['popup']['disable_animation'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Disable animation'),
    '#options' => [
      TRUE => $this
        ->t('Yes'),
      FALSE => $this
        ->t('No'),
    ],
    '#description' => $this
      ->t('Disables the popup animation'),
    '#default_value' => empty($popup_settings['disable_animation']) ? $default_settings['popup']['disable_animation'] : $popup_settings['disable_animation'],
  ];
  $popup_classes_settings = !empty($popup_settings['classes']) ? $popup_settings['classes'] : $default_settings['popup']['classes'];
  $elements['popup']['classes']['content_container'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Wrapper class'),
    '#default_value' => empty($popup_classes_settings['content_container']) ? $default_settings['popup']['classes']['content_container'] : $popup_classes_settings['content_container'],
  ];
  $elements['popup']['classes']['background'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Background class'),
    '#default_value' => empty($popup_classes_settings['background']) ? $default_settings['popup']['classes']['background'] : $popup_classes_settings['background'],
  ];
  $elements['popup']['classes']['arrow'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Arrow class'),
    '#default_value' => empty($popup_classes_settings['arrow']) ? $default_settings['popup']['classes']['arrow'] : $popup_classes_settings['arrow'],
  ];
  $elements['popup']['classes']['arrow_outer'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Arrow outer class'),
    '#default_value' => empty($popup_classes_settings['arrow_outer']) ? $default_settings['popup']['classes']['arrow_outer'] : $popup_classes_settings['arrow_outer'],
  ];
  $elements['popup']['classes']['arrow_inner'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Arrow inner class'),
    '#default_value' => empty($popup_classes_settings['arrow_inner']) ? $default_settings['popup']['classes']['arrow_inner'] : $popup_classes_settings['arrow_inner'],
  ];
  $elements['zoom'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Zoom'),
  ];
  $zoom_settings = $this
    ->getSetting('zoom');
  $elements['zoom']['default'] = [
    '#type' => 'select',
    '#options' => range(1, 23),
    '#title' => $this
      ->t('Default zoom level'),
    '#default_value' => empty($zoom_settings['default']) ? $default_settings['zoom']['default'] : $zoom_settings['default'],
    '#description' => $this
      ->t('Should be between the Min and Max zoom level.'),
    '#required' => TRUE,
  ];
  $elements['zoom']['max'] = [
    '#type' => 'select',
    '#options' => range(1, 23),
    '#title' => $this
      ->t('Max zoom level'),
    '#default_value' => empty($zoom_settings['max']) ? $default_settings['zoom']['max'] : $zoom_settings['max'],
    '#description' => $this
      ->t('Should be greater then the Min zoom level.'),
    '#required' => TRUE,
  ];
  $elements['zoom']['min'] = [
    '#type' => 'select',
    '#options' => range(1, 23),
    '#title' => $this
      ->t('Min zoom level'),
    '#default_value' => empty($zoom_settings['min']) ? $default_settings['zoom']['min'] : $zoom_settings['min'],
    '#description' => $this
      ->t('Should be smaller then the Max zoom level.'),
    '#required' => TRUE,
  ];
  $elements['directions'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Getting directions'),
  ];
  $directions_settings = $this
    ->getSetting('directions');
  $elements['directions']['enabled'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Enable'),
    '#default_value' => empty($directions_settings['enabled']) ? $default_settings['directions']['enabled'] : $directions_settings['enabled'],
    '#description' => $this
      ->t('If you want to show "Get directions" block on the map'),
  ];
  $elements['directions']['type'] = [
    '#type' => 'select',
    '#options' => [
      'SELECTABLE' => $this
        ->t('Allow user to choose'),
      'DRIVING' => $this
        ->t('Driving (indicates standard driving directions using the road network)'),
      'BICYCLING' => $this
        ->t('Bicycling (requests bicycling directions via bicycle paths & preferred streets)'),
      'TRANSIT' => $this
        ->t('Public transport'),
      'WALKING' => $this
        ->t('Walking'),
    ],
    '#title' => $this
      ->t('Travel mode'),
    '#default_value' => empty($directions_settings['type']) ? $default_settings['directions']['type'] : $directions_settings['type'],
    '#description' => $this
      ->t('Read more about <a href="@url" target="_blank">travel mode</a>.', [
      '@url' => 'https://developers.google.com/maps/documentation/javascript/directions#TravelModes',
    ]),
    '#required' => TRUE,
  ];
  $elements['directions']['steps'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Show detailed steps in a separate window'),
    '#default_value' => empty($directions_settings['steps']) ? $default_settings['directions']['steps'] : $directions_settings['steps'],
    '#description' => $this
      ->t('When enabled will show detailed steps of the route in a separate window.'),
  ];
  $elements['maptypecontrol'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Enable Map Type control'),
    '#default_value' => $this
      ->getSetting('maptypecontrol'),
  ];
  $elements['scalecontrol'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Enable scale control'),
    '#default_value' => $this
      ->getSetting('scalecontrol'),
  ];
  $elements['rotatecontrol'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Enable rotate control'),
    '#default_value' => $this
      ->getSetting('rotatecontrol'),
  ];
  $elements['draggable'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Enable dragging'),
    '#default_value' => $this
      ->getSetting('draggable'),
  ];
  $elements['mobile_draggable'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Enable mobile dragging'),
    '#description' => $this
      ->t('Sometimes when the map covers big part of touch device screen draggable feature can cause inability to scroll the page'),
    '#default_value' => $this
      ->getSetting('mobile_draggable'),
  ];
  $elements['streetviewcontrol'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Enable street view control'),
    '#default_value' => $this
      ->getSetting('streetviewcontrol'),
  ];
  $elements['zoomcontrol'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Enable zoom control'),
    '#default_value' => $this
      ->getSetting('zoomcontrol'),
  ];
  $elements['fullscreen'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Enable full screen control'),
    '#default_value' => $this
      ->getSetting('fullscreen'),
  ];
  return $elements;
}