class WebformSubmissionFilterForm in Webform 8.5
Same name and namespace in other branches
- 6.x src/Form/WebformSubmissionFilterForm.php \Drupal\webform\Form\WebformSubmissionFilterForm
Provides the webform submission filter form.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\webform\Form\WebformSubmissionFilterForm
Expanded class hierarchy of WebformSubmissionFilterForm
File
- src/
Form/ WebformSubmissionFilterForm.php, line 12
Namespace
Drupal\webform\FormView source
class WebformSubmissionFilterForm extends FormBase {
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'webform_submission_filter_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state, $search = NULL, $state = NULL, array $state_options = [], $source_entity = NULL, $source_entity_options = []) {
$form['#attributes'] = [
'class' => [
'webform-filter-form',
],
];
$form['filter'] = [
'#type' => 'details',
'#title' => $this
->t('Filter submissions'),
'#open' => TRUE,
'#attributes' => [
'class' => [
'container-inline',
],
],
];
$form['filter']['search'] = [
'#type' => 'search',
'#title' => $this
->t('Keyword'),
'#title_display' => 'invisible',
'#placeholder' => $this
->t('Filter by submitted data and/or notes'),
'#maxlength' => 128,
'#size' => 40,
'#default_value' => $search,
];
if ($source_entity_options) {
if ($source_entity_options instanceof WebformInterface) {
$form['filter']['entity'] = [
'#type' => 'search',
'#title' => $this
->t('Submitted to'),
'#title_display' => 'invisible',
'#autocomplete_route_name' => 'entity.webform.results.source_entity.autocomplete',
'#autocomplete_route_parameters' => [
'webform' => $source_entity_options
->id(),
],
'#placeholder' => $this
->t('Enter submitted to…'),
'#size' => 20,
'#default_value' => $source_entity,
];
}
else {
$form['filter']['entity'] = [
'#type' => 'select',
'#title' => $this
->t('Submitted to'),
'#title_display' => 'invisible',
'#options' => [
'' => $this
->t('Filter by submitted to'),
] + $source_entity_options,
'#default_value' => $source_entity,
];
}
}
$form['filter']['state'] = [
'#type' => 'select',
'#title' => $this
->t('State'),
'#title_display' => 'invisible',
'#options' => $state_options,
'#default_value' => $state,
];
$form['filter']['submit'] = [
'#type' => 'submit',
'#button_type' => 'primary',
'#value' => $this
->t('Filter'),
];
if (!empty($search) || !empty($state)) {
$form['filter']['reset'] = [
'#type' => 'submit',
'#submit' => [
'::resetForm',
],
'#value' => $this
->t('Reset'),
];
}
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$query = [
'search' => trim($form_state
->getValue('search')),
'state' => trim($form_state
->getValue('state')),
'entity' => trim($form_state
->getValue('entity')),
];
$query = array_filter($query);
if (!empty($query['entity']) && preg_match('#\\(([^)]+)\\)#', $query['entity'], $match)) {
$query['entity'] = $match[1];
}
$form_state
->setRedirect($this
->getRouteMatch()
->getRouteName(), $this
->getRouteMatch()
->getRawParameters()
->all(), [
'query' => $query,
]);
}
/**
* Resets the filter selection.
*
* @param array $form
* An associative array containing the structure of the form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*/
public function resetForm(array &$form, FormStateInterface $form_state) {
$form_state
->setRedirect($this
->getRouteMatch()
->getRouteName(), $this
->getRouteMatch()
->getRawParameters()
->all());
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
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:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
87 |
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. | |
WebformSubmissionFilterForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
WebformSubmissionFilterForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
WebformSubmissionFilterForm:: |
public | function | Resets the filter selection. | |
WebformSubmissionFilterForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |