[Summary view]

Differences Between: [Versions 311 and 402] [Versions 311 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_data field updated event.
  19   *
  20   * @package    mod_data
  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_data\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The mod_data field updated event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - string fieldname: the name of the field.
  36   *      - int dataid: the id of the data activity.
  37   * }
  38   *
  39   * @package    mod_data
  40   * @since      Moodle 2.7
  41   * @copyright  2014 Mark Nelson <markn@moodle.com>
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class field_updated extends \core\event\base {
  45  
  46      /**
  47       * Init method.
  48       *
  49       * @return void
  50       */
  51      protected function init() {
  52          $this->data['objecttable'] = 'data_fields';
  53          $this->data['crud'] = 'u';
  54          $this->data['edulevel'] = self::LEVEL_TEACHING;
  55      }
  56  
  57      /**
  58       * Return localised event name.
  59       *
  60       * @return string
  61       */
  62      public static function get_name() {
  63          return get_string('eventfieldupdated', 'mod_data');
  64      }
  65  
  66      /**
  67       * Returns description of what happened.
  68       *
  69       * @return string
  70       */
  71      public function get_description() {
  72          return "The user with id '$this->userid' updated the field with id '$this->objectid' in the data activity " .
  73              "with course module id '$this->contextinstanceid'.";
  74      }
  75  
  76      /**
  77       * Get URL related to the action.
  78       *
  79       * @return \moodle_url
  80       */
  81      public function get_url() {
  82          return new \moodle_url('/mod/data/field.php', array('d' => $this->other['dataid']));
  83      }
  84  
  85      /**
  86       * Get the legacy event log data.
  87       *
  88       * @return array
  89       */
  90      public function get_legacy_logdata() {
  91          return array($this->courseid, 'data', 'fields update', 'field.php?d=' . $this->other['dataid'] .
  92              '&amp;mode=display&amp;fid=' . $this->objectid, $this->objectid, $this->contextinstanceid);
  93      }
  94  
  95      /**
  96       * Custom validation.
  97       *
  98       * @throws \coding_exception when validation does not pass.
  99       * @return void
 100       */
 101      protected function validate_data() {
 102          parent::validate_data();
 103  
 104          if (!isset($this->other['fieldname'])) {
 105              throw new \coding_exception('The \'fieldname\' value must be set in other.');
 106          }
 107  
 108          if (!isset($this->other['dataid'])) {
 109              throw new \coding_exception('The \'dataid\' value must be set in other.');
 110          }
 111      }
 112  
 113      public static function get_objectid_mapping() {
 114          return array('db' => 'data_fields', 'restore' => 'data_field');
 115      }
 116  
 117      public static function get_other_mapping() {
 118          $othermapped = array();
 119          $othermapped['dataid'] = array('db' => 'data', 'restore' => 'data');
 120  
 121          return $othermapped;
 122      }
 123  }