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'
File
- src/
Form/ CurrencyLocaleImportForm.php, line 17
Namespace
Drupal\currency\FormView 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:: |
protected | property | The Currency config importer. | |
CurrencyLocaleImportForm:: |
protected | property | The Currency form helper. | |
CurrencyLocaleImportForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
CurrencyLocaleImportForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
CurrencyLocaleImportForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
CurrencyLocaleImportForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
CurrencyLocaleImportForm:: |
public | function | Constructs a new instance. | |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
62 |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |