You are here

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

class UpdateEncryptionProfileForm in Field Encryption 3.0.x

Confirmation form for updating encryption on an entity.

Hierarchy

Expanded class hierarchy of UpdateEncryptionProfileForm

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

File

src/Form/UpdateEncryptionProfileForm.php, line 17

Namespace

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

  /**
   * The entity type.
   *
   * @var \Drupal\Core\Entity\EntityType
   */
  protected $entityType;

  /**
   * The encryption profile.
   *
   * @var \Drupal\encrypt\Entity\EncryptionProfile
   */
  protected $encryptionProfile;

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

  /**
   * The queue.
   *
   * @var \Drupal\Core\Queue\QueueInterface
   */
  protected $queue;

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

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

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    $default_encryption_profile = $this->entityTypeManager
      ->getStorage('encryption_profile')
      ->load($this
      ->config('field_encrypt.settings')
      ->get('encryption_profile'));
    return $this
      ->t('Are you sure you want to update the encryption profile from %from to %to for %entity_type_plural?', [
      '%from' => $this->encryptionProfile
        ->label(),
      '%to' => $default_encryption_profile
        ->label(),
      '%entity_type_plural' => $this->entityType
        ->getPluralLabel(),
    ]);
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->t('Existing entities will be updated through a batch process.');
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $entity_type = NULL, EncryptionProfile $encryption_profile = NULL) {
    $this->entityType = $this->entityTypeManager
      ->getDefinition($entity_type);
    $this->encryptionProfile = $encryption_profile;
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Get entities that need updating.
    $query = $this->entityTypeManager
      ->getStorage($this->entityType
      ->id())
      ->getQuery();
    $query
      ->condition(ProcessEntities::ENCRYPTED_FIELD_STORAGE_NAME . '.encryption_profile', $this->encryptionProfile
      ->id());

    // Make sure to get all revisions for revisionable entities.
    if ($this->entityType
      ->isRevisionable()) {
      $query
        ->allRevisions();
    }
    $entity_ids = $query
      ->execute();
    if (!empty($entity_ids)) {

      // Call the Queue API and add items for processing.
      $data = [
        'entity_type' => $this->entityType
          ->id(),
      ];
      foreach (array_keys($entity_ids) as $entity_id) {
        $data['entity_id'] = $entity_id;
        $this->queue
          ->createItem($data);
      }
    }
    $this
      ->messenger()
      ->addStatus($this
      ->formatPlural(count($entity_ids), 'Queued one %entity_type update. You should immediately <a href=":url">run this process manually</a>. Alternatively, the update will be performed automatically by cron.', 'Queued @count @entity_type updates. You should immediately <a href=":url">run this process manually</a>. Alternatively, the updates will be performed automatically by cron.', [
      '@entity_type' => $this->entityType
        ->getSingularLabel(),
      ':url' => Url::fromRoute('field_encrypt.process_queue')
        ->toString(),
    ]));
    $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
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.
UpdateEncryptionProfileForm::$encryptionProfile protected property The encryption profile.
UpdateEncryptionProfileForm::$entityType protected property The entity type.
UpdateEncryptionProfileForm::$entityTypeManager protected property The entity type manager service.
UpdateEncryptionProfileForm::$queue protected property The queue.
UpdateEncryptionProfileForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
UpdateEncryptionProfileForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
UpdateEncryptionProfileForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
UpdateEncryptionProfileForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
UpdateEncryptionProfileForm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
UpdateEncryptionProfileForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
UpdateEncryptionProfileForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
UpdateEncryptionProfileForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
UpdateEncryptionProfileForm::__construct public function Constructs a new FieldEncryptDecryptForm.