FieldEncryptSettingsForm.php in Field Encryption 8.2

Namespace

Drupal\field_encrypt\Form

File

src/Form/FieldEncryptSettingsForm.php

<?php

namespace Drupal\field_encrypt\Form;

use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\Field\FieldTypePluginManagerInterface;
use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Form builder for the field_encrypt settings admin page.
 */
class FieldEncryptSettingsForm extends ConfigFormBase {

  /**
   * The field type plugin manager.
   *
   * @var \Drupal\Core\Field\FieldTypePluginManagerInterface
   */
  protected $fieldTypePluginManager;

  /**
   * Constructs a new FieldEncryptSettingsForm.
   *
   * @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_plugin_manager
   *   The field type plugin manager.
   */
  public function __construct(FieldTypePluginManagerInterface $field_type_plugin_manager) {
    $this->fieldTypePluginManager = $field_type_plugin_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.field.field_type'));
  }

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'field_encrypt.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $config = $this
      ->config('field_encrypt.settings');
    $default_properties = $config
      ->get('default_properties');
    $form['default_properties'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('Default properties'),
      '#description' => $this
        ->t('Select which field properties will be checked by default on the field encryption settings form, per field type. Note that this does not change existing field settings, but merely sets sensible defaults.'),
      '#tree' => TRUE,
      '#open' => TRUE,
    );

    // Gather valid field types.
    foreach ($this->fieldTypePluginManager
      ->getGroupedDefinitions($this->fieldTypePluginManager
      ->getUiDefinitions()) as $category => $field_types) {
      $form['default_properties'][$category] = array(
        '#type' => 'details',
        '#title' => $category,
        '#open' => TRUE,
      );
      foreach ($field_types as $name => $field_type) {

        // Special handling for preconfigured definitions.
        // @see \Drupal\Core\Field\FieldTypePluginManager::getUiDefinitions()
        $type = strpos($name, 'field_ui:') === 0 ? $field_type['id'] : $name;
        $field_definition = BaseFieldDefinition::create($type);
        $definitions = $field_definition
          ->getPropertyDefinitions();
        $properties = [];
        foreach ($definitions as $property => $definition) {
          $properties[$property] = $property . ' (' . $definition
            ->getLabel() . ' - ' . $definition
            ->getDataType() . ')';
        }
        $form['default_properties'][$category][$name] = [
          '#type' => 'checkboxes',
          '#title' => $this
            ->t('@field_type properties', array(
            '@field_type' => $field_type['label'],
          )),
          '#description' => t('Specify the default properties to encrypt for this field type.'),
          '#options' => $properties,
          '#default_value' => isset($default_properties[$name]) ? $default_properties[$name] : [],
        ];
      }
      $form['batch_update'] = array(
        '#type' => 'details',
        '#title' => $this
          ->t('Batch update settings'),
        '#description' => $this
          ->t('Configure behaviour of the batch field update feature. When changing field encryption settings for fields that already contain data, a batch process will be started that updates the existing field values according to the new settings.'),
        '#open' => TRUE,
      );
      $form['batch_update']['batch_size'] = array(
        '#type' => 'number',
        '#title' => $this
          ->t('Batch size'),
        '#default_value' => $config
          ->get('batch_size'),
        '#description' => $this
          ->t('Specify the number of entities to process on each field update batch execution. It is recommended to keep this number low, to avoid timeouts.'),
      );
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $default_properties = [];
    $form_state
      ->getValue('default_properties');
    $values = $form_state
      ->getValue('default_properties');
    foreach ($values as $category => $field_types) {
      foreach ($field_types as $field_type => $properties) {
        $default_properties[$field_type] = array_keys(array_filter($properties));
      }
    }
    $this
      ->config('field_encrypt.settings')
      ->set('default_properties', $default_properties)
      ->set('batch_size', $form_state
      ->getValue('batch_size'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Classes

Name	Description
FieldEncryptSettingsForm	Form builder for the field_encrypt settings admin page.