[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_workshop phase switched event.
  19   *
  20   * @package    mod_workshop
  21   * @copyright  2013 Adrian Greeve
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_workshop\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The mod_workshop phase switched event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about the event.
  33   *
  34   *      - int workshopphase: Workshop phase.
  35   * }
  36   *
  37   * @package    mod_workshop
  38   * @since      Moodle 2.7
  39   * @copyright  2013 Adrian Greeve
  40   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class phase_switched extends \core\event\base {
  43  
  44      /**
  45       * Init method.
  46       *
  47       * @return void
  48       */
  49      protected function init() {
  50          $this->data['crud'] = 'u';
  51          $this->data['edulevel'] = self::LEVEL_TEACHING;
  52          $this->data['objecttable'] = 'workshop';
  53      }
  54  
  55      /**
  56       * Returns description of what happened.
  57       *
  58       * @return string
  59       */
  60      public function get_description() {
  61          return "The user with id '$this->userid' has switched the phase of the workshop with course module id " .
  62              "'$this->contextinstanceid' to '{$this->other['workshopphase']}'.";
  63      }
  64  
  65      /**
  66       * Return the legacy event log data.
  67       *
  68       * @return array|null
  69       */
  70      protected function get_legacy_logdata() {
  71          return array($this->courseid, 'workshop', 'update switch phase', 'view.php?id=' . $this->contextinstanceid,
  72                  $this->other['workshopphase'], $this->contextinstanceid);
  73      }
  74  
  75      /**
  76       * Return localised event name.
  77       *
  78       * @return string
  79       */
  80      public static function get_name() {
  81          return get_string('eventphaseswitched', 'mod_workshop');
  82      }
  83  
  84      /**
  85       * Get URL related to the action.
  86       *
  87       * @return \moodle_url
  88       */
  89      public function get_url() {
  90          return new \moodle_url('/mod/workshop/view.php', array('id' => $this->contextinstanceid));
  91      }
  92  
  93      /**
  94       * Custom validation.
  95       *
  96       * @throws \coding_exception
  97       * @return void
  98       */
  99      protected function validate_data() {
 100          parent::validate_data();
 101  
 102          if (!isset($this->other['workshopphase'])) {
 103              throw new \coding_exception('The \'workshopphase\' value must be set in other.');
 104          }
 105      }
 106  
 107      public static function get_objectid_mapping() {
 108          return array('db' => 'workshop', 'restore' => 'workshop');
 109      }
 110  
 111      public static function get_other_mapping() {
 112          // Nothing to map.
 113          return false;
 114      }
 115  }