[Summary view]

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