moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-08 02:16:41 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-43056 tool_uploadcourse: Add capability to upload courses from file

Browse source 
An entrypoint capability has been added that allows accessing the
upload tool. Further relevant capability checks are then performed
depending on the action being taken during the upload process.

Co-authored-by: Marina Glancy <marina@moodle.com>
This commit is contained in:
David Woloszyn 2024-01-31 11:29:33 +11:00
parent f30110b5eb
commit 4807a4dd5f
27 changed files with 717 additions and 53 deletions
Download patch file Download diff file Expand all files Collapse all files

28
lib/enrollib.php
View file

@ -2707,6 +2707,9 @@ abstract class enrol_plugin {
/**
* Check if enrolment plugin is supported in csv course upload.
*
* If supported, plugins are also encouraged to override methods:
* {@see self::fill_enrol_custom_fields()}, {@see self::validate_plugin_data_context()}
*
* @return bool
*/
public function is_csv_upload_supported(): bool {
@ -3485,7 +3488,10 @@ abstract class enrol_plugin {
/**
* Fill custom fields data for a given enrolment plugin.
*
* @param array $enrolmentdata enrolment data.
* For example: resolve linked entities from the idnumbers (cohort, role, group, etc.)
* Also fill the default values that are not specified.
*
* @param array $enrolmentdata enrolment data received in CSV file in tool_uploadcourse
* @param int $courseid Course ID.
* @return array Updated enrolment data with custom fields info.
*/
@ -3514,11 +3520,31 @@ abstract class enrol_plugin {
/**
* Check if plugin custom data is allowed in relevant context.
*
* This is called from the tool_uploadcourse if the plugin supports instance creation in
* upload course ({@see self::is_csv_upload_supported()})
*
* The fallback is to call the edit_instance_validation() but it will be better if the plugins
* implement this method to return better error messages.
*
* @param array $enrolmentdata enrolment data to validate.
* @param int|null $courseid Course ID.
* @return lang_string|null Error
*/
public function validate_plugin_data_context(array $enrolmentdata, ?int $courseid = null) : ?lang_string {
if ($courseid) {
$enrolmentdata += ['courseid' => $courseid, 'id' => 0, 'status' => ENROL_INSTANCE_ENABLED];
$instance = (object)[
'id' => null,
'courseid' => $courseid,
'status' => $enrolmentdata['status'],
'type' => $this->get_name(),
];
$formerrors = $this->edit_instance_validation($enrolmentdata, [], $instance, context_course::instance($courseid));
if (!empty($formerrors)) {
$errors = array_map(fn($key) => "{$key}: {$formerrors[$key]}", array_keys($formerrors));
return new lang_string('errorcannotcreateorupdateenrolment', 'tool_uploadcourse', $errors);
}
}
return null;
}