geolocation-8.x-3.x-dev/src/Plugin/Block/GeolocationBlock.php

<?php

namespace Drupal\geolocation\Plugin\Block;

use Drupal\Core\Block\Attribute\Block;
use Drupal\Component\Utility\NestedArray;
use Drupal\Core\Block\BlockBase;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\filter\Entity\FilterFormat;
use Drupal\geolocation\MapCenterManager;
use Drupal\geolocation\MapProviderManager;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Exposes a map rendered as a block.
 */
#[Block(
  id: 'geolocation_block',
  admin_label: new \Drupal\Core\StringTranslation\TranslatableMarkup('Geolocation Map')
)]
class GeolocationBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * {@inheritdoc}
   */
  public function __construct(
    array $configuration,
    $plugin_id,
    $plugin_definition,
    protected MapProviderManager $mapProviderManager,
    protected MapCenterManager $mapCenterManager,
    protected ModuleHandlerInterface $moduleHandler,
  ) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition): GeolocationBlock {
    return new static(
      $configuration,
      $plugin_id,
      $plugin_definition,
      $container->get('plugin.manager.geolocation.mapprovider'),
      $container->get('plugin.manager.geolocation.mapcenter'),
      $container->get('module_handler')
    );
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration(): array {
    $configuration = parent::defaultConfiguration();
    $configuration['map_provider_id'] = '';
    if ($this->moduleHandler->moduleExists('geolocation_google_maps')) {
      $configuration['map_provider_id'] = 'google_maps';
    }
    elseif ($this->moduleHandler->moduleExists('geolocation_leaflet')) {
      $configuration['map_provider_id'] = 'leaflet';
    }
    $configuration['map_provider_settings'] = [];

    $configuration['centre'] = [];
    $configuration['locations'] = [];

    return $configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state): array {
    $form = parent::blockForm($form, $form_state);

    $form['locations'] = [
      '#type' => 'fieldset',
      '#title' => $this->t('Markers'),
      '#attributes' => [
        'id' => 'block-locations',
      ],
    ];

    if (!$form_state->has('locations')) {
      $form_state->set('locations', $this->configuration['locations']);
    }
    $locations = $form_state->get('locations');

    for ($i = 0; $i < count($locations); $i++) {

      $form['locations'][$i] = [
        '#type' => 'fieldset',
        '#title' => $this->t('Marker %index', ['%index' => $i]),
        'marker_title' => [
          '#type' => 'textfield',
          '#title' => $this->t('Marker title'),
          '#description' => $this->t('When the cursor hovers on the marker, this title will be shown as description.'),
          '#default_value' => empty($locations[$i]['marker_title']) ? '' : $locations[$i]['marker_title'],
        ],
        'marker_content' => [
          '#type' => 'text_format',
          '#title' => $this->t('Marker info text'),
          '#description' => $this->t('When the marker is clicked, this text will be shown in a popup above it. Leave blank to not display. Token replacement supported.'),
        ],
        'marker_coordinates' => [
          '#type' => 'geolocation_input',
          '#title' => $this->t('Marker Coordinates'),
          '#default_value' => empty($locations[$i]['marker_coordinates']) ? [] : $locations[$i]['marker_coordinates'],
        ],
      ];

      if (!empty($locations[$i]['marker_content']['value'])) {
        $form['locations'][$i]['marker_content']['#default_value'] = $locations[$i]['marker_content']['value'];
      }

      if (!empty($locations[$i]['marker_content']['format'])) {
        $form['locations'][$i]['marker_content']['#format'] = $locations[$i]['marker_content']['format'];
      }

      $form['locations'][$i]['remove_item'] = [
        '#type' => 'submit',
        '#value' => $this->t('Remove one'),
        '#submit' => [[$this, 'removeCallback']],
        '#ajax' => [
          'callback' => [$this, 'addLocation'],
          'wrapper'  => 'block-locations',
          'effect' => 'fade',
        ],
      ];
    }

    $form['locations']['add_item'] = [
      '#type' => 'submit',
      '#value' => $this->t('Add one more'),
      '#submit' => [[$this, 'addCallback']],
      '#ajax' => [
        'callback' => [$this, 'addLocation'],
        'wrapper'  => 'block-locations',
        'effect' => 'fade',
      ],
    ];

    $map_provider_options = $this->mapProviderManager->getMapProviderOptions();

    if (empty($map_provider_options)) {
      return [
        '#type' => 'html_tag',
        '#tag' => 'span',
        '#value' => $this->t("No map provider found."),
      ];
    }

    $form['centre'] = $this->mapCenterManager->getCenterOptionsForm((array) $this->configuration['centre'], ['formatter' => $this]);

    $form['map_provider_id'] = [
      '#type' => 'select',
      '#options' => $map_provider_options,
      '#title' => $this->t('Map Provider'),
      '#default_value' => $this->configuration['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' => $this->t("No settings available."),
    ];

    $parents = [
      'settings',
    ];

    $user_input = $form_state->getUserInput();
    $map_provider_id = NestedArray::getValue($user_input, array_merge($parents, ['map_provider_id']));
    if (empty($map_provider_id)) {
      $map_provider_id = $this->configuration['map_provider_id'];
    }
    if (empty($map_provider_id)) {
      $map_provider_id = key($map_provider_options);
    }

    $map_provider_settings = NestedArray::getValue($user_input, array_merge($parents, ['map_provider_settings']));
    if (empty($map_provider_settings)) {
      $map_provider_settings = $this->configuration['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,
          array_merge($parents, ['map_provider_settings'])
        );
    }

    $form['map_provider_settings'] = array_replace(
      $form['map_provider_settings'],
      [
        '#prefix' => '<div id="map-provider-settings">',
        '#suffix' => '</div>',
      ]
    );

    return $form;
  }

  /**
   * Add location.
   *
   * @param array $form
   *   Current form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Current form state.
   */
  public function addCallback(array &$form, FormStateInterface $form_state): void {
    $locations = $form_state->get('locations');
    $locations[] = [
      'marker_title' => '',
      'marker_content' => [
        'value' => '',
        'format' => filter_default_format(),
      ],
      'marker_coordinates' => [],
    ];
    $form_state->set('locations', $locations);
    $form_state->setRebuild();
  }

  /**
   * Add location.
   *
   * @param array $form
   *   Current form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Current form state.
   */
  public function removeCallback(array &$form, FormStateInterface $form_state): void {
    $parents = $form_state->getTriggeringElement()['#parents'];
    end($parents);
    $key = prev($parents);
    $locations = $form_state->get('locations');
    unset($locations[$key]);
    $form_state->set('locations', $locations);
    $form_state->setRebuild();
  }

  /**
   * Add location.
   *
   * @param array $form
   *   Current form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Current form state.
   *
   * @return array
   *   Render array.
   */
  public function addLocation(array $form, FormStateInterface &$form_state): array {
    return $form['settings']['locations'];
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state): void {
    $this->configuration['map_provider_id'] = $form_state->getValue('map_provider_id');
    $this->configuration['map_provider_settings'] = $form_state->getValue('map_provider_settings');
    $this->configuration['centre'] = $form_state->getValue('centre');

    $this->configuration['locations'] = [];
    $locations = $form_state->getValue('locations');
    foreach ($locations as $index => $location) {
      if ($index === 'add_item') {
        continue;
      }

      if (!empty($location['marker_coordinates'])) {
        $location_item = [
          'marker_title' => '',
          'marker_content' => '',
          'marker_coordinates' => $location['marker_coordinates'],
        ];

        if (!empty($location['marker_title'])) {
          $location_item['marker_title'] = $location['marker_title'];
        }

        if (!empty($location['marker_content'])) {
          $location_item['marker_content'] = $location['marker_content'];
        }

        $this->configuration['locations'][] = $location_item;
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function build(): array {
    $build = [
      '#id' => uniqid("map-"),
      '#type' => 'geolocation_map',
      '#settings' => $this->configuration['map_provider_settings'],
      '#maptype' => $this->configuration['map_provider_id'],
      '#centre' => [],
      '#context' => ['block' => $this],
    ];

    foreach ($this->configuration['locations'] as $index => $location) {
      $build[$index] = [
        '#type' => 'geolocation_map_location',
        '#title' => $location['marker_title'],
        '#coordinates' => $location['marker_coordinates'],
        'content' => [
          '#type' => 'processed_text',
          '#text' => $location['marker_content']['value'],
          '#format' => $location['marker_content']['format'],
        ],
      ];
    }

    return $this->mapCenterManager->alterMap($build, $this->configuration['centre'], ['block' => $this]);
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies(): array {
    $dependencies = parent::calculateDependencies();
    foreach ($this->configuration['locations'] as $index => $location) {
      $filter_format = FilterFormat::load($location['marker_content']['format']);
      $dependencies['config'][] = $filter_format->getConfigDependencyName();
    }
    return $dependencies;
  }

}