public function CommonMapBase::buildOptionsForm in Geolocation Field 8.2

Provide a form to edit options for this plugin.

Overrides StylePluginBase::buildOptionsForm

File

src/Plugin/views/style/CommonMapBase.php, line 350

Class

CommonMapBase

Allow to display several field items on a common map.

Namespace

Drupal\geolocation\Plugin\views\style

Code

public function buildOptionsForm(&$form, FormStateInterface $form_state) {
  $map_provider_options = $this->mapProviderManager
    ->getMapProviderOptions();
  if (empty($map_provider_options)) {
    $form = [
      '#type' => 'html_tag',
      '#tag' => 'span',
      '#value' => t("No map provider found."),
    ];
    return;
  }
  parent::buildOptionsForm($form, $form_state);
  $labels = $this->displayHandler
    ->getFieldLabels();
  $geo_options = [];

  /** @var \Drupal\geolocation\DataProviderInterface[] $data_providers */
  $data_providers = [];
  $title_options = [];
  $icon_options = [];
  $fields = $this->displayHandler
    ->getHandlers('field');

  /** @var \Drupal\views\Plugin\views\field\FieldPluginBase[] $fields */
  foreach ($fields as $field_name => $field) {
    $data_provider_settings = [];
    if ($this->options['geolocation_field'] == $field_name && !empty($this->options['data_provider_settings'])) {
      $data_provider_settings = $this->options['data_provider_settings'];
    }
    if ($data_provider = $this->dataProviderManager
      ->getDataProviderByViewsField($field, $data_provider_settings)) {
      $geo_options[$field_name] = $field
        ->adminLabel();
      $data_providers[$field_name] = $data_provider;
    }
    if (!empty($field->options['type']) && $field->options['type'] == 'image') {
      $icon_options[$field_name] = $labels[$field_name];
    }
    if (!empty($field->options['type']) && $field->options['type'] == 'string') {
      $title_options[$field_name] = $labels[$field_name];
    }
  }
  $form['geolocation_field'] = [
    '#title' => $this
      ->t('Geolocation source field'),
    '#type' => 'select',
    '#default_value' => $this->options['geolocation_field'],
    '#description' => $this
      ->t("The source of geodata for each entity."),
    '#options' => $geo_options,
    '#required' => TRUE,
    '#ajax' => [
      'callback' => [
        get_class($this->dataProviderManager),
        'addDataProviderSettingsFormAjax',
      ],
      'wrapper' => 'data-provider-settings',
      'effect' => 'fade',
    ],
  ];
  $data_provider = NULL;
  $form_state_data_provider_id = NestedArray::getValue($form_state
    ->getUserInput(), [
    'style_options',
    'geolocation_field',
  ]);
  if (!empty($form_state_data_provider_id) && !empty($data_providers[$form_state_data_provider_id])) {
    $data_provider = $data_providers[$form_state_data_provider_id];
  }
  elseif (!empty($data_providers[$this->options['geolocation_field']])) {
    $data_provider = $data_providers[$this->options['geolocation_field']];
  }
  elseif ($data_providers[reset($geo_options)]) {
    $data_provider = $data_providers[reset($geo_options)];
  }
  else {
    return;
  }
  $form['data_provider_id'] = [
    '#type' => 'value',
    '#value' => $data_provider
      ->getPluginId(),
  ];
  $form['data_provider_settings'] = [
    '#type' => 'container',
  ];
  if ($data_provider) {
    $form['data_provider_settings'] = $data_provider
      ->getSettingsForm($this->options['data_provider_settings'], [
      'style_options',
      'map_provider_settings',
    ]);
  }
  $form['data_provider_settings'] = array_replace($form['data_provider_settings'], [
    '#prefix' => '<div id="data-provider-settings">',
    '#suffix' => '</div>',
  ]);
  $form['title_field'] = [
    '#title' => $this
      ->t('Title source field'),
    '#type' => 'select',
    '#default_value' => $this->options['title_field'],
    '#description' => $this
      ->t("The source of the title for each entity. Field type must be 'string'."),
    '#options' => $title_options,
    '#empty_value' => 'none',
  ];
  $map_update_target_options = $this
    ->getMapUpdateOptions();

  /*
   * Dynamic map handling.
   */
  if (!empty($map_update_target_options)) {
    $form['dynamic_map'] = [
      '#title' => $this
        ->t('Dynamic Map'),
      '#type' => 'fieldset',
    ];
    $form['dynamic_map']['enabled'] = [
      '#title' => $this
        ->t('Update view on map boundary changes. Also known as "AirBnB" style.'),
      '#type' => 'checkbox',
      '#default_value' => $this->options['dynamic_map']['enabled'],
      '#description' => $this
        ->t("If enabled, moving the map will filter results based on current map boundary. This functionality requires an exposed boundary filter. Enabling AJAX is highly recommend for best user experience. If additional views are to be updated with the map change as well, it is highly recommended to use the view containing the map as 'parent' and the additional views as attachments."),
    ];
    $form['dynamic_map']['update_handler'] = [
      '#title' => $this
        ->t('Dynamic map update handler'),
      '#type' => 'select',
      '#default_value' => $this->options['dynamic_map']['update_handler'],
      '#description' => $this
        ->t("The map has to know how to feed back the update boundary data to the view."),
      '#options' => $map_update_target_options,
      '#states' => [
        'visible' => [
          ':input[name="style_options[dynamic_map][enabled]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['dynamic_map']['hide_form'] = [
      '#title' => $this
        ->t('Hide exposed filter form element if applicable.'),
      '#type' => 'checkbox',
      '#default_value' => $this->options['dynamic_map']['hide_form'],
      '#states' => [
        'visible' => [
          ':input[name="style_options[dynamic_map][enabled]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['dynamic_map']['views_refresh_delay'] = [
      '#title' => $this
        ->t('Minimum idle time in milliseconds required to trigger views refresh'),
      '#description' => $this
        ->t('Once the view refresh is triggered, any further change of the map bounds will have no effect until the map update is finished. User interactions like scrolling in and out or dragging the map might trigger the map idle event, before the user is finished interacting. This setting adds a delay before the view is refreshed to allow further map interactions.'),
      '#type' => 'number',
      '#min' => 0,
      '#default_value' => $this->options['dynamic_map']['views_refresh_delay'],
      '#states' => [
        'visible' => [
          ':input[name="style_options[dynamic_map][enabled]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    if ($this->displayHandler
      ->getPluginId() !== 'page') {
      $update_targets = [
        $this->displayHandler->display['id'] => $this
          ->t('- This display -'),
      ];
      foreach ($this->view->displayHandlers
        ->getInstanceIds() as $instance_id) {
        $display_instance = $this->view->displayHandlers
          ->get($instance_id);
        if ($display_instance
          ->getPluginId() == 'page') {
          $update_targets[$instance_id] = $display_instance->display['display_title'];
        }
      }
      if (!empty($update_targets)) {
        $form['dynamic_map']['update_target'] = [
          '#title' => $this
            ->t('Dynamic map update target'),
          '#type' => 'select',
          '#default_value' => $this->options['dynamic_map']['update_target'],
          '#description' => $this
            ->t("Non-page displays will only update themselves. Most likely a page view should be updated instead."),
          '#options' => $update_targets,
          '#states' => [
            'visible' => [
              ':input[name="style_options[dynamic_map][enabled]"]' => [
                'checked' => TRUE,
              ],
            ],
          ],
        ];
      }
    }
  }

  /*
   * Centre handling.
   */
  $form['centre'] = $this->mapCenterManager
    ->getCenterOptionsForm((array) $this->options['centre'], $this);

  /*
   * Advanced settings
   */
  $form['advanced_settings'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Advanced settings'),
  ];
  $form['even_empty'] = [
    '#group' => 'style_options][advanced_settings',
    '#title' => $this
      ->t('Display map when no locations are found'),
    '#type' => 'checkbox',
    '#default_value' => $this->options['even_empty'],
  ];
  if ($icon_options) {
    $form['icon_field'] = [
      '#group' => 'style_options][advanced_settings',
      '#title' => $this
        ->t('Icon source field'),
      '#type' => 'select',
      '#default_value' => $this->options['icon_field'],
      '#description' => $this
        ->t("Optional image (field) to use as icon."),
      '#options' => $icon_options,
      '#empty_value' => 'none',
      '#process' => [
        [
          '\\Drupal\\Core\\Render\\Element\\RenderElement',
          'processGroup',
        ],
        [
          '\\Drupal\\Core\\Render\\Element\\Select',
          'processSelect',
        ],
      ],
      '#pre_render' => [
        [
          '\\Drupal\\Core\\Render\\Element\\RenderElement',
          'preRenderGroup',
        ],
      ],
    ];
  }
  $form['marker_icon_path'] = [
    '#group' => 'style_options][advanced_settings',
    '#type' => 'textfield',
    '#title' => $this
      ->t('Marker icon path'),
    '#description' => $this
      ->t('Set relative or absolute path to custom marker icon. Tokens & Views replacement patterns supported. Empty for default.'),
    '#default_value' => $this->options['marker_icon_path'],
  ];
  $form['marker_row_number'] = [
    '#group' => 'style_options][advanced_settings',
    '#title' => $this
      ->t('Show views result row number in marker'),
    '#type' => 'checkbox',
    '#default_value' => $this->options['marker_row_number'],
  ];
  $form['map_provider_id'] = [
    '#type' => 'select',
    '#options' => $map_provider_options,
    '#title' => $this
      ->t('Map Provider'),
    '#default_value' => $this->options['map_provider_id'],
    '#ajax' => [
      'callback' => [
        get_class($this->mapProviderManager),
        'addSettingsFormAjax',
      ],
      'wrapper' => 'map-provider-settings',
      'effect' => 'fade',
    ],
  ];
  $form['map_provider_settings'] = [
    '#type' => 'html_tag',
    '#tag' => 'span',
    '#value' => t("No settings available."),
  ];
  $map_provider_id = NestedArray::getValue($form_state
    ->getUserInput(), [
    'style_options',
    'map_provider_id',
  ]);
  if (empty($map_provider_id)) {
    $map_provider_id = $this->options['map_provider_id'];
  }
  if (empty($map_provider_id)) {
    $map_provider_id = key($map_provider_options);
  }
  $map_provider_settings = NestedArray::getValue($form_state
    ->getUserInput(), [
    'style_options',
    'map_provider_settings',
  ]);
  if (empty($map_provider_settings)) {
    $map_provider_settings = $this->options['map_provider_settings'];
  }
  if (!empty($map_provider_id)) {
    $form['map_provider_settings'] = $this->mapProviderManager
      ->createInstance($map_provider_id, $map_provider_settings)
      ->getSettingsForm($map_provider_settings, [
      'style_options',
      'map_provider_settings',
    ]);
  }
  $form['map_provider_settings'] = array_replace($form['map_provider_settings'], [
    '#prefix' => '<div id="map-provider-settings">',
    '#suffix' => '</div>',
  ]);
}