forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'MDL-57633-master' of git://github.com/jleyva/moodle
- Loading branch information
Showing
7 changed files
with
679 additions
and
143 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,212 @@ | ||
| <?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/>. | ||
|
|
||
| /** | ||
| * Lesson external API | ||
| * | ||
| * @package mod_lesson | ||
| * @category external | ||
| * @copyright 2017 Juan Leyva <[email protected]> | ||
| * @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'); | ||
| require_once($CFG->dirroot . '/mod/lesson/locallib.php'); | ||
|
|
||
| /** | ||
| * Lesson external functions | ||
| * | ||
| * @package mod_lesson | ||
| * @category external | ||
| * @copyright 2017 Juan Leyva <[email protected]> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| * @since Moodle 3.3 | ||
| */ | ||
| class mod_lesson_external extends external_api { | ||
|
|
||
| /** | ||
| * Describes the parameters for get_lessons_by_courses. | ||
| * | ||
| * @return external_function_parameters | ||
| * @since Moodle 3.3 | ||
| */ | ||
| public static function get_lessons_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 lessons in a provided list of courses, | ||
| * if no list is provided all lessons that the user can view will be returned. | ||
| * | ||
| * @param array $courseids Array of course ids | ||
| * @return array of lessons details | ||
| * @since Moodle 3.3 | ||
| */ | ||
| public static function get_lessons_by_courses($courseids = array()) { | ||
| global $USER; | ||
|
|
||
| $warnings = array(); | ||
| $returnedlessons = array(); | ||
|
|
||
| $params = array( | ||
| 'courseids' => $courseids, | ||
| ); | ||
| $params = self::validate_parameters(self::get_lessons_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 lessons in this course, this function checks users visibility permissions. | ||
| // We can avoid then additional validate_context calls. | ||
| $lessons = get_all_instances_in_courses("lesson", $courses); | ||
| foreach ($lessons as $lesson) { | ||
| $context = context_module::instance($lesson->coursemodule); | ||
|
|
||
| $lesson = new lesson($lesson); | ||
| $lesson->update_effective_access($USER->id); | ||
|
|
||
| // Entry to return. | ||
| $lessondetails = array(); | ||
| // First, we return information that any user can see in the web interface. | ||
| $lessondetails['id'] = $lesson->id; | ||
| $lessondetails['coursemodule'] = $lesson->coursemodule; | ||
| $lessondetails['course'] = $lesson->course; | ||
| $lessondetails['name'] = external_format_string($lesson->name, $context->id); | ||
|
|
||
| $lessonavailable = $lesson->get_time_restriction_status() === false; | ||
| $lessonavailable = $lessonavailable && $lesson->get_password_restriction_status('') === false; | ||
| $lessonavailable = $lessonavailable && $lesson->get_dependencies_restriction_status() === false; | ||
|
|
||
| if ($lessonavailable) { | ||
| // Format intro. | ||
| list($lessondetails['intro'], $lessondetails['introformat']) = external_format_text($lesson->intro, | ||
| $lesson->introformat, $context->id, 'mod_lesson', 'intro', null); | ||
|
|
||
| $lessondetails['introfiles'] = external_util::get_area_files($context->id, 'mod_lesson', 'intro', false, false); | ||
| $lessondetails['mediafiles'] = external_util::get_area_files($context->id, 'mod_lesson', 'mediafile', 0); | ||
| $viewablefields = array('practice', 'modattempts', 'usepassword', 'grade', 'custom', 'ongoing', 'usemaxgrade', | ||
| 'maxanswers', 'maxattempts', 'review', 'nextpagedefault', 'feedback', 'minquestions', | ||
| 'maxpages', 'timelimit', 'retake', 'mediafile', 'mediaheight', 'mediawidth', | ||
| 'mediaclose', 'slideshow', 'width', 'height', 'bgcolor', 'displayleft', 'displayleftif', | ||
| 'progressbar'); | ||
|
|
||
| // Fields only for managers. | ||
| if ($lesson->can_manage()) { | ||
| $additionalfields = array('password', 'dependency', 'conditions', 'activitylink', 'available', 'deadline', | ||
| 'timemodified', 'completionendreached', 'completiontimespent'); | ||
| $viewablefields = array_merge($viewablefields, $additionalfields); | ||
| } | ||
|
|
||
| foreach ($viewablefields as $field) { | ||
| $lessondetails[$field] = $lesson->{$field}; | ||
| } | ||
| } | ||
| $returnedlessons[] = $lessondetails; | ||
| } | ||
| } | ||
| $result = array(); | ||
| $result['lessons'] = $returnedlessons; | ||
| $result['warnings'] = $warnings; | ||
| return $result; | ||
| } | ||
|
|
||
| /** | ||
| * Describes the get_lessons_by_courses return value. | ||
| * | ||
| * @return external_single_structure | ||
| * @since Moodle 3.3 | ||
| */ | ||
| public static function get_lessons_by_courses_returns() { | ||
| return new external_single_structure( | ||
| array( | ||
| 'lessons' => new external_multiple_structure( | ||
| new external_single_structure( | ||
| array( | ||
| 'id' => new external_value(PARAM_INT, 'Standard Moodle primary key.'), | ||
| 'course' => new external_value(PARAM_INT, 'Foreign key reference to the course this lesson is part of.'), | ||
| 'coursemodule' => new external_value(PARAM_INT, 'Course module id.'), | ||
| 'name' => new external_value(PARAM_RAW, 'Lesson name.'), | ||
| 'intro' => new external_value(PARAM_RAW, 'Lesson introduction text.', VALUE_OPTIONAL), | ||
| 'introformat' => new external_format_value('intro', VALUE_OPTIONAL), | ||
| 'introfiles' => new external_files('Files in the introduction text', VALUE_OPTIONAL), | ||
| 'practice' => new external_value(PARAM_INT, 'Practice lesson?', VALUE_OPTIONAL), | ||
| 'modattempts' => new external_value(PARAM_INT, 'Allow student review?', VALUE_OPTIONAL), | ||
| 'usepassword' => new external_value(PARAM_INT, 'Password protected lesson?', VALUE_OPTIONAL), | ||
| 'password' => new external_value(PARAM_RAW, 'Password', VALUE_OPTIONAL), | ||
| 'dependency' => new external_value(PARAM_INT, 'Dependent on (another lesson id)', VALUE_OPTIONAL), | ||
| 'conditions' => new external_value(PARAM_RAW, 'Conditions to enable the lesson', VALUE_OPTIONAL), | ||
| 'grade' => new external_value(PARAM_INT, 'The total that the grade is scaled to be out of', | ||
| VALUE_OPTIONAL), | ||
| 'custom' => new external_value(PARAM_INT, 'Custom scoring?', VALUE_OPTIONAL), | ||
| 'ongoing' => new external_value(PARAM_INT, 'Display ongoing score?', VALUE_OPTIONAL), | ||
| 'usemaxgrade' => new external_value(PARAM_INT, 'How to calculate the final grade', VALUE_OPTIONAL), | ||
| 'maxanswers' => new external_value(PARAM_INT, 'Maximum answers per page', VALUE_OPTIONAL), | ||
| 'maxattempts' => new external_value(PARAM_INT, 'Maximum attempts', VALUE_OPTIONAL), | ||
| 'review' => new external_value(PARAM_INT, 'Provide option to try a question again', VALUE_OPTIONAL), | ||
| 'nextpagedefault' => new external_value(PARAM_INT, 'Action for a correct answer', VALUE_OPTIONAL), | ||
| 'feedback' => new external_value(PARAM_INT, 'Display default feedback', VALUE_OPTIONAL), | ||
| 'minquestions' => new external_value(PARAM_INT, 'Minimum number of questions', VALUE_OPTIONAL), | ||
| 'maxpages' => new external_value(PARAM_INT, 'Number of pages to show', VALUE_OPTIONAL), | ||
| 'timelimit' => new external_value(PARAM_INT, 'Time limit', VALUE_OPTIONAL), | ||
| 'retake' => new external_value(PARAM_INT, 'Re-takes allowed', VALUE_OPTIONAL), | ||
| 'activitylink' => new external_value(PARAM_INT, 'Link to next activity', VALUE_OPTIONAL), | ||
| 'mediafile' => new external_value(PARAM_RAW, 'Local file path or full external URL', VALUE_OPTIONAL), | ||
| 'mediafiles' => new external_files('Media files', VALUE_OPTIONAL), | ||
| 'mediaheight' => new external_value(PARAM_INT, 'Popup for media file height', VALUE_OPTIONAL), | ||
| 'mediawidth' => new external_value(PARAM_INT, 'Popup for media with', VALUE_OPTIONAL), | ||
| 'mediaclose' => new external_value(PARAM_INT, 'Display a close button in the popup?', VALUE_OPTIONAL), | ||
| 'slideshow' => new external_value(PARAM_INT, 'Display lesson as slideshow', VALUE_OPTIONAL), | ||
| 'width' => new external_value(PARAM_INT, 'Slideshow width', VALUE_OPTIONAL), | ||
| 'height' => new external_value(PARAM_INT, 'Slideshow height', VALUE_OPTIONAL), | ||
| 'bgcolor' => new external_value(PARAM_TEXT, 'Slideshow bgcolor', VALUE_OPTIONAL), | ||
| 'displayleft' => new external_value(PARAM_INT, 'Display left pages menu?', VALUE_OPTIONAL), | ||
| 'displayleftif' => new external_value(PARAM_INT, 'Minimum grade to display menu', VALUE_OPTIONAL), | ||
| 'progressbar' => new external_value(PARAM_INT, 'Display progress bar?', VALUE_OPTIONAL), | ||
| 'available' => new external_value(PARAM_INT, 'Available from', VALUE_OPTIONAL), | ||
| 'deadline' => new external_value(PARAM_INT, 'Available until', VALUE_OPTIONAL), | ||
| 'timemodified' => new external_value(PARAM_INT, 'Last time settings were updated', VALUE_OPTIONAL), | ||
| 'completionendreached' => new external_value(PARAM_INT, 'Require end reached for completion?', | ||
| VALUE_OPTIONAL), | ||
| 'completiontimespent' => new external_value(PARAM_INT, 'Student must do this activity at least for', | ||
| 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, 'Grouping id', VALUE_OPTIONAL), | ||
| ) | ||
| ) | ||
| ), | ||
| 'warnings' => new external_warnings(), | ||
| ) | ||
| ); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| <?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/>. | ||
|
|
||
| /** | ||
| * Lesson external functions and service definitions. | ||
| * | ||
| * @package mod_lesson | ||
| * @category external | ||
| * @copyright 2017 Juan Leyva <[email protected]> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| * @since Moodle 3.3 | ||
| */ | ||
|
|
||
| defined('MOODLE_INTERNAL') || die; | ||
|
|
||
| $functions = array( | ||
| 'mod_lesson_get_lessons_by_courses' => array( | ||
| 'classname' => 'mod_lesson_external', | ||
| 'methodname' => 'get_lessons_by_courses', | ||
| 'description' => 'Returns a list of lessons in a provided list of courses, if no list is provided all lessons that the user can view will be returned.', | ||
| 'type' => 'read', | ||
| 'capabilities' => 'mod/lesson:view', | ||
| 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE), | ||
| ), | ||
| ); |
Oops, something went wrong.