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.
MDL-53189 tool_lp: Create event for user competency viewed
- Loading branch information
Showing
16 changed files
with
1,232 additions
and
4 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
142 changes: 142 additions & 0 deletions
142
admin/tool/lp/classes/event/user_competency_plan_viewed.php
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,142 @@ | ||
| <?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/>. | ||
|
|
||
| /** | ||
| * User competency plan viewed event. | ||
| * | ||
| * @package tool_lp | ||
| * @copyright 2016 Issam Taboubi <[email protected]> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| namespace tool_lp\event; | ||
|
|
||
| use core\event\base; | ||
| use tool_lp\user_competency_plan; | ||
|
|
||
| defined('MOODLE_INTERNAL') || die(); | ||
|
|
||
| /** | ||
| * User competency plan viewed event class. | ||
| * | ||
| * @property-read array $other { | ||
| * Extra information about event. | ||
| * | ||
| * - int planid: id of plan for which competency is associated. | ||
| * - int competencyid: id of the competency. | ||
| * } | ||
| * | ||
| * @package tool_lp | ||
| * @since Moodle 3.1 | ||
| * @copyright 2016 Issam Taboubi <[email protected]> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class user_competency_plan_viewed extends base { | ||
|
|
||
| /** | ||
| * Convenience method to instantiate the event. | ||
| * | ||
| * @param user_competency_plan $usercompetencyplan The user competency plan. | ||
| * @return self | ||
| */ | ||
| public static function create_from_user_competency_plan(user_competency_plan $usercompetencyplan) { | ||
| if (!$usercompetencyplan->get_id()) { | ||
| throw new \coding_exception('The user competency plan ID must be set.'); | ||
| } | ||
| $event = static::create(array( | ||
| 'contextid' => $usercompetencyplan->get_context()->id, | ||
| 'objectid' => $usercompetencyplan->get_id(), | ||
| 'relateduserid' => $usercompetencyplan->get_userid(), | ||
| 'other' => array( | ||
| 'planid' => $usercompetencyplan->get_planid(), | ||
| 'competencyid' => $usercompetencyplan->get_competencyid() | ||
| ) | ||
| )); | ||
| $event->add_record_snapshot(user_competency_plan::TABLE, $usercompetencyplan->to_record()); | ||
| return $event; | ||
| } | ||
|
|
||
| /** | ||
| * Returns description of what happened. | ||
| * | ||
| * @return string | ||
| */ | ||
| public function get_description() { | ||
| return "The user with id '$this->userid' viewed the user competency plan with id '$this->objectid'"; | ||
| } | ||
|
|
||
| /** | ||
| * Return localised event name. | ||
| * | ||
| * @return string | ||
| */ | ||
| public static function get_name() { | ||
| return get_string('eventusercompetencyplanviewed', 'tool_lp'); | ||
| } | ||
|
|
||
| /** | ||
| * Get URL related to the action | ||
| * | ||
| * @return \moodle_url | ||
| */ | ||
| public function get_url() { | ||
| return new \moodle_url('/admin/tool/lp/user_competency_in_plan.php', array( | ||
| 'competencyid' => $this->other['competencyid'], | ||
| 'userid' => $this->relateduserid, | ||
| 'planid' => $this->other['planid'] | ||
| )); | ||
| } | ||
|
|
||
| /** | ||
| * Init method. | ||
| * | ||
| * @return void | ||
| */ | ||
| protected function init() { | ||
| $this->data['crud'] = 'r'; | ||
| $this->data['edulevel'] = self::LEVEL_PARTICIPATING; | ||
| $this->data['objecttable'] = user_competency_plan::TABLE; | ||
| } | ||
|
|
||
| /** | ||
| * Get_objectid_mapping method. | ||
| * | ||
| * @return string the name of the restore mapping the objectid links to | ||
| */ | ||
| public static function get_objectid_mapping() { | ||
| return base::NOT_MAPPED; | ||
| } | ||
|
|
||
| /** | ||
| * Custom validation. | ||
| * | ||
| * Throw \coding_exception notice in case of any problems. | ||
| */ | ||
| protected function validate_data() { | ||
| if ($this->other === null) { | ||
| throw new \coding_exception('The \'competencyid\' and \'planid\' values must be set.'); | ||
| } | ||
|
|
||
| if (!isset($this->other['competencyid'])) { | ||
| throw new \coding_exception('The \'competencyid\' value must be set.'); | ||
| } | ||
|
|
||
| if (!isset($this->other['planid'])) { | ||
| throw new \coding_exception('The \'planid\' value must be set.'); | ||
| } | ||
| } | ||
|
|
||
| } |
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,132 @@ | ||
| <?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/>. | ||
|
|
||
| /** | ||
| * User competency viewed event. | ||
| * | ||
| * @package tool_lp | ||
| * @copyright 2016 Issam Taboubi <[email protected]> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| namespace tool_lp\event; | ||
|
|
||
| use core\event\base; | ||
| use tool_lp\user_competency; | ||
| use context_course; | ||
| defined('MOODLE_INTERNAL') || die(); | ||
|
|
||
| /** | ||
| * User competency viewed event class. | ||
| * | ||
| * @property-read array $other { | ||
| * Extra information about event. | ||
| * | ||
| * - int competencyid: id of competency. | ||
| * } | ||
| * | ||
| * @package tool_lp | ||
| * @since Moodle 3.1 | ||
| * @copyright 2016 Issam Taboubi <[email protected]> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class user_competency_viewed extends base { | ||
|
|
||
| /** | ||
| * Convenience method to instantiate the event. | ||
| * | ||
| * @param user_competency $usercompetency The user competency. | ||
| * @return self | ||
| */ | ||
| public static function create_from_user_competency_viewed(user_competency $usercompetency) { | ||
| if (!$usercompetency->get_id()) { | ||
| throw new \coding_exception('The user competency ID must be set.'); | ||
| } | ||
| $params = array( | ||
| 'contextid' => $usercompetency->get_context()->id, | ||
| 'objectid' => $usercompetency->get_id(), | ||
| 'relateduserid' => $usercompetency->get_userid(), | ||
| 'other' => array( | ||
| 'competencyid' => $usercompetency->get_competencyid() | ||
| ) | ||
| ); | ||
|
|
||
| $event = static::create($params); | ||
| $event->add_record_snapshot(user_competency::TABLE, $usercompetency->to_record()); | ||
| return $event; | ||
| } | ||
|
|
||
| /** | ||
| * Returns description of what happened. | ||
| * | ||
| * @return string | ||
| */ | ||
| public function get_description() { | ||
| return "The user with id '$this->userid' viewed the user competency with id '$this->objectid'"; | ||
| } | ||
|
|
||
| /** | ||
| * Return localised event name. | ||
| * | ||
| * @return string | ||
| */ | ||
| public static function get_name() { | ||
| return get_string('eventusercompetencyviewed', 'tool_lp'); | ||
| } | ||
|
|
||
| /** | ||
| * Get URL related to the action | ||
| * | ||
| * @return \moodle_url | ||
| */ | ||
| public function get_url() { | ||
| return new \moodle_url('/admin/tool/lp/user_competency.php', array( | ||
| 'id' => $this->objectid | ||
| )); | ||
| } | ||
|
|
||
| /** | ||
| * Init method. | ||
| * | ||
| * @return void | ||
| */ | ||
| protected function init() { | ||
| $this->data['crud'] = 'r'; | ||
| $this->data['edulevel'] = self::LEVEL_PARTICIPATING; | ||
| $this->data['objecttable'] = user_competency::TABLE; | ||
| } | ||
|
|
||
| /** | ||
| * Get_objectid_mapping method. | ||
| * | ||
| * @return string the name of the restore mapping the objectid links to | ||
| */ | ||
| public static function get_objectid_mapping() { | ||
| return base::NOT_MAPPED; | ||
| } | ||
|
|
||
| /** | ||
| * Custom validation. | ||
| * | ||
| * Throw \coding_exception notice in case of any problems. | ||
| */ | ||
| protected function validate_data() { | ||
| if (!isset($this->other) || !isset($this->other['competencyid'])) { | ||
| throw new \coding_exception('The \'competencyid\' value must be set.'); | ||
| } | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.