mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-16 05:54:19 +02:00
Code Issues Projects Releases Wiki Activity

MDL-63303 message: add get_member_info external function

Browse Source
This commit is contained in:
Ryan Wyllie 2018-11-05 15:30:59 +08:00
parent 38004e777f
commit 8350978aa1
3 changed files with 84 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
lib/db/services.php
View File

@ -1105,6 +1105,15 @@ $functions = array(
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
'ajax' => true,
),
'core_message_get_member_info' => array(
'classname' => 'core_message_external',
'methodname' => 'get_member_info',
'classpath' => 'message/externallib.php',
'description' => 'Retrieve a user message profiles',
'type' => 'read',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
'ajax' => true,
),
'core_message_get_unread_conversations_count' => array(
'classname' => 'core_message_external',
'methodname' => 'get_unread_conversations_count',

74
message/externallib.php
View File

@ -3953,4 +3953,78 @@ class core_message_external extends external_api {
public static function unset_favourite_conversations_returns() {
return new external_warnings();
}
/**
* Returns description of method parameters for get_member_info() method.
*
* @return external_function_parameters
*/
public static function get_member_info_parameters() {
return new external_function_parameters(
array(
'referenceuserid' => new external_value(PARAM_INT, 'id of the user'),
'userids' => new external_multiple_structure(
new external_value(PARAM_INT, 'id of members to get')
),
'includecontactrequests' => new external_value(PARAM_BOOL, 'include contact requests in response', VALUE_DEFAULT, false),
'includeprivacyinfo' => new external_value(PARAM_BOOL, 'include privacy info in response', VALUE_DEFAULT, false)
)
);
}
/**
* Returns conversation member info for the supplied users, relative to the supplied referenceuserid.
*
* This is the basic structure used when returning members, and includes information about the relationship between each member
* and the referenceuser, such as a whether the referenceuser has marked the member as a contact, or has blocked them.
*
* @param int $referenceuserid the id of the user which check contact and blocked status.
* @param array $userids
* @return array the array of objects containing member info.
* @throws moodle_exception if messaging is disabled or if the user cannot perform the action.
*/
public static function get_member_info(
int $referenceuserid,
array $userids,
bool $includecontactrequests = false,
bool $includeprivacyinfo = false
) {
global $CFG, $USER;
// All the business logic checks that really shouldn't be in here.
if (empty($CFG->messaging)) {
throw new moodle_exception('disabled', 'message');
}
$params = [
'referenceuserid' => $referenceuserid,
'userids' => $userids,
'includecontactrequests' => $includecontactrequests,
'includeprivacyinfo' => $includeprivacyinfo
];
$params = self::validate_parameters(self::get_member_info_parameters(), $params);
$systemcontext = context_system::instance();
self::validate_context($systemcontext);
if (($USER->id != $referenceuserid) && !has_capability('moodle/site:readallmessages', $systemcontext)) {
throw new moodle_exception('You do not have permission to perform this action.');
}
return \core_message\helper::get_member_info(
$params['referenceuserid'],
$params['userids'],
$params['includecontactrequests'],
$params['includeprivacyinfo']
);
}
/**
* Get member info return description.
*
* @return external_description
*/
public static function get_member_info_returns() {
return new external_multiple_structure(
self::get_conversation_member_structure(true)
);
}
}

2
version.php
View File

@ -29,7 +29,7 @@
defined('MOODLE_INTERNAL') || die();
$version = 2018111301.00; // YYYYMMDD = weekly release date of this DEV branch.
$version = 2018111301.01; // YYYYMMDD = weekly release date of this DEV branch.
// RR = release increments - 00 in DEV branches.
// .XX = incremental changes.