Skip to content

Commit

Permalink
MDL-65212 course: Return custom fields in WS
Browse files Browse the repository at this point in the history 
External function core_course_external::get_courses_by_field was not returning custom course fields.
  • Loading branch information
@jleyva
jleyva committed Apr 30, 2019
1 parent 14cdf51 commit bfae6ca
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 11 deletions.
14 changes: 14 additions & 0 deletions course/externallib.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2463,6 +2463,20 @@ protected static function get_course_public_information(core_course_list_element
$coursereturns['contacts'] = $coursecontacts;
$coursereturns['enrollmentmethods'] = $enroltypes;
$coursereturns['sortorder'] = $course->sortorder;

$handler = core_course\customfield\course_handler::create();
if ($customfields = $handler->export_instance_data($course->id)) {
$coursereturns['customfields'] = [];
foreach ($customfields as $data) {
$coursereturns['customfields'][] = [
'type' => $data->get_type(),
'value' => $data->get_value(),
'name' => $data->get_name(),
'shortname' => $data->get_shortname()
];
}
}

return $coursereturns;
}

Expand Down
31 changes: 20 additions & 11 deletions course/tests/externallib_test.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2370,7 +2370,13 @@ public function test_get_courses_by_field() {
$category2 = self::getDataGenerator()->create_category(array('parent' => $category1->id));
$course1 = self::getDataGenerator()->create_course(
array('category' => $category1->id, 'shortname' => 'c1', 'format' => 'topics'));
$course2 = self::getDataGenerator()->create_course(array('visible' => 0, 'category' => $category2->id, 'idnumber' => 'i2'));

$fieldcategory = self::getDataGenerator()->create_custom_field_category(['name' => 'Other fields']);
$customfield = ['shortname' => 'test', 'name' => 'Custom field', 'type' => 'text',
'categoryid' => $fieldcategory->get('id')];
$field = self::getDataGenerator()->create_custom_field($customfield);
$customfieldvalue = ['shortname' => 'test', 'value' => 'Test value'];
$course2 = self::getDataGenerator()->create_course(array('visible' => 0, 'category' => $category2->id, 'idnumber' => 'i2', 'customfields' => [$customfieldvalue]));

$student1 = self::getDataGenerator()->create_user();
$user1 = self::getDataGenerator()->create_user();
Expand All @@ -2384,16 +2390,16 @@ public function test_get_courses_by_field() {
$result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
$this->assertCount(3, $result['courses']);
// Expect to receive all the fields.
$this->assertCount(37, $result['courses'][0]);
$this->assertCount(38, $result['courses'][1]); // One more field because is not the site course.
$this->assertCount(38, $result['courses'][2]); // One more field because is not the site course.
$this->assertCount(38, $result['courses'][0]);
$this->assertCount(39, $result['courses'][1]); // One more field because is not the site course.
$this->assertCount(39, $result['courses'][2]); // One more field because is not the site course.

$result = core_course_external::get_courses_by_field('id', $course1->id);
$result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
$this->assertCount(1, $result['courses']);
$this->assertEquals($course1->id, $result['courses'][0]['id']);
// Expect to receive all the fields.
$this->assertCount(38, $result['courses'][0]);
$this->assertCount(39, $result['courses'][0]);
// Check default values for course format topics.
$this->assertCount(2, $result['courses'][0]['courseformatoptions']);
foreach ($result['courses'][0]['courseformatoptions'] as $option) {
Expand All @@ -2409,6 +2415,9 @@ public function test_get_courses_by_field() {
$result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
$this->assertCount(1, $result['courses']);
$this->assertEquals($course2->id, $result['courses'][0]['id']);
// Check custom fields properly returned.
unset($customfield['categoryid']);
$this->assertEquals([array_merge($customfield, $customfieldvalue)], $result['courses'][0]['customfields']);

$result = core_course_external::get_courses_by_field('ids', "$course1->id,$course2->id");
$result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
Expand Down Expand Up @@ -2446,15 +2455,15 @@ public function test_get_courses_by_field() {
$result = core_course_external::get_courses_by_field();
$result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
$this->assertCount(2, $result['courses']);
$this->assertCount(30, $result['courses'][0]);
$this->assertCount(31, $result['courses'][1]); // One field more (course format options), not present in site course.
$this->assertCount(31, $result['courses'][0]);
$this->assertCount(32, $result['courses'][1]); // One field more (course format options), not present in site course.

$result = core_course_external::get_courses_by_field('id', $course1->id);
$result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
$this->assertCount(1, $result['courses']);
$this->assertEquals($course1->id, $result['courses'][0]['id']);
// Expect to receive all the files that a student can see.
$this->assertCount(31, $result['courses'][0]);
$this->assertCount(32, $result['courses'][0]);

// Check default filters.
$filters = $result['courses'][0]['filters'];
Expand Down Expand Up @@ -2499,15 +2508,15 @@ public function test_get_courses_by_field() {
$result = core_course_external::get_courses_by_field();
$result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
$this->assertCount(2, $result['courses']);
$this->assertCount(30, $result['courses'][0]); // Site course.
$this->assertCount(13, $result['courses'][1]); // Only public information, not enrolled.
$this->assertCount(31, $result['courses'][0]); // Site course.
$this->assertCount(14, $result['courses'][1]); // Only public information, not enrolled.

$result = core_course_external::get_courses_by_field('id', $course1->id);
$result = external_api::clean_returnvalue(core_course_external::get_courses_by_field_returns(), $result);
$this->assertCount(1, $result['courses']);
$this->assertEquals($course1->id, $result['courses'][0]['id']);
// Expect to receive all the files that a authenticated can see.
$this->assertCount(13, $result['courses'][0]);
$this->assertCount(14, $result['courses'][0]);

// Course 2 is not visible.
$result = core_course_external::get_courses_by_field('id', $course2->id);
Expand Down

0 comments on commit bfae6ca

Please sign in to comment.