class CurrencyLocaleImportForm in Currency 8.3

Provides the currency locale import form.

Hierarchy

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

Expanded class hierarchy of CurrencyLocaleImportForm

2 files declare their use of CurrencyLocaleImportForm

CurrencyLocaleImportFormTest.php in tests/src/Unit/Controller/CurrencyLocaleImportFormTest.php
CurrencyLocaleImportFormTest.php in tests/src/Unit/Form/CurrencyLocaleImportFormTest.php

1 string reference to 'CurrencyLocaleImportForm'

currency.routing.yml in ./currency.routing.yml: currency.routing.yml

File

src/Form/CurrencyLocaleImportForm.php, line 17

Namespace

Drupal\currency\Form

View source

class CurrencyLocaleImportForm extends FormBase implements ContainerInjectionInterface {

  /**
   * The Currency config importer.
   *
   * @var \Drupal\currency\ConfigImporterInterface
   */
  protected $configImporter;

  /**
   * The Currency form helper.
   *
   * @var \Drupal\currency\FormHelperInterface
   */
  protected $formHelper;

  /**
   * Constructs a new instance.
   *
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   *   The string translator.
   * @param \Drupal\currency\ConfigImporterInterface
   *   The Currency config importer.
   * @param \Drupal\currency\FormHelperInterface
   *   The Currency form helper.
   */
  public function __construct(TranslationInterface $string_translation, ConfigImporterInterface $config_importer, FormHelperInterface $form_helper) {
    $this->configImporter = $config_importer;
    $this->formHelper = $form_helper;
    $this->stringTranslation = $string_translation;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('string_translation'), $container
      ->get('currency.config_importer'), $container
      ->get('currency.form_helper'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'currency_locale_import';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $currency_locales = $this->configImporter
      ->getImportableCurrencyLocales();
    if (empty($currency_locales)) {
      $form['message'] = [
        '#markup' => $this
          ->t('All currency locales have been imported already.'),
      ];
    }
    else {
      $form['locale'] = [
        '#options' => $this->formHelper
          ->getCurrencyLocaleOptions($currency_locales),
        '#required' => TRUE,
        '#title' => $this
          ->t('Currency locale'),
        '#type' => 'select',
      ];
      $form['actions'] = [
        '#type' => 'actions',
      ];
      $form['actions']['import'] = [
        '#dropbutton' => 'submit',
        '#name' => 'import',
        '#type' => 'submit',
        '#value' => $this
          ->t('Import'),
      ];
      $form['actions']['import_edit'] = [
        '#dropbutton' => 'submit',
        '#name' => 'import_edit',
        '#type' => 'submit',
        '#value' => $this
          ->t('Import and edit'),
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $currency_locale = $this->configImporter
      ->importCurrencyLocale($form_state
      ->getValues()['locale']);
    $this
      ->messenger()
      ->addMessage($this
      ->t('The %label has been imported.', [
      '%label' => $currency_locale
        ->label(),
    ]));
    if ($form_state
      ->getTriggeringElement()['#name'] == 'import_edit') {
      $form_state
        ->setRedirectUrl($currency_locale
        ->toUrl('edit-form'));
    }
    else {
      $form_state
        ->setRedirectUrl(new Url('entity.currency_locale.collection'));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CurrencyLocaleImportForm::$configImporter	protected	property	The Currency config importer.
CurrencyLocaleImportForm::$formHelper	protected	property	The Currency form helper.
CurrencyLocaleImportForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
CurrencyLocaleImportForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
CurrencyLocaleImportForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
CurrencyLocaleImportForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
CurrencyLocaleImportForm::__construct	public	function	Constructs a new instance.
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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 CurrencyLocaleImportForm in Currency 8.3

Hierarchy

File

Namespace

Members

API Navigation