[Summary view]

Differences Between: [Versions 310 and 402] [Versions 310 and 403]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * The mod_assign submission form viewed event.
  19   *
  20   * @package    mod_assign
  21   * @copyright  2014 Mark Nelson <markn@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_assign\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The mod_assign submission form viewed event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - int assignid: the id of the assignment.
  36   * }
  37   *
  38   * @package    mod_assign
  39   * @since      Moodle 2.7
  40   * @copyright  2014 Mark Nelson <markn@moodle.com>
  41   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42   */
  43  class submission_confirmation_form_viewed extends base {
  44      /**
  45       * Flag for prevention of direct create() call.
  46       * @var bool
  47       */
  48      protected static $preventcreatecall = true;
  49  
  50      /**
  51       * Create instance of event.
  52       *
  53       * @param \assign $assign
  54       * @return submission_confirmation_form_viewed
  55       */
  56      public static function create_from_assign(\assign $assign) {
  57          $data = array(
  58              'context' => $assign->get_context(),
  59              'other' => array(
  60                  'assignid' => $assign->get_instance()->id,
  61              ),
  62          );
  63          self::$preventcreatecall = false;
  64          /** @var submission_confirmation_form_viewed $event */
  65          $event = self::create($data);
  66          self::$preventcreatecall = true;
  67          $event->set_assign($assign);
  68          return $event;
  69      }
  70  
  71      /**
  72       * Init method.
  73       */
  74      protected function init() {
  75          $this->data['crud'] = 'r';
  76          $this->data['edulevel'] = self::LEVEL_OTHER;
  77      }
  78  
  79      /**
  80       * Returns localised general event name.
  81       *
  82       * @return string
  83       */
  84      public static function get_name() {
  85          return get_string('eventsubmissionconfirmationformviewed', 'mod_assign');
  86      }
  87  
  88      /**
  89       * Returns description of what happened.
  90       *
  91       * @return string
  92       */
  93      public function get_description() {
  94          return "The user with id '$this->userid' viewed the submission confirmation form for the assignment with " .
  95              "course module id '$this->contextinstanceid'.";
  96      }
  97  
  98      /**
  99       * Return legacy data for add_to_log().
 100       *
 101       * @return array
 102       */
 103      protected function get_legacy_logdata() {
 104          $logmessage = get_string('viewownsubmissionform', 'assign');
 105          $this->set_legacy_logdata('view confirm submit assignment form', $logmessage);
 106          return parent::get_legacy_logdata();
 107      }
 108  
 109      /**
 110       * Custom validation.
 111       *
 112       * @throws \coding_exception
 113       * @return void
 114       */
 115      protected function validate_data() {
 116          if (self::$preventcreatecall) {
 117              throw new \coding_exception('cannot call submission_confirmation_form_viewed::create() directly, use submission_confirmation_form_viewed::create_from_assign() instead.');
 118          }
 119  
 120          parent::validate_data();
 121  
 122          if (!isset($this->other['assignid'])) {
 123              throw new \coding_exception('The \'assignid\' value must be set in other.');
 124          }
 125      }
 126  
 127      public static function get_other_mapping() {
 128          $othermapped = array();
 129          $othermapped['assignid'] = array('db' => 'assign', 'restore' => 'assign');
 130  
 131          return $othermapped;
 132      }
 133  }