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.
MDL-40049 mod_choice: Replaced old add_to_log calls with event triggers.
Also added a generator for unit tests.
- Loading branch information
Showing
13 changed files
with
878 additions
and
6 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,103 @@ | ||
<?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/>. | ||
|
||
/** | ||
* mod_choice answer submitted event. | ||
* | ||
* @package mod_choice | ||
* @copyright 2013 Adrian Greeve <adrian@moodle.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
|
||
namespace mod_choice\event; | ||
|
||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
/** | ||
* mod_choice answer submitted event class. | ||
* | ||
* @package mod_choice | ||
* @copyright 2013 Adrian Greeve <adrian@moodle.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
class answer_submitted extends \core\event\base { | ||
|
||
/** | ||
* Returns description of what happened. | ||
* | ||
* @return string | ||
*/ | ||
public function get_description() { | ||
return "User {$this->userid} has made their choice {$this->objectid} in {$this->other['choiceid']}."; | ||
} | ||
|
||
/** | ||
* Return legacy data for add_to_log(). | ||
* | ||
* @return array | ||
*/ | ||
protected function get_legacy_logdata() { | ||
$legacylogdata = array($this->courseid, | ||
'choice', | ||
'choose', | ||
'view.php?id=' . $this->context->instanceid, | ||
$this->other['choiceid'], | ||
$this->context->instanceid); | ||
|
||
return $legacylogdata; | ||
} | ||
|
||
/** | ||
* Return localised event name. | ||
* | ||
* @return string | ||
*/ | ||
public static function get_name() { | ||
return get_string('event_answer_created', 'mod_choice'); | ||
} | ||
|
||
/** | ||
* Get URL related to the action | ||
* | ||
* @return \moodle_url | ||
*/ | ||
public function get_url() { | ||
return new \moodle_url('/mod/choice/view.php', array('id' => $this->context->instanceid)); | ||
} | ||
|
||
/** | ||
* Init method. | ||
* | ||
* @return void | ||
*/ | ||
protected function init() { | ||
$this->data['crud'] = 'c'; | ||
$this->data['level'] = self::LEVEL_PARTICIPATING; | ||
$this->data['objecttable'] = 'choice_answers'; | ||
} | ||
|
||
/** | ||
* Custom validation. | ||
* | ||
* @throws \coding_exception | ||
* @return void | ||
*/ | ||
protected function validate_data() { | ||
if (!isset($this->other['choiceid'])) { | ||
throw new \coding_exception('choiceid must be set in $other.'); | ||
} | ||
} | ||
} |
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,103 @@ | ||
<?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/>. | ||
|
||
/** | ||
* mod_choice answer updated event. | ||
* | ||
* @package mod_choice | ||
* @copyright 2013 Adrian Greeve <adrian@moodle.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
|
||
namespace mod_choice\event; | ||
|
||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
/** | ||
* mod_choice answer updated event class. | ||
* | ||
* @package mod_choice | ||
* @copyright 2013 Adrian Greeve <adrian@moodle.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
class answer_updated extends \core\event\base { | ||
|
||
/** | ||
* Returns description of what happened. | ||
* | ||
* @return string | ||
*/ | ||
public function get_description() { | ||
return "User {$this->userid} has updated their choice {$this->objectid} in {$this->other['choiceid']}."; | ||
} | ||
|
||
/** | ||
* Return legacy data for add_to_log(). | ||
* | ||
* @return array | ||
*/ | ||
protected function get_legacy_logdata() { | ||
$legacylogdata = array($this->courseid, | ||
'choice', | ||
'choose again', | ||
'view.php?id=' . $this->context->instanceid, | ||
$this->other['choiceid'], | ||
$this->context->instanceid); | ||
|
||
return $legacylogdata; | ||
} | ||
|
||
/** | ||
* Return localised event name. | ||
* | ||
* @return string | ||
*/ | ||
public static function get_name() { | ||
return get_string('event_answer_updated', 'mod_choice'); | ||
} | ||
|
||
/** | ||
* Get URL related to the action | ||
* | ||
* @return \moodle_url | ||
*/ | ||
public function get_url() { | ||
return new \moodle_url('/mod/choice/view.php', array('id' => $this->context->instanceid)); | ||
} | ||
|
||
/** | ||
* Init method. | ||
* | ||
* @return void | ||
*/ | ||
protected function init() { | ||
$this->data['crud'] = 'u'; | ||
$this->data['level'] = self::LEVEL_PARTICIPATING; | ||
$this->data['objecttable'] = 'choice_answers'; | ||
} | ||
|
||
/** | ||
* Custom validation. | ||
* | ||
* @throws \coding_exception | ||
* @return void | ||
*/ | ||
protected function validate_data() { | ||
if (!isset($this->other['choiceid'])) { | ||
throw new \coding_exception('choiceid must be set in $other.'); | ||
} | ||
} | ||
} |
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,73 @@ | ||
<?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/>. | ||
|
||
/** | ||
* This file contains an event for when a choice activity is viewed. | ||
* | ||
* @package mod_choice | ||
* @copyright 2013 Adrian Greeve <adrian@moodle.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
|
||
namespace mod_choice\event; | ||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
/** | ||
* Event for when a choice activity is viewed. | ||
* | ||
* @package mod_choice | ||
* @copyright 2013 Adrian Greeve | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
class course_module_viewed extends \core\event\content_viewed { | ||
|
||
/** | ||
* Init method. | ||
*/ | ||
protected function init() { | ||
$this->data['crud'] = 'r'; | ||
$this->data['level'] = self::LEVEL_PARTICIPATING; | ||
$this->data['objecttable'] = 'choice'; | ||
} | ||
|
||
/** | ||
* Returns localised general event name. | ||
* | ||
* @return string | ||
*/ | ||
public static function get_name() { | ||
return get_string('event_choice_viewed', 'choice'); | ||
} | ||
|
||
/** | ||
* Returns relevant URL. | ||
* @return \moodle_url | ||
*/ | ||
public function get_url() { | ||
$url = '/mod/choice/view.php'; | ||
return new \moodle_url($url, array('id' => $this->context->instanceid)); | ||
} | ||
|
||
/** | ||
* replace add_to_log() statement. | ||
* | ||
* @return array of parameters to be passed to legacy add_to_log() function. | ||
*/ | ||
protected function get_legacy_logdata() { | ||
$url = new \moodle_url('view.php', array('id' => $this->context->instanceid)); | ||
return array($this->courseid, 'choice', 'view', $url->out(), $this->objectid, $this->context->instanceid); | ||
} | ||
} |
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,72 @@ | ||
<?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/>. | ||
|
||
/** | ||
* Course module instances list_viewed event. | ||
* | ||
* @package mod_choice | ||
* @copyright 2013 Adrian Greeve | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
|
||
namespace mod_choice\event; | ||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
/** | ||
* Course module instances list viewed event class for mod_choice. | ||
* | ||
* @package mod_choice | ||
* @copyright 2013 Adrian Greeve | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
class instances_list_viewed extends \core\event\course_module_instances_list_viewed { | ||
|
||
/** | ||
* Returns description of what happened. | ||
* | ||
* @return string | ||
*/ | ||
public function get_description() { | ||
return "User $this->userid viewed the list of choice activities in the course $this->courseid."; | ||
} | ||
|
||
/** | ||
* Return the legacy event log data. | ||
* | ||
* @return array | ||
*/ | ||
protected function get_legacy_logdata() { | ||
return array($this->courseid, 'choice', 'view all', 'index.php?id=' . $this->courseid, ''); | ||
} | ||
|
||
/** | ||
* Return localised event name. | ||
* | ||
* @return string | ||
*/ | ||
public static function get_name() { | ||
return get_string('event_instances_list_viewed', 'mod_choice'); | ||
} | ||
|
||
/** | ||
* Get URL related to the action | ||
* | ||
* @return \moodle_url | ||
*/ | ||
public function get_url() { | ||
return new \moodle_url('/mod/choice/index.php', array('id' => $this->courseid)); | ||
} | ||
} |
Oops, something went wrong.