You are here

Home » API reference » Field Encryption 3.0.x » DecryptFieldForm.php

class DecryptFieldForm in Field Encryption 3.0.x

Confirmation form for removing encryption on field.

Hierarchy

Expanded class hierarchy of DecryptFieldForm

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

File

src/Form/DecryptFieldForm.php, line 14

Namespace

Drupal\field_encrypt\Form
View source 
class DecryptFieldForm extends ConfirmFormBase {

  /**
   * The entity type.
   *
   * @var string
   */
  protected $entityType;

  /**
   * The field name to decrypt.
   *
   * @var string
   */
  protected $fieldName;

  /**
   * Whether the field is a base field.
   *
   * @var bool
   */
  protected $baseField;

  /**
   * The entity type manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a new FieldEncryptDecryptForm.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager service.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Are you sure you want to remove encryption for field %field on %entity_type?', [
      '%field' => $this->fieldName,
      '%entity_type' => $this->entityType,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return new Url('field_encrypt.field_overview');
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return $this
      ->t('Remove field encryption');
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->t('This action removes field encryption from the specified field. Existing field data will be decrypted through a batch process.');
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $entity_type = NULL, $field_name = NULL, $base_field = FALSE) {
    $this->entityType = $entity_type;
    $this->fieldName = $field_name;
    $this->baseField = (bool) $base_field;
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    if ($this->baseField) {

      /** @var \Drupal\field_encrypt\Entity\FieldEncryptEntityType $field_encrypt_settings */
      $field_encrypt_settings = $this->entityTypeManager
        ->getStorage('field_encrypt_entity_type')
        ->load($this->entityType);
      $field_encrypt_settings
        ->removeBaseField($this->fieldName)
        ->save();
    }
    else {
      $storage = $this->entityTypeManager
        ->getStorage('field_storage_config');
      $field_storage_config = $storage
        ->load($this->entityType . '.' . $this->fieldName);
      $field_storage_config
        ->unsetThirdPartySetting('field_encrypt', 'encrypt');
      $field_storage_config
        ->unsetThirdPartySetting('field_encrypt', 'properties');
      $field_storage_config
        ->save();
    }
    $form_state
      ->setRedirectUrl($this
      ->getCancelUrl());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText 2
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
DecryptFieldForm::$baseField protected property Whether the field is a base field.
DecryptFieldForm::$entityType protected property The entity type.
DecryptFieldForm::$entityTypeManager protected property The entity type manager service.
DecryptFieldForm::$fieldName protected property The field name to decrypt.
DecryptFieldForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
DecryptFieldForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
DecryptFieldForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
DecryptFieldForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
DecryptFieldForm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
DecryptFieldForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
DecryptFieldForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
DecryptFieldForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
DecryptFieldForm::__construct public function Constructs a new FieldEncryptDecryptForm.
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::config protected function Retrieves a configuration object.
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 72
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.