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.
Merge branch 'MDL-78019' of https://github.com/AnupamaSarjoshi/moodle
- Loading branch information
Showing
5 changed files
with
215 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
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,83 @@ | ||
| <?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/>. | ||
|
|
||
| namespace core\event; | ||
|
|
||
| /** | ||
| * Event fired when a file is deleted from the draft area. | ||
| * | ||
| * @property-read array $other { | ||
| * Extra information about the event. | ||
| * | ||
| * - string itemid: itemid of the file | ||
| * - string filename: Name of the file deleted from the draft area. | ||
| * - string filesize: The file size. | ||
| * - string filepath: The filepath. | ||
| * - string contenthash: The file contenthash. | ||
| * } | ||
| * | ||
| * @package core | ||
| * @since Moodle 4.2 | ||
| * @copyright 2023 The Open University. | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class draft_file_deleted extends base { | ||
|
|
||
| protected function init() { | ||
| $this->data['objecttable'] = 'files'; | ||
| $this->data['crud'] = 'd'; | ||
| $this->data['edulevel'] = self::LEVEL_OTHER; | ||
| } | ||
|
|
||
| public static function get_name() { | ||
| return get_string('eventfiledeletedfromdraftarea', 'files'); | ||
| } | ||
|
|
||
| public function get_description() { | ||
| $humansize = display_size($this->other['filesize']); | ||
| $filetype = 'file'; | ||
| if ($this->other['filename'] == '.') { | ||
| $filetype = 'folder'; | ||
| } | ||
| return "The user with id '{$this->userid}' has deleted {$filetype} '{$this->other['filepath']}" . | ||
| "{$this->other['filename']}' from the draft file area with item id {$this->other['itemid']}. Size: {$humansize}. ". | ||
| "Content hash: {$this->other['contenthash']}."; | ||
| } | ||
|
|
||
| protected function validate_data() { | ||
| parent::validate_data(); | ||
|
|
||
| if (!isset($this->other['itemid'])) { | ||
| throw new \coding_exception('The \'itemid\' must be set in other.'); | ||
| } | ||
|
|
||
| if (!isset($this->other['filename'])) { | ||
| throw new \coding_exception('The \'filename\' value must be set in other.'); | ||
| } | ||
|
|
||
| if (!isset($this->other['filesize'])) { | ||
| throw new \coding_exception('The \'filesize\' value must be set in other.'); | ||
| } | ||
|
|
||
| if (!isset($this->other['filepath'])) { | ||
| throw new \coding_exception('The \'filepath\' value must be set in other.'); | ||
| } | ||
|
|
||
| if (!isset($this->other['contenthash'])) { | ||
| throw new \coding_exception('The \'contenthash\' value 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,86 @@ | ||
| <?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/>. | ||
|
|
||
| /** | ||
| * File deleted from draft area test events. | ||
| * | ||
| * @package core | ||
| * @category test | ||
| * @copyright 2023 The Open University. | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| namespace core\event; | ||
|
|
||
| /** | ||
| * Test for draft file deleted event. | ||
| * | ||
| * @package core | ||
| * @category test | ||
| * @copyright 2023 The Open University. | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| * @covers \core\event\draft_file_deleted | ||
| */ | ||
| class draft_file_deleted_test extends \advanced_testcase { | ||
| /** | ||
| * Test draft file deleted event. | ||
| */ | ||
| public function test_event() { | ||
| $this->resetAfterTest(); | ||
| $user = $this->getDataGenerator()->create_user(); | ||
| $this->setUser($user); | ||
| $usercontext = \context_user::instance($user->id); | ||
|
|
||
| $sink = $this->redirectEvents(); | ||
| $fs = get_file_storage(); | ||
|
|
||
| $filerecord = [ | ||
| 'contextid' => $usercontext->id, | ||
| 'component' => 'core', | ||
| 'filearea' => 'unittest', | ||
| 'itemid' => 0, | ||
| 'filepath' => '/', | ||
| 'filename' => 'test.txt', | ||
| 'source' => 'Copyright stuff', | ||
| ]; | ||
| $originalfile = $fs->create_file_from_string($filerecord, 'Test content'); | ||
| $nbsp = "\xc2\xa0"; | ||
|
|
||
| // Event data for logging. | ||
| $eventdata = [ | ||
| 'objectid' => $originalfile->get_id(), | ||
| 'context' => $usercontext, | ||
| 'other' => [ | ||
| 'itemid' => $originalfile->get_itemid(), | ||
| 'filename' => $originalfile->get_filename(), | ||
| 'filesize' => $originalfile->get_filesize(), | ||
| 'filepath' => $originalfile->get_filepath(), | ||
| 'contenthash' => $originalfile->get_contenthash(), | ||
| ] | ||
| ]; | ||
| $event = \core\event\draft_file_deleted::create($eventdata); | ||
| $event->trigger(); | ||
|
|
||
| $events = $sink->get_events(); | ||
| $this->assertCount(1, $events); | ||
| $event = reset($events); | ||
|
|
||
| $this->assertEquals($usercontext, $event->get_context()); | ||
| $expected = "The user with id '{$user->id}' has deleted file '/test.txt' from the draft file area with item id 0. ". | ||
| "Size: 12{$nbsp}bytes. Content hash: {$originalfile->get_contenthash()}."; | ||
| $this->assertSame($expected, $event->get_description()); | ||
| } | ||
| } |
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
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