mirrored from git://git.moodle.org/moodle.git
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-70817-master-8' of git://github.com/junpataleta/moodle
- Loading branch information
Showing
34 changed files
with
1,532 additions
and
86 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
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,198 @@ | ||
| <?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/>. | ||
|
|
||
| /** | ||
| * Contains the class for building the user's activity completion details. | ||
| * | ||
| * @package core_completion | ||
| * @copyright Jun Pataleta <jun@moodle.com> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| declare(strict_types = 1); | ||
|
|
||
| namespace core_completion; | ||
|
|
||
| use cm_info; | ||
| use completion_info; | ||
|
|
||
| /** | ||
| * Class for building the user's activity completion details. | ||
| * | ||
| * @package core_completion | ||
| * @copyright Jun Pataleta <jun@moodle.com> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class cm_completion_details { | ||
| /** @var completion_info The completion info instance for this cm's course. */ | ||
| protected $completioninfo = null; | ||
|
|
||
| /** @var cm_info The course module information. */ | ||
| protected $cminfo = null; | ||
|
|
||
| /** @var int The user ID. */ | ||
| protected $userid = 0; | ||
|
|
||
| /** @var bool Whether to return automatic completion details. */ | ||
| protected $returndetails = true; | ||
|
|
||
| /** | ||
| * Constructor. | ||
| * | ||
| * @param completion_info $completioninfo The completion info instance for this cm's course. | ||
| * @param cm_info $cminfo The course module information. | ||
| * @param int $userid The user ID. | ||
| * @param bool $returndetails Whether to return completion details or not. | ||
| */ | ||
| public function __construct(completion_info $completioninfo, cm_info $cminfo, int $userid, bool $returndetails = true) { | ||
| $this->completioninfo = $completioninfo; | ||
| $this->cminfo = $cminfo; | ||
| $this->userid = $userid; | ||
| $this->returndetails = $returndetails; | ||
| } | ||
|
|
||
| /** | ||
| * Fetches the completion details for a user. | ||
| * | ||
| * @return array An array of completion details for a user containing the completion requirement's description and status. | ||
| */ | ||
| public function get_details(): array { | ||
| if (!$this->is_automatic()) { | ||
| // No details need to be returned for modules that don't have automatic completion tracking enabled. | ||
| return []; | ||
| } | ||
|
|
||
| if (!$this->returndetails) { | ||
| // We don't need to return completion details. | ||
| return []; | ||
| } | ||
|
|
||
| $completiondata = $this->completioninfo->get_data($this->cminfo, false, $this->userid); | ||
| $hasoverride = !empty($this->overridden_by()); | ||
|
|
||
| $details = []; | ||
|
|
||
| // Completion rule: Student must view this activity. | ||
| if (!empty($this->cminfo->completionview)) { | ||
| if (!$hasoverride) { | ||
| $status = COMPLETION_INCOMPLETE; | ||
| if ($completiondata->viewed == COMPLETION_VIEWED) { | ||
| $status = COMPLETION_COMPLETE; | ||
| } | ||
| } else { | ||
| $status = $completiondata->completionstate; | ||
| } | ||
|
|
||
| $details['completionview'] = (object)[ | ||
| 'status' => $status, | ||
| 'description' => get_string('detail_desc:view', 'completion'), | ||
| ]; | ||
| } | ||
|
|
||
| // Completion rule: Student must receive a grade. | ||
| if (!is_null($this->cminfo->completiongradeitemnumber)) { | ||
| if (!$hasoverride) { | ||
| $status = $completiondata->completiongrade ?? COMPLETION_INCOMPLETE; | ||
| } else { | ||
| $status = $completiondata->completionstate; | ||
| } | ||
|
|
||
| $details['completionusegrade'] = (object)[ | ||
| 'status' => $status, | ||
| 'description' => get_string('detail_desc:receivegrade', 'completion'), | ||
| ]; | ||
| } | ||
|
|
||
| // Custom completion rules. | ||
| $cmcompletionclass = activity_custom_completion::get_cm_completion_class($this->cminfo->modname); | ||
| if (!isset($completiondata->customcompletion) || !$cmcompletionclass) { | ||
| // Return early if there are no custom rules to process or the cm completion class implementation is not available. | ||
| return $details; | ||
| } | ||
|
|
||
| /** @var activity_custom_completion $cmcompletion */ | ||
| $cmcompletion = new $cmcompletionclass($this->cminfo, $this->userid); | ||
| foreach ($completiondata->customcompletion as $rule => $status) { | ||
| $details[$rule] = (object)[ | ||
| 'status' => !$hasoverride ? $status : $completiondata->completionstate, | ||
| 'description' => $cmcompletion->get_custom_rule_description($rule), | ||
| ]; | ||
| } | ||
|
|
||
| return $details; | ||
| } | ||
|
|
||
| /** | ||
| * Fetches the overall completion state of this course module. | ||
| * | ||
| * @return int The overall completion state for this course module. | ||
| */ | ||
| public function get_overall_completion(): int { | ||
| $completiondata = $this->completioninfo->get_data($this->cminfo, false, $this->userid); | ||
| return (int)$completiondata->completionstate; | ||
| } | ||
|
|
||
| /** | ||
| * Whether this activity module has completion enabled. | ||
| * | ||
| * @return bool | ||
| */ | ||
| public function has_completion(): bool { | ||
| return $this->completioninfo->is_enabled($this->cminfo) != COMPLETION_DISABLED; | ||
| } | ||
|
|
||
| /** | ||
| * Whether this activity module instance tracks completion automatically. | ||
| * | ||
| * @return bool | ||
| */ | ||
| public function is_automatic(): bool { | ||
| return $this->cminfo->completion == COMPLETION_TRACKING_AUTOMATIC; | ||
| } | ||
|
|
||
| /** | ||
| * Fetches the user ID that has overridden the completion state of this activity for the user. | ||
| * | ||
| * @return int|null | ||
| */ | ||
| public function overridden_by(): ?int { | ||
| $completiondata = $this->completioninfo->get_data($this->cminfo); | ||
| return isset($completiondata->overrideby) ? (int)$completiondata->overrideby : null; | ||
| } | ||
|
|
||
| /** | ||
| * Checks whether completion is being tracked for this user. | ||
| * | ||
| * @return bool | ||
| */ | ||
| public function is_tracked_user(): bool { | ||
| return $this->completioninfo->is_tracked_user($this->userid); | ||
| } | ||
|
|
||
| /** | ||
| * Generates an instance of this class. | ||
| * | ||
| * @param cm_info $cminfo The course module info instance. | ||
| * @param int $userid The user ID that we're fetching completion details for. | ||
| * @param bool $returndetails Whether to return completion details or not. | ||
| * @return cm_completion_details | ||
| */ | ||
| public static function get_instance(cm_info $cminfo, int $userid, bool $returndetails = true): cm_completion_details { | ||
| $course = $cminfo->get_course(); | ||
| $completioninfo = new completion_info($course); | ||
| return new self($completioninfo, $cminfo, $userid, $returndetails); | ||
| } | ||
| } |
62 changes: 62 additions & 0 deletions
62
completion/tests/behat/custom_completion_display_conditions.feature
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,62 @@ | ||
| @core @core_completion | ||
| Feature: Allow teachers to edit the visibility of completion conditions in a course | ||
| In order to show students the course completion conditions in a course | ||
| As a teacher | ||
| I need to be able to edit completion conditions settings | ||
|
|
||
| Background: | ||
| Given the following "users" exist: | ||
| | username | firstname | lastname | email | | ||
| | teacher1 | Teacher | 1 | teacher1@example.com | | ||
| And the following "courses" exist: | ||
| | fullname | shortname | enablecompletion | showcompletionconditions | | ||
| | Course 1 | C1 | 1 | 1 | | ||
| And the following "course enrolments" exist: | ||
| | user | course | role | | ||
| | teacher1 | C1 | editingteacher | | ||
| And the following "activities" exist: | ||
| | activity | course | idnumber | name | completion | completionsubmit | | ||
| | choice | C1 | c1m | Test choice manual| 1 | 0 | | ||
| | choice | C1 | c1a | Test choice auto | 2 | 1 | | ||
|
|
||
| Scenario: Completion condition displaying for manual and auto completion | ||
| Given I log in as "teacher1" | ||
| And I am on "Course 1" course homepage | ||
| And I follow "Test choice manual" | ||
| And I should see "Mark as done" | ||
| And I am on "Course 1" course homepage | ||
| When I follow "Test choice auto" | ||
| Then I should see "Make a choice" in the "[data-region=completionrequirements]" "css_element" | ||
| # TODO MDL-70821: Check completion conditions display on course homepage. | ||
|
|
||
| Scenario: Completion condition displaying setting can be disabled at course level | ||
| Given I log in as "teacher1" | ||
| And I am on "Course 1" course homepage with editing mode on | ||
| And I navigate to "Edit settings" in current page administration | ||
| When I set the following fields to these values: | ||
| | Show completion conditions | No | | ||
| And I click on "Save and display" "button" | ||
| And I follow "Test choice auto" | ||
| # Completion conditions are always shown in the module's view page. | ||
| Then I should see "Make a choice" in the "[data-region=completionrequirements]" "css_element" | ||
| And I am on "Course 1" course homepage | ||
| And I follow "Test choice manual" | ||
| And I should see "Mark as done" | ||
|
|
||
| Scenario: Default show completion conditions value in course form when default show completion conditions admin setting is set to No | ||
| Given I log in as "admin" | ||
| And I navigate to "Courses > Course default settings" in site administration | ||
| When I set the following fields to these values: | ||
| | Show completion conditions | No | | ||
| And I click on "Save changes" "button" | ||
| And I navigate to "Courses > Add a new course" in site administration | ||
| Then the field "showcompletionconditions" matches value "No" | ||
|
|
||
| Scenario: Default show completion conditions value in course form when default show completion conditions admin setting is set to Yes | ||
| Given I log in as "admin" | ||
| And I navigate to "Courses > Course default settings" in site administration | ||
| When I set the following fields to these values: | ||
| | Show completion conditions | Yes | | ||
| And I click on "Save changes" "button" | ||
| And I navigate to "Courses > Add a new course" in site administration | ||
| Then the field "showcompletionconditions" matches value "Yes" |
Oops, something went wrong.