Your IP : 3.144.224.116
<?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/>.
/**
* Core grades external functions
*
* @package core_grades
* @copyright 2012 Andrew Davis
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.7
*/
defined('MOODLE_INTERNAL') || die;
require_once("$CFG->libdir/externallib.php");
require_once("$CFG->libdir/gradelib.php");
require_once("$CFG->dirroot/grade/edit/tree/lib.php");
require_once("$CFG->dirroot/grade/querylib.php");
/**
* core grades functions
*/
class core_grades_external extends external_api {
/**
* Returns description of method parameters
*
* @return external_function_parameters
* @since Moodle 2.7
*/
public static function update_grades_parameters() {
return new external_function_parameters(
array(
'source' => new external_value(PARAM_TEXT, 'The source of the grade update'),
'courseid' => new external_value(PARAM_INT, 'id of course'),
'component' => new external_value(PARAM_COMPONENT, 'A component, for example mod_forum or mod_quiz'),
'activityid' => new external_value(PARAM_INT, 'The activity ID'),
'itemnumber' => new external_value(
PARAM_INT, 'grade item ID number for modules that have multiple grades. Typically this is 0.'),
'grades' => new external_multiple_structure(
new external_single_structure(
array(
'studentid' => new external_value(PARAM_INT, 'Student ID'),
'grade' => new external_value(PARAM_FLOAT, 'Student grade'),
'str_feedback' => new external_value(
PARAM_TEXT, 'A string representation of the feedback from the grader', VALUE_OPTIONAL),
)
), 'Any student grades to alter', VALUE_DEFAULT, array()),
'itemdetails' => new external_single_structure(
array(
'itemname' => new external_value(
PARAM_ALPHANUMEXT, 'The grade item name', VALUE_OPTIONAL),
'idnumber' => new external_value(
PARAM_INT, 'Arbitrary ID provided by the module responsible for the grade item', VALUE_OPTIONAL),
'gradetype' => new external_value(
PARAM_INT, 'The type of grade (0 = none, 1 = value, 2 = scale, 3 = text)', VALUE_OPTIONAL),
'grademax' => new external_value(
PARAM_FLOAT, 'Maximum grade allowed', VALUE_OPTIONAL),
'grademin' => new external_value(
PARAM_FLOAT, 'Minimum grade allowed', VALUE_OPTIONAL),
'scaleid' => new external_value(
PARAM_INT, 'The ID of the custom scale being is used', VALUE_OPTIONAL),
'multfactor' => new external_value(
PARAM_FLOAT, 'Multiply all grades by this number', VALUE_OPTIONAL),
'plusfactor' => new external_value(
PARAM_FLOAT, 'Add this to all grades', VALUE_OPTIONAL),
'deleted' => new external_value(
PARAM_BOOL, 'True if the grade item should be deleted', VALUE_OPTIONAL),
'hidden' => new external_value(
PARAM_BOOL, 'True if the grade item is hidden', VALUE_OPTIONAL),
), 'Any grade item settings to alter', VALUE_DEFAULT, array()
)
)
);
}
/**
* Update a grade item and, optionally, student grades
*
* @param string $source The source of the grade update
* @param int $courseid The course id
* @param string $component Component name
* @param int $activityid The activity id
* @param int $itemnumber The item number
* @param array $grades Array of grades
* @param array $itemdetails Array of item details
* @return int A status flag
* @since Moodle 2.7
*/
public static function update_grades($source, $courseid, $component, $activityid,
$itemnumber, $grades = array(), $itemdetails = array()) {
global $CFG;
$params = self::validate_parameters(
self::update_grades_parameters(),
array(
'source' => $source,
'courseid' => $courseid,
'component' => $component,
'activityid' => $activityid,
'itemnumber' => $itemnumber,
'grades' => $grades,
'itemdetails' => $itemdetails
)
);
list($itemtype, $itemmodule) = normalize_component($params['component']);
if (! $cm = get_coursemodule_from_id($itemmodule, $activityid)) {
throw new moodle_exception('invalidcoursemodule');
}
$iteminstance = $cm->instance;
$coursecontext = context_course::instance($params['courseid']);
try {
self::validate_context($coursecontext);
} catch (Exception $e) {
$exceptionparam = new stdClass();
$exceptionparam->message = $e->getMessage();
$exceptionparam->courseid = $params['courseid'];
throw new moodle_exception('errorcoursecontextnotvalid' , 'webservice', '', $exceptionparam);
}
$hidinggrades = false;
$editinggradeitem = false;
$editinggrades = false;
$gradestructure = array();
foreach ($grades as $grade) {
$editinggrades = true;
$gradestructure[ $grade['studentid'] ] = array('userid' => $grade['studentid'], 'rawgrade' => $grade['grade']);
}
if (!empty($params['itemdetails'])) {
if (isset($params['itemdetails']['hidden'])) {
$hidinggrades = true;
} else {
$editinggradeitem = true;
}
}
if ($editinggradeitem && !has_capability('moodle/grade:manage', $coursecontext)) {
throw new moodle_exception('nopermissiontoviewgrades', 'error', '', null,
'moodle/grade:manage required to edit grade information');
}
if ($hidinggrades && !has_capability('moodle/grade:hide', $coursecontext) &&
!has_capability('moodle/grade:hide', $coursecontext)) {
throw new moodle_exception('nopermissiontoviewgrades', 'error', '', null,
'moodle/grade:hide required to hide grade items');
}
if ($editinggrades && !has_capability('moodle/grade:edit', $coursecontext)) {
throw new moodle_exception('nopermissiontoviewgrades', 'error', '', null,
'moodle/grade:edit required to edit grades');
}
return grade_update($params['source'], $params['courseid'], $itemtype,
$itemmodule, $iteminstance, $itemnumber, $gradestructure, $params['itemdetails'], true);
}
/**
* Returns description of method result value
*
* @return external_description
* @since Moodle 2.7
*/
public static function update_grades_returns() {
return new external_value(
PARAM_INT,
'A value like ' . GRADE_UPDATE_OK . ' => OK, ' . GRADE_UPDATE_FAILED . ' => FAILED
as defined in lib/grade/constants.php'
);
}
/**
* Returns description of method parameters
*
* @deprecated since Moodle 3.11 MDL-71031 - please do not use this function any more.
* @todo MDL-71325 This will be deleted in Moodle 4.3.
* @see core_grades\external\create_gradecategories::create_gradecategories()
*
* @return external_function_parameters
* @since Moodle 3.10
*/
public static function create_gradecategory_parameters() {
return new external_function_parameters(
[
'courseid' => new external_value(PARAM_INT, 'id of course', VALUE_REQUIRED),
'fullname' => new external_value(PARAM_TEXT, 'fullname of category', VALUE_REQUIRED),
'options' => new external_single_structure([
'aggregation' => new external_value(PARAM_INT, 'aggregation method', VALUE_OPTIONAL),
'aggregateonlygraded' => new external_value(PARAM_BOOL, 'exclude empty grades', VALUE_OPTIONAL),
'aggregateoutcomes' => new external_value(PARAM_BOOL, 'aggregate outcomes', VALUE_OPTIONAL),
'droplow' => new external_value(PARAM_INT, 'drop low grades', VALUE_OPTIONAL),
'itemname' => new external_value(PARAM_TEXT, 'the category total name', VALUE_OPTIONAL),
'iteminfo' => new external_value(PARAM_TEXT, 'the category iteminfo', VALUE_OPTIONAL),
'idnumber' => new external_value(PARAM_TEXT, 'the category idnumber', VALUE_OPTIONAL),
'gradetype' => new external_value(PARAM_INT, 'the grade type', VALUE_OPTIONAL),
'grademax' => new external_value(PARAM_INT, 'the grade max', VALUE_OPTIONAL),
'grademin' => new external_value(PARAM_INT, 'the grade min', VALUE_OPTIONAL),
'gradepass' => new external_value(PARAM_INT, 'the grade to pass', VALUE_OPTIONAL),
'display' => new external_value(PARAM_INT, 'the display type', VALUE_OPTIONAL),
'decimals' => new external_value(PARAM_INT, 'the decimal count', VALUE_OPTIONAL),
'hiddenuntil' => new external_value(PARAM_INT, 'grades hidden until', VALUE_OPTIONAL),
'locktime' => new external_value(PARAM_INT, 'lock grades after', VALUE_OPTIONAL),
'weightoverride' => new external_value(PARAM_BOOL, 'weight adjusted', VALUE_OPTIONAL),
'aggregationcoef2' => new external_value(PARAM_RAW, 'weight coefficient', VALUE_OPTIONAL),
'parentcategoryid' => new external_value(PARAM_INT, 'The parent category id', VALUE_OPTIONAL),
'parentcategoryidnumber' => new external_value(PARAM_TEXT, 'the parent category idnumber', VALUE_OPTIONAL),
], 'optional category data', VALUE_DEFAULT, [])
]
);
}
/**
* Creates a gradecategory inside of the specified course.
*
* @deprecated since Moodle 3.11 MDL-71031 - please do not use this function any more.
* @todo MDL-71325 This will be deleted in Moodle 4.3.
* @see core_grades\external\create_gradecategories::create_gradecategories()
*
* @param int $courseid the courseid to create the gradecategory in.
* @param string $fullname the fullname of the grade category to create.
* @param array $options array of options to set.
*
* @return array array of created categoryid and warnings.
*/
public static function create_gradecategory(int $courseid, string $fullname, array $options) {
global $CFG, $DB;
$params = self::validate_parameters(self::create_gradecategory_parameters(),
['courseid' => $courseid, 'fullname' => $fullname, 'options' => $options]);
// Now params are validated, update the references.
$courseid = $params['courseid'];
$fullname = $params['fullname'];
$options = $params['options'];
// Check that the context and permissions are OK.
$context = context_course::instance($courseid);
self::validate_context($context);
require_capability('moodle/grade:manage', $context);
$categories = [];
$categories[] = ['fullname' => $fullname, 'options' => $options];
// Call through to webservice class for multiple creations,
// Where the majority of the this functionality moved with the deprecation of this function.
$result = \core_grades\external\create_gradecategories::create_gradecategories_from_data($courseid, $categories);
return['categoryid' => $result['categoryids'][0], 'warnings' => []];
}
/**
* Returns description of method result value
*
* @deprecated since Moodle 3.11 MDL-71031 - please do not use this function any more.
* @todo MDL-71325 This will be deleted in Moodle 4.3.
* @see core_grades\external\create_gradecategories::create_gradecategories()
*
* @return external_description
* @since Moodle 3.10
*/
public static function create_gradecategory_returns() {
return new external_single_structure([
'categoryid' => new external_value(PARAM_INT, 'The ID of the created category', VALUE_OPTIONAL),
'warnings' => new external_warnings(),
]);
}
/**
* Marking the method as deprecated. See MDL-71031 for details.
* @since Moodle 3.11
* @return bool
*/
public static function create_gradecategory_is_deprecated() {
return true;
}
}