Issue #2975897 by Mile23: Remove usages of @deprecated drupal_set_message()

Author: Mile23

ajax_example/src/Form/Autotextfields.php

@@ -101,7 +101,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
    * {@inheritdoc}
    */
   public function submitForm(array &$form, FormStateInterface $form_state) {
-    drupal_set_message(
+    $this->messenger()->addMessage(
       $this->t('Submit handler: First name: @first_name Last name: @last_name',
         [
           '@first_name' => $form_state->getValue('first_name', 'n/a'),

ajax_example/src/Form/DependentDropdown.php

@@ -161,7 +161,7 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
     switch ($trigger) {
       case 'Submit':
         // Submit: We're done.
-        drupal_set_message($this->t('Your values have been submitted. Instrument family: @family, Instrument: @instrument', [
+        $this->messenger()->addMessage($this->t('Your values have been submitted. Instrument family: @family, Instrument: @instrument', [
           '@family' => $form_state->getValue('instrument_family_dropdown'),
           '@instrument' => $form_state->getValue('instrument_dropdown'),
         ]));

ajax_example/src/Form/DynamicFormSections.php

@@ -172,6 +172,7 @@ public function buildForm(array $form, FormStateInterface $form_state, $nojs = N
    * Reports what values were finally set.
    */
   public function submitForm(array &$form, FormStateInterface $form_state) {
+    $messenger = $this->messenger();
     // This is only executed when a button is pressed, not when the AJAXfield
     // select is changed.
     // Now handle the case of the next, previous, and submit buttons.
@@ -189,10 +190,10 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
         $answer = $form['questions_fieldset']['question']['#title'];
       }
       if ($answer == $this->t('George Washington')) {
-        drupal_set_message($this->t('You got the right answer: @answer', ['@answer' => $answer]));
+        $messenger->addMessage($this->t('You got the right answer: @answer', ['@answer' => $answer]));
       }
       else {
-        drupal_set_message($this->t('Sorry, your answer (@answer) is wrong', ['@answer' => $answer]));
+        $messenger->addMessage($this->t('Sorry, your answer (@answer) is wrong', ['@answer' => $answer]));
       }
       return;
     }

ajax_example/src/Form/EntityAutocomplete.php

@@ -6,6 +6,7 @@
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\Form\FormInterface;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Messenger\MessengerTrait;
 use Drupal\Core\StringTranslation\StringTranslationTrait;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
@@ -17,6 +18,7 @@
 class EntityAutocomplete implements FormInterface, ContainerInjectionInterface {
 
   use StringTranslationTrait;
+  use MessengerTrait;
 
   /**
    * The entity type manager service.
@@ -41,6 +43,7 @@ public static function create(ContainerInterface $container) {
       $container->get('entity_type.manager')
     );
     $form->setStringTranslation($container->get('string_translation'));
+    $form->setMessenger($container->get('messenger'));
     return $form;
   }
 
@@ -120,7 +123,7 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
       $uid = $state_user['target_id'];
       $users[] = $this->entityTypeManager->getStorage('user')->load($uid)->getUsername();
     }
-    drupal_set_message('These are your users: ' . implode(' ', $users));
+    $this->messenger()->addMessage('These are your users: ' . implode(' ', $users));
   }
 
 }

ajax_example/src/Form/Wizard.php

@@ -116,7 +116,7 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
           $value_message .= "$key=$value, ";
         }
       }
-      drupal_set_message($value_message);
+      $this->messenger()->addMessage($value_message);
       $form_state->setRebuild(FALSE);
       // Redirect to #action, else return.
       return;

batch_example/batch_example.module

@@ -107,17 +107,18 @@ function batch_example_op_2($operation_details, &$context) {
  * Batch 'finished' callback used by both batch 1 and batch 2.
  */
 function batch_example_finished($success, $results, $operations) {
+  $messenger = \Drupal::messenger();
   if ($success) {
     // Here we could do something meaningful with the results.
     // We just display the number of nodes we processed...
-    drupal_set_message(t('@count results processed.', ['@count' => count($results)]));
-    drupal_set_message(t('The final result was "%final"', ['%final' => end($results)]));
+    $messenger->addMessage(t('@count results processed.', ['@count' => count($results)]));
+    $messenger->addMessage(t('The final result was "%final"', ['%final' => end($results)]));
   }
   else {
     // An error occurred.
     // $operations contains the operations that remained unprocessed.
     $error_operation = reset($operations);
-    drupal_set_message(
+    $messenger->addMessage(
       t('An error occurred while processing @operation with arguments : @args',
         [
           '@operation' => $error_operation[0],

batch_example/src/Form/BatchExampleForm.php

@@ -75,7 +75,7 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
    */
   public function generateBatch1() {
     $num_operations = 1000;
-    drupal_set_message(t('Creating an array of @num operations', ['@num' => $num_operations]));
+    $this->messenger()->addMessage($this->t('Creating an array of @num operations', ['@num' => $num_operations]));
 
     $operations = [];
     // Set up an operations array with 1000 elements, each doing function

…s/src/functional/BatchExampleWebTest.php …s/src/Functional/BatchExampleWebTest.phpbatch_example/tests/src/functional/BatchExampleWebTest.php renamed to batch_example/tests/src/Functional/BatchExampleWebTest.php batch_example/tests/src/functional/BatchExampleWebTest.php renamed to batch_example/tests/src/Functional/BatchExampleWebTest.php

@@ -7,7 +7,7 @@
 /**
  * Functional tests for the Batch Example module.
  *
- * @group fapi_example
+ * @group batch_example
  *
  * @ingroup batch_example
  */

cache_example/src/Form/CacheExampleForm.php

@@ -64,12 +64,14 @@ public static function create(ContainerInterface $container) {
     // @link https://www.drupal.org/node/2203931.
     // Those services are passed in the $container through the static create
     // method.
-    return new static(
+    $form = new static(
       $container->get('request_stack'),
       $container->get('string_translation'),
       $container->get('current_user'),
       $container->get('cache.default')
     );
+    $form->setMessenger($container->get('messenger'));
+    return $form;
   }
 
   /**
@@ -237,7 +239,7 @@ public function expireFiles($form, &$form_state) {
     $this->cacheBackend->delete('cache_example_files_count');
 
     // Display message to the user.
-    drupal_set_message($this->t('Cached data key "cache_example_files_count" was cleared.'), 'status');
+    $this->messenger()->addMessage($this->t('Cached data key "cache_example_files_count" was cleared.'), 'status');
   }
 
   /**
@@ -262,7 +264,7 @@ public function createExpiringItem($form, &$form_state) {
     // required interval. Also add a tag to it to be able to clear caches more
     // precise.
     $this->cacheBackend->set('cache_example_expiring_item', $expiration_friendly, $expiration, $tags);
-    drupal_set_message($this->t('cache_example_expiring_item was set to expire at %time', ['%time' => $expiration_friendly]));
+    $this->messenger()->addMessage($this->t('cache_example_expiring_item was set to expire at %time', ['%time' => $expiration_friendly]));
   }
 
   /**
@@ -274,14 +276,14 @@ public function cacheClearing($form, &$form_state) {
         // Here we'll remove all cache keys in the 'cache' bin that have
         // expired.
         $this->cacheBackend->garbageCollection();
-        drupal_set_message($this->t('\Drupal::cache()->garbageCollection() was called, removing any expired cache items.'));
+        $this->messenger()->addMessage($this->t('\Drupal::cache()->garbageCollection() was called, removing any expired cache items.'));
         break;
 
       case 'remove_all':
         // This removes all keys in a bin using a super-wildcard. This
         // has nothing to do with expiration. It's just brute-force removal.
         $this->cacheBackend->deleteAll();
-        drupal_set_message($this->t('ALL entries in the "cache" bin were removed with \Drupal::cache()->deleteAll().'));
+        $this->messenger()->addMessage($this->t('ALL entries in the "cache" bin were removed with \Drupal::cache()->deleteAll().'));
         break;
 
       case 'remove_tag':
@@ -291,7 +293,7 @@ public function cacheClearing($form, &$form_state) {
           'cache_example:1',
         ];
         Cache::invalidateTags($tags);
-        drupal_set_message($this->t('Cache entries with the tag "cache_example" set to 1 in the "cache" bin were invalidated with \Drupal\Core\Cache\Cache::invalidateTags($tags).'));
+        $this->messenger()->addMessage($this->t('Cache entries with the tag "cache_example" set to 1 in the "cache" bin were invalidated with \Drupal\Core\Cache\Cache::invalidateTags($tags).'));
         break;
     }
   }

config_entity_example/src/Form/RobotDeleteForm.php

@@ -78,7 +78,7 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
     $this->entity->delete();
 
     // Set a message that the entity was deleted.
-    drupal_set_message($this->t('Robot %label was deleted.', [
+    $this->messenger()->addMessage($this->t('Robot %label was deleted.', [
       '%label' => $this->entity->label(),
     ]));