[Summary view]

   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   * Custom field updated event.
  19   *
  20   * @package    core_customfield
  21   * @copyright  2018 Daniel Neis Araujo <daniel@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_customfield\event;
  26  
  27  use core_customfield\field_controller;
  28  
  29  defined('MOODLE_INTERNAL') || die();
  30  
  31  /**
  32   * Custom field updated event class.
  33   *
  34   * @package    core_customfield
  35   * @since      Moodle 3.6
  36   * @copyright  2018 Daniel Neis Araujo <daniel@moodle.com>
  37   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  38   */
  39  class field_updated extends \core\event\base {
  40  
  41      /**
  42       * Initialise the event data.
  43       */
  44      protected function init() {
  45          $this->data['objecttable'] = 'customfield_field';
  46          $this->data['crud'] = 'c';
  47          $this->data['edulevel'] = self::LEVEL_OTHER;
  48      }
  49  
  50      /**
  51       * Creates an instance from a field controller object
  52       *
  53       * @param field_controller $field
  54       * @return field_updated
  55       */
  56      public static function create_from_object(field_controller $field) : field_updated {
  57          $eventparams = [
  58              'objectid' => $field->get('id'),
  59              'context'  => $field->get_handler()->get_configuration_context(),
  60              'other'    => [
  61                  'shortname' => $field->get('shortname'),
  62                  'name'      => $field->get('name')
  63              ]
  64          ];
  65          $event = self::create($eventparams);
  66          $event->add_record_snapshot($event->objecttable, $field->to_record());
  67          return $event;
  68      }
  69  
  70      /**
  71       * Returns localised general event name.
  72       *
  73       * @return string
  74       */
  75      public static function get_name() {
  76          return get_string('eventfieldupdated', 'core_customfield');
  77      }
  78  
  79      /**
  80       * Returns non-localised description of what happened.
  81       *
  82       * @return string
  83       */
  84      public function get_description() {
  85          return "The user with id '$this->userid' updated the field with id '$this->objectid'.";
  86      }
  87  }