public function DelimitedWebformExporter::buildConfigurationForm in Webform 6.x

Same name and namespace in other branches

1. 8.5 src/Plugin/WebformExporter/DelimitedWebformExporter.php \Drupal\webform\Plugin\WebformExporter\DelimitedWebformExporter::buildConfigurationForm()

Form constructor.

Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and #array_parents, see \Drupal\Core\Render\Element\FormElement.

Parameters

array $form: An associative array containing the initial structure of the plugin form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().

Return value

array The form structure.

Overrides WebformExporterBase::buildConfigurationForm

File

src/Plugin/WebformExporter/DelimitedWebformExporter.php, line 41

Class

DelimitedWebformExporter

Defines a delimited text exporter.

Namespace

Drupal\webform\Plugin\WebformExporter

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form = parent::buildConfigurationForm($form, $form_state);
  $form['warning'] = [
    '#type' => 'webform_message',
    '#message_type' => 'warning',
    '#message_message' => $this
      ->t('<strong>Warning:</strong> Opening delimited text files with spreadsheet applications may expose you to <a href=":href">formula injection</a> or other security vulnerabilities. When the submissions contain data from untrusted users and the downloaded file will be used with Microsoft Excel, use \'HTML table\' format.', [
      ':href' => 'https://www.google.com/search?q=spreadsheet+formula+injection',
    ]),
  ];
  $form['delimiter'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Delimiter text format'),
    '#description' => $this
      ->t('This is the delimiter used in the CSV/TSV file when downloading webform results. Using tabs in the export is the most reliable method for preserving non-latin characters. You may want to change this to another character depending on the program with which you anticipate importing results.'),
    '#required' => TRUE,
    '#options' => [
      ',' => $this
        ->t('Comma (,)'),
      '\\t' => $this
        ->t('Tab (\\t)'),
      ';' => $this
        ->t('Semicolon (;)'),
      ':' => $this
        ->t('Colon (:)'),
      '|' => $this
        ->t('Pipe (|)'),
      '.' => $this
        ->t('Period (.)'),
      ' ' => $this
        ->t('Space ( )'),
    ],
    '#default_value' => $this->configuration['delimiter'] === "\t" ? '\\t' : $this->configuration['delimiter'],
  ];
  $form['excel'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Generate Excel compatible file'),
    '#description' => $this
      ->t("If checked, the generated file's carriage returns will be compatible with Excel and a marker flagging the data as UTF-8 will be added at the beginning."),
    '#return_value' => TRUE,
    '#default_value' => $this->configuration['excel'],
  ];
  return $form;
}