mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-03-19 23:20:09 +01:00
Code Issues Projects Releases Wiki Activity

MDL-48883 Lesson: Add question viewed and answered events

Browse Source
This commit is contained in:
Stephen Bourget 2015-02-08 20:18:23 -05:00
parent 28c36dd085
commit 8101328a69
11 changed files with 285 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

98
mod/lesson/classes/event/question_answered.php Normal file
View File

@ -0,0 +1,98 @@
<?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/>.
/**
* The mod_lesson true / false question answered event class.
*
* @package mod_lesson
* @copyright 2015 Stephen Bourget
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
*/
namespace mod_lesson\event;
defined('MOODLE_INTERNAL') || die();
/**
* The mod_lesson question answered event class.
*
* @property-read array $other {
* Extra information about event.
*
* - string pagetype: the name of the pagetype as defined in the individual page class
* }
*
* @package mod_lesson
* @since Moodle 2.9
* @copyright 2015 Stephen Bourget
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
*/
class question_answered extends \core\event\base {
/**
* Set basic properties for the event.
*/
protected function init() {
$this->data['objecttable'] = 'lesson_pages';
$this->data['crud'] = 'c';
$this->data['edulevel'] = self::LEVEL_PARTICIPATING;
}
/**
* Returns localised general event name.
*
* @return string
*/
public static function get_name() {
return get_string('eventquestionanswered', 'mod_lesson');
}
/**
* Get URL related to the action.
*
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/mod/lesson/view.php', array('id' => $this->contextinstanceid, 'pageid' => $this->objectid));
}
/**
* Returns non-localised event description with id's for admin use only.
*
* @return string
*/
public function get_description() {
return "The user with id '$this->userid' has answered the ".$this->other['pagetype'] .
" question with id '$this->objectid' in the lesson activity with course module id '$this->contextinstanceid'.";
}
/**
* Custom validations.
*
* @throws \coding_exception when validation fails.
* @return void
*/
protected function validate_data() {
parent::validate_data();
// Make sure this class is never used without proper object details.
if (!$this->contextlevel === CONTEXT_MODULE) {
throw new \coding_exception('Context level must be CONTEXT_MODULE.');
}
if (!isset($this->other['pagetype'])) {
throw new \coding_exception('The \'pagetype\' value must be set in other.');
}
}
}

98
mod/lesson/classes/event/question_viewed.php Normal file
View File

@ -0,0 +1,98 @@
<?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/>.
/**
* The mod_lesson true / false question viewed event class.
*
* @package mod_lesson
* @copyright 2015 Stephen Bourget
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
*/
namespace mod_lesson\event;
defined('MOODLE_INTERNAL') || die();
/**
* The mod_lesson question viewed event class.
*
* @property-read array $other {
* Extra information about event.
*
* - string pagetype: the name of the pagetype as defined in the individual page class
* }
*
* @package mod_lesson
* @since Moodle 2.9
* @copyright 2015 Stephen Bourget
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
*/
class question_viewed extends \core\event\base {
/**
* Set basic properties for the event.
*/
protected function init() {
$this->data['objecttable'] = 'lesson_pages';
$this->data['crud'] = 'r';
$this->data['edulevel'] = self::LEVEL_PARTICIPATING;
}
/**
* Returns localised general event name.
*
* @return string
*/
public static function get_name() {
return get_string('eventquestionviewed', 'mod_lesson');
}
/**
* Get URL related to the action.
*
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/mod/lesson/view.php', array('id' => $this->contextinstanceid, 'pageid' => $this->objectid));
}
/**
* Returns non-localised event description with id's for admin use only.
*
* @return string
*/
public function get_description() {
return "The user with id '$this->userid' has viewed the ".$this->other['pagetype'] .
" question with id '$this->objectid' in the lesson activity with course module id '$this->contextinstanceid'.";
}
/**
* Custom validations.
*
* @throws \coding_exception when validation fails.
* @return void
*/
protected function validate_data() {
parent::validate_data();
// Make sure this class is never used without proper object details.
if (!$this->contextlevel === CONTEXT_MODULE) {
throw new \coding_exception('Context level must be CONTEXT_MODULE.');
}
if (!isset($this->other['pagetype'])) {
throw new \coding_exception('The \'pagetype\' value must be set in other.');
}
}
}

2
mod/lesson/lang/en/lesson.php
View File

@ -181,6 +181,8 @@ $string['eventhighscoreadded'] = 'Highscore added';
$string['eventhighscoresviewed'] = 'Highscores viewed';
$string['eventlessonended'] = 'Lesson ended';
$string['eventlessonstarted'] = 'Lesson started';
$string['eventquestionanswered'] = 'Question answered';
$string['eventquestionviewed'] = 'Question viewed';
$string['false'] = 'False';
$string['fileformat'] = 'File format';
$string['finish'] = 'Finish';

16
mod/lesson/locallib.php
View File

@ -1993,7 +1993,7 @@ abstract class lesson_page extends lesson_base {
* @return stdClass Returns the result of the attempt
*/
final public function record_attempt($context) {
global $DB, $USER, $OUTPUT;
global $DB, $USER, $OUTPUT, $PAGE;
/**
* This should be overridden by each page type to actually check the response
@ -2033,7 +2033,19 @@ abstract class lesson_page extends lesson_base {
// Only insert a record if we are not reviewing the lesson.
if (!$userisreviewing) {
if ($this->lesson->retake || (!$this->lesson->retake && $nretakes == 0)) {
$DB->insert_record("lesson_attempts", $attempt);
$attempt->id = $DB->insert_record("lesson_attempts", $attempt);
// Trigger an event: question answered.
$eventparams = array(
'context' => context_module::instance($PAGE->cm->id),
'objectid' => $this->properties->id,
'other' => array(
'pagetype' => $this->get_typestring()
)
);
$event = \mod_lesson\event\question_answered::create($eventparams);
$event->add_record_snapshot('lesson_attempts', $attempt);
$event->trigger();
}
}
// "number of attempts remaining" message if $this->lesson->maxattempts > 1

12
mod/lesson/pagetypes/essay.php
View File

@ -77,6 +77,18 @@ class lesson_page_type_essay extends lesson_page {
$data->answer = $essayinfo->answer;
}
$mform->set_data($data);
// Trigger an event question viewed.
$eventparams = array(
'context' => context_module::instance($PAGE->cm->id),
'objectid' => $this->properties->id,
'other' => array(
'pagetype' => $this->get_typestring()
)
);
$event = \mod_lesson\event\question_viewed::create($eventparams);
$event->trigger();
return $mform->display();
}
public function create_answers($properties) {

12
mod/lesson/pagetypes/matching.php
View File

@ -54,6 +54,18 @@ class lesson_page_type_matching extends lesson_page {
$data->id = $PAGE->cm->id;
$data->pageid = $this->properties->id;
$mform->set_data($data);
// Trigger an event question viewed.
$eventparams = array(
'context' => context_module::instance($PAGE->cm->id),
'objectid' => $this->properties->id,
'other' => array(
'pagetype' => $this->get_typestring()
)
);
$event = \mod_lesson\event\question_viewed::create($eventparams);
$event->trigger();
return $mform->display();
}

12
mod/lesson/pagetypes/multichoice.php
View File

@ -99,6 +99,18 @@ class lesson_page_type_multichoice extends lesson_page {
$data->id = $PAGE->cm->id;
$data->pageid = $this->properties->id;
$mform->set_data($data);
// Trigger an event question viewed.
$eventparams = array(
'context' => context_module::instance($PAGE->cm->id),
'objectid' => $this->properties->id,
'other' => array(
'pagetype' => $this->get_typestring()
)
);
$event = \mod_lesson\event\question_viewed::create($eventparams);
$event->trigger();
return $mform->display();
}

12
mod/lesson/pagetypes/numerical.php
View File

@ -57,6 +57,18 @@ class lesson_page_type_numerical extends lesson_page {
$data->answer = s($attempt->useranswer);
}
$mform->set_data($data);
// Trigger an event question viewed.
$eventparams = array(
'context' => context_module::instance($PAGE->cm->id),
'objectid' => $this->properties->id,
'other' => array(
'pagetype' => $this->get_typestring()
)
);
$event = \mod_lesson\event\question_viewed::create($eventparams);
$event->trigger();
return $mform->display();
}
public function check_answer() {

12
mod/lesson/pagetypes/shortanswer.php
View File

@ -57,6 +57,18 @@ class lesson_page_type_shortanswer extends lesson_page {
$data->answer = s($attempt->useranswer);
}
$mform->set_data($data);
// Trigger an event question viewed.
$eventparams = array(
'context' => context_module::instance($PAGE->cm->id),
'objectid' => $this->properties->id,
'other' => array(
'pagetype' => $this->get_typestring()
)
);
$event = \mod_lesson\event\question_viewed::create($eventparams);
$event->trigger();
return $mform->display();
}
public function check_answer() {

12
mod/lesson/pagetypes/truefalse.php
View File

@ -61,6 +61,18 @@ class lesson_page_type_truefalse extends lesson_page {
$data->id = $PAGE->cm->id;
$data->pageid = $this->properties->id;
$mform->set_data($data);
// Trigger an event question viewed.
$eventparams = array(
'context' => context_module::instance($PAGE->cm->id),
'objectid' => $this->properties->id,
'other' => array(
'pagetype' => $this->get_typestring()
)
);
$event = \mod_lesson\event\question_viewed::create($eventparams);
$event->trigger();
return $mform->display();
}
public function check_answer() {

2
mod/lesson/version.php
View File

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