class WebformResultsExportForm in Webform 8.5
Same name and namespace in other branches
- 6.x src/Form/WebformResultsExportForm.php \Drupal\webform\Form\WebformResultsExportForm
Webform for webform results export webform.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\webform\Form\WebformResultsExportForm
Expanded class hierarchy of WebformResultsExportForm
File
- src/
Form/ WebformResultsExportForm.php, line 13
Namespace
Drupal\webform\FormView source
class WebformResultsExportForm extends FormBase {
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'webform_results_export';
}
/**
* The webform submission exporter.
*
* @var \Drupal\webform\WebformSubmissionExporterInterface
*/
protected $submissionExporter;
/**
* Constructs a WebformResultsExportForm object.
*
* @param \Drupal\webform\WebformSubmissionExporterInterface $webform_submission_exporter
* The webform submission exported.
*/
public function __construct(WebformSubmissionExporterInterface $webform_submission_exporter) {
$this->submissionExporter = $webform_submission_exporter;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('webform_submission.exporter'));
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
// Set the merged default (global setting), saved, and user export options
// into the webform's state.
$settings_options = $this
->config('webform.settings')
->get('export');
$saved_options = $this->submissionExporter
->getWebformOptions();
$user_options = $this->submissionExporter
->getValuesFromInput($form_state
->getUserInput());
$export_options = $user_options + $saved_options + $settings_options;
// Build the webform.
$this->submissionExporter
->buildExportOptionsForm($form, $form_state, $export_options);
// Build actions.
$form['actions']['#type'] = 'actions';
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this
->t('Download'),
'#button_type' => 'primary',
];
$form['actions']['save'] = [
'#type' => 'submit',
'#value' => $this
->t('Save settings'),
'#submit' => [
'::save',
],
];
$form['actions']['delete'] = [
'#type' => 'submit',
'#value' => $this
->t('Reset settings'),
'#attributes' => [
'class' => [
'button',
'button--danger',
],
],
'#access' => $saved_options ? TRUE : FALSE,
'#submit' => [
'::delete',
],
];
// Disable single submit.
$form['#attributes']['class'][] = 'webform-remove-single-submit';
$form['#attached']['library'][] = 'webform/webform.form';
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$default_options = $this->submissionExporter
->getDefaultExportOptions();
$export_options = $this->submissionExporter
->getValuesFromInput($form_state
->getValues());
// Implode arrays.
foreach ($export_options as $key => $value) {
if (is_array($default_options[$key]) && is_array($value)) {
$export_options[$key] = implode(',', $value);
}
}
$webform = $this->submissionExporter
->getWebform();
if ($source_entity = $this->submissionExporter
->getSourceEntity()) {
$entity_type = $source_entity
->getEntityTypeId();
$entity_id = $source_entity
->id();
$route_parameters = [
$entity_type => $entity_id,
];
if ($webform) {
$route_parameters['webform'] = $webform
->id();
}
$route_options = [
'query' => $export_options,
];
$form_state
->setRedirect('entity.' . $entity_type . '.webform.results_export', $route_parameters, $route_options);
}
elseif ($webform) {
$route_parameters = [
'webform' => $webform
->id(),
];
$route_options = [
'query' => $export_options,
];
$form_state
->setRedirect('entity.webform.results_export', $route_parameters, $route_options);
}
}
/**
* Webform save configuration handler.
*
* @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 save(array &$form, FormStateInterface $form_state) {
// Save the export options to the webform's state.
$export_options = $this->submissionExporter
->getValuesFromInput($form_state
->getValues());
$this->submissionExporter
->setWebformOptions($export_options);
$this
->messenger()
->addStatus($this
->t('The download settings have been saved.'));
}
/**
* Webform delete configuration handler.
*
* @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 delete(array &$form, FormStateInterface $form_state) {
$this->submissionExporter
->deleteWebformOptions();
$this
->messenger()
->addStatus($this
->t('The download settings have been reset.'));
}
}
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:: |
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. | |
WebformResultsExportForm:: |
protected | property | The webform submission exporter. | |
WebformResultsExportForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
WebformResultsExportForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
WebformResultsExportForm:: |
public | function | Webform delete configuration handler. | |
WebformResultsExportForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
WebformResultsExportForm:: |
public | function | Webform save configuration handler. | |
WebformResultsExportForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
WebformResultsExportForm:: |
public | function | Constructs a WebformResultsExportForm object. |