class WebformAdminConfigExportersForm in Webform 6.x

Same name and namespace in other branches

8.5 src/Form/AdminConfig/WebformAdminConfigExportersForm.php \Drupal\webform\Form\AdminConfig\WebformAdminConfigExportersForm

Configure webform admin settings for exporters.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\webform\Form\AdminConfig\WebformAdminConfigBaseForm
    class \Drupal\webform\Form\AdminConfig\WebformAdminConfigExportersForm

Expanded class hierarchy of WebformAdminConfigExportersForm

1 string reference to 'WebformAdminConfigExportersForm'

webform.routing.yml in ./webform.routing.yml: webform.routing.yml

File

src/Form/AdminConfig/WebformAdminConfigExportersForm.php, line 12

Namespace

Drupal\webform\Form\AdminConfig

View source

class WebformAdminConfigExportersForm extends WebformAdminConfigBaseForm {

  /**
   * The file system service.
   *
   * @var \Drupal\Core\File\FileSystemInterface
   */
  protected $fileSystem;

  /**
   * The webform exporter manager.
   *
   * @var \Drupal\webform\Plugin\WebformExporterManagerInterface
   */
  protected $exporterManager;

  /**
   * The webform submission exporter.
   *
   * @var \Drupal\webform\WebformSubmissionExporterInterface
   */
  protected $submissionExporter;

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'webform_admin_config_exporters_form';
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance->fileSystem = $container
      ->get('file_system');
    $instance->exporterManager = $container
      ->get('plugin.manager.webform.exporter');
    $instance->submissionExporter = $container
      ->get('webform_submission.exporter');
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('webform.settings');
    $form['export_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Export general settings'),
      '#open' => TRUE,
    ];
    $form['export_settings']['temp_directory'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Temporary directory'),
      '#description' => $this
        ->t('A local file system path where temporary export files will be stored. This directory should be persistent between requests and should not be accessible over the web.'),
      '#required' => TRUE,
      '#default_value' => $config
        ->get('export.temp_directory') ?: $this->fileSystem
        ->getTempDirectory(),
    ];

    // Export.
    $form['export_default_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Export default settings'),
      '#description' => $this
        ->t('Enter default export settings to be used by all webforms.'),
      '#open' => TRUE,
    ];
    $export_options = $config
      ->get('export');
    $export_form_state = new FormState();
    $this->submissionExporter
      ->buildExportOptionsForm($form['export_default_settings'], $export_form_state, $export_options);

    // (Excluded) Exporters.
    $form['exporter_types'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Submission exporters'),
      '#description' => $this
        ->t('Select available submission exporters'),
      '#open' => TRUE,
    ];
    $form['exporter_types']['excluded_exporters'] = $this
      ->buildExcludedPlugins($this->exporterManager, $config
      ->get('export.excluded_exporters') ?: [] ?: []);
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

    // Copied from: system_check_directory().
    $temp_directory = $form_state
      ->getValue('temp_directory');
    if (!is_dir($temp_directory) && !$this->fileSystem
      ->mkdir($temp_directory, NULL, TRUE)) {
      $form_state
        ->setErrorByName('temp_directory', $this
        ->t('The directory %directory does not exist and could not be created.', [
        '%directory' => $temp_directory,
      ]));
    }
    if (is_dir($temp_directory) && !is_writable($temp_directory) && !$this->fileSystem
      ->chmod($temp_directory)) {
      $form_state
        ->setErrorByName('temp_directory', $this
        ->t('The directory %directory exists but is not writable and could not be made writable.', [
        '%directory' => $temp_directory,
      ]));
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $excluded_exporters = $this
      ->convertIncludedToExcludedPluginIds($this->exporterManager, $form_state
      ->getValue('excluded_exporters'));
    $values = $form_state
      ->getValues();
    $export = $this->submissionExporter
      ->getValuesFromInput($values) + [
      'excluded_exporters' => $excluded_exporters,
    ];

    // Set custom temp directory.
    $export['temp_directory'] = $values['temp_directory'] === $this->fileSystem
      ->getTempDirectory() ? '' : $values['temp_directory'];

    // Update config and submit form.
    $config = $this
      ->config('webform.settings');
    $config
      ->set('export', $export);
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object.	16
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::configFactory	protected	function	Gets the config factory for this form.	3
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route.
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
WebformAdminConfigBaseForm::buildBulkOperations	protected	function	Build bulk operation settings for webforms and submissions.
WebformAdminConfigBaseForm::buildExcludedPlugins	protected	function	Build excluded plugins element.
WebformAdminConfigBaseForm::convertIncludedToExcludedPluginIds	protected	function	Convert included ids returned from table select element to excluded ids.
WebformAdminConfigBaseForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
WebformAdminConfigBaseForm::getPluginDefinitions	protected	function	Get plugin definitions.
WebformAdminConfigBaseForm::validateBulkFormActions	public static	function	Form API callback. Validate bulk form actions.
WebformAdminConfigExportersForm::$exporterManager	protected	property	The webform exporter manager.
WebformAdminConfigExportersForm::$fileSystem	protected	property	The file system service.
WebformAdminConfigExportersForm::$submissionExporter	protected	property	The webform submission exporter.
WebformAdminConfigExportersForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
WebformAdminConfigExportersForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
WebformAdminConfigExportersForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
WebformAdminConfigExportersForm::submitForm	public	function	Form submission handler. Overrides WebformAdminConfigBaseForm::submitForm
WebformAdminConfigExportersForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm

You are here

class WebformAdminConfigExportersForm in Webform 6.x

Hierarchy

File

Namespace

Members

API Navigation