public function SettingsForm::buildForm in Field Encryption 3.0.x

Form constructor.

Parameters

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

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form structure.

Overrides ConfigFormBase::buildForm

File

src/Form/SettingsForm.php, line 77

Class

SettingsForm

Form builder for the field_encrypt settings admin page.

Namespace

Drupal\field_encrypt\Form

Code

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['encryption_profile'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Encryption profile'),
    '#description' => $this
      ->t('Select the encryption profile to use for encrypting fields. New entities and revisions will always use this profile. Existing entities and revisions can be updated via <a href=":link">Encrypted fields entity type settings</a>', [
      ':link' => Url::fromRoute('field_encrypt.settings.entity_type')
        ->toString(),
    ]),
    '#options' => $this->encryptionProfileManager
      ->getEncryptionProfileNamesAsOptions(),
    '#default_value' => $config
      ->get('encryption_profile'),
    '#required' => TRUE,
    '#empty_value' => '',
  ];
  $form['make_entities_uncacheable'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Exclude entities from persistent caches'),
    '#description' => $this
      ->t('This will ensure unencrypted data will not be exposed in the cache, but will have a negative impact on performance.'),
    '#default_value' => $config
      ->get('make_entities_uncacheable'),
  ];
  $form['default_properties'] = [
    '#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] = [
      '#type' => 'details',
      '#title' => $category,
      '#open' => FALSE,
    ];
    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', [
          '@field_type' => $field_type['label'],
        ]),
        '#description' => $this
          ->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'] = [
      '#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'] = [
      '#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;
}