mirrored from git://git.moodle.org/moodle.git
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'MDL-31681' of https://github.com/Lightwork-Marking/moodle
- Loading branch information
Showing
6 changed files
with
554 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,280 @@ | ||
| <?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/>. | ||
|
|
||
| /** | ||
| * External assign API | ||
| * | ||
| * @package core_grade | ||
| * @since Moodle 2.5 | ||
| * @copyright 2013 Paul Charsley | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| defined('MOODLE_INTERNAL') || die; | ||
|
|
||
| require_once("$CFG->libdir/externallib.php"); | ||
| require_once("$CFG->dirroot/grade/grading/lib.php"); | ||
|
|
||
| /** | ||
| * core grade functions | ||
| */ | ||
| class core_grade_external extends external_api { | ||
|
|
||
| /** | ||
| * Describes the parameters for get_definitions | ||
| * @return external_function_parameters | ||
| * @since Moodle 2.5 | ||
| */ | ||
| public static function get_definitions_parameters () { | ||
| return new external_function_parameters( | ||
| array( | ||
| 'cmids' => new external_multiple_structure( | ||
| new external_value(PARAM_INT, 'course module id'), '1 or more course module ids'), | ||
| 'areaname' => new external_value(PARAM_AREA, 'area name'), | ||
| 'activeonly' => new external_value(PARAM_BOOL, 'Only the active method', VALUE_DEFAULT, 0) | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the definitions for the requested course module ids | ||
| * @param array of ints $cmids | ||
| * @param string $areaname | ||
| * @param boolean $activeonly default is false, if true, only the active method is returned | ||
| * @return array of areas with definitions for each requested course module id | ||
| * @since Moodle 2.5 | ||
| */ | ||
| public static function get_definitions ($cmids, $areaname, $activeonly = false) { | ||
| global $DB, $CFG; | ||
| require_once("$CFG->dirroot/grade/grading/form/lib.php"); | ||
| $params = self::validate_parameters(self::get_definitions_parameters(), | ||
| array('cmids' => $cmids, | ||
| 'areaname' => $areaname, | ||
| 'activeonly' => $activeonly)); | ||
| $warnings = array(); | ||
| $areas = array(); | ||
| foreach ($params['cmids'] as $cmid) { | ||
| $context = context_module::instance($cmid); | ||
| try { | ||
| self::validate_context($context); | ||
| } catch (Exception $e) { | ||
| $warnings[] = array( | ||
| 'item' => 'module', | ||
| 'itemid' => $cmid, | ||
| 'message' => 'No access rights in module context', | ||
| 'warningcode' => '1' | ||
| ); | ||
| continue; | ||
| } | ||
| // Check if the user has managegradingforms capability. | ||
| $isgradingmethodmanager = false; | ||
| if (has_capability('moodle/grade:managegradingforms', $context)) { | ||
| $isgradingmethodmanager = true; | ||
| } | ||
| $module = get_coursemodule_from_id('', $cmid, 0, false, MUST_EXIST); | ||
| $componentname = "mod_".$module->modname; | ||
|
|
||
| // Get the grading manager. | ||
| $gradingmanager = get_grading_manager($context, $componentname, $params['areaname']); | ||
| // Get the controller for each grading method. | ||
| $methods = array(); | ||
| if ($params['activeonly'] == true) { | ||
| $methods[] = $gradingmanager->get_active_method(); | ||
| } else { | ||
| $methods = array_keys($gradingmanager->get_available_methods(false)); | ||
| } | ||
|
|
||
| $area = array(); | ||
| $area['cmid'] = $cmid; | ||
| $area['contextid'] = $context->id; | ||
| $area['component'] = $componentname; | ||
| $area['activemethod'] = $gradingmanager->get_active_method(); | ||
| $area['definitions'] = array(); | ||
|
|
||
| foreach ($methods as $method) { | ||
| $controller = $gradingmanager->get_controller($method); | ||
| $def = $controller->get_definition(true); | ||
| if ($def == false) { | ||
| continue; | ||
| } | ||
| if ($isgradingmethodmanager == false) { | ||
| $isviewable = true; | ||
| if ($def->status != gradingform_controller::DEFINITION_STATUS_READY) { | ||
| $warnings[] = array( | ||
| 'item' => 'module', | ||
| 'itemid' => $cmid, | ||
| 'message' => 'Capability moodle/grade:managegradingforms required to view draft definitions', | ||
| 'warningcode' => '1'); | ||
| $isviewable = false; | ||
| } | ||
| if (!empty($def->options)) { | ||
| $options = json_decode($def->options); | ||
| if (isset ($options->alwaysshowdefinition) | ||
| && $options->alwaysshowdefinition == 0) { | ||
| $warnings[] = array( | ||
| 'item' => 'module', | ||
| 'itemid' => $cmid, | ||
| 'message' => 'Capability moodle/grade:managegradingforms required to preview definition', | ||
| 'warningcode' => '1'); | ||
| $isviewable = false; | ||
| } | ||
| } | ||
| if ($isviewable == false) { | ||
| continue; | ||
| } | ||
| } | ||
| $definition = array(); | ||
| $definition['id'] = $def->id; | ||
| $definition['method'] = $method; | ||
| $definition['name'] = $def->name; | ||
| $definition['description'] = $def->description; | ||
| $definition['descriptionformat'] = $def->descriptionformat; | ||
| $definition['status'] = $def->status; | ||
| $definition['copiedfromid'] = $def->copiedfromid; | ||
| $definition['timecreated'] = $def->timecreated; | ||
| $definition['usercreated'] = $def->usercreated; | ||
| $definition['timemodified'] = $def->timemodified; | ||
| $definition['usermodified'] = $def->usermodified; | ||
| $definition['timecopied'] = $def->timecopied; | ||
| // Format the description text field. | ||
| list($definition['description'], $definition['descriptionformat']) = | ||
| external_format_text($definition['description'], $definition['descriptionformat'], | ||
| $context->id, $componentname, 'description', $def->id); | ||
| $details = $controller->get_external_definition_details(); | ||
| $items = array(); | ||
| foreach ($details as $key => $value) { | ||
| $items[$key] = self::format_text($def->{$key}, $context->id, $componentname, $def->id); | ||
| } | ||
| $definition[$method] = $items; | ||
| $area['definitions'][] = $definition; | ||
| } | ||
| $areas[] = $area; | ||
| } | ||
| $result = array( | ||
| 'areas' => $areas, | ||
| 'warnings' => $warnings | ||
| ); | ||
| return $result; | ||
| } | ||
|
|
||
| /** | ||
| * Recursively processes all elements in an array and runs external_format_text()on | ||
| * all elements which have a text field and associated format field with a key name | ||
| * that ends with the text 'format'. The modified array is returned. | ||
| * @param array $items the array to be processed | ||
| * @param int $contextid | ||
| * @param string $componentname | ||
| * @param int $itemid | ||
| * @see external_format_text in lib/externallib.php | ||
| * @return array the input array with all fields formatted | ||
| */ | ||
| private static function format_text($items, $contextid, $componentname, $itemid) { | ||
| $formatkeys = array(); | ||
| foreach ($items as $key => $value) { | ||
| if (!is_array($value) && substr_compare($key, 'format', -6, 6) === 0) { | ||
| $formatkeys[] = $key; | ||
| } | ||
| } | ||
| foreach ($formatkeys as $formatkey) { | ||
| $descriptionkey = substr($formatkey, 0, -6); | ||
| list($items[$descriptionkey], $items[$formatkey]) = | ||
| external_format_text($items[$descriptionkey], $items[$formatkey], | ||
| $contextid, $componentname, 'description', $itemid); | ||
| } | ||
| foreach ($items as &$value) { | ||
| if (is_array($value)) { | ||
| $value = self::format_text($value, $contextid, $componentname, $itemid); | ||
| } | ||
| } | ||
| return $items; | ||
| } | ||
|
|
||
| /** | ||
| * Creates a grading area | ||
| * @return external_single_structure | ||
| * @since Moodle 2.5 | ||
| */ | ||
| private static function grading_area() { | ||
| return new external_single_structure( | ||
| array ( | ||
| 'cmid' => new external_value(PARAM_INT, 'course module id'), | ||
| 'contextid' => new external_value(PARAM_INT, 'context id'), | ||
| 'component' => new external_value(PARAM_TEXT, 'component name'), | ||
| 'activemethod' => new external_value(PARAM_TEXT, 'active method', VALUE_OPTIONAL), | ||
| 'definitions' => new external_multiple_structure(self::definition(), 'definitions') | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * creates a grading form definition | ||
| * @return external_single_structure | ||
| * @since Moodle 2.5 | ||
| */ | ||
| private static function definition() { | ||
| global $CFG; | ||
| $definition = array(); | ||
| $definition['id'] = new external_value(PARAM_INT, 'definition id'); | ||
| $definition['method'] = new external_value(PARAM_TEXT, 'method'); | ||
| $definition['name'] = new external_value(PARAM_TEXT, 'name'); | ||
| $definition['description'] = new external_value(PARAM_RAW, 'description'); | ||
| $definition['descriptionformat'] = new external_format_value('description'); | ||
| $definition['status'] = new external_value(PARAM_INT, 'status'); | ||
| $definition['copiedfromid'] = new external_value(PARAM_INT, 'copied from id', VALUE_OPTIONAL); | ||
| $definition['timecreated'] = new external_value(PARAM_INT, 'creation time'); | ||
| $definition['usercreated'] = new external_value(PARAM_INT, 'user who created definition'); | ||
| $definition['timemodified'] = new external_value(PARAM_INT, 'last modified time'); | ||
| $definition['usermodified'] = new external_value(PARAM_INT, 'user who modified definition'); | ||
| $definition['timecopied'] = new external_value(PARAM_INT, 'time copied', VALUE_OPTIONAL); | ||
| foreach (self::get_grading_methods() as $method) { | ||
| require_once($CFG->dirroot.'/grade/grading/form/'.$method.'/lib.php'); | ||
| $details = call_user_func('gradingform_'.$method.'_controller::get_external_definition_details'); | ||
| if ($details != null) { | ||
| $items = array(); | ||
| foreach ($details as $key => $value) { | ||
| $details[$key]->required = VALUE_OPTIONAL; | ||
| $items[$key] = $value; | ||
| } | ||
| $definition[$method] = new external_single_structure($items, 'items', VALUE_OPTIONAL); | ||
| } | ||
| } | ||
| return new external_single_structure($definition); | ||
| } | ||
|
|
||
| /** | ||
| * Describes the get_definitions return value | ||
| * @return external_single_structure | ||
| * @since Moodle 2.5 | ||
| */ | ||
| public static function get_definitions_returns() { | ||
| return new external_single_structure( | ||
| array( | ||
| 'areas' => new external_multiple_structure(self::grading_area(), 'list of grading areas'), | ||
| 'warnings' => new external_warnings() | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * @return array of available grading methods | ||
| * @since Moodle 2.5 | ||
| */ | ||
| private static function get_grading_methods() { | ||
| $methods = array_keys(grading_manager::available_methods(false)); | ||
| return $methods; | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.