mirrored from git://git.moodle.org/moodle.git
-
Notifications
You must be signed in to change notification settings - Fork 6.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-66404 core_h5p: Add new h5p_deleted event
- Loading branch information
Showing
3 changed files
with
186 additions
and
0 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,97 @@ | ||
<?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/>. | ||
|
||
/** | ||
* H5P deleted event class. | ||
* | ||
* @package core | ||
* @since Moodle 3.8 | ||
* @copyright 2019 Carlos Escobedo <carlos@moodle.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
|
||
namespace core_h5p\event; | ||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
/** | ||
* H5P viewed event class. | ||
* | ||
* @package core_h5p | ||
* @since Moodle 3.8 | ||
* @copyright 2019 Carlos Escobedo <carlos@moodle.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
class h5p_deleted extends \core\event\base { | ||
|
||
/** | ||
* Initialise event parameters. | ||
*/ | ||
protected function init() { | ||
$this->data['objecttable'] = 'h5p'; | ||
$this->data['crud'] = 'd'; | ||
$this->data['edulevel'] = self::LEVEL_PARTICIPATING; | ||
} | ||
|
||
/** | ||
* Returns localised event name. | ||
* | ||
* @return string | ||
*/ | ||
public static function get_name() { | ||
return get_string('eventh5pdeleted', 'h5p'); | ||
} | ||
|
||
/** | ||
* 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' deleted the H5P with id '$this->objectid'."; | ||
} | ||
|
||
/** | ||
* Custom validations. | ||
* | ||
* @throws \coding_exception | ||
* @return void | ||
*/ | ||
protected function validate_data() { | ||
parent::validate_data(); | ||
if (!isset($this->objectid)) { | ||
throw new \coding_exception('The \'objectid\' must be set.'); | ||
} | ||
} | ||
|
||
/** | ||
* Returns relevant URL. | ||
* | ||
* @return \moodle_url | ||
*/ | ||
public function get_url() { | ||
// There is no url since the previous event already has the url where the h5p content has been displayed. | ||
return null; | ||
} | ||
|
||
/** | ||
* Return the legacy event name. | ||
* | ||
* @return string | ||
*/ | ||
public static function get_legacy_eventname() { | ||
return 'core_h5p_deleted'; | ||
} | ||
} |
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,88 @@ | ||
<?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/>. | ||
|
||
/** | ||
* Tests for h5p deleted event. | ||
* | ||
* @package core_h5p | ||
* @category test | ||
* @copyright 2019 Carlos Escobedo <carlos@moodle.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
* @since Moodle 3.8 | ||
*/ | ||
|
||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
use core_h5p\autoloader; | ||
|
||
/** | ||
* Tests for h5p deleted event. | ||
* | ||
* @package core_h5p | ||
* @category test | ||
* @copyright 2019 Carlos Escobedo <carlos@moodle.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
* @since Moodle 3.8 | ||
*/ | ||
class core_h5p_event_h5p_deleted_testcase extends advanced_testcase { | ||
|
||
/** | ||
* Setup test. | ||
*/ | ||
protected function setUp() { | ||
parent::setUp(); | ||
autoloader::register(); | ||
} | ||
|
||
/** | ||
* test_event_h5p_deleted description | ||
* @runInSeparateProcess | ||
*/ | ||
public function test_event_h5p_deleted() { | ||
$this->resetAfterTest(true); | ||
|
||
$user = $this->getDataGenerator()->create_user(); | ||
$course = $this->getDataGenerator()->create_course(); | ||
$page = $this->getDataGenerator()->create_module('page', array('course' => $course->id)); | ||
$pagecontext = \context_module::instance($page->cmid); | ||
|
||
// Dummy H5P id for testing proposal. We don't need a real h5p. | ||
$dummyh5pid = 111; | ||
$now = time(); | ||
// Event parameters for testing. | ||
$params = [ | ||
'objectid' => $dummyh5pid, | ||
'userid' => $user->id, | ||
'context' => $pagecontext, | ||
'other' => [ | ||
'time' => $now | ||
] | ||
]; | ||
// Prepare redirect Events. | ||
$sink = $this->redirectEvents(); | ||
// Test the event H5P deleted. | ||
$event = \core_h5p\event\h5p_deleted::create($params); | ||
$event->trigger(); | ||
$result = $sink->get_events(); | ||
$event = reset($result); | ||
$sink->close(); | ||
// Check the event info. | ||
$this->assertEquals($dummyh5pid, $event->objectid); | ||
$this->assertEquals($user->id, $event->userid); | ||
$this->assertEquals($pagecontext->id, $event->contextid); | ||
$this->assertEquals($now, $event->other['time']); | ||
} | ||
} |
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