class GeocoderProviderCreationForm in Geocoder 8.3

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.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\geocoder\Form\GeocoderProviderCreationForm

Expanded class hierarchy of GeocoderProviderCreationForm

1 file declares its use of GeocoderProviderCreationForm

GeocoderProviderListBuilder.php in src/GeocoderProviderListBuilder.php

File

src/Form/GeocoderProviderCreationForm.php, line 20

Namespace

Drupal\geocoder\Form

View source

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(t('list of all available Geocoder providers'), 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. Here is the @providers_list.', [
          '@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'),
      ]);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
GeocoderProviderCreationForm::$link	protected	property	The Link generator Service.
GeocoderProviderCreationForm::$pluginManager	protected	property	The geocoder provider plugin manager.
GeocoderProviderCreationForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
GeocoderProviderCreationForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
GeocoderProviderCreationForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
GeocoderProviderCreationForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
GeocoderProviderCreationForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
GeocoderProviderCreationForm::__construct	public	function	Constructs a new GeocoderProviderCreationForm.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class GeocoderProviderCreationForm in Geocoder 8.3

Hierarchy

File

Namespace

Members

API Navigation