[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  declare(strict_types=1);
  18  
  19  namespace core_reportbuilder\event;
  20  
  21  use coding_exception;
  22  use core\event\base;
  23  use core_reportbuilder\local\models\report;
  24  
  25  /**
  26   * Report builder custom report deleted event class.
  27   *
  28   * @package     core_reportbuilder
  29   * @copyright   2021 David Matamoros <davidmc@moodle.com>
  30   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  31   *
  32   * @property-read array $other {
  33   *      Extra information about the event.
  34   *
  35   *      - string    name:      The name of the report
  36   *      - string    source:    The report source class
  37   * }
  38   */
  39  class report_deleted extends base {
  40  
  41      /**
  42       * Initialise the event data.
  43       */
  44      protected function init() {
  45          $this->data['objecttable'] = report::TABLE;
  46          $this->data['crud'] = 'd';
  47          $this->data['edulevel'] = self::LEVEL_OTHER;
  48      }
  49  
  50      /**
  51       * Creates an instance from a report object
  52       *
  53       * @param report $report
  54       * @return self
  55       */
  56      public static function create_from_object(report $report): self {
  57          $eventparams = [
  58              'context'  => $report->get_context(),
  59              'objectid' => $report->get('id'),
  60              'other' => [
  61                  'name'     => $report->get('name'),
  62                  'source'   => $report->get('source'),
  63              ]
  64          ];
  65          $event = self::create($eventparams);
  66          $event->add_record_snapshot($event->objecttable, $report->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('reportdeleted', 'core_reportbuilder');
  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' deleted the custom report with id '$this->objectid'.";
  86      }
  87  
  88      /**
  89       * Custom validations.
  90       *
  91       * @throws coding_exception
  92       */
  93      protected function validate_data(): void {
  94          parent::validate_data();
  95          if (!isset($this->objectid)) {
  96              throw new coding_exception('The \'objectid\' must be set.');
  97          }
  98      }
  99  }