From 57532ad68052c289c28e1d9ebf23b7db34a880ce Mon Sep 17 00:00:00 2001
From: Mark Nelson <markn@moodle.com>
Date: Fri, 12 Apr 2019 14:27:44 +0800
Subject: [PATCH] MDL-65344 core_message: deprecate
 get_individual_conversations_between_users()

---
 message/classes/api.php    | 14 +++++++++++---
 message/tests/api_test.php |  6 ++++++
 message/upgrade.txt        |  5 +++++
 3 files changed, 22 insertions(+), 3 deletions(-)

diff --git a/message/classes/api.php b/message/classes/api.php
index fb3b8e76c59..5e4e98ba573 100644
--- a/message/classes/api.php
+++ b/message/classes/api.php
@@ -2389,10 +2389,14 @@ class api {
     public static function get_conversation_between_users(array $userids) {
         global $DB;
 
-        $conversations = self::get_individual_conversations_between_users([$userids]);
-        $conversation = $conversations[0];
+        if (empty($userids)) {
+            return false;
+        }
 
-        if ($conversation) {
+        $hash = helper::get_conversation_hash($userids);
+
+        if ($conversation = $DB->get_record('message_conversations', ['type' => self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
+                'convhash' => $hash])) {
             return $conversation->id;
         }
 
@@ -2418,12 +2422,16 @@ class api {
      *
      * Where null is returned for the pairing of [3, 4] since no record exists.
      *
+     * @deprecated since 3.8
      * @param array $useridsets An array of arrays where the inner array is the set of user ids
      * @return stdClass[] Array of conversation records
      */
     public static function get_individual_conversations_between_users(array $useridsets) : array {
         global $DB;
 
+        debugging('\core_message\api::get_individual_conversations_between_users is deprecated and no longer used',
+            DEBUG_DEVELOPER);
+
         if (empty($useridsets)) {
             return [];
         }
diff --git a/message/tests/api_test.php b/message/tests/api_test.php
index 4e9f4e09aa0..126ff7ebb7d 100644
--- a/message/tests/api_test.php
+++ b/message/tests/api_test.php
@@ -5666,6 +5666,7 @@ class core_message_api_testcase extends core_message_messagelib_testcase {
      */
     public function test_get_individual_conversations_between_users_no_user_sets() {
         $this->assertEmpty(\core_message\api::get_individual_conversations_between_users([]));
+        $this->assertDebuggingCalled();
     }
 
     /**
@@ -5680,6 +5681,7 @@ class core_message_api_testcase extends core_message_messagelib_testcase {
             [null],
             \core_message\api::get_individual_conversations_between_users([[$user1->id, $user2->id]])
         );
+        $this->assertDebuggingCalled();
     }
 
     /**
@@ -5700,6 +5702,7 @@ class core_message_api_testcase extends core_message_messagelib_testcase {
             [$user2->id, $user3->id],
             [$user1->id, $user3->id]
         ]);
+        $this->assertDebuggingCalled();
 
         $result = array_map(function($result) {
             if ($result) {
@@ -5734,6 +5737,7 @@ class core_message_api_testcase extends core_message_messagelib_testcase {
             [$user2->id, $user3->id],
             [$user1->id, $user3->id]
         ]);
+        $this->assertDebuggingCalled();
 
         $result = array_map(function($result) {
             if ($result) {
@@ -5768,6 +5772,7 @@ class core_message_api_testcase extends core_message_messagelib_testcase {
             [$user2->id, $user3->id],
             [$user1->id, $user3->id]
         ]);
+        $this->assertDebuggingCalled();
 
         $result = array_map(function($result) {
             if ($result) {
@@ -5787,6 +5792,7 @@ class core_message_api_testcase extends core_message_messagelib_testcase {
             [$user1->id, $user2->id],
             [$user1->id, $user3->id]
         ]);
+        $this->assertDebuggingCalled();
 
         $result = array_map(function($result) {
             if ($result) {
diff --git a/message/upgrade.txt b/message/upgrade.txt
index b0142f1d441..041fa20deb9 100644
--- a/message/upgrade.txt
+++ b/message/upgrade.txt
@@ -1,6 +1,11 @@
 This files describes API changes in /message/ messaging system,
 information provided here is intended especially for developers.
 
+=== 3.8 ===
+
+* The following methods have been deprecated and should not be used any more:
+  - \core_message\api::get_individual_conversations_between_users()
+
 === 3.7 ===
 
 * The message/index.php page used to support viewing another user's messages (if you had the right capabilities) by