[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   * Default completion for activity in a course updated event
  19   *
  20   * @package    core
  21   * @copyright  2017 Marina Glancy
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Default completion for activity in a course updated event
  31   *
  32   * @package    core
  33   * @since      Moodle 3.3
  34   * @copyright  2017 Marina Glancy
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class completion_defaults_updated extends base {
  38  
  39      /**
  40       * Initialise the event data.
  41       */
  42      protected function init() {
  43          $this->data['objecttable'] = 'course_completion_defaults';
  44          $this->data['crud'] = 'u';
  45          $this->data['edulevel'] = self::LEVEL_OTHER;
  46      }
  47  
  48      /**
  49       * Returns localised general event name.
  50       *
  51       * @return string
  52       */
  53      public static function get_name() {
  54          return get_string('eventdefaultcompletionupdated', 'completion');
  55      }
  56  
  57      /**
  58       * Returns relevant URL.
  59       *
  60       * @return \moodle_url
  61       */
  62      public function get_url() {
  63          return new \moodle_url('/course/defaultcompletion.php', array('id' => $this->courseid));
  64      }
  65  
  66      /**
  67       * Returns non-localised description of what happened.
  68       *
  69       * @return string
  70       */
  71      public function get_description() {
  72          return "The user with id '$this->userid' updated the default completion for module " .
  73              "'{$this->other['modulename']}' in course with id '$this->courseid'.";
  74      }
  75  
  76      /**
  77       * Custom validation.
  78       *
  79       * @throws \coding_exception
  80       */
  81      protected function validate_data() {
  82          parent::validate_data();
  83          if ($this->contextlevel != CONTEXT_COURSE) {
  84              throw new \coding_exception('Context passed must be course context.');
  85          }
  86          if (!isset($this->other['modulename'])) {
  87              throw new \coding_exception('The \'modulename\' value must be set in other.');
  88          }
  89      }
  90  
  91      /**
  92       * This is used when restoring course logs where it is required that we
  93       * map the objectid to it's new value in the new course.
  94       *
  95       * @return array
  96       */
  97      public static function get_objectid_mapping() {
  98          parent::get_objectid_mapping();
  99          return array('db' => 'course_completion_defaults', 'restore' => 'course_completion_defaults');
 100      }
 101  }