geocoder-8.x-3.x-dev/src/Form/GeocoderProviderCreationForm.php

<?php

declare(strict_types=1);

namespace Drupal\geocoder\Form;

use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Url;
use Drupal\Core\Utility\LinkGeneratorInterface;
use Drupal\geocoder\ProviderPluginManager;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides a simple form that allows to select the provider type.
 *
 * This form is shown on the list of providers and leads to the full form to add
 * a new provider when submitted.
 */
class GeocoderProviderCreationForm extends FormBase {

  /**
   * The geocoder provider plugin manager.
   *
   * @var \Drupal\geocoder\ProviderPluginManager
   */
  protected $pluginManager;

  /**
   * The Link generator Service.
   *
   * @var \Drupal\Core\Utility\LinkGeneratorInterface
   */
  protected $link;

  /**
   * Constructs a new GeocoderProviderCreationForm.
   *
   * @param \Drupal\geocoder\ProviderPluginManager $plugin_manager
   *   The geocoder provider plugin manager.
   * @param \Drupal\Core\Utility\LinkGeneratorInterface $link_generator
   *   The Link Generator service.
   */
  public function __construct(ProviderPluginManager $plugin_manager, LinkGeneratorInterface $link_generator) {
    $this->pluginManager = $plugin_manager;
    $this->link = $link_generator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static(
      $container->get('plugin.manager.geocoder.provider'),
      $container->get('link_generator')
    );
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId(): string {
    return 'geocoder_provider_creation_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state): array {
    $providers = [];
    foreach ($this->pluginManager->getDefinitions() as $id => $definition) {
      $providers[$id] = $definition['name'];
    }
    asort($providers);

    $form['header']['#markup'] = '<h3>' . $this->t('Add a Geocoder provider') . '</h3>';

    $form['container'] = [
      '#type' => 'container',
      '#attributes' => ['class' => ['container-inline']],
      '#open' => TRUE,
    ];

    $form['container']['geocoder_provider'] = [
      '#type' => 'select',
      '#title' => $this->t('Geocoder provider plugin'),
      '#title_display' => 'invisible',
      '#options' => $providers,
      '#empty_option' => $this->t('- Select -'),
    ];

    $form['container']['actions'] = [
      '#type' => 'actions',
    ];

    $form['container']['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this->t('Add'),
    ];

    $providers = $this->link->generate($this->t('List of all possible Geocoder providers|packages'), Url::fromUri('https://packagist.org/providers/geocoder-php/provider-implementation', [
      'absolute' => TRUE,
      'attributes' => ['target' => 'blank'],
    ]));

    $form['help'] = [
      'caption' => [
        '#type' => 'html_tag',
        '#tag' => 'p',
        '#value' => $this->t('If the provider of your choice does not appear in the dropdown, make sure that it is installed using Composer.<br>@providers_list.<br><b>Note: </b> Only the ones listed in the "src/Plugin/Geocoder/Provider" folder are supported by the Geocoder module at the moment. Missing ones need specific additional plugin implementation, eventually shared with the Drupal community as new Geocoder module public issue.', [
          '@providers_list' => $providers,
        ]),
      ],
    ];

    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    if (!$form_state->getValue('geocoder_provider')) {
      $form_state->setErrorByName('geocoder_provider', $this->t('A Geocoder Provider to add should be selected.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state): void {
    if ($form_state->getValue('geocoder_provider')) {
      $form_state->setRedirect(
        'entity.geocoder_provider.add_form',
        ['geocoder_provider_id' => $form_state->getValue('geocoder_provider')]
      );
    }
  }

}