Merge branch 'MDL-77585-master' of https://github.com/jleyva/moodle

This commit is contained in:
Ilya Tregubov 2023-04-12 17:24:22 +08:00
commit 99e2c31f3a
3 changed files with 100 additions and 1 deletions

View File

@ -0,0 +1,92 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
namespace gradereport_user\external;
use context_course;
use core_external\external_api;
use core_external\external_function_parameters;
use core_external\external_single_structure;
use core_external\external_value;
use core_external\external_warnings;
use stdClass;
/**
* External grade report API implementation
*
* @package gradereport_user
* @copyright 2023 Juan Leyva <juan@moodle.com>
* @category external
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class get_access_information extends external_api {
/**
* Returns description of method parameters.
*
* @return external_function_parameters.
* @since Moodle 4.2
*/
public static function execute_parameters(): external_function_parameters {
return new external_function_parameters(
[
'courseid' => new external_value(PARAM_INT, 'Course to check.'),
]
);
}
/**
* Convenience function to retrieve some permissions information for the given course grade report.
*
* @param int $courseid Course to check, empty for site.
* @return array The access information
* @since Moodle 4.2
*/
public static function execute(int $courseid): array {
$params = self::validate_parameters(self::execute_parameters(), ['courseid' => $courseid]);
$context = context_course::instance($params['courseid']);
self::validate_context($context);
return [
'canviewusergradereport' => has_capability('gradereport/user:view', $context),
'canviewmygrades' => has_capability('moodle/grade:view', $context),
'canviewallgrades' => has_capability('moodle/grade:viewall', $context),
'warnings' => [],
];
}
/**
* Returns description of method result value.
*
* @return external_single_structure.
* @since Moodle 4.2
*/
public static function execute_returns(): external_single_structure {
return new external_single_structure(
[
'canviewusergradereport' => new external_value(PARAM_BOOL, 'Whether the user can view the user grade report.'),
'canviewmygrades' => new external_value(PARAM_BOOL, 'Whether the user can view his grades in the course.'),
'canviewallgrades' => new external_value(PARAM_BOOL, 'Whether the user can view all users grades in the course.'),
'warnings' => new external_warnings(),
]
);
}
}

View File

@ -49,4 +49,11 @@ $functions = [
'capabilities' => 'gradereport/user:view',
'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE],
],
'gradereport_user_get_access_information' => [
'classname' => 'gradereport_user\external\get_access_information',
'methodname' => 'execute',
'description' => 'Returns user access information for the user grade report.',
'type' => 'read',
'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE],
],
];

View File

@ -24,6 +24,6 @@
defined('MOODLE_INTERNAL') || die();
$plugin->version = 2022112800; // The current plugin version (Date: YYYYMMDDXX).
$plugin->version = 2022112801; // The current plugin version (Date: YYYYMMDDXX).
$plugin->requires = 2022111800; // Requires this Moodle version.
$plugin->component = 'gradereport_user'; // Full name of the plugin (used for diagnostics)