[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   * The tool_monitor subscription criteria met event.
  19   *
  20   * @package    tool_monitor
  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 tool_monitor\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The tool_monitor subscription criteria met event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - string subscriptionid: id of the subscription.
  36   * }
  37   *
  38   * @package    tool_monitor
  39   * @since      Moodle 2.8
  40   * @copyright  2014 Mark Nelson <markn@moodle.com>
  41   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42   */
  43  class subscription_criteria_met extends \core\event\base {
  44  
  45      /**
  46       * Init method.
  47       *
  48       * @return void
  49       */
  50      protected function init() {
  51          $this->data['crud'] = 'c';
  52          $this->data['edulevel'] = self::LEVEL_TEACHING;
  53      }
  54  
  55      /**
  56       * Return localised event name.
  57       *
  58       * @return string
  59       */
  60      public static function get_name() {
  61          return get_string('eventsubcriteriamet', 'tool_monitor');
  62      }
  63  
  64      /**
  65       * Returns description of what happened.
  66       *
  67       * @return string
  68       */
  69      public function get_description() {
  70          return "The criteria for the subscription with id '{$this->other['subscriptionid']}' was met.";
  71      }
  72  
  73      /**
  74       * Custom validation.
  75       *
  76       * @throws \coding_exception
  77       * @return void
  78       */
  79      protected function validate_data() {
  80          parent::validate_data();
  81  
  82          if (!isset($this->other['subscriptionid'])) {
  83              throw new \coding_exception('The \'subscriptionid\' value must be set in other.');
  84          }
  85      }
  86  
  87      public static function get_other_mapping() {
  88          // No mapping required for this event because event monitor subscriptions are not backed up.
  89          return false;
  90      }
  91  }