From bdfe13c4fd2b87bb03cc25bb3b36bbdeb41e2ad3 Mon Sep 17 00:00:00 2001 From: Paul Holden Date: Tue, 8 Aug 2023 17:20:45 +0100 Subject: [PATCH] MDL-78533 grade: relax param type of itemname in external structures. Ensure it conforms to the same format as allowed for course modules. --- grade/classes/external/get_gradeitems.php | 2 +- grade/report/user/classes/external/user.php | 2 +- grade/upgrade.txt | 3 +++ 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/grade/classes/external/get_gradeitems.php b/grade/classes/external/get_gradeitems.php index 881d00870ce..fde28588c93 100644 --- a/grade/classes/external/get_gradeitems.php +++ b/grade/classes/external/get_gradeitems.php @@ -96,7 +96,7 @@ class get_gradeitems extends external_api { 'gradeItems' => new external_multiple_structure( new external_single_structure([ 'id' => new external_value(PARAM_ALPHANUM, 'An ID for the grade item', VALUE_REQUIRED), - 'itemname' => new external_value(PARAM_TEXT, 'The full name of the grade item', VALUE_REQUIRED), + 'itemname' => new external_value(PARAM_CLEANHTML, 'The full name of the grade item', VALUE_REQUIRED), 'category' => new external_value(PARAM_TEXT, 'The grade category of the grade item', VALUE_OPTIONAL), ]) ), diff --git a/grade/report/user/classes/external/user.php b/grade/report/user/classes/external/user.php index 1a167ae5e62..f5281a8b658 100644 --- a/grade/report/user/classes/external/user.php +++ b/grade/report/user/classes/external/user.php @@ -505,7 +505,7 @@ class user extends external_api { new external_single_structure( [ 'id' => new external_value(PARAM_INT, 'Grade item id'), - 'itemname' => new external_value(PARAM_TEXT, 'Grade item name'), + 'itemname' => new external_value(PARAM_CLEANHTML, 'Grade item name'), 'itemtype' => new external_value(PARAM_ALPHA, 'Grade item type'), 'itemmodule' => new external_value(PARAM_PLUGIN, 'Grade item module'), 'iteminstance' => new external_value(PARAM_INT, 'Grade item instance'), diff --git a/grade/upgrade.txt b/grade/upgrade.txt index dc28280f315..a632d4de052 100644 --- a/grade/upgrade.txt +++ b/grade/upgrade.txt @@ -17,6 +17,9 @@ Information provided here is intended especially for developers. - grade/classes/external/get_groups_for_selector - Has been relocated to core_group_external::get_groups_for_selector() - groupimageurl is now available as an optional parameter to give the user an image either set or generated for the group. +* The grade `itemname` property contained in the return structure of the following external methods is now PARAM_CLEANHTML: + - `core_grades_get_gradeitems` + - `gradereport_user_get_grade_items` * The grade_helper::get_lang_string() function has been deprecated. Please use get_string() instead. === 4.1 ===