You are here

class FieldEncryptSettingsForm in Field Encryption 8.2

Form builder for the field_encrypt settings admin page.

Hierarchy

Expanded class hierarchy of FieldEncryptSettingsForm

1 string reference to 'FieldEncryptSettingsForm'
field_encrypt.routing.yml in ./field_encrypt.routing.yml
field_encrypt.routing.yml

File

src/Form/FieldEncryptSettingsForm.php, line 14

Namespace

Drupal\field_encrypt\Form
View source
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);
  }

}

Members

Namesort descending 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
FieldEncryptSettingsForm::$fieldTypePluginManager protected property The field type plugin manager.
FieldEncryptSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
FieldEncryptSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
FieldEncryptSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
FieldEncryptSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FieldEncryptSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
FieldEncryptSettingsForm::__construct public function Constructs a new FieldEncryptSettingsForm. Overrides ConfigFormBase::__construct
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.
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.