class TranslateFilterForm in Drupal 9
Same name and namespace in other branches
- 8 core/modules/locale/src/Form/TranslateFilterForm.php \Drupal\locale\Form\TranslateFilterForm
Provides a filtered translation edit form.
@internal
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\locale\Form\TranslateFormBase
- class \Drupal\locale\Form\TranslateFilterForm
- class \Drupal\locale\Form\TranslateFormBase
Expanded class hierarchy of TranslateFilterForm
File
- core/
modules/ locale/ src/ Form/ TranslateFilterForm.php, line 12
Namespace
Drupal\locale\FormView source
class TranslateFilterForm extends TranslateFormBase {
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'locale_translate_filter_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$filters = $this
->translateFilters();
$filter_values = $this
->translateFilterValues();
$form['#attached']['library'][] = 'locale/drupal.locale.admin';
$form['filters'] = [
'#type' => 'details',
'#title' => $this
->t('Filter translatable strings'),
'#open' => TRUE,
];
foreach ($filters as $key => $filter) {
// Special case for 'string' filter.
if ($key == 'string') {
$form['filters']['status']['string'] = [
'#type' => 'search',
'#title' => $filter['title'],
'#description' => $filter['description'],
'#default_value' => $filter_values[$key],
];
}
else {
$empty_option = isset($filter['options'][$filter['default']]) ? $filter['options'][$filter['default']] : '- None -';
$form['filters']['status'][$key] = [
'#title' => $filter['title'],
'#type' => 'select',
'#empty_value' => $filter['default'],
'#empty_option' => $empty_option,
'#size' => 0,
'#options' => $filter['options'],
'#default_value' => $filter_values[$key],
];
if (isset($filter['states'])) {
$form['filters']['status'][$key]['#states'] = $filter['states'];
}
}
}
$form['filters']['actions'] = [
'#type' => 'actions',
'#attributes' => [
'class' => [
'container-inline',
],
],
];
$form['filters']['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this
->t('Filter'),
];
if ($this
->getRequest()
->getSession()
->has('locale_translate_filter')) {
$form['filters']['actions']['reset'] = [
'#type' => 'submit',
'#value' => $this
->t('Reset'),
'#submit' => [
'::resetForm',
],
];
}
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$filters = $this
->translateFilters();
$session_filters = $this
->getRequest()
->getSession()
->get('locale_translate_filter', []);
foreach ($filters as $name => $filter) {
if ($form_state
->hasValue($name)) {
$session_filters[$name] = trim($form_state
->getValue($name));
}
}
$this
->getRequest()
->getSession()
->set('locale_translate_filter', $session_filters);
$form_state
->setRedirect('locale.translate_page');
}
/**
* Provides a submit handler for the reset button.
*/
public function resetForm(array &$form, FormStateInterface $form_state) {
$this
->getRequest()
->getSession()
->remove('locale_translate_filter');
$form_state
->setRedirect('locale.translate_page');
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 3 |
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. | 3 |
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. | |
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:: |
72 |
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. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
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. | 4 |
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. | |
TranslateFilterForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
TranslateFilterForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
TranslateFilterForm:: |
public | function | Provides a submit handler for the reset button. | |
TranslateFilterForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
TranslateFormBase:: |
protected static | property | Filter values. Shared between objects that inherit this class. | |
TranslateFormBase:: |
protected | property | The language manager. | |
TranslateFormBase:: |
protected | property | The locale storage. | |
TranslateFormBase:: |
protected | property | The state store. | |
TranslateFormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
TranslateFormBase:: |
protected | function | Builds a string search query and returns an array of string objects. | |
TranslateFormBase:: |
protected | function | Lists locale translation filters that can be applied. | |
TranslateFormBase:: |
protected | function | Builds an array out of search criteria specified in request variables. | |
TranslateFormBase:: |
public | function | Constructs a new TranslationFormBase object. |