Proyectos de Subversion Moodle

<?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/>.

/**

 * The mod_assign remove submission form viewed event.

 *

 * @package    mod_assign

 * @copyright  2019 Damyon Wiese

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

namespace mod_assign\event;

defined('MOODLE_INTERNAL') || die();

/**

 * The mod_assign remove submission form viewed event class.

 *

 * @package    mod_assign

 * @copyright  2019 Damyon Wiese

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

class remove_submission_form_viewed extends base {

    /**

     * Flag for prevention of direct create() call.

     * @var bool

     */

    protected static $preventcreatecall = true;

    /**

     * Create instance of event.

     *

     * @param \assign $assign

     * @param \stdClass $user

     * @return remove_submission_form_viewed

     */

    public static function create_from_user(\assign $assign, \stdClass $user) {

        $data = array(

            'relateduserid' => $user->id,

            'context' => $assign->get_context(),

            'other' => array(

                'assignid' => $assign->get_instance()->id,

            ),

        );

        self::$preventcreatecall = false;

        /** @var remove_submission_form_viewed $event */

        $event = self::create($data);

        self::$preventcreatecall = true;

        $event->set_assign($assign);

        $event->add_record_snapshot('user', $user);

        return $event;

    }

    /**

     * Init method.

     */

    protected function init() {

        $this->data['crud'] = 'r';

        $this->data['edulevel'] = self::LEVEL_OTHER;

    }

    /**

     * Returns localised general event name.

     *

     * @return string

     */

    public static function get_name() {

        return get_string('eventremovesubmissionformviewed', 'mod_assign');

    }

    /**

     * Returns description of what happened.

     *

     * @return string

     */

    public function get_description() {

        if ($this->userid != $this->relateduserid) {

            return "The user with id '$this->userid' viewed the " .

                "remove submission form for the user with id '$this->relateduserid' " .

                "for the assignment with course module id '$this->contextinstanceid'.";

        }

        return "The user with id '$this->userid' viewed their remove submission form for the assignment with course module id " .

            "'$this->contextinstanceid'.";

    }

    /**

     * Custom validation.

     *

     * @throws \coding_exception

     */

    protected function validate_data() {

        if (self::$preventcreatecall) {

            throw new \coding_exception('cannot call remove_submission_form_viewed::create() directly, use ' .

                                        'remove_submission_form_viewed::create_from_user() instead.');

        }

        parent::validate_data();

        if (!isset($this->relateduserid)) {

            throw new \coding_exception('The \'relateduserid\' must be set.');

        }

        if (!isset($this->other['assignid'])) {

            throw new \coding_exception('The \'assignid\' value must be set in other.');

        }

    }

    /**

     * This is documented in the parent class.

     *

     * @return array an array of other values and their corresponding mapping

     */

    public static function get_other_mapping() {

        $othermapped = array();

        $othermapped['assignid'] = array('db' => 'assign', 'restore' => 'assign');

        return $othermapped;

    }

}