src/Plugin/Field/FieldWidget/PrivateMessageThreadMemberWidget.php

@@ -5,16 +5,19 @@ namespace Drupal\private_message\Plugin\Field\FieldWidget;
 use Drupal\Component\Utility\Crypt;
 use Drupal\Component\Utility\NestedArray;
 use Drupal\Core\Access\CsrfTokenGenerator;
+use Drupal\Core\Config\Config;
 use Drupal\Core\Config\ConfigFactoryInterface;
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\Field\FieldDefinitionInterface;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Field\Plugin\Field\FieldWidget\EntityReferenceAutocompleteWidget;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\KeyValueStore\KeyValueFactoryInterface;
 use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
 use Drupal\Core\Session\AccountProxyInterface;
 use Drupal\Core\Site\Settings;
 use Drupal\Core\Url;
+use Drupal\user\UserStorageInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\RequestStack;
 
@@ -36,35 +39,42 @@ class PrivateMessageThreadMemberWidget extends EntityReferenceAutocompleteWidget
    *
    * @var \Drupal\Core\Access\CsrfTokenGenerator
    */
-  protected $csrfTokenGenerator;
+  protected CsrfTokenGenerator $csrfTokenGenerator;
 
   /**
    * The current user.
    *
    * @var \Drupal\Core\Session\AccountProxyInterface
    */
-  protected $currentUser;
+  protected AccountProxyInterface $currentUser;
 
   /**
    * The request stack.
    *
    * @var \Symfony\Component\HttpFoundation\RequestStack
    */
-  protected $requestStack;
+  protected RequestStack $requestStack;
+
+  /**
+   * Key-value storage.
+   *
+   * @var \Drupal\Core\KeyValueStore\KeyValueFactoryInterface
+   */
+  protected KeyValueFactoryInterface $keyValue;
 
   /**
    * The user manager service.
    *
    * @var \Drupal\user\UserStorageInterface
    */
-  protected $userManager;
+  protected UserStorageInterface $userManager;
 
   /**
    * The configuration factory.
    *
-   * @var \Drupal\Core\Config\ImmutableConfig
+   * @var \Drupal\Core\Config\Config
    */
-  protected $config;
+  protected Config $config;
 
   /**
    * Constructs a PrivateMessageThreadMemberWidget object.
@@ -85,9 +95,9 @@ class PrivateMessageThreadMemberWidget extends EntityReferenceAutocompleteWidget
    *   The current user.
    * @param \Symfony\Component\HttpFoundation\RequestStack $requestStack
    *   The request stack.
-   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
+   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
    *   The entity type manager service.
-   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
+   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
    *   The configuration factory.
    */
   public function __construct(
@@ -99,22 +109,24 @@ class PrivateMessageThreadMemberWidget extends EntityReferenceAutocompleteWidget
     CsrfTokenGenerator $csrfTokenGenerator,
     AccountProxyInterface $currentUser,
     RequestStack $requestStack,
-    EntityTypeManagerInterface $entityTypeManager,
-    ConfigFactoryInterface $configFactory
+    EntityTypeManagerInterface $entity_type_manager,
+    ConfigFactoryInterface $config_factory,
+    KeyValueFactoryInterface $key_value_factory
   ) {
     parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
 
     $this->csrfTokenGenerator = $csrfTokenGenerator;
     $this->currentUser = $currentUser;
     $this->requestStack = $requestStack;
-    $this->userManager = $entityTypeManager->getStorage('user');
-    $this->config = $configFactory->get('private_message.settings');
+    $this->keyValue = $key_value_factory;
+    $this->userManager = $entity_type_manager->getStorage('user');
+    $this->config = $config_factory->get('private_message.settings');
   }
 
   /**
    * {@inheritdoc}
    */
-  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition): PrivateMessageThreadMemberWidget {
     return new static(
       $plugin_id,
       $plugin_definition,
@@ -125,21 +137,22 @@ class PrivateMessageThreadMemberWidget extends EntityReferenceAutocompleteWidget
       $container->get('current_user'),
       $container->get('request_stack'),
       $container->get('entity_type.manager'),
-      $container->get('config.factory')
+      $container->get('config.factory'),
+      $container->get('keyvalue')
     );
   }
 
   /**
    * {@inheritdoc}
    */
-  public static function isApplicable(FieldDefinitionInterface $field_definition) {
+  public static function isApplicable(FieldDefinitionInterface $field_definition): bool {
     return $field_definition->getFieldStorageDefinition()->getTargetEntityTypeId() == 'private_message_thread' && $field_definition->getFieldStorageDefinition()->getSetting('target_type') == 'user';
   }
 
   /**
    * {@inheritdoc}
    */
-  public static function defaultSettings() {
+  public static function defaultSettings(): array {
     return [
       'max_members' => 0,
     ] + parent::defaultSettings();
@@ -151,7 +164,7 @@ class PrivateMessageThreadMemberWidget extends EntityReferenceAutocompleteWidget
    * The settings summary is returned empty, as the parent settings have no
    * effect on this form.
    */
-  public function settingsSummary() {
+  public function settingsSummary(): array {
     $summary = parent::settingsSummary();
 
     unset($summary[0]);
@@ -164,7 +177,7 @@ class PrivateMessageThreadMemberWidget extends EntityReferenceAutocompleteWidget
   /**
    * {@inheritdoc}
    */
-  public function settingsForm(array $form, FormStateInterface $form_state) {
+  public function settingsForm(array $form, FormStateInterface $form_state): array {
     $form = parent::settingsForm($form, $form_state);
     // This setting has no bearing on this widget, so it is removed.
     unset($form['match_operator']);
@@ -183,7 +196,7 @@ class PrivateMessageThreadMemberWidget extends EntityReferenceAutocompleteWidget
   /**
    * {@inheritdoc}
    */
-  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
+  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state): array {
     $element = parent::formElement($items, $delta, $element, $form, $form_state);
 
     $recipient = FALSE;
@@ -222,7 +235,7 @@ class PrivateMessageThreadMemberWidget extends EntityReferenceAutocompleteWidget
     $data = serialize($selection_settings) . $target_type . $selection_handler;
     $selection_settings_key = Crypt::hmacBase64($data, Settings::getHashSalt());
 
-    $key_value_storage = \Drupal::keyValue('entity_autocomplete');
+    $key_value_storage = $this->keyValue->get('entity_autocomplete');
     if (!$key_value_storage->has($selection_settings_key)) {
       $key_value_storage->set($selection_settings_key, $selection_settings);
     }
@@ -257,7 +270,7 @@ class PrivateMessageThreadMemberWidget extends EntityReferenceAutocompleteWidget
    * created as an unlimited cardinality field, but the widget allows for
    * setting a maximum number of users.
    */
-  public static function validateFormElement(array $element, FormStateInterface $form_state) {
+  public static function validateFormElement(array $element, FormStateInterface $form_state): void {
     $input_exists = FALSE;
     $parents = $element['#parents'];
     array_pop($parents);

src/Plugin/PrivateMessageConfigForm/PrivateMessageConfigFormBase.php

@@ -17,7 +17,7 @@ abstract class PrivateMessageConfigFormBase extends PluginBase implements Privat
    *
    * @var \Drupal\Core\Config\ConfigFactoryInterface
    */
-  protected $configFactory;
+  protected ConfigFactoryInterface $configFactory;
 
   /**
    * Constructs a PrivateMessageForm object.

src/Plugin/Validation/Constraint/PrivateMessageThreadMemberConstraint.php

@@ -23,6 +23,6 @@ class PrivateMessageThreadMemberConstraint extends Constraint {
    *
    * @var string
    */
-  public $userPrivateMessagePermissionError = 'User %user not found';
+  public string $userPrivateMessagePermissionError = 'User %user not found';
 
 }

src/Service/PrivateMessageService.php

@@ -7,6 +7,7 @@ use Drupal\Core\Cache\CacheTagsInvalidatorInterface;
 use Drupal\Core\Config\ConfigFactoryInterface;
 use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
 use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Entity\EntityStorageInterface;
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\Session\AccountProxyInterface;
 use Drupal\Core\Url;
@@ -15,6 +16,7 @@ use Drupal\private_message\Entity\PrivateMessageThreadInterface;
 use Drupal\private_message\Mapper\PrivateMessageMapperInterface;
 use Drupal\user\UserDataInterface;
 use Drupal\user\UserInterface;
+use Drupal\user\UserStorageInterface;
 
 /**
  * The Private Message service for the private message module.
@@ -26,56 +28,56 @@ class PrivateMessageService implements PrivateMessageServiceInterface {
    *
    * @var \Drupal\private_message\Mapper\PrivateMessageMapperInterface
    */
-  protected $mapper;
+  protected PrivateMessageMapperInterface $mapper;
 
   /**
    * The current user.
    *
    * @var \Drupal\Core\Session\AccountProxyInterface
    */
-  protected $currentUser;
+  protected AccountProxyInterface $currentUser;
 
   /**
    * The configuration factory.
    *
    * @var \Drupal\Core\Config\ConfigFactoryInterface
    */
-  protected $configFactory;
+  protected ConfigFactoryInterface $configFactory;
 
   /**
    * The user data service.
    *
    * @var \Drupal\user\UserDataInterface
    */
-  protected $userData;
+  protected UserDataInterface $userData;
 
   /**
    * Cache Tags Invalidator.
    *
    * @var \Drupal\Core\Cache\CacheTagsInvalidatorInterface
    */
-  protected $cacheTagsInvalidator;
+  protected CacheTagsInvalidatorInterface $cacheTagsInvalidator;
 
   /**
    * The private message thread manager.
    *
    * @var \Drupal\Core\Entity\Sql\SqlContentEntityStorage
    */
-  protected $pmThreadManager;
+  protected EntityStorageInterface $pmThreadManager;
 
   /**
    * The user entity manager.
    *
    * @var \Drupal\user\UserStorageInterface
    */
-  protected $userManager;
+  protected UserStorageInterface $userManager;
 
   /**
    * The time service.
    *
    * @var \Drupal\Component\Datetime\TimeInterface
    */
-  protected $time;
+  protected TimeInterface $time;
 
   /**
    * Constructs a PrivateMessageService object.
@@ -112,9 +114,9 @@ class PrivateMessageService implements PrivateMessageServiceInterface {
     $this->configFactory = $configFactory;
     $this->userData = $userData;
     $this->cacheTagsInvalidator = $cacheTagsInvalidator;
+    $this->time = $time;
     $this->pmThreadManager = $entityTypeManager->getStorage('private_message_thread');
     $this->userManager = $entityTypeManager->getStorage('user');
-    $this->time = $time;
   }
 
   /**

src/Service/PrivateMessageServiceInterface.php

@@ -40,7 +40,7 @@ interface PrivateMessageServiceInterface {
   /**
    * Get the most recently updated thread for the given user.
    *
-   * @param \Drupal\user\Entity\UserInterface $user
+   * @param \Drupal\user\UserInterface $user
    *   The user whose most recently updated thread should be retrieved.
    */
   public function getFirstThreadForUser(UserInterface $user);

src/Service/PrivateMessageThreadManager.php

@@ -17,28 +17,28 @@ class PrivateMessageThreadManager implements PrivateMessageThreadManagerInterfac
    *
    * @var \Drupal\private_message\Service\PrivateMessageServiceInterface
    */
-  private $privateMessageService;
+  private PrivateMessageServiceInterface $privateMessageService;
 
   /**
    * The private message.
    *
-   * @var \Drupal\private_message\Entity\PrivateMessageInterface
+   * @var \Drupal\private_message\Entity\PrivateMessageInterface|null
    */
-  private $message;
+  private ?PrivateMessageInterface $message;
 
   /**
    * The message recipients.
    *
    * @var \Drupal\Core\Session\AccountInterface[]
    */
-  private $recipients = [];
+  private array $recipients = [];
 
   /**
    * The private message thread.
    *
    * @var \Drupal\private_message\Entity\PrivateMessageThreadInterface|null
    */
-  private $thread;
+  private ?PrivateMessageThreadInterface $thread;
 
   /**
    * PrivateMessageThreadManager constructor.
@@ -55,7 +55,7 @@ class PrivateMessageThreadManager implements PrivateMessageThreadManagerInterfac
   /**
    * {@inheritdoc}
    */
-  public function saveThread(PrivateMessageInterface $message, array $recipients = [], PrivateMessageThreadInterface $thread = NULL) {
+  public function saveThread(PrivateMessageInterface $message, array $recipients = [], PrivateMessageThreadInterface $thread = NULL): void {
     $this->message = $message;
     $this->thread = $thread;
     $this->recipients = $recipients;
@@ -68,7 +68,7 @@ class PrivateMessageThreadManager implements PrivateMessageThreadManagerInterfac
    *
    * @return $this
    */
-  private function getThread() {
+  private function getThread(): PrivateMessageThreadManagerInterface {
     if (is_null($this->thread)) {
       $this->thread = $this->privateMessageService->getThreadForMembers($this->recipients);
     }
@@ -81,9 +81,11 @@ class PrivateMessageThreadManager implements PrivateMessageThreadManagerInterfac
    *
    * @return $this
    */
-  private function addMessage() {
-    $this->thread->addMessage($this->message);
-    $this->thread->save();
+  private function addMessage(): PrivateMessageThreadManagerInterface {
+    if ($this->thread) {
+      $this->thread->addMessage($this->message);
+      $this->thread->save();
+    }
 
     return $this;
   }

tests/src/Functional/PrivateMessageNotificationTest.php

@@ -39,7 +39,7 @@ class PrivateMessageNotificationTest extends BrowserTestBase {
   /**
    * SetUp the test class.
    */
-  public function setUp() {
+  public function setUp(): void {
     parent::setUp();
     $this->userA = $this->drupalCreateUser([
       'use private messaging system',
@@ -60,16 +60,16 @@ class PrivateMessageNotificationTest extends BrowserTestBase {
     $this->drupalLogin($this->userA);
 
     $this->drupalGet('/private-message/create');
-    $this->assertResponse(200);
-    $this->drupalPostForm(NULL, [
+    $this->assertSession()->statusCodeEquals(200);
+    $this->submitForm([
       'members[0][target_id]' => $this->userB->getDisplayName(),
       'message[0][value]' => $this->getRandomGenerator()->sentences(5),
     ], 'Send');
-    $this->assertResponse(200);
+    $this->assertSession()->statusCodeEquals(200);
 
     $this->drupalLogin($this->userB);
     $this->drupalGet('private-message/create');
-    $this->assertResponse(200);
+    $this->assertSession()->statusCodeEquals(200);
     $this->assertSession()->elementTextContains('css', 'a.private-message-page-link', 1);
   }
 

tests/src/Functional/PrivateMessageSettingsFormTest.php

@@ -20,7 +20,7 @@ class PrivateMessageSettingsFormTest extends BrowserTestBase {
    *
    * @var array
    */
-  public static $modules = ['private_message'];
+  protected static $modules = ['private_message'];
 
   /**
    * The User used for the test.
@@ -39,7 +39,7 @@ class PrivateMessageSettingsFormTest extends BrowserTestBase {
   /**
    * SetUp the test class.
    */
-  public function setUp() {
+  public function setUp(): void {
     parent::setUp();
     $this->user = $this->DrupalCreateUser();
     $this->adminUser = $this->DrupalCreateUser([
@@ -54,11 +54,11 @@ class PrivateMessageSettingsFormTest extends BrowserTestBase {
   public function testSettingsPageExists() {
     $this->drupalLogin($this->user);
     $this->drupalGet('admin/config/private-message/config');
-    $this->assertResponse(403);
+    $this->assertSession()->statusCodeEquals(403);
 
     $this->drupalLogin($this->adminUser);
     $this->drupalGet('admin/config/private-message/config');
-    $this->assertResponse(200);
+    $this->assertSession()->statusCodeEquals(200);
   }
 
   /**
@@ -67,13 +67,11 @@ class PrivateMessageSettingsFormTest extends BrowserTestBase {
   public function testConfigForm() {
     $this->drupalLogin($this->adminUser);
     $this->drupalGet('admin/config/private-message/config');
-    $this->assertResponse(200);
+    $this->assertSession()->statusCodeEquals(200);
 
     // Test form submission.
-    $this->drupalPostForm(NULL, [], t('Save configuration'));
-    $this->assertText(
-      'The configuration options have been saved.'
-    );
+    $this->submitForm([], t('Save configuration'));
+    $this->assertSession()->pageTextContains('The configuration options have been saved.');
   }
 
 }

tests/src/Functional/PrivateMessageThreadMembersTest.php

@@ -46,7 +46,7 @@ class PrivateMessageThreadMembersTest extends BrowserTestBase {
   /**
    * {@inheritdoc}
    */
-  protected function setUp() {
+  protected function setUp(): void {
     parent::setUp();
     $this->userA = $this->drupalCreateUser([
       'use private messaging system',

tests/src/Functional/PrivateMessageUnreadCountTest.php

@@ -21,7 +21,7 @@ class PrivateMessageUnreadCountTest extends BrowserTestBase {
    *
    * @var array
    */
-  public static $modules = ['block', 'private_message'];
+  protected static $modules = ['block', 'private_message'];
 
   /**
    * The first User used for the test.
@@ -40,7 +40,7 @@ class PrivateMessageUnreadCountTest extends BrowserTestBase {
   /**
    * SetUp the test class.
    */
-  public function setUp() {
+  public function setUp(): void {
     parent::setUp();
     $this->userA = $this->drupalCreateUser([
       'use private messaging system',
@@ -61,12 +61,12 @@ class PrivateMessageUnreadCountTest extends BrowserTestBase {
     $this->drupalLogin($this->userA);
 
     $this->drupalGet('/private-message/create');
-    $this->assertResponse(200);
-    $this->drupalPostForm(NULL, [
+    $this->assertSession()->statusCodeEquals(200);
+    $this->submitForm([
       'members[0][target_id]' => $this->userB->getDisplayName(),
       'message[0][value]' => $this->getRandomGenerator()->sentences(5),
     ], 'Send');
-    $this->assertResponse(200);
+    $this->assertSession()->statusCodeEquals(200);
     // I should not see a notification for my own message.
     $this->assertSession()->elementTextContains('css', 'a.private-message-page-link', 0);
     // When going to a different page, I should still not see a notification for
@@ -80,14 +80,14 @@ class PrivateMessageUnreadCountTest extends BrowserTestBase {
 
     // We visit the thread directly.
     $this->drupalGet('private-messages/1');
-    $this->assertResponse(200);
+    $this->assertSession()->statusCodeEquals(200);
     $this->assertSession()->elementTextContains('css', 'a.private-message-page-link', 0);
 
     // We are not already looking at the thread.
-    $this->drupalPostForm(NULL, [
+    $this->submitForm([
       'message[0][value]' => $this->getRandomGenerator()->sentences(5),
     ], 'Send');
-    $this->assertResponse(200);
+    $this->assertSession()->statusCodeEquals(200);
     // I should not see a notification for my own message.
     $this->assertSession()->elementTextContains('css', 'a.private-message-page-link', 0);