customfield/classes/event/category_created.php

   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 category created 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\category_controller;
  28
  29 defined('MOODLE_INTERNAL') || die();
  30
  31 /**
  32  * Custom field category created 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 category_created extends \core\event\base {
  40
  41     /**
  42      * Initialise the event data.
  43      */
  44     protected function init() {
  45         $this->data['objecttable'] = 'customfield_category';
  46         $this->data['crud'] = 'c';
  47         $this->data['edulevel'] = self::LEVEL_OTHER;
  48     }
  49
  50     /**
  51      * Creates an instance from a category controller object
  52      *
  53      * @param category_controller $category
  54      * @return category_created
  55      */
  56     public static function create_from_object(category_controller $category) : category_created {
  57         $eventparams = [
  58             'objectid' => $category->get('id'),
  59             'context'  => $category->get_handler()->get_configuration_context(),
  60             'other'    => ['name' => $category->get('name')]
  61         ];
  62         $event = self::create($eventparams);
  63         $event->add_record_snapshot($event->objecttable, $category->to_record());
  64         return $event;
  65     }
  66
  67     /**
  68      * Returns localised general event name.
  69      *
  70      * @return string
  71      */
  72     public static function get_name() {
  73         return get_string('eventcategorycreated', 'core_customfield');
  74     }
  75
  76     /**
  77      * Returns non-localised description of what happened.
  78      *
  79      * @return string
  80      */
  81     public function get_description() {
  82         return "The user with id '$this->userid' created the category with id '$this->objectid'.";
  83     }
  84 }