mirror of
https://github.com/moodle/moodle.git
synced 2025-03-14 12:40:01 +01:00
MDL-50543 mod_lti: New WS mod_lti_get_ltis_by_courses
This commit is contained in:
Juan Leyva
parent
d5ded9e72d
commit
dfcdec1254
@ -1238,6 +1238,7 @@ $services = array(
|
||||
'mod_choice_view_choice',
|
||||
'mod_choice_get_choices_by_courses',
|
||||
'mod_lti_get_tool_launch_data',
|
||||
'mod_lti_get_ltis_by_courses',
|
||||
'mod_imscp_view_imscp',
|
||||
'mod_imscp_get_imscps_by_courses',
|
||||
),
|
||||
|
||||
@ -122,4 +122,153 @@ class mod_lti_external extends external_api {
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Describes the parameters for get_ltis_by_courses.
|
||||
*
|
||||
* @return external_function_parameters
|
||||
* @since Moodle 3.0
|
||||
*/
|
||||
public static function get_ltis_by_courses_parameters() {
|
||||
return new external_function_parameters (
|
||||
array(
|
||||
'courseids' => new external_multiple_structure(
|
||||
new external_value(PARAM_INT, 'course id'), 'Array of course ids', VALUE_DEFAULT, array()
|
||||
),
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of external tools in a provided list of courses,
|
||||
* if no list is provided all external tools that the user can view will be returned.
|
||||
*
|
||||
* @param array $courseids the course ids
|
||||
* @return array the lti details
|
||||
* @since Moodle 3.0
|
||||
*/
|
||||
public static function get_ltis_by_courses($courseids = array()) {
|
||||
global $CFG;
|
||||
|
||||
$returnedltis = array();
|
||||
$warnings = array();
|
||||
|
||||
$params = self::validate_parameters(self::get_ltis_by_courses_parameters(), array('courseids' => $courseids));
|
||||
|
||||
if (empty($params['courseids'])) {
|
||||
$params['courseids'] = array_keys(enrol_get_my_courses());
|
||||
}
|
||||
|
||||
// Ensure there are courseids to loop through.
|
||||
if (!empty($params['courseids'])) {
|
||||
|
||||
list($courses, $warnings) = external_util::validate_courses($params['courseids']);
|
||||
|
||||
// Get the ltis in this course, this function checks users visibility permissions.
|
||||
// We can avoid then additional validate_context calls.
|
||||
$ltis = get_all_instances_in_courses("lti", $courses);
|
||||
|
||||
foreach ($ltis as $lti) {
|
||||
|
||||
$context = context_module::instance($lti->coursemodule);
|
||||
|
||||
// Entry to return.
|
||||
$module = array();
|
||||
|
||||
// First, we return information that any user can see in (or can deduce from) the web interface.
|
||||
$module['id'] = $lti->id;
|
||||
$module['coursemodule'] = $lti->coursemodule;
|
||||
$module['course'] = $lti->course;
|
||||
$module['name'] = external_format_string($lti->name, $context->id);
|
||||
|
||||
$viewablefields = [];
|
||||
if (has_capability('mod/lti:view', $context)) {
|
||||
list($module['intro'], $module['introformat']) =
|
||||
external_format_text($lti->intro, $lti->introformat, $context->id, 'mod_lti', 'intro', $lti->id);
|
||||
|
||||
$viewablefields = array('launchcontainer', 'showtitlelaunch', 'showdescriptionlaunch', 'icon', 'secureicon');
|
||||
}
|
||||
|
||||
// Check additional permissions for returning optional private settings.
|
||||
if (has_capability('moodle/course:manageactivities', $context)) {
|
||||
|
||||
$additionalfields = array('timecreated', 'timemodified', 'typeid', 'toolurl', 'securetoolurl',
|
||||
'instructorchoicesendname', 'instructorchoicesendemailaddr', 'instructorchoiceallowroster',
|
||||
'instructorchoiceallowsetting', 'instructorcustomparameters', 'instructorchoiceacceptgrades', 'grade',
|
||||
'resourcekey', 'password', 'debuglaunch', 'servicesalt', 'visible', 'groupmode', 'groupingid');
|
||||
$viewablefields = array_merge($viewablefields, $additionalfields);
|
||||
|
||||
}
|
||||
|
||||
foreach ($viewablefields as $field) {
|
||||
$module[$field] = $lti->{$field};
|
||||
}
|
||||
|
||||
$returnedltis[] = $module;
|
||||
}
|
||||
}
|
||||
|
||||
$result = array();
|
||||
$result['ltis'] = $returnedltis;
|
||||
$result['warnings'] = $warnings;
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Describes the get_ltis_by_courses return value.
|
||||
*
|
||||
* @return external_single_structure
|
||||
* @since Moodle 3.0
|
||||
*/
|
||||
public static function get_ltis_by_courses_returns() {
|
||||
|
||||
return new external_single_structure(
|
||||
array(
|
||||
'ltis' => new external_multiple_structure(
|
||||
new external_single_structure(
|
||||
array(
|
||||
'id' => new external_value(PARAM_INT, 'External tool id'),
|
||||
'coursemodule' => new external_value(PARAM_INT, 'Course module id'),
|
||||
'course' => new external_value(PARAM_INT, 'Course id'),
|
||||
'name' => new external_value(PARAM_RAW, 'LTI name'),
|
||||
'intro' => new external_value(PARAM_RAW, 'The LTI intro', VALUE_OPTIONAL),
|
||||
'introformat' => new external_format_value('intro', VALUE_OPTIONAL),
|
||||
'timecreated' => new external_value(PARAM_INT, 'Time of creation', VALUE_OPTIONAL),
|
||||
'timemodified' => new external_value(PARAM_INT, 'Time of last modification', VALUE_OPTIONAL),
|
||||
'typeid' => new external_value(PARAM_INT, 'Type id', VALUE_OPTIONAL),
|
||||
'toolurl' => new external_value(PARAM_URL, 'Tool url', VALUE_OPTIONAL),
|
||||
'securetoolurl' => new external_value(PARAM_RAW, 'Secure tool url', VALUE_OPTIONAL),
|
||||
'instructorchoicesendname' => new external_value(PARAM_TEXT, 'Instructor choice send name',
|
||||
VALUE_OPTIONAL),
|
||||
'instructorchoicesendemailaddr' => new external_value(PARAM_INT, 'instructor choice send mail address',
|
||||
VALUE_OPTIONAL),
|
||||
'instructorchoiceallowroster' => new external_value(PARAM_INT, 'Instructor choice allow roster',
|
||||
VALUE_OPTIONAL),
|
||||
'instructorchoiceallowsetting' => new external_value(PARAM_INT, 'Instructor choice allow setting',
|
||||
VALUE_OPTIONAL),
|
||||
'instructorcustomparameters' => new external_value(PARAM_RAW, 'instructor custom parameters',
|
||||
VALUE_OPTIONAL),
|
||||
'instructorchoiceacceptgrades' => new external_value(PARAM_INT, 'instructor choice accept grades',
|
||||
VALUE_OPTIONAL),
|
||||
'grade' => new external_value(PARAM_INT, 'Enable grades', VALUE_OPTIONAL),
|
||||
'launchcontainer' => new external_value(PARAM_INT, 'Launch container mode', VALUE_OPTIONAL),
|
||||
'resourcekey' => new external_value(PARAM_RAW, 'Resource key', VALUE_OPTIONAL),
|
||||
'password' => new external_value(PARAM_RAW, 'Shared secret', VALUE_OPTIONAL),
|
||||
'debuglaunch' => new external_value(PARAM_INT, 'Debug launch', VALUE_OPTIONAL),
|
||||
'showtitlelaunch' => new external_value(PARAM_INT, 'Show title launch', VALUE_OPTIONAL),
|
||||
'showdescriptionlaunch' => new external_value(PARAM_INT, 'Show description launch', VALUE_OPTIONAL),
|
||||
'servicesalt' => new external_value(PARAM_RAW, 'Service salt', VALUE_OPTIONAL),
|
||||
'icon' => new external_value(PARAM_URL, 'Alternative icon URL', VALUE_OPTIONAL),
|
||||
'secureicon' => new external_value(PARAM_URL, 'Secure icon URL', VALUE_OPTIONAL),
|
||||
'section' => new external_value(PARAM_INT, 'course section id', VALUE_OPTIONAL),
|
||||
'visible' => new external_value(PARAM_INT, 'visible', VALUE_OPTIONAL),
|
||||
'groupmode' => new external_value(PARAM_INT, 'group mode', VALUE_OPTIONAL),
|
||||
'groupingid' => new external_value(PARAM_INT, 'group id', VALUE_OPTIONAL),
|
||||
), 'Tool'
|
||||
)
|
||||
),
|
||||
'warnings' => new external_warnings(),
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@ -34,4 +34,12 @@ $functions = array(
|
||||
'capabilities' => 'mod/lti:view'
|
||||
),
|
||||
|
||||
'mod_lti_get_ltis_by_courses' => array(
|
||||
'classname' => 'mod_lti_external',
|
||||
'methodname' => 'get_ltis_by_courses',
|
||||
'description' => 'Returns a list of external tool instances in a provided set of courses, if
|
||||
no courses are provided then all the external tool instances the user has access to will be returned.',
|
||||
'type' => 'read',
|
||||
'capabilities' => 'mod/lti:view'
|
||||
)
|
||||
);
|
||||
|
||||
@ -96,4 +96,124 @@ class mod_lti_external_testcase extends externallib_advanced_testcase {
|
||||
|
||||
}
|
||||
|
||||
/*
|
||||
* Test get ltis by courses
|
||||
*/
|
||||
public function test_mod_lti_get_ltis_by_courses() {
|
||||
global $DB;
|
||||
|
||||
// Create additional course.
|
||||
$course2 = self::getDataGenerator()->create_course();
|
||||
|
||||
// Second lti.
|
||||
$record = new stdClass();
|
||||
$record->course = $course2->id;
|
||||
$lti2 = self::getDataGenerator()->create_module('lti', $record);
|
||||
|
||||
// Execute real Moodle enrolment as we'll call unenrol() method on the instance later.
|
||||
$enrol = enrol_get_plugin('manual');
|
||||
$enrolinstances = enrol_get_instances($course2->id, true);
|
||||
foreach ($enrolinstances as $courseenrolinstance) {
|
||||
if ($courseenrolinstance->enrol == "manual") {
|
||||
$instance2 = $courseenrolinstance;
|
||||
break;
|
||||
}
|
||||
}
|
||||
$enrol->enrol_user($instance2, $this->student->id, $this->studentrole->id);
|
||||
|
||||
self::setUser($this->student);
|
||||
|
||||
$returndescription = mod_lti_external::get_ltis_by_courses_returns();
|
||||
|
||||
// Create what we expect to be returned when querying the two courses.
|
||||
// First for the student user.
|
||||
$expectedfields = array('id', 'coursemodule', 'course', 'name', 'intro', 'introformat', 'launchcontainer',
|
||||
'showtitlelaunch', 'showdescriptionlaunch', 'icon', 'secureicon');
|
||||
|
||||
// Add expected coursemodule and data.
|
||||
$lti1 = $this->lti;
|
||||
$lti1->coursemodule = $lti1->cmid;
|
||||
$lti1->introformat = 1;
|
||||
$lti1->section = 0;
|
||||
$lti1->visible = true;
|
||||
$lti1->groupmode = 0;
|
||||
$lti1->groupingid = 0;
|
||||
|
||||
$lti2->coursemodule = $lti2->cmid;
|
||||
$lti2->introformat = 1;
|
||||
$lti2->section = 0;
|
||||
$lti2->visible = true;
|
||||
$lti2->groupmode = 0;
|
||||
$lti2->groupingid = 0;
|
||||
|
||||
foreach ($expectedfields as $field) {
|
||||
$expected1[$field] = $lti1->{$field};
|
||||
$expected2[$field] = $lti2->{$field};
|
||||
}
|
||||
|
||||
$expectedltis = array($expected2, $expected1);
|
||||
|
||||
// Call the external function passing course ids.
|
||||
$result = mod_lti_external::get_ltis_by_courses(array($course2->id, $this->course->id));
|
||||
$result = external_api::clean_returnvalue($returndescription, $result);
|
||||
|
||||
$this->assertEquals($expectedltis, $result['ltis']);
|
||||
$this->assertCount(0, $result['warnings']);
|
||||
|
||||
// Call the external function without passing course id.
|
||||
$result = mod_lti_external::get_ltis_by_courses();
|
||||
$result = external_api::clean_returnvalue($returndescription, $result);
|
||||
$this->assertEquals($expectedltis, $result['ltis']);
|
||||
$this->assertCount(0, $result['warnings']);
|
||||
|
||||
// Unenrol user from second course and alter expected ltis.
|
||||
$enrol->unenrol_user($instance2, $this->student->id);
|
||||
array_shift($expectedltis);
|
||||
|
||||
// Call the external function without passing course id.
|
||||
$result = mod_lti_external::get_ltis_by_courses();
|
||||
$result = external_api::clean_returnvalue($returndescription, $result);
|
||||
$this->assertEquals($expectedltis, $result['ltis']);
|
||||
|
||||
// Call for the second course we unenrolled the user from, expected warning.
|
||||
$result = mod_lti_external::get_ltis_by_courses(array($course2->id));
|
||||
$this->assertCount(1, $result['warnings']);
|
||||
$this->assertEquals('1', $result['warnings'][0]['warningcode']);
|
||||
$this->assertEquals($course2->id, $result['warnings'][0]['itemid']);
|
||||
|
||||
// Now, try as a teacher for getting all the additional fields.
|
||||
self::setUser($this->teacher);
|
||||
|
||||
$additionalfields = array('timecreated', 'timemodified', 'typeid', 'toolurl', 'securetoolurl',
|
||||
'instructorchoicesendname', 'instructorchoicesendemailaddr', 'instructorchoiceallowroster',
|
||||
'instructorchoiceallowsetting', 'instructorcustomparameters', 'instructorchoiceacceptgrades', 'grade',
|
||||
'resourcekey', 'password', 'debuglaunch', 'servicesalt', 'visible', 'groupmode', 'groupingid');
|
||||
|
||||
foreach ($additionalfields as $field) {
|
||||
$expectedltis[0][$field] = $lti1->{$field};
|
||||
}
|
||||
|
||||
$result = mod_lti_external::get_ltis_by_courses();
|
||||
$result = external_api::clean_returnvalue($returndescription, $result);
|
||||
$this->assertEquals($expectedltis, $result['ltis']);
|
||||
|
||||
// Admin also should get all the information.
|
||||
self::setAdminUser();
|
||||
|
||||
$result = mod_lti_external::get_ltis_by_courses(array($this->course->id));
|
||||
$result = external_api::clean_returnvalue($returndescription, $result);
|
||||
$this->assertEquals($expectedltis, $result['ltis']);
|
||||
|
||||
// Now, prohibit capabilities.
|
||||
$this->setUser($this->student);
|
||||
$contextcourse1 = context_course::instance($this->course->id);
|
||||
// Prohibit capability = mod:lti:view on Course1 for students.
|
||||
assign_capability('mod/lti:view', CAP_PROHIBIT, $this->studentrole->id, $contextcourse1->id);
|
||||
accesslib_clear_all_caches_for_unit_testing();
|
||||
|
||||
$ltis = mod_lti_external::get_ltis_by_courses(array($this->course->id));
|
||||
$ltis = external_api::clean_returnvalue(mod_lti_external::get_ltis_by_courses_returns(), $ltis);
|
||||
$this->assertFalse(isset($ltis['ltis'][0]['intro']));
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@ -48,7 +48,7 @@
|
||||
|
||||
defined('MOODLE_INTERNAL') || die;
|
||||
|
||||
$plugin->version = 2015051101; // The current module version (Date: YYYYMMDDXX).
|
||||
$plugin->version = 2015051102; // The current module version (Date: YYYYMMDDXX).
|
||||
$plugin->requires = 2015050500; // Requires this Moodle version.
|
||||
$plugin->component = 'mod_lti'; // Full name of the plugin (used for diagnostics).
|
||||
$plugin->cron = 0;
|
||||
|
||||
@ -29,7 +29,7 @@
|
||||
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
$version = 2015100200.01; // YYYYMMDD = weekly release date of this DEV branch.
|
||||
$version = 2015100200.02; // YYYYMMDD = weekly release date of this DEV branch.
|
||||
// RR = release increments - 00 in DEV branches.
|
||||
// .XX = incremental changes.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user