mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-22 17:02:03 +02:00
Code Issues Projects Releases Wiki Activity

MDL-63915 core_message: mark items that can be removed in MDL-63261

Browse Source
This commit is contained in:
Mark Nelson 2018-12-05 11:17:19 +08:00
parent ee45ecc014
commit 7ece4ca9da
10 changed files with 49 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
message/classes/api.php
View File

@ -151,10 +151,9 @@ class api {
/**
* Handles searching for user in a particular course in the message area.
*
* TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
* For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
* But we are deprecating data_for_messagearea_search_users_in_course external function.
* Followup: MDL-63915
* TODO: This function should be removed once the related web service goes through final deprecation.
* The related web service is data_for_messagearea_search_users_in_course.
* Followup: MDL-63261
*
* @param int $userid The user id doing the searching
* @param int $courseid The id of the course we are searching in
@ -197,10 +196,9 @@ class api {
/**
* Handles searching for user in the message area.
*
* TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
* For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
* But we are deprecating data_for_messagearea_search_users external function.
* Followup: MDL-63915
* TODO: This function should be removed once the related web service goes through final deprecation.
* The related web service is data_for_messagearea_search_users.
* Followup: MDL-63261
*
* @param int $userid The user id doing the searching
* @param string $search The string the user is searching
@ -1022,9 +1020,9 @@ class api {
/**
* Returns the contacts to display in the contacts area.
*
* TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
* For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
* Followup: MDL-63915
* TODO: This function should be removed once the related web service goes through final deprecation.
* The related web service is data_for_messagearea_contacts.
* Followup: MDL-63261
*
* @param int $userid The user id
* @param int $limitfrom
@ -1192,9 +1190,9 @@ class api {
/**
* Returns the messages to display in the message area.
*
* TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
* For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
* Followup: MDL-63915
* TODO: This function should be removed once the related web service goes through final deprecation.
* The related web service is data_for_messagearea_messages.
* Followup: MDL-63261
*
* @param int $userid the current user
* @param int $otheruserid the other user
@ -1273,9 +1271,9 @@ class api {
/**
* Returns the most recent message between two users.
*
* TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
* For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
* Followup: MDL-63915
* TODO: This function should be removed once the related web service goes through final deprecation.
* The related web service is data_for_messagearea_get_most_recent_message.
* Followup: MDL-63261
*
* @param int $userid the current user
* @param int $otheruserid the other user
@ -1318,9 +1316,9 @@ class api {
/**
* Returns the profile information for a contact for a user.
*
* TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
* For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
* Followup: MDL-63915
* TODO: This function should be removed once the related web service goes through final deprecation.
* The related web service is data_for_messagearea_get_profile.
* Followup: MDL-63261
*
* @param int $userid The user id
* @param int $otheruserid The id of the user whose profile we want to view.

16
message/classes/helper.php
View File

@ -37,9 +37,9 @@ class helper {
/**
* Helper function to retrieve the messages between two users
*
* TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
* For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
* Followup: MDL-63915
* TODO: This function should be removed once the related web services go through final deprecation.
* The related web services are data_for_messagearea_messages AND data_for_messagearea_get_most_recent_message.
* Followup: MDL-63261
*
* @param int $userid the current user
* @param int $otheruserid the other user
@ -232,9 +232,9 @@ class helper {
/**
* Helper function to return an array of messages.
*
* TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
* For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
* Followup: MDL-63915
* TODO: This function should be removed once the related web services go through final deprecation.
* The related web services are data_for_messagearea_messages AND data_for_messagearea_get_most_recent_message.
* Followup: MDL-63261
*
* @param int $userid
* @param array $messages
@ -604,6 +604,10 @@ class helper {
/**
* Backwards compatibility formatter, transforming the new output of get_conversations() into the old format.
*
* TODO: This function should be removed once the related web services go through final deprecation.
* The related web services are data_for_messagearea_conversations.
* Followup: MDL-63261
*
* @param array $conversations the array of conversations, which must come from get_conversations().
* @return array the array of conversations, formatted in the legacy style.
*/

3
message/classes/output/messagearea/contact.php
View File

@ -17,6 +17,9 @@
/**
* Contains class used to prepare a contact for display.
*
* TODO: This file should be removed once the related web services go through final deprecation.
* Followup: MDL-63261
*
* @package core_message
* @copyright 2016 Mark Nelson <markn@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

3
message/classes/output/messagearea/contacts.php
View File

@ -17,6 +17,9 @@
/**
* Contains class used to prepare the contacts for display.
*
* TODO: This file should be removed once the related web services go through final deprecation.
* Followup: MDL-63261
*
* @package core_message
* @copyright 2016 Mark Nelson <markn@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

3
message/classes/output/messagearea/message.php
View File

@ -17,6 +17,9 @@
/**
* Contains class used to prepare a message for display.
*
* TODO: This file should be removed once the related web services go through final deprecation.
* Followup: MDL-63261
*
* @package core_message
* @copyright 2016 Mark Nelson <markn@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

3
message/classes/output/messagearea/message_area.php
View File

@ -17,6 +17,9 @@
/**
* Contains class used to prepare the message area for display.
*
* TODO: This file should be removed once the related web services go through final deprecation.
* Followup: MDL-63261
*
* @package core_message
* @copyright 2016 Mark Nelson <markn@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

3
message/classes/output/messagearea/messages.php
View File

@ -17,6 +17,9 @@
/**
* Contains class used to prepare the messages for display.
*
* TODO: This file should be removed once the related web services go through final deprecation.
* Followup: MDL-63261
*
* @package core_message
* @copyright 2016 Mark Nelson <markn@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

3
message/classes/output/messagearea/profile.php
View File

@ -17,6 +17,9 @@
/**
* Contains class used to prepare a profile for display.
*
* TODO: This file should be removed once the related web services go through final deprecation.
* Followup: MDL-63261
*
* @package core_message
* @copyright 2016 Mark Nelson <markn@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

3
message/classes/output/messagearea/user_search_results.php
View File

@ -17,6 +17,9 @@
/**
* Contains class used to display user search results.
*
* TODO: This file should be removed once the related web services go through final deprecation.
* Followup: MDL-63261
*
* @package core_message
* @copyright 2016 Mark Nelson <markn@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

8
message/externallib.php
View File

@ -1250,10 +1250,6 @@ class core_message_external extends external_api {
*
* @deprecated since 3.6
*
* NOTE: We are deprecating this function but not search_users_in_course API function for backwards compatibility
* with messaging UI. But should be removed once new group messaging UI is in place and old messaging UI is removed.
* Followup: MDL-63915
*
* @param int $userid The id of the user who is performing the search
* @param int $courseid The id of the course
* @param string $search The string being searched
@ -1351,10 +1347,6 @@ class core_message_external extends external_api {
*
* @deprecated since 3.6
*
* NOTE: We are deprecating this function but not search_users API function for backwards compatibility
* with messaging UI. But should be removed once new group messaging UI is in place and old messaging UI is removed.
* Followup: MDL-63915
*
* @param int $userid The id of the user who is performing the search
* @param string $search The string being searched
* @param int $limitnum