diff --git a/mod/choice/classes/completion/custom_completion.php b/mod/choice/classes/completion/custom_completion.php new file mode 100644 index 00000000000..5f04988dc0b --- /dev/null +++ b/mod/choice/classes/completion/custom_completion.php @@ -0,0 +1,72 @@ +. + +declare(strict_types = 1); + +namespace mod_choice\completion; + +use core_completion\activity_custom_completion; + +/** + * Activity custom completion subclass for the choice activity. + * + * Class for defining mod_choice's custom completion rules and fetching the completion statuses + * of the custom completion rules for a given choice instance and a user. + * + * @package mod_choice + * @copyright 2021 Jun Pataleta + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class custom_completion extends activity_custom_completion { + + /** + * Fetches the completion state for a given completion rule. + * + * @param string $rule The completion rule. + * @return int The completion state. + */ + public function get_state(string $rule): int { + global $DB; + + $this->validate_rule($rule); + + // Choice only supports completionsubmit as a custom rule. + $status = $DB->record_exists('choice_answers', ['choiceid' => $this->cm->instance, 'userid' => $this->userid]); + return $status ? COMPLETION_COMPLETE : COMPLETION_INCOMPLETE; + } + + /** + * Fetch the list of custom completion rules that this module defines. + * + * @return array + */ + public static function get_defined_custom_rules(): array { + return [ + 'completionsubmit' + ]; + } + + /** + * Returns an associative array of the descriptions of custom completion rules. + * + * @return array + */ + public function get_custom_rule_descriptions(): array { + return [ + 'completionsubmit' => get_string('completiondetail:submit', 'choice') + ]; + } +} diff --git a/mod/choice/lang/en/choice.php b/mod/choice/lang/en/choice.php index eba9b28090a..033a0a6efc8 100644 --- a/mod/choice/lang/en/choice.php +++ b/mod/choice/lang/en/choice.php @@ -31,6 +31,7 @@ $string['calendarend'] = '{$a} closes'; $string['calendarstart'] = '{$a} opens'; $string['cannotsubmit'] = 'Sorry, there was a problem submitting your choice. Please try again.'; $string['closebeforeopen'] = 'You have specified a close date before the open date.'; +$string['completiondetail:submit'] = 'Make a choice'; $string['completionsubmit'] = 'Show as complete when user makes a choice'; $string['displayhorizontal'] = 'Display horizontally'; $string['displaymode'] = 'Display mode for the options';