mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-03-14 04:30:15 +01:00
Code Issues Projects Releases Wiki Activity

Merge branch 'MDL-50542-master' of git://github.com/jleyva/moodle

Browse Source
This commit is contained in:
Dan Poltawski 2017-01-17 07:32:38 +00:00
commit 5bd052f809
4 changed files with 341 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

140
mod/label/classes/external.php Normal file
View File

@ -0,0 +1,140 @@
<?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/>.
/**
* Label external API
*
* @package mod_label
* @category external
* @copyright 2017 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.3
*/
defined('MOODLE_INTERNAL') || die;
require_once("$CFG->libdir/externallib.php");
/**
* Label external functions
*
* @package mod_label
* @category external
* @copyright 2017 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.3
*/
class mod_label_external extends external_api {
/**
* Describes the parameters for get_labels_by_courses.
*
* @return external_function_parameters
* @since Moodle 3.3
*/
public static function get_labels_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 labels in a provided list of courses.
* If no list is provided all labels that the user can view will be returned.
*
* @param array $courseids course ids
* @return array of warnings and labels
* @since Moodle 3.3
*/
public static function get_labels_by_courses($courseids = array()) {
$warnings = array();
$returnedlabels = array();
$params = array(
'courseids' => $courseids,
);
$params = self::validate_parameters(self::get_labels_by_courses_parameters(), $params);
$mycourses = array();
if (empty($params['courseids'])) {
$mycourses = enrol_get_my_courses();
$params['courseids'] = array_keys($mycourses);
}
// Ensure there are courseids to loop through.
if (!empty($params['courseids'])) {
list($courses, $warnings) = external_util::validate_courses($params['courseids'], $mycourses);
// Get the labels in this course, this function checks users visibility permissions.
// We can avoid then additional validate_context calls.
$labels = get_all_instances_in_courses("label", $courses);
foreach ($labels as $label) {
$context = context_module::instance($label->coursemodule);
// Entry to return.
$label->name = external_format_string($label->name, $context->id);
list($label->intro, $label->introformat) = external_format_text($label->intro,
$label->introformat, $context->id, 'mod_label', 'intro', null);
$label->introfiles = external_util::get_area_files($context->id, 'mod_label', 'intro', false, false);
$returnedlabels[] = $label;
}
}
$result = array(
'labels' => $returnedlabels,
'warnings' => $warnings
);
return $result;
}
/**
* Describes the get_labels_by_courses return value.
*
* @return external_single_structure
* @since Moodle 3.3
*/
public static function get_labels_by_courses_returns() {
return new external_single_structure(
array(
'labels' => new external_multiple_structure(
new external_single_structure(
array(
'id' => new external_value(PARAM_INT, 'Module id'),
'course' => new external_value(PARAM_INT, 'Course id'),
'name' => new external_value(PARAM_RAW, 'Label name'),
'intro' => new external_value(PARAM_RAW, 'Label contents'),
'introformat' => new external_format_value('intro', 'Content format'),
'introfiles' => new external_files('Files in the introduction text'),
'timemodified' => new external_value(PARAM_INT, 'Last time the label was modified'),
'section' => new external_value(PARAM_INT, 'Course section id'),
'visible' => new external_value(PARAM_INT, 'Module visibility'),
'groupmode' => new external_value(PARAM_INT, 'Group mode'),
'groupingid' => new external_value(PARAM_INT, 'Grouping id'),
)
)
),
'warnings' => new external_warnings(),
)
);
}
}

40
mod/label/db/services.php Normal file
View File

@ -0,0 +1,40 @@
<?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/>.
/**
* Label external functions and service definitions.
*
* @package mod_label
* @category external
* @copyright 2017 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.3
*/
defined('MOODLE_INTERNAL') || die;
$functions = array(
'mod_label_get_labels_by_courses' => array(
'classname' => 'mod_label_external',
'methodname' => 'get_labels_by_courses',
'description' => 'Returns a list of labels in a provided list of courses, if no list is provided all labels that the user
can view will be returned.',
'type' => 'read',
'capabilities' => 'mod/label:view',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
),
);

160
mod/label/tests/externallib_test.php Normal file
View File

@ -0,0 +1,160 @@
<?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 mod_label functions unit tests
*
* @package mod_label
* @category external
* @copyright 2017 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.3
*/
defined('MOODLE_INTERNAL') || die();
global $CFG;
require_once($CFG->dirroot . '/webservice/tests/helpers.php');
/**
* External mod_label functions unit tests
*
* @package mod_label
* @category external
* @copyright 2017 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.3
*/
class mod_label_external_testcase extends externallib_advanced_testcase {
/**
* Test test_mod_label_get_labels_by_courses
*/
public function test_mod_label_get_labels_by_courses() {
global $DB;
$this->resetAfterTest(true);
$course1 = self::getDataGenerator()->create_course();
$course2 = self::getDataGenerator()->create_course();
$student = self::getDataGenerator()->create_user();
$studentrole = $DB->get_record('role', array('shortname' => 'student'));
$this->getDataGenerator()->enrol_user($student->id, $course1->id, $studentrole->id);
// First label.
$record = new stdClass();
$record->course = $course1->id;
$label1 = self::getDataGenerator()->create_module('label', $record);
// Second label.
$record = new stdClass();
$record->course = $course2->id;
$label2 = self::getDataGenerator()->create_module('label', $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, $student->id, $studentrole->id);
self::setUser($student);
$returndescription = mod_label_external::get_labels_by_courses_returns();
// Create what we expect to be returned when querying the two courses.
$expectedfields = array('id', 'course', 'name', 'intro', 'introformat', 'introfiles', 'timemodified', 'section',
'visible', 'groupmode', 'groupingid');
// Add expected coursemodule and data.
$label1->coursemodule = $label1->cmid;
$label1->introformat = 1;
$label1->section = 0;
$label1->visible = true;
$label1->groupmode = 0;
$label1->groupingid = 0;
$label1->introfiles = [];
$label2->coursemodule = $label2->cmid;
$label2->introformat = 1;
$label2->section = 0;
$label2->visible = true;
$label2->groupmode = 0;
$label2->groupingid = 0;
$label2->introfiles = [];
foreach ($expectedfields as $field) {
$expected1[$field] = $label1->{$field};
$expected2[$field] = $label2->{$field};
}
$expectedlabels = array($expected2, $expected1);
// Call the external function passing course ids.
$result = mod_label_external::get_labels_by_courses(array($course2->id, $course1->id));
$result = external_api::clean_returnvalue($returndescription, $result);
$this->assertEquals($expectedlabels, $result['labels']);
$this->assertCount(0, $result['warnings']);
// Call the external function without passing course id.
$result = mod_label_external::get_labels_by_courses();
$result = external_api::clean_returnvalue($returndescription, $result);
$this->assertEquals($expectedlabels, $result['labels']);
$this->assertCount(0, $result['warnings']);
// Add a file to the intro.
$filename = "file.txt";
$filerecordinline = array(
'contextid' => context_module::instance($label2->cmid)->id,
'component' => 'mod_label',
'filearea' => 'intro',
'itemid' => 0,
'filepath' => '/',
'filename' => $filename,
);
$fs = get_file_storage();
$timepost = time();
$fs->create_file_from_string($filerecordinline, 'image contents (not really)');
$result = mod_label_external::get_labels_by_courses(array($course2->id, $course1->id));
$result = external_api::clean_returnvalue($returndescription, $result);
$this->assertCount(1, $result['labels'][0]['introfiles']);
$this->assertEquals($filename, $result['labels'][0]['introfiles'][0]['filename']);
// Unenrol user from second course.
$enrol->unenrol_user($instance2, $student->id);
array_shift($expectedlabels);
// Call the external function without passing course id.
$result = mod_label_external::get_labels_by_courses();
$result = external_api::clean_returnvalue($returndescription, $result);
$this->assertEquals($expectedlabels, $result['labels']);
// Call for the second course we unenrolled the user from, expected warning.
$result = mod_label_external::get_labels_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']);
}
}

2
mod/label/version.php
View File

@ -24,7 +24,7 @@
defined('MOODLE_INTERNAL') || die();
$plugin->version = 2016120500; // The current module version (Date: YYYYMMDDXX)
$plugin->version = 2016120501; // The current module version (Date: YYYYMMDDXX)
$plugin->requires = 2016112900; // Requires this Moodle version
$plugin->component = 'mod_label'; // Full name of the plugin (used for diagnostics)
$plugin->cron = 0;