MDL-39954 core: Abstract event assessable_submitted & assessable_uploaded

This commit is contained in:
Frederic Massart 2013-07-30 17:21:13 +08:00
parent 50ff861263
commit e185f72d58
2 changed files with 138 additions and 0 deletions

View file

@ -0,0 +1,67 @@
<?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/>.
/**
* Abstract assessable submitted event.
*
* @package core
* @copyright 2013 Frédéric Massart
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core\event;
defined('MOODLE_INTERNAL') || die();
/**
* Abstract assessable submitted event class.
*
* This class has to be extended by any event which represent that some content,
* on which someone will be assessed, has been submitted and so made available
* for grading. See {@link \core\event\assessable_uploaded} for when the content
* has just been uploaded.
*
* Both events could be triggered in a row, first the uploaded, then the submitted.
*
* @package core
* @copyright 2013 Frédéric Massart
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
abstract class assessable_submitted extends \core\event\base {
/**
* Init method.
*
* @return void
*/
protected function init() {
$this->data['crud'] = 'u';
$this->data['level'] = 50; // TODO MDL-37658.
}
/**
* Custom validation.
*
* @throws coding_exception on error.
* @return void
*/
protected function validate_data() {
if (!$this->context->contextlevel === CONTEXT_MODULE) {
throw new coding_exception('Content level must be CONTEXT_MODULE.');
}
}
}

View file

@ -0,0 +1,71 @@
<?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/>.
/**
* Abstract assessable uploaded event.
*
* @package core
* @copyright 2013 Frédéric Massart
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core\event;
defined('MOODLE_INTERNAL') || die();
/**
* Abstract assessable uploaded event class.
*
* This class has to be extended by any event which represent that some content,
* on which someone will be assessed, has been uploaded. This is different
* than other events such as assessable_submitted, which means that the content
* has been submitted and made available for grading.
*
* Both events could be triggered in a row, first the uploaded, then the submitted.
*
* @package core
* @copyright 2013 Frédéric Massart
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
abstract class assessable_uploaded extends \core\event\base {
/**
* Init method.
*
* @return void
*/
protected function init() {
$this->data['crud'] = 'c';
$this->data['level'] = 50; // TODO MDL-37658.
}
/**
* Validation that should be shared among child classes.
*
* @throws coding_exception when validation fails.
* @return void
*/
protected function validate_data() {
if (!$this->context->contextlevel === CONTEXT_MODULE) {
throw new coding_exception('Content level must be CONTEXT_MODULE.');
} else if (!isset($this->other['pathnamehashes']) || !is_array($this->other['pathnamehashes'])) {
throw new coding_exception('pathnamehashes must be set in $other and must be an array.');
} else if (!isset($this->other['content']) || !is_string($this->other['content'])) {
throw new coding_exception('content must be set in $other and must be a string.');
}
}
}