mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-22 08:55:15 +02:00
Code Issues Projects Releases Wiki Activity

MDL-57407 mod_glossary: Return ratings in external functions

Browse Source
This commit is contained in:
Juan Leyva 2017-07-14 17:52:16 +01:00
parent 26d8bceac2
commit 84c50d1cc4
3 changed files with 108 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
mod/glossary/classes/external.php
View File

@ -486,6 +486,7 @@ class mod_glossary_external extends external_api {
return array(
'count' => $count,
'entries' => $entries,
'ratinginfo' => \core_rating\external\util::get_rating_info($glossary, $context, 'mod_glossary', 'entry', $entries),
'warnings' => $warnings
);
}
@ -502,6 +503,7 @@ class mod_glossary_external extends external_api {
'entries' => new external_multiple_structure(
self::get_entry_return_structure()
),
'ratinginfo' => \core_rating\external\util::external_ratings_structure(),
'warnings' => new external_warnings()
));
}
@ -583,6 +585,7 @@ class mod_glossary_external extends external_api {
return array(
'count' => $count,
'entries' => $entries,
'ratinginfo' => \core_rating\external\util::get_rating_info($glossary, $context, 'mod_glossary', 'entry', $entries),
'warnings' => $warnings
);
}
@ -599,6 +602,7 @@ class mod_glossary_external extends external_api {
'entries' => new external_multiple_structure(
self::get_entry_return_structure()
),
'ratinginfo' => \core_rating\external\util::external_ratings_structure(),
'warnings' => new external_warnings()
));
}
@ -760,6 +764,7 @@ class mod_glossary_external extends external_api {
return array(
'count' => $count,
'entries' => $entries,
'ratinginfo' => \core_rating\external\util::get_rating_info($glossary, $context, 'mod_glossary', 'entry', $entries),
'warnings' => $warnings
);
}
@ -776,6 +781,7 @@ class mod_glossary_external extends external_api {
'entries' => new external_multiple_structure(
self::get_entry_return_structure(true)
),
'ratinginfo' => \core_rating\external\util::external_ratings_structure(),
'warnings' => new external_warnings()
));
}
@ -954,6 +960,7 @@ class mod_glossary_external extends external_api {
return array(
'count' => $count,
'entries' => $entries,
'ratinginfo' => \core_rating\external\util::get_rating_info($glossary, $context, 'mod_glossary', 'entry', $entries),
'warnings' => $warnings
);
}
@ -970,6 +977,7 @@ class mod_glossary_external extends external_api {
'entries' => new external_multiple_structure(
self::get_entry_return_structure()
),
'ratinginfo' => \core_rating\external\util::external_ratings_structure(),
'warnings' => new external_warnings()
));
}
@ -1057,6 +1065,7 @@ class mod_glossary_external extends external_api {
return array(
'count' => $count,
'entries' => $entries,
'ratinginfo' => \core_rating\external\util::get_rating_info($glossary, $context, 'mod_glossary', 'entry', $entries),
'warnings' => $warnings
);
}
@ -1073,6 +1082,7 @@ class mod_glossary_external extends external_api {
'entries' => new external_multiple_structure(
self::get_entry_return_structure()
),
'ratinginfo' => \core_rating\external\util::external_ratings_structure(),
'warnings' => new external_warnings()
));
}
@ -1158,6 +1168,7 @@ class mod_glossary_external extends external_api {
return array(
'count' => $count,
'entries' => $entries,
'ratinginfo' => \core_rating\external\util::get_rating_info($glossary, $context, 'mod_glossary', 'entry', $entries),
'warnings' => $warnings
);
}
@ -1174,6 +1185,7 @@ class mod_glossary_external extends external_api {
'entries' => new external_multiple_structure(
self::get_entry_return_structure()
),
'ratinginfo' => \core_rating\external\util::external_ratings_structure(),
'warnings' => new external_warnings()
));
}
@ -1238,6 +1250,7 @@ class mod_glossary_external extends external_api {
return array(
'count' => $count,
'entries' => $entries,
'ratinginfo' => \core_rating\external\util::get_rating_info($glossary, $context, 'mod_glossary', 'entry', $entries),
'warnings' => $warnings
);
}
@ -1254,6 +1267,7 @@ class mod_glossary_external extends external_api {
'entries' => new external_multiple_structure(
self::get_entry_return_structure()
),
'ratinginfo' => \core_rating\external\util::external_ratings_structure(),
'warnings' => new external_warnings()
));
}
@ -1324,6 +1338,7 @@ class mod_glossary_external extends external_api {
return array(
'count' => $count,
'entries' => $entries,
'ratinginfo' => \core_rating\external\util::get_rating_info($glossary, $context, 'mod_glossary', 'entry', $entries),
'warnings' => $warnings
);
}
@ -1340,6 +1355,7 @@ class mod_glossary_external extends external_api {
'entries' => new external_multiple_structure(
self::get_entry_return_structure()
),
'ratinginfo' => \core_rating\external\util::external_ratings_structure(),
'warnings' => new external_warnings()
));
}
@ -1385,6 +1401,8 @@ class mod_glossary_external extends external_api {
return array(
'entry' => $entry,
'ratinginfo' => \core_rating\external\util::get_rating_info($glossary, $context, 'mod_glossary', 'entry',
array($entry)),
'warnings' => $warnings
);
}
@ -1398,6 +1416,7 @@ class mod_glossary_external extends external_api {
public static function get_entry_by_id_returns() {
return new external_single_structure(array(
'entry' => self::get_entry_return_structure(),
'ratinginfo' => \core_rating\external\util::external_ratings_structure(),
'warnings' => new external_warnings()
));
}

86
mod/glossary/tests/external_test.php
View File

@ -1250,4 +1250,90 @@ class mod_glossary_external_testcase extends externallib_advanced_testcase {
$this->assertEquals('shouldbeanimage.txt', $editorfiles[0]['filename']);
$this->assertEquals('attachment.txt', $attachmentfiles[0]['filename']);
}
/**
* Test get entry including rating information.
*/
public function test_get_entry_rating_information() {
$this->resetAfterTest(true);
global $DB, $CFG;
require_once($CFG->dirroot . '/rating/lib.php');
$this->resetAfterTest(true);
$user1 = self::getDataGenerator()->create_user();
$user2 = self::getDataGenerator()->create_user();
$user3 = self::getDataGenerator()->create_user();
$teacher = self::getDataGenerator()->create_user();
// Create course to add the module.
$course = self::getDataGenerator()->create_course();
$studentrole = $DB->get_record('role', array('shortname' => 'student'));
$teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher'));
$this->getDataGenerator()->enrol_user($user1->id, $course->id, $studentrole->id, 'manual');
$this->getDataGenerator()->enrol_user($user2->id, $course->id, $studentrole->id, 'manual');
$this->getDataGenerator()->enrol_user($user3->id, $course->id, $studentrole->id, 'manual');
$this->getDataGenerator()->enrol_user($teacher->id, $course->id, $teacherrole->id, 'manual');
// Create the glossary and contents.
$record = new stdClass();
$record->course = $course->id;
$record->assessed = RATING_AGGREGATE_AVERAGE;
$scale = $this->getDataGenerator()->create_scale(array('scale' => 'A,B,C,D'));
$record->scale = "-$scale->id";
$glossary = $this->getDataGenerator()->create_module('glossary', $record);
$context = context_module::instance($glossary->cmid);
$gg = $this->getDataGenerator()->get_plugin_generator('mod_glossary');
$entry = $gg->create_content($glossary, array('approved' => 1, 'userid' => $user1->id));
// Rate the entry as user2.
$rating1 = new stdClass();
$rating1->contextid = $context->id;
$rating1->component = 'mod_glossary';
$rating1->ratingarea = 'entry';
$rating1->itemid = $entry->id;
$rating1->rating = 1; // 1 is A.
$rating1->scaleid = "-$scale->id";
$rating1->userid = $user2->id;
$rating1->timecreated = time();
$rating1->timemodified = time();
$rating1->id = $DB->insert_record('rating', $rating1);
// Rate the entry as user3.
$rating2 = new stdClass();
$rating2->contextid = $context->id;
$rating2->component = 'mod_glossary';
$rating2->ratingarea = 'entry';
$rating2->itemid = $entry->id;
$rating2->rating = 3; // 3 is C.
$rating2->scaleid = "-$scale->id";
$rating2->userid = $user3->id;
$rating2->timecreated = time() + 1;
$rating2->timemodified = time() + 1;
$rating2->id = $DB->insert_record('rating', $rating2);
// As student, retrieve ratings information.
$this->setUser($user1);
$result = mod_glossary_external::get_entry_by_id($entry->id);
$result = external_api::clean_returnvalue(mod_glossary_external::get_entry_by_id_returns(), $result);
$this->assertCount(1, $result['ratinginfo']['ratings']);
$this->assertFalse($result['ratinginfo']['ratings'][0]['canviewaggregate']);
$this->assertFalse($result['ratinginfo']['canviewall']);
$this->assertFalse($result['ratinginfo']['ratings'][0]['canrate']);
$this->assertTrue(!isset($result['ratinginfo']['ratings'][0]['count']));
// Now, as teacher, I should see the info correctly.
$this->setUser($teacher);
$result = mod_glossary_external::get_entry_by_id($entry->id);
$result = external_api::clean_returnvalue(mod_glossary_external::get_entry_by_id_returns(), $result);
$this->assertCount(1, $result['ratinginfo']['ratings']);
$this->assertTrue($result['ratinginfo']['ratings'][0]['canviewaggregate']);
$this->assertTrue($result['ratinginfo']['canviewall']);
$this->assertTrue($result['ratinginfo']['ratings'][0]['canrate']);
$this->assertEquals(2, $result['ratinginfo']['ratings'][0]['count']);
$this->assertEquals(2, $result['ratinginfo']['ratings'][0]['aggregate']); // 2 is B, that is the average of A + C.
}
}

3
mod/glossary/upgrade.txt
View File

@ -1,6 +1,9 @@
This files describes API changes in /mod/glossary/*,
information provided here is intended especially for developers.
=== 3.4 ===
* External functions returning entries now return an additional field "ratinginfo" containing the entry rating information.
=== 3.2 ===
* External functions that were returning file information now return the following file fields:
filename, filepath, mimetype, filesize, timemodified and fileurl.