moodle/lib/classes/event/draft_file_deleted.php

84 lines
2.9 KiB
PHP

<?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.');
}
}
}