class SettingsForm in General Data Protection Regulation 8

Same name and namespace in other branches

8.2 modules/gdpr_dump/src/Form/SettingsForm.php \Drupal\gdpr_dump\Form\SettingsForm
3.0.x modules/gdpr_dump/src/Form/SettingsForm.php \Drupal\gdpr_dump\Form\SettingsForm

Class SettingsForm.

@package Drupal\gdpr_dump\Form

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\gdpr_dump\Form\SettingsForm

Expanded class hierarchy of SettingsForm

2 files declare their use of SettingsForm

GdprSqlDump.php in modules/gdpr_dump/src/Service/GdprSqlDump.php
GdprSqlMysql.php in modules/gdpr_dump/src/Sql/GdprSqlMysql.php

1 string reference to 'SettingsForm'

gdpr_dump.routing.yml in modules/gdpr_dump/gdpr_dump.routing.yml: modules/gdpr_dump/gdpr_dump.routing.yml

File

modules/gdpr_dump/src/Form/SettingsForm.php, line 19

Namespace

Drupal\gdpr_dump\Form

View source

class SettingsForm extends ConfigFormBase {
  const GDPR_DUMP_CONF_KEY = 'gdpr_dump.table_map';
  const GDPR_DUMP_NO_PLUGIN_KEY = 'none';

  /**
   * Database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;

  /**
   * Database manager.
   *
   * @var \Drupal\gdpr_dump\Service\GdprDatabaseManager
   */
  protected $databaseManager;

  /**
   * The plugin manager for anonymizers.
   *
   * @var \Drupal\anonymizer\Anonymizer\AnonymizerPluginManager
   */
  protected $pluginManager;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('database'), $container
      ->get('plugin.manager.anonymizer'), $container
      ->get('gdpr_dump.database_manager'));
  }

  /**
   * SettingsForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
   *   The config factory.
   * @param \Drupal\Core\Database\Connection $database
   *   The database connection.
   * @param \Drupal\anonymizer\Anonymizer\AnonymizerPluginManager $pluginManager
   *   The plugin manager for anonymizers.
   * @param \Drupal\gdpr_dump\Service\GdprDatabaseManager $gdprDatabaseManager
   *   Database manager service.
   */
  public function __construct(ConfigFactoryInterface $configFactory, Connection $database, AnonymizerPluginManager $pluginManager, GdprDatabaseManager $gdprDatabaseManager) {
    parent::__construct($configFactory);
    $this->database = $database;
    $this->pluginManager = $pluginManager;
    $this->databaseManager = $gdprDatabaseManager;
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      self::GDPR_DUMP_CONF_KEY,
    ];
  }

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

  /**
   * {@inheritdoc}
   *
   * @throws \Drupal\Core\Database\InvalidQueryException
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['#tree'] = TRUE;
    $form['description'] = [
      '#markup' => $this
        ->t('Apply anonymization for each table columns containing sensitive data!'),
    ];
    $form['tables'] = [
      '#type' => 'container',
    ];
    $plugins = [];
    foreach ($this->pluginManager
      ->getDefinitions() as $definition) {
      $plugins[$definition['id']] = $definition['label'];
    }

    /* @todo:
     * Maybe divide by type (int, varchar, etc) and
     * display only appropriate ones for the actual selects.
     */
    $anonymizationOptions = [
      '#type' => 'select',
      '#title' => $this
        ->t('Apply anonymization'),
      '#options' => $plugins,
      '#empty_value' => self::GDPR_DUMP_NO_PLUGIN_KEY,
      '#empty_option' => $this
        ->t('- No -'),
      '#title_display' => 'invisible',
    ];
    $config = $this
      ->config(self::GDPR_DUMP_CONF_KEY);
    $mapping = $config
      ->get('mapping');
    $emptyTables = $config
      ->get('empty_tables');
    $table_header = [
      $this
        ->t('Field'),
      $this
        ->t('Type'),
      $this
        ->t('Description'),
      $this
        ->t('Apply anonymization'),
    ];
    $moreHeader = [
      $this
        ->t('Table name'),
    ];
    $dbSchema = $this->database
      ->schema();
    $schemaHandlesTableComments = \is_callable([
      $dbSchema,
      'getComment',
    ]);
    if ($schemaHandlesTableComments) {
      $moreHeader[] = $this
        ->t('Description');
    }
    $moreHeader[] = $this
      ->t('Columns');
    $form['more_wrapper'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('More tables'),
      'more_tables' => [
        '#caption' => $this
          ->t("Select from the following tables to be able to configure more for anonymization, then press the 'Refresh form' button below to add them to the form."),
        '#header' => $moreHeader,
        '#type' => 'tableselect',
        '#options' => [],
        '#js_select' => FALSE,
      ],
      'refresh' => [
        '#type' => 'button',
        '#value' => $this
          ->t('Refresh form'),
      ],
    ];
    $added = NestedArray::getValue($form_state
      ->getUserInput(), [
      'more_wrapper',
      'more_tables',
    ]);

    // Force some tables to always show in the form if they exist.
    $forced = [
      'comment_field_data' => TRUE,
      'contact_message' => TRUE,
      'users_data' => TRUE,
      'users_field_data' => TRUE,
      'webform_submission' => TRUE,
      'webform_submission_data' => TRUE,
      'webform_submission_log' => TRUE,
    ];

    /** @var array $columns */
    foreach ($this->databaseManager
      ->getTableColumns() as $table => $columns) {
      $tableComment = $schemaHandlesTableComments ? $dbSchema
        ->getComment($table) : NULL;
      $tableConfigured = isset($mapping[$table]) || isset($emptyTables[$table]);
      $tableForced = isset($forced[$table]) || \strpos($table, 'user__') === 0 || \strpos($table, 'contact_message__') === 0 || \strpos($table, 'comment__') === 0;
      $tableAdded = isset($added[$table]);
      if ($tableConfigured || $tableAdded || $tableForced) {
        $rows = [];
        foreach ($columns as $column) {
          $currentOptions = $anonymizationOptions;
          if (isset($mapping[$table][$column['COLUMN_NAME']])) {
            $currentOptions['#default_value'] = $mapping[$table][$column['COLUMN_NAME']];
          }
          $rows[$column['COLUMN_NAME']] = [
            'name' => [
              '#markup' => '<strong>' . $column['COLUMN_NAME'] . '</strong>',
            ],
            'type' => [
              '#markup' => '<strong>' . $column['DATA_TYPE'] . '</strong>',
            ],
            'description' => [
              '#markup' => '<strong>' . (empty($column['COLUMN_COMMENT']) ? '-' : $column['COLUMN_COMMENT']) . '</strong>',
            ],
            'option' => $currentOptions,
          ];
        }
        $form['tables'][$table] = [
          '#type' => 'details',
          '#title' => $this
            ->t('Table: %table', [
            '%table' => $table,
          ]),
          '#description' => $tableComment,
          'empty_table' => [
            '#type' => 'checkbox',
            '#title' => $this
              ->t('Empty this table'),
            '#default_value' => isset($emptyTables[$table]) ? $emptyTables[$table] : NULL,
            '#weight' => 1,
          ],
          'columns' => [
            '#type' => 'table',
            '#header' => $table_header,
            '#weight' => 0,
          ] + $rows,
        ];
        if ($schemaHandlesTableComments) {
          $form['tables'][$table]['#description'] = $tableComment;
        }
      }
      if (!$tableConfigured && !$tableForced) {
        $row = [
          [
            'data' => [
              '#markup' => '<strong>' . $table . '</strong>',
            ],
          ],
        ];
        if ($schemaHandlesTableComments) {
          $row[] = $tableComment;
        }
        $row[] = \implode(', ', \array_column($columns, 'COLUMN_NAME'));
        $form['more_wrapper']['more_tables']['#options'][$table] = $row;
      }
    }
    $form['more_wrapper']['#access'] = !empty($form['more_wrapper']['more_tables']['#options']);
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   *
   * @throws \Drupal\Core\Config\ConfigValueException
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->hasValue('tables')) {
      $mapping = [];

      /** @var array $tables */
      $tables = $form_state
        ->getValue('tables', []);
      $emptyTables = [];
      foreach ($tables as $table => $row) {
        if ($row['empty_table']) {
          $emptyTables[$table] = 1;
        }
        foreach ($row['columns'] as $name => $data) {
          if (!empty($data['option']) && $data['option'] !== self::GDPR_DUMP_NO_PLUGIN_KEY) {
            $mapping[$table][$name] = $data['option'];
          }
        }
      }
      $config = $this->configFactory
        ->getEditable(self::GDPR_DUMP_CONF_KEY);
      $config
        ->set('mapping', $mapping)
        ->save();
      $config
        ->set('empty_tables', $emptyTables)
        ->save();
    }
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	1
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.	1
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. Overrides UrlGeneratorTrait::redirect
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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.
SettingsForm::$database	protected	property	Database connection.
SettingsForm::$databaseManager	protected	property	Database manager.
SettingsForm::$pluginManager	protected	property	The plugin manager for anonymizers.
SettingsForm::buildForm	public	function	Overrides ConfigFormBase::buildForm
SettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
SettingsForm::GDPR_DUMP_CONF_KEY		constant
SettingsForm::GDPR_DUMP_NO_PLUGIN_KEY		constant
SettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::submitForm	public	function	Overrides ConfigFormBase::submitForm
SettingsForm::__construct	public	function	SettingsForm constructor. Overrides ConfigFormBase::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class SettingsForm in General Data Protection Regulation 8

Hierarchy

File

Namespace

Members

API Navigation